Preview quote estimate

Calculate estimate and enriched contract structure without creating database records

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request schema for previewing quote estimate without creating a quote

Accepts either a customer_id (for existing customers) OR a customer object (for prospective customers not yet in the system). Exactly ONE must be provided.

This endpoint performs all validations from create_quote but does NOT persist any data - it's purely computational for getting cost estimates.

Existing customer ID (provide this OR customer object, not both)

CreateCustomerRequestSchema | null

Inline customer data for prospects (provide this OR customer_id, not both)

Business entity for this estimate (inherits from customer if not provided)

Existing contract ID to use for estimate (if estimating changes to existing contract)

string
required
length between 3 and 3

Currency code (ISO 4217, e.g., USD, EUR)

date
required

Contract start date (when service begins) - required

Contract end date (null = open-ended)

Reference date for billing cycle calculations. Determines when bills are generated in the billing period (e.g., if anchor_date is 15th, monthly bills generate on the 15th). Defaults to start_date if not provided. Can be overridden at line item level.

object | null

Custom data for the contract. When contract_id is provided, this will override the existing contract's custom_data.

line_items
array of objects
required
length ≥ 1

Quote line items (at least one required)

Line Items*
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json