Skip to main content
GET
Get a product

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01

Path Parameters

id
string
required

Unique identifier for the product

Response

Success

created_at
string<date-time>
required

Timestamp when the product was created

Example:

"2026-04-01T10:00:00Z"

description
string
required

A brief description of the product

Example:

"Monthly platform access fee"

fee_type
enum<string>
required

Whether the product is fixed-price or usage-based

Available options:
fixed,
metered
Example:

"fixed"

id
string
required

Unique identifier for the product

Example:

"prod_01H1VECT"

name
string
required

The name of the product

Example:

"Platform Fee"

payment_terms
enum<string>
required

When the product is billed relative to the billing period

Available options:
advance,
arrears
Example:

"arrears"

revenue_allocation_method
enum<string>
required

How revenue is allocated across time periods within a billing cycle

Available options:
straight_line,
usage_based,
contract_level_straight_line
Example:

"straight_line"

updated_at
string<date-time>
required

Timestamp when the product was last updated

Example:

"2026-04-01T12:30:00Z"

billing_frequency
enum<string> | null

How often the product is billed

Available options:
recurring,
one-off
Example:

"recurring"

metric_ids
string[]

Identifiers for associated metrics. Applicable for metered products

Example:
sku
string | null

Stock keeping unit code used in external ERP or revenue recognition systems

Example:

"PLATFORM_FEE"

tag_ids
string[]

Identifiers for tags associated with this product

Example:
unit_label_plural
string | null

Custom plural term for multiple units of the product (e.g. 'API calls'). Falls back to 'units' when omitted

Example:

"API calls"

unit_label_singular
string | null

Custom singular term for one unit of the product (e.g. 'API call'). Falls back to 'unit' when omitted

Example:

"API call"