subscription.cancelled
Cancellation recorded; access continues until endsat.
When this fires
Cancellation is recorded by the subscriber, by the creator, or by the payment provider (a gateway-side cancellation, or a terminal payment failure on CeyPay, CoinPayments or Skrill). If the paid period still has time left, the subscription stays active and the subscriber keeps access until ends_at, after which subscription.expired fires. If no paid period remains, ends_at is set to the cancellation moment and resource access is revoked straight away.
Caveats
- Cancellation is reversible until
ends_at; seesubscription.reactivated. - A renewal does not occur after cancellation;
subscription.renewedwill not fire.
Related events
subscription.expired: fires when the period ends.subscription.reactivated: reverse path.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Request Body
application/json
The signed JSON envelope posted to your endpoint.
TypeScript Definitions
Use the request body type in TypeScript.
The envelope every event is delivered in.
Response Body
Example Requests
/subscription.cancelledHow is this guide?