Skip to main content
POST
Create a pricing calculator

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Calculator name

display_settings
object
required

Display and billing configuration for the pricing calculator.

submission_mode
enum<string>
default:disabled
required
Available options:
disabled,
lead_only,
lead_with_products,
lead_with_quote
description
string | null

Calculator description

currency_uuid
string
partner_type_referral
boolean

Visible to referral partners

partner_type_reseller
boolean

Visible to reseller partners

partner_type_distributor
boolean

Visible to distributor partners

available_on_leads
boolean

Partners may quote from this calculator when creating a lead

required_on_leads
boolean

Partners must supply a quote from an available calculator to create a lead. Implies available_on_leads.

available_on_deals
boolean

Partners may quote from this calculator when creating a deal

required_on_deals
boolean

Partners must supply a quote from an available calculator to create a deal. Implies available_on_deals.

Response

201 - application/json

Default Response

uuid
string
required
name
string
required
description
string | null
required
status
enum<string>
required
Available options:
draft,
live,
archived
submission_mode
enum<string>
required
Available options:
disabled,
lead_only,
lead_with_products,
lead_with_quote
display_settings
object
required

Display and billing configuration for the pricing calculator.

partner_type_referral
boolean
required
partner_type_reseller
boolean
required
partner_type_distributor
boolean
required
available_on_leads
boolean
required
required_on_leads
boolean
required
available_on_deals
boolean
required
required_on_deals
boolean
required
currency
object
required
fields_count
number
required
products_count
number
required
created_at
string
required
updated_at
string
required
fields
object[]
required
products
object[]
required
formulas
object[]
required