Skip to main content

subscription.amount_changed

Generated from COPE public event contracts. Do not edit this page by hand.
Use this event to mirror a repriced subscription into your own billing records. The change is applied in place with no proration, so nothing is charged when it happens: the new amount bills at the existing cycle boundary. effective_at is when we expect that to be — it is derived from the subscription’s next payment date at the moment of the change, and a cycle that later moves for an unrelated reason leaves it stale, so treat it as a prediction and take the charge itself as the confirmation. old_recurring_amount_cents and new_recurring_amount_cents are what the buyer is billed, quantity included, in currency, and old_recurring_amount_minor_units and new_recurring_amount_minor_units carry the same two values under the API convention’s names. 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.