Skip to main content

Preview Subscription Update

POST 
/subscriptions/:id/preview

Calculate what a prorated change to a subscription would settle, without applying it.

Send the amount, interval, intervalCount or nextPaymentAt you intend to set. The response reports the credit for unused time, the charge for the new price or the extra time, and the net difference that would move. Nothing is charged, refunded or stored.

Use this to show a customer the cost of a plan change, or of moving their next charge date, before they confirm it. Then apply the change with Update Subscription and prorate: true.

The figures are an estimate. Applying the change recalculates them at that moment, so a preview taken much earlier can differ. The same validation runs here as on the update, so a change this endpoint rejects would also be rejected when applied.

Request​

Responses​

The proration a subscription update would settle

Last updated on