Change subscription plan
POST
/portal/subscriptions/{subscription_id}/change_plan
Change a subscription’s plan (upgrade or downgrade).
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” subscription_id
required
Subscription Id
string format: uuid
Query Parameters
Section titled “Query Parameters ” token
required
Token
string
Request Body required
Section titled “Request Body required ” PortalChangePlanRequest
Request body for portal plan change.
object
new_plan_id
required
New Plan Id
string format: uuid
Responses
Section titled “ Responses ”Successful Response
SubscriptionResponse
object
id
required
Id
string format: uuid
external_id
required
External Id
string
customer_id
required
Customer Id
string format: uuid
plan_id
required
Plan Id
string format: uuid
status
required
SubscriptionStatus
string
billing_time
required
Billing Time
string
trial_period_days
required
Trial Period Days
integer
pay_in_advance
required
Pay In Advance
boolean
on_termination_action
required
On Termination Action
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Invalid plan change
Invalid or expired portal token
Subscription not found
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context