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.
Update a specific deployed version of the product. This applies to WordPress products only. Use this endpoint to update the release_mode of a deployment to make it available to your customers.
Defined by the release_mode property, with the following possible values:
pending – The deployment is pending and not visible to customers. This is the default value.
beta – The deployment is in beta mode. Only customers with beta access will see this version.
released – The deployment is released and visible to all customers.
Additionally, WordPress plugins and themes support incremental releases and staged rollouts:
Incremental Release: Controlled via the is_incremental flag, incremental releases enforce sequential updates, requiring users to install designated intermediate versions before proceeding to newer ones.
Staged Rollout: Managed through the limit and percentage_limit flags, staged rollouts enable gradual deployment of updates to a subset of users, allowing for monitoring and issue resolution before full release.
Note: Incremental Release and Staged Rollout are not supported for templates and widgets.
The maximum number of downloads allowed for this version. This is used for staged rollout of WordPress products. Unlimited number is set as null.
Possible values:>= 1
Example: 50
percentage_limitinteger
Instead of limit, you can use this property to limit the percentage of license owners that will receive an update. The value must be between 0 and 100. Behind the scenes the system will count the current active license owners and convert it into an absolute value.
Possible values:>= 0 and <= 100
is_incrementalboolean
Determines whether the version is incremental or not.
The programming language version (e.g PHP version).
Example: 5.6
tested_up_to_versionstringnullable
The tested platform version that the product is compatible (e.g WordPress version).
Example: 1.0.0
downloadedinteger
The number of times the product has been downloaded.
Possible values:>= 0
Example: 1234
has_freeboolean
If the product has a free version.
has_premiumboolean
If the product has a premium version.
release_modestring
The release mode of the product.
Possible values: [released, pending, beta]
limitinteger
The maximum number of downloads allowed for this version. This is used for staged rollout of WordPress products. Unlimited number is set as null.
Possible values:>= 1
Example: 50
uniquesinteger
The number of unique users that have downloaded the product.
Possible values:>= 1
Example: 1234
is_incrementalboolean
Determines whether the version is incremental or not.
Example: true
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"}
Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.
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.
