Change subscription plan

Upgrades or downgrades a customer's subscription to a different plan.

Upgrade behavior: Takes effect immediately. A new invoice is generated for the upgraded plan.

Downgrade behavior: Scheduled for the end of the current billing period. The customer keeps their current plan until the period ends, then transitions to the new plan automatically.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The subscription ID to change.

Body Params
string
required

The ID of the plan to switch to.

string
enum
required

The type of plan change. Determines timing:

  • UPGRADE — Takes effect immediately with a new invoice.
  • DOWNGRADE — Scheduled for the end of the current billing period.
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json