Skip to main content
GET
Get product

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

product_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required

Product ID

name
string
required

Product name

type
enum<string>
required

Product Type

Available options:
product,
group
description
string | null

Product Description

tags
any[] | null

Product Tags

sku
string | null

Product SKU

Parent Link ID

tax_codes
Tax Codes · object | null

Product Tax Codes

is_active
boolean | null

Is Active or not

created_at
string<date-time> | null

Created At

updated_at
string<date-time> | null

Updated At

default_pricing_id
string<uuid> | null

Default Pricing ID

custom_attributes
Custom Attributes · object | null

Custom Attributes

product_category
enum<string> | null

Product Category

Available options:
group,
standalone,
bundle
product_type
enum<string> | null

Product Type

Available options:
time_dependent,
time_independent
product_sub_type
enum<string> | null

Product Sub Type

Available options:
quantity,
boolean,
credits
track_usage
boolean | null

Track Usage or not

enum_values
string[] | null

Enum Values

unit
string | null

Unit

entitlements
EntitlementResponseSchema · object[] | null

Entitlement