Utopia PaymentsDocs
Webhook events

subscription.on_hold

Sent to your endpoint as a signed POST. Answer with any 2xx within 10 seconds; failures are retried with backoff for about a day. Verify the signature before trusting the body.

Sent to your endpoint as a signed POST. Answer with any 2xx within 10 seconds; failures are retried with backoff for about a day. Verify the signature before trusting the body.

Header Parameters

webhook-id*string

Unique per event; use it to ignore duplicates.

Match^evt_[0-9a-f]{32}$
webhook-timestamp*string

Unix seconds. Reject deliveries older than a few minutes.

webhook-signature*string

v1, + base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{raw body}, keyed with the base64-decoded part of your whsec_ secret.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

Example Requests

POST/subscription.on_hold