Single declarative entry point for every subscription update. Exactly one operation group is accepted per call:
Plan change (amountInCents, interval, intervalCount, cycleCount, name, description), with prorationBehavior controlling the money side. Two independent choices — when (now or at the next billing date) and whether to prorate — are folded into this single value, since proration only makes sense for an immediate change. PRORATE_NOW: apply immediately, with proration — an amount increase is charged pro-rata now (authorized, then captured once the change is applied); an amount decrease or a longer billing cycle applies now, a fresh billing cycle starts and the unused portion of the current cycle is credited to the customer's balance, only the net is charged. FULL_CHARGE_NOW: apply immediately, without proration — an amount increase is charged in full now (not scaled down for the days remaining in the cycle); an amount decrease or a longer billing cycle starts a fresh cycle now at the full new amount, with no credit for the unused portion. NEXT_PERIOD: the new plan takes effect at the next billing date, nothing charged or credited now. Defaults: amount increase and longer cycle use PRORATE_NOW; amount decrease and shorter cycle use NEXT_PERIOD. A shorter cycle only supports NEXT_PERIOD (PRORATE_NOW/FULL_CHARGE_NOW rejected) — the customer finishes the period already paid, then switches. No cash refund is ever issued: any excess credit stays on the customer's balance and is consumed by upcoming invoices. A body carrying only name and/or description renames the subscription labels: no billing change is applied and nothing is charged.
pauseCollection: pass an object (optionally with resumesAt) to pause payment collection, pass null explicitly to resume.
trialEnd: an ISO 8601 date extends a trial or postpones the next charge of an active subscription (forward only, at most one year); the special value "now" ends a trial immediately and starts billing; the special value "cancel" reverts a pending billing postponement or trial extension to its original date (only while that date is still in the future).
cancelAtPeriodEnd: true schedules the cancellation at the end of the current billing period, false reactivates a subscription in PENDING_CANCELLATION.
Replaces POST /subscription/:id/reactivate, which is deprecated.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||