Skip to main content
POST
/
v1
/
billing
/
change-plan
Change Plan
curl --request POST \
  --url https://api.example.com/v1/billing/change-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_tier": "<string>",
  "new_interval": "<string>"
}
'
{
  "success": true,
  "subscription_id": "<string>",
  "old_plan": "<string>",
  "new_plan": "<string>",
  "credits_adjusted": 123,
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

JWT Bearer token for dashboard access

Body

application/json

Request to change subscription plan.

new_tier
string
required
new_interval
string
required
proration_mode
string
default:prorated_immediately

Response

Successful Response

Response after changing subscription plan.

success
boolean
required
subscription_id
string
required
old_plan
string
required
new_plan
string
required
credits_adjusted
integer
required
message
string
required