Skip to main content

When this fires

A move to another version that was waiting for the subscription’s renewal will not happen, and the subscription stays on its version. toVersionId is the version it was going to move to, and reason says why: A move made now has nothing pending, so it never fires this event. Neither does a new move that replaces the pending one, a change to another plan, or a subscription that ends instead of renewing: the pending move is dropped and scheduledVersionChange becomes null. To move the subscription later, resolve what reason names and request the move again. Only endpoints that list this event receive it. New event types are not added to existing endpoints: add it to the endpoint’s events in Settings → Webhooks or with Update webhook endpoint.

Body

application/json
id
string
required
event
string
required
Allowed value: "subscription.version_change_canceled"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.