Switch subscription plan
Switch the organization to a new subscription plan, credit volume, or billing interval. Returns the Stripe URL to send the customer to: hosted Checkout for a first paid subscription, or the billing portal’s confirmation flow for a change to an existing one, where Stripe shows the proration and takes the confirmation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request schema for switching subscription plan.
Partial path (e.g. /billing/plans) of where the stripe Checkout session should redirect the user if payment is cancelled.
1 - 255The new product to switch to.
free_plan, team_plan, pro_plan, enterprise_plan Partial path (e.g. /billing/complete) of where the stripe Checkout session should redirect the user if payment is successful.
1 - 255The billing interval to subscribe with.
month, year The credit tier to subscribe to (e.g. 'tier_20k'). Required for products with selectable credit tiers (the Team plan).
1 - 50Response
Successful Response
Where to send the customer to complete the plan change.
There is no "completed" case: Stripe confirms every plan change, so this always carries a URL to leave for.