v1

latestOpenAPI 3.1.02026-07-24104338.0 KB

Webhooks

A recurring charge failed

Sent when a recurring charge fails to settle. payload.data is the Payment record; see payload.data.failureReason. payload.entityId is the parent subscription.

postWebhooksubscription.payment.failed

Payload

idstring uuid required

Unique id of this event (UUIDv7). Stable across redeliveries — delivery is at-least-once and the same id is replayed on retry, so use it to dedupe.

timestampstring date-time required

When the event was produced (ISO-8601 UTC).

entityIdstring uuid required

The subscription this event concerns. Always the subscription id, even for payment events — which route to their parent subscription.

versioninteger required

Monotonically increasing per subscription. Use it to order a subscription's events and discard stale redeliveries.

Example payload

{
  "payload": {
    "eventType": "subscription.activated",
    "data": {
      "billedAmount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "paidAmount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "paidAt": 1748513400,
      "createdAt": 1748513400
    }
  }
}

Response

Return any 2xx status to acknowledge receipt. Any other response (or a timeout) is treated as a delivery failure and retried.