Skip to main content
GET
List products on a deal

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
product
object
required
quantity
number
required
unit_price
number | null
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is. Expressed in the row's billing period (see billing_period): a quote-sourced row is in its quote's billing period, a manual row in the product's own billing period.

billing_type
enum<string>
required

Whether the product is charged once or on a recurring basis.

Available options:
one_time,
recurring
billing_period
enum<string> | null
required

Billing period a recurring row's unit_price is expressed in; null means monthly. Not meaningful for one-time rows.

Available options:
monthly,
quarterly,
yearly
source
enum<string>
required
Available options:
manual,
quote,
lead
created_at
string
required
updated_at
string
required