Sign in
Subscriptions

Execute a plan change (v2, swap in place)

Change a subscription's plan in place. Subscription id, billing anchor and period bounds are preserved; line items are sliced and settled in one transaction.

post/subscriptions/{id}/change/v2/execute

Path parameters

idstring required

Subscription ID

Request body

idempotency_keystring
metadataobject
proration_behavior'create_prorations' | 'none' required
target_plan_idstring required

Response

OK

change_type'upgrade' | 'downgrade' | 'lateral'
effective_atstring date-time
metadataobject
warningsstring[]

Changes