Upgrade a subscription (deprecated)

Deprecated — use PATCH /subscription/:id instead. Upgrades an existing subscription to a higher amount on the same billing cycle, charged pro-rata immediately.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the subscription to upgrade

Body Params
number
required

The new amount in cents for the subscription upgrade, must be greater than the current subscription amount

string

The URL to redirect to after successful 3DS authentication, only required if card information is provided

string

The URL to redirect to after failed 3DS authentication, only required if card information is provided

string

The name of the upgraded subscription plan, if not provided, the current subscription name will be used

string

The description of the upgraded subscription plan, if not provided, the current subscription description will be used

boolean

Whether to save the payment method

boolean

Whether to use the customer's last saved payment method, it will get the current subscription's customer payment method

boolean

Whether to auto-confirm the payment, if not provided, the payment will be confirmed manually

string

The pricing mode for the products

boolean

When false, the upgrade is charged in full immediately instead of being prorated for the days remaining in the current cycle. Defaults to true.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json