Skip to main content

subscription.resumed

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to resume tracking renewals on a subscription you paused. It is the counterpart of subscription.paused with pause_reason business_request only: when collection restarts after a failed payment is settled (pause_reason payment_failed), no subscription.resumed is sent, so do not wait for one. Nothing is charged at the moment of resuming. Billing continues from the existing cycle boundary, and next_billing_at is when the next renewal is due, or null if that date could not be determined. 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 only next_billing_at, as this event always has. 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.