Simulate a Quote

Synchronously calculates quote pricing and details based on the provided configuration without creating a persistent quote object in DealHub. Ideal for real-time price calculations.

Use this endpoint to calculate real-time pricing and quote details without creating a permanent record in DealHub. You have to inform the product and configuration data to receive the calculated line items and a financial summary.

To run a simulation, your request must include a version_id to specify which pricing and product rules to use. You also need to provide one of the following options:

  • external_opportunity_id: Use this to base the simulation on an existing opportunity in your CRM.
  • geo_code and currency: Use this combination for simulations that do not depend on specific CRM data.
📘

Required data

You must provide either the external_opportunity_id or both the geo_code and currency parameters. Providing both in the same request will result in an error.

❗️

quote_data is required

The quote_data field is required and must always be present in the request body. If you do not have any line items to include, send it as an empty array: "quote_data": []

Omitting the quote_data field entirely will result in an error. Note that the auto-generated code example on this page may not include quote_data when no line item values are provided, but the field itself must still be present in your request.

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

DealHub version ID. If not provided, the system will use the active version.

string
length ≤ 50

CRM opportunity ID.

string
length ≤ 200

Geographic code.

string
length ≤ 3

Currency ISO code to evaluate rules. Immutable once created.

string
enum
Defaults to basic

Determines the level of detail included in the response for line items.

Allowed:
string
length ≤ 50

The unique name of the playbook (not the display name). If not provided, the system uses the first API-type playbook.

number

Total discount for all line items. Overrides default line-item discounts if provided.

partner_program
array of objects

List of selected partner programs.

partner_program
quote_data
array of objects
required
Defaults to []

List of question group data, including questions and answers for repeatable/non-repeatable groups.

quote_data*
line_items
array of objects

A list of line items along with their associated data.

line_items
Responses

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