Skip to main content

subscription.plan_changed

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to follow a subscription that changed plan rather than price — the sibling of subscription.amount_changed, which announces a new amount on the SAME plan. The switch is applied in place with no proration; the new plan’s amount bills at the existing cycle boundary, and the currency does not move. A plan on another cadence starts it at that same boundary: the period already paid for is kept, and nothing is charged until then. new_plan is the plan the subscription now runs on; old_plan is the plan it moved off, and null when no recorded fact names that plan. effective_at is a prediction on the same terms as subscription.amount_changed. 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 currency, as this event always has. effective_at is the prediction recorded with the change; pending_change.effective_at is the next renewal as of the event. 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.