Skip to main content

What a plan or interval change does, before confirming

POST 
/api/v3/billing/subscription/preview

What a plan or interval change does, before confirming. mode now (an upgrade, or any change in a trial): Paddle's prorated amounts — new_plan_amount (the new plan for the rest of the period), unused_credit (the unused part of the old plan), tax, result_action charge | credit and result_amount (tax in); covered: true when Paddle was already paid for the target plan (or a higher one) in the current billing period, same interval and not yet ended (an upgrade back after a downgrade), so it applies unbilled (do_not_bill) until the next renewal. mode scheduled (a downgrade: a lower plan, or year → month): nothing is charged now and the change takes effect at effective_at, the end of the paid period

Request​

Responses​

{ plan, interval, mode, covered, effective_at, new_plan_amount, unused_credit, tax, charge, credit, result_action, result_amount, currency, next_billed_at }