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.
Retrieve cart details associated with the product.
You can use enriched=true to get more details about the cart, for example the gross, coupon_code and licenses fields will only be returned if enriched is enabled. Please see individual parameters in the response data below to learn more.
The date and time the entity was created, under UTC timezone.
Example: 2025-01-01 00:00:00
updatedstring<date-time>nullable
The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.
Example: 2025-01-01 00:00:00
statusstring
Default value: visit
The status of the cart.
Possible values: [pricing_visit, visit, abandoned, completed, email_1_sent, email_2_sent, email_3_sent, recovered]
modestring
Default value: dialog
The mode the checkout app was opened in, when the cart was created. For example
dashboard: The checkout was opened through our WordPress SDK.
dialog: The checkout was opened through our JavaScript SDK.
page: The checkout was opened directly.
Possible values: [dashboard, dialog, page]
payment_methodstring
Default value: cc
The payment method selected for the purchase.
Possible values: [cc, paypal, ideal]
plugin_idstring<int64>
The ID of the product the entity belongs to.
Possible values:>= 1
Example: 123456
plan_idstring<int64>nullable
The ID of the plan associated with the entity.
Possible values:>= 1
Example: 123456
pricing_idstring<int64>nullable
The ID of the pricing associated with the entity.
Possible values:>= 1
Example: 123456
is_trialboolean
Whether the plan is a trial.
billing_cyclenumber
The billing cycle of the subscription in number of months. 1 means monthly, 12 means annually, 0 means lifetime usually when subscriptions are created for lifetime trials.
Possible values: [1, 12, 0]
install_idstring<int64>nullable
The ID of the installation or site the entity is associated with, a null value means it has not been associated with an installation yet.
Possible values:>= 1
Example: 123456
coupon_idstring<int64>nullable
The ID of the coupon associated with the entity.
Possible values:>= 1
Example: 123456
country_codestringnullable
The ISO 3166-1 alpha 2 two-letter country code associated with the entity.
Example: us
zip_postal_codestring
The postal/zip code of the location.
Example: 92710
vat_idstringnullable
The business VAT number (EU or UK territories) or other tax ID (for example Sales Tax ID for the US).
Example: GB12345678
user_idstring<int64>nullable
The ID of the user the entity belongs to. If NULL then still not associated to any user.
The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment.
Possible values: [1, 0]
Example: 0
is_disabledboolean
Default value: false
Cart supports recovery campaign. If disabled, the recovery campaign will be stopped.
is_unsubscribedboolean
Default value: false
If set to true, the cart recovery campaign will be non-functional and cannot be re-enabled. This happens if the prospect has clicked the "unsubscribe" link from any of the cart recovery emails.
visitedstring<date-time>nullable
The first time the prospect visited the checkout when the cart was being created.
Example: 2025-01-01 00:00:00
completedstring<date-time>nullable
The cart completion date.
Example: 2025-01-01 00:00:00
pricenumber<float>
The cart's original price.
Example: 19.99
grossnumber<float>nullable
Gross amount associated with the cart. (Only available when enriched is set to true.)
Example: 359.64
coupon_codestringnullable
Coupon code associated with the cart. (Only available when enriched is set to true.)
Example: BLACKFRIDAY2024
licensesnumbernullable
Number of licenses associated with the cart. (Only available when enriched is set to true.)
Example: 10
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"}
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.
