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.
The gateway used for the purchase. The gateway will be set to null when purchasing a product with a 100% discount.
environmentnumber
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
idstring<int64>
The unique identifier of the entity.
Possible values:>= 1
Example: 123456
createdstring<date-time>
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
currencystring
3-char currency code.
Possible values:>= 3 characters and <= 3 characters, [usd, eur, gbp]
tax_ratenumber<float>
The tax rate as a fraction. It will either be US sales tax or VAT.
Possible values:>= 0
Example: 1.00
total_grossnumber<float>
The total gross amount of the subscription, including taxes.
Possible values:>= 0
Example: 1.21
amount_per_cyclenumber<float>
The plan's original amount per cycle (not including taxes).
Possible values:>= 0
Example: 1.00
initial_amountnumber<float>
The initial payment amount (not including taxes).
Possible values:>= 0
Example: 1.00
renewal_amountnumber<float>
The renewals amount (not including taxes).
Possible values:>= 0
Example: 1.00
renewals_discountinteger
The renewals discount that will be applied to the chosen plan.
Possible values:>= 0
Example: 1
renewals_discount_typestring
The type of renewals discount, percentage or dollar.
Possible values: [percentage, dollar]
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]
outstanding_balancenumber<float>
Any outstanding balance that the user has for this subscription.
Possible values:>= 0
Example: 1.00
failed_paymentsinteger
Number of failed payments associated with the subscription.
Possible values:>= 0
Example: 1
trial_endsstring<date-time>nullable
The date time when the trial period ends. If null the subscription is not associated with a trial.
Example: 2025-01-01 00:00:00
next_paymentstring<date-time>nullable
Datetime of the next payment, or null if cancelled.
Example: 2025-01-01 00:00:00
canceled_atstring<date-time>nullable
Datetime of the cancellation.
Example: 2025-01-01 00:00:00
plan_namestringnullable
Name of the plan associated with the subscription. (Only available when extended is set to true.)
Example: Professional
emailstringnullable
Email of the user associated with the subscription. (Only available when extended is set to true.)
Whether subscription cancellation discount was already applied. (Only available when enrich_with_cancellation_discounts is set to true.)
Example: true
]
discounts
The key represents the ID of the subscription
property name* object[]
Array [
idstring<int64>
The unique identifier of the entity.
Possible values:>= 1
Example: 123456
createdstring<date-time>
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
entity_idstring<int64>
The ID of the related entity.
Possible values:>= 1
entity_typestring
Default value: payment
The type of the related entity. Defaults to payment.
Possible values: [payment, subscription]
typestring
Default value: prorate
The type of discount. Possible values are prorate and subscription_cancellation. Defaults to prorate.
Possible values: [prorate, subscription_cancellation]
discountnumber<float>
Discount amount in USD.
Example: 10.0
coupon_idstring<int64>
The ID of the related coupon.
Possible values:>= 1
]
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.
