Skip to main content

subscription.cancelled

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to stop expecting renewals on a subscription and to end whatever you grant alongside it. You receive it once per subscription. A cancellation the buyer or COPE support asked for through COPE arrives when it is accepted: the subscription keeps running and the buyer keeps access until access_until, so do not revoke anything before that date. Every other ending — one you asked for through the cancel endpoint, renewal payments that kept failing, or a cancellation made directly at the payment processor — arrives when the subscription has already ended, and access_until is when it ended. cancellation_reason is one of buyer_cancel, admin_cancel, business_cancel and payment_failed, and those four are the whole list. The body names the business, the order, the line item and the subscription, each as object and id; store subscription.id to match later events on the same subscription. The body also carries the subscription’s state as of the event — status, currency, amount_minor_units with its net_amount_minor_units and tax_minor_units halves and has_net_price, next_billing_at and pending_change, read from the same state the Subscription object (GET /v1/commerce/subscriptions/{id}) is built from, with timestamps to the second — so you do not need to call back to learn it. An instalment plan, which the Subscription API does not serve, carries none of it. Read anything else about these entities through the API.

Delivery Contract

Payload Fields

Example delivery

Compatibility

Fields may be added within the same major version. Removing or changing the meaning of a documented field requires a new event version.