Skip to main content
POST
/
v1
/
billing
/
preview-change-plan
Preview Change Plan
curl --request POST \
  --url https://api.example.com/v1/billing/preview-change-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_tier": "<string>",
  "new_interval": "<string>"
}
'
{
  "current_plan": "<string>",
  "new_plan": "<string>",
  "proration_amount": 123,
  "credit_adjustment": 123,
  "effective_date": "2023-11-07T05:31:56Z",
  "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

Preview of plan change before executing.

current_plan
string
required
new_plan
string
required
proration_amount
integer
required
credit_adjustment
integer
required
effective_date
string<date-time>
required
message
string
required