v1

latestOpenAPI 3.1.02026-07-24104338.0 KB

Webhooks

A subscription was canceled

Sent when a subscription is canceled before its natural end. See payload.data.cancellation.reason for who canceled it and why. payload.data is the full Subscription.

postWebhooksubscription.canceled

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": {
      "amount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "startDate": 1748513400,
      "currentPeriod": {
        "start": 1748513400,
        "end": 1748513400
      },
      "nextPaymentDate": 1748513400,
      "endsAt": 1748513400,
      "cancellation": {
        "at": 1748513400
      },
      "expiration": {
        "at": 1748513400
      },
      "createdAt": 1748513400,
      "updatedAt": 1748513400
    }
  }
}

Response

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