Preview a subscription proration

POST 
/v2/subscriptions/subscriptions/:subscription_uuid/proration-preview

Computes the proration amounts a prospective plan or pricing option change would produce, without persisting anything or affecting billing. Use this to show a subscriber the cost impact of a change before submitting it via a subscription update.

A 200 response with would_prorate: false is not an error - it means the prospective change would not result in a proration being applied if actually submitted. See rejection_reason.

Request

Responses

200

Success. The proration preview was computed.

400

Bad request. The request failed validation.

404

Not found. The requested entity does not exist.

422

Unprocessable Content.

500

Internal server error. There was a system failure in the platform.