Skip to main content
GET
JavaScript

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

Product Id

Parâmetros de consulta

locale
string

Shows the translated name, description and unit of the catalog entities in this locale. The value must be a code from GET /locales, for example fr. A field with no translation, an unknown code, or no code shows the base text.

Do not send a text from a localized response back in a create or update request. The base text then changes to the translated text.

Resposta

Product Details

brand_id
string
obrigatório
business_id
string
obrigatório

Unique identifier for the business to which the product belongs.

created_at
string<date-time>
obrigatório

Timestamp when the product was created.

credit_entitlements
object[]
obrigatório

Attached credit entitlements with settings

entitlements
object[]
obrigatório

Attached entitlements (integration-based access grants)

is_recurring
boolean
obrigatório

Indicates if the product is recurring (e.g., subscriptions).

license_key_enabled
boolean
obrigatório
obsoleto

Indicates whether the product requires a license key.

metadata
Metadata · object
obrigatório

Additional custom data associated with the product

price
One Time Price · object
obrigatório

Pricing information for the product.

product_id
string
obrigatório

Unique identifier for the product.

tax_category
enum<string>
obrigatório

Tax category associated with the product.

Opções disponíveis:
digital_products,
saas,
e_book,
edtech,
live_tutoring
updated_at
string<date-time>
obrigatório

Timestamp when the product was last updated.

addons
string[] | null

Available Addons for subscription products

description
string | null

Description of the product, optional.

digital_product_delivery
null | Digital Product Delivery · object

Digital-product-delivery payload, present on grants for digital_files entitlements. Each file carries a short-lived presigned download URL.

image
string | null

URL of the product image, optional.

license_key_activation_message
string | null
obsoleto

Message sent upon license key activation, if applicable.

license_key_activations_limit
integer<int32> | null
obsoleto

Limit on the number of activations for the license key, if enabled.

license_key_duration
null | License Key Duration · object

Duration of the license key validity, if enabled.

name
string | null

Name of the product, optional.

pricing_mode
null | enum<string>

Pricing mode for localized pricing. NULL means base-only (no localized rules apply).

Opções disponíveis:
by_currency,
by_country
product_collection_id
string | null

The product collection ID this product belongs to, if any

Última modificação em 1 de abril de 2026