Change subscription plan
Change a subscription plan by ID.
Path Parameters
org_id string required
id string required
ID of the subscription to update
application/json
Request Body required
billing_id ID of the billing account to update the subscription for
plan plan to change to
deprecated in favor of plan_change
immediate should the change be immediate or at the end of the current billing period
deprecated in favor of plan_change
plan_change object
plan plan to change to
immediate should the change be immediate or at the end of the current billing period
phase_change object
cancel_upcoming_changes should the upcoming changes be cancelled
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
phase object
effective_at date-time
plan_id string
{
"phase": {
"effective_at": "2024-07-13T09:54:48.262Z",
"plan_id": "string"
}
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Loading...