Subscription cancellation scheduled (standard payload)
Issued when a subscription cancellation is scheduled.
What an endpoint configured for standard payloads receives: subscription is a summary rather than the full resource. Other endpoints receive the expanded payload.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
v1= followed by the hex HMAC-SHA256 of v1:{X-Orb-Timestamp}:{raw request body}, keyed by the endpoint's webhook secret. The header may carry several space-separated signatures during a secret rotation; a receiver accepts the delivery when any v1 signature matches. Compare in constant time, and sign the bytes as received rather than a re-serialized body.
When the delivery was signed, ISO 8601 to milliseconds. It is part of the signed message, so a receiver must reject timestamps outside its tolerance to stop replays.
Body
Issued when a subscription cancellation is scheduled.
The ID of this webhook event.
The time at which this event was created, to the second.
The event this payload describes.
subscription.cancellation_scheduled The serialization style this payload was rendered in, as configured on the endpoint.
expanded, standard A subscription's own fields, with its plan and customer as references, as listed by List subscription summaries and carried in standard webhook payloads. Fetch the subscription for its price intervals, billing periods, plan phases and other derived fields.
Response
Any 2xx acknowledges receipt.