Swap the subscription to another plan
PUT/panel/workspaces/:workspace/subscription/change-plan
Swaps the workspace's subscription to a different plan and billing cycle, applying the requested proration. Requires an active payment platform, since the swap is performed there.
A subscription in trial can be swapped when the instance's billing settings allow plan changes during a trial and the payment platform supports it (Stripe and Paddle Billing do, Paddle Classic doesn't). The trial keeps its end date and nothing is billed until it ends, so prorate has no effect on it. Otherwise, and for a canceled, paused, past due or incomplete subscription, the request is refused with a 422 and an errors.subscription message.
Request
Responses
- 200
- 401
- 403
- 404
- 422
{"success": true} — hard-coded literal, never false.
The bearer token is missing, malformed, unknown, or expired.
The token is valid, but the user it belongs to may not perform this action:
- they are not a member of the
{workspace}in the path; or - their workspace role is too low for this endpoint (write routes require Admin or Member); or
- for
/panelendpoints, they are not a platform administrator.
The {workspace} UUID in the path does not match any workspace.
The request body failed validation.