Skip to main content
POST
Add a formula 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
formula_type
enum<string>
required

discount, tax, or surcharge

Available options:
discount,
tax,
surcharge
name
string
required

Formula name

calculation_type
enum<string>
required
Available options:
fixed,
percentage,
formula
condition
string | null
value
number | null

Fixed amount or percentage

formula_config
object | null

Structured amount config used when calculation_type is "formula".

billing_type
enum<string>
Available options:
one_time,
recurring
percentage_base
enum<string>
Available options:
subtotal,
running_total
selected_product_uuid
string | null
sort_order
number

Response

201 - application/json

Default Response

uuid
string
required
formula_type
enum<string>
required
Available options:
discount,
tax,
surcharge
name
string
required
condition
string | null
required
calculation_type
enum<string>
required
Available options:
fixed,
percentage,
formula
value
number | null
required
formula_config
object | null
required

Structured amount config used when calculation_type is "formula".

billing_type
enum<string>
required
Available options:
one_time,
recurring
percentage_base
enum<string>
required
Available options:
subtotal,
running_total
selected_product_uuid
string | null
required
sort_order
number
required
created_at
string
required
updated_at
string
required