access_until | yes | `string | null` | - |
amount_minor_units | no | integer | - | The recurring amount in force, in the minor units of currency, quantity included: what the period already billed was billed at. As of the event, read from the state the Subscription object (GET /v1/commerce/subscriptions/{id}) is built from, with timestamps to the second. A change waiting for the next renewal is pending_change. |
business | no | object | - | The business that sold the subscription. |
cancellation_reason | yes | string | buyer_cancel, admin_cancel, business_cancel, payment_failed | Who or what ended it: the buyer, COPE support, you, or renewal payments that kept failing. |
cancelled_at | yes | string | - | When the cancellation was accepted, or when the subscription ended if nobody asked for it through COPE. |
currency | no | string | - | ISO 4217 code of the subscription’s currency: the currency of every amount in this body. |
has_net_price | no | boolean | - | The basis these terms were set in: true when the recurring amount was stated net of tax, false when it was stated with the tax included. |
line_item | no | object | - | The order line the subscription belongs to. |
net_amount_minor_units | no | integer | - | The part of amount_minor_units before tax, in the minor units of currency. |
next_billing_at | no | `string | null` | - |
order | no | object | - | The order the subscription was bought on. |
pending_change | no | `object | null` | - |
status | no | string | pending, trial, active, overdue, paused, canceling, cancelled | The subscription’s status. As of the event, read from the state the Subscription object (GET /v1/commerce/subscriptions/{id}) is built from, with timestamps to the second. canceling means a cancellation was accepted and has not taken effect; it becomes cancelled when the subscription ends. Absent, with the rest of the subscription’s state, on an instalment plan, which the Subscription API does not serve, and on an event sent before the state was added. |
subscription | no | object | - | The subscription. Absent when the event names no subscription id of the right shape. |
tax_minor_units | no | integer | - | The tax in amount_minor_units, at the rate the subscription was sold at. Each renewal’s tax is calculated again when it is charged, from amount_minor_units. |