Changes a subscription's priceId and/or quantity mid-cycle and issues a Stripe-style daily-prorated invoice for the rate difference. Allowed on active or trialing subs only (trialing skips proration entirely — the new price takes effect at trial end). The new price must be active, recurring, and the same currency as the current one. Downgrades that net <= 0 apply without generating a credit invoice (v1 has no credit balance — the customer simply pays less at next renewal).
AuthorizationRequiredBearer <token>API key as Bearer token
In: header
application/jsonRequiredpriceIdstringSwitch to this Price. Must be active, recurring, same currency.
quantityintegerNew unit count. Must differ from the current quantity when priceId is unchanged.
1Maximum: 9007199254740991notesstringMemo carried onto future renewal invoices. Empty/whitespace clears.
5000taxIdsarray<object>Tax-ID snapshot forwarded onto future renewals.
taxRatenumberTax rate (percent) applied to renewal subtotals. 0 clears.
0Maximum: 100autoChargebooleanFlip auto-charge vs. manual-collection. Effective next renewal.
dunningEnabledbooleanSmart-retry toggle for failed renewals.
paymentDueDaysintegerNet-N-days for manual-collection invoices.
0Maximum: 9007199254740991idRequiredstringSubscription id, discoverable via list_subscriptions