subscription.access_suspended
A failed renewal's grace window closed unpaid, and the member's access was paused.
When this fires
The grace window the project gives a failed renewal (seven days by default, 0 to 30, set per project) ran out with no settled charge. The member is removed from the project's resources and told that their access is paused and how to pay, the subscription stays past_due so the rail's own retries can still settle it, and the next settled charge brings them back. A window of zero days pauses at the failure itself.
A membership that never paid is revoked at the failure without a window, as it always was, and fires subscription.expired instead.
Caveats
- The subscription's status does not change on this event: it was already
past_due, and stays so until a charge settles or the rail gives up (subscription.unpaid). - A creator's own pause (
subscription.paused) is a different thing and never collides with this: a subscription the creator paused is left out of the grace sweep.
Related events
subscription.past_due: the failure that opened the window.subscription.payment_recovered: the charge that ends it.subscription.access_restored: the member let back in.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
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.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on