Skip to main content
POST
Add a product to a pricing calculator

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)$

Body

application/json
product_uuid
string
required
quantity_type
enum<string>
default:fixed
required
Available options:
fixed,
variable,
conditional
is_optional
boolean
default:false
required
is_included_by_default
boolean
default:true
required
quantity_editable
boolean
default:false
required
quantity_fixed
number | null
quantity_variable_name
string | null
quantity_condition
string | null
quantity_if_true
number | null
quantity_if_false
number | null
price_override
number | null

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.

anchor_field_id
number | null
sort_order
number

Response

201 - application/json

Default Response

uuid
string
required
sort_order
number
required
quantity_type
enum<string>
required
Available options:
fixed,
variable,
conditional
quantity_fixed
number | null
required
quantity_variable_name
string | null
required
quantity_condition
string | null
required
quantity_if_true
number | null
required
quantity_if_false
number | null
required
price_override
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.

is_optional
boolean
required
is_included_by_default
boolean
required
quantity_editable
boolean
required
anchor_field_id
number | null
required
product
object
required
created_at
string
required
updated_at
string
required