Skip to main content
POST
Upgrade subscription

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
type
enum<string>
required

Subscription tier to upgrade to.

Available options:
free,
pro,
enterprise
cycle
enum<string>
required

Billing cycle

Available options:
monthly,
yearly
quantity
integer

Seat quantity for licensed subscriptions

Required range: x >= 1
server_quantity
integer | null

Recurring server add-on quantity

Required range: x >= 0
sandbox_quantity
integer | null

Recurring sandbox add-on quantity

Required range: x >= 0
success_url
string<uri>

URL to redirect to after successful payment

cancel_url
string<uri>

URL to redirect to if payment is canceled.

Response

Stripe checkout session URL for the subscription upgrade.

status
string
required

Upgrade status

checkout_url
string | null

Stripe checkout session URL for the subscription upgrade.

amount_decimal
string | null

Exact decimal amount due, without a currency suffix, when available.

Pattern: ^-?\d+(?:\.\d+)?$
currency
string | null

Currency reported by the billing provider, when an amount is available.

amount
string | null

Formatted amount due, when available

error
string | null

Error message when status is error