Skip to main content
POST
Preview a pricing calculator without saving a quote

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

Inputs and optional calculator-product membership UUID selections used to preview a pricing calculator without saving a quote.

Inputs and optional calculator-product membership UUID selections used to preview a pricing calculator without saving a quote.

field_values
object
required
selected_optional_products
string<uuid>[]
Maximum array length: 100
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)$
optional_product_quantities
object

Response

200 - application/json

Calculated totals, adjustments, and presentation for a pricing calculator preview. Product and formula references are public UUIDs.

Calculated totals, adjustments, and presentation for a pricing calculator preview. Product and formula references are public UUIDs.

line_items
object[]
required
selected_optional_products
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)$
subtotal
number
required
adjustments
object[]
required
total
number
required
recurring_total
number