Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.
Copy the API Bearer Authorization Token from the UI.
Generate an upgrade link for a license. The API accepts a variety of parameters with which you can specify new plans or quota or billing cycles. If you skip all those, then a manual renewal link will be generated instead. The link will be valid for 24 hours.
The quota to use. Can be a number or the string 'unlimited'.
oneOf
integer
string
integer
Possible values:>= 1
is_payment_method_updateboolean
Default value: false
Whether to update the payment method. If true, the link will be generated for the current plan and billing cycle of the license and other parameters will be ignored. If the license is not associated with a subscription, or is lifetime, an exception will be thrown.
Bad request. The request could not be understood by the server due to malformed syntax or arguments.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
Current timestamp.
Example: Thu, 11 May 2023 11:45:30 +0000
request object
This object sends back the request payload as received by the server (both from path and from body or query).
property name*any
This object sends back the request payload as received by the server (both from path and from body or query).
Example: {"beautify":true,"format":"json"}
The request is missing the specified argument.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
Current timestamp.
Example: Thu, 11 May 2023 11:45:30 +0000
request object
This object sends back the request payload as received by the server (both from path and from body or query).
property name*any
This object sends back the request payload as received by the server (both from path and from body or query).
Example: {"beautify":true,"format":"json"}
The requested resource was not found.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
Current timestamp.
Example: Thu, 11 May 2023 11:45:30 +0000
request object
This object sends back the request payload as received by the server (both from path and from body or query).
property name*any
This object sends back the request payload as received by the server (both from path and from body or query).
Example: {"beautify":true,"format":"json"}
We use essential cookies to enable our site to function. With your consent, we also use analytics and advertising cookies to understand how visitors interact with our site and to improve our services.
