Quotes API guide

​

Quotes vs. legacy quotes

• When creating a quote, you must set hs_template_type to CPQ_QUOTE at the time of creation. This automatically sets the quote to use the correct type of template. Learn more about quote templates below.
• While many of the existing legacy quote properties are supported for configuring quotes, there’s a new set of properties, which replaces some legacy properties.

• A quote must include line item, contact, and deal associations. For quotes that require signatures, you’ll also need to associate a signing contact.
• Currently, one-time discounts, taxes, fees, and payment schedules are not supported for quotes. You can still set discounts and tax rates on individual line items.
• If you want to associate a specific quote template with a quote, you can only do so at the time of creation. The quote template’s, properties, content, and associations will be added to the quote as supplemental information, with properties set on the quote overriding the quote template’s settings.

• A quote created via the API will automatically be set to DRAFT. Other states such as PENDING_APPROVAL,APPROVED, and REJECTED are primarily managed via the UI and approval workflows.
• The state will automatically be updated to ACCEPTED when the buyer accepts the quote.

​

Create a quote

• hs_title
• hs_expiration_date
• hs_template_type (must be set to CPQ_QUOTE)

{
  "properties": {
    "hs_title": "My quote",
    "hs_expiration_date": "2026-09-30",
    "hs_template_type": "CPQ_QUOTE"
  }
}

​

Enable e-signatures

{
  "properties": {
    "hs_title": "My custom quote",
    "hs_expiration_date": "2026-09-30",
    "hs_template_type": "CPQ_QUOTE",
    "hs_acceptance_method": "clickwrap"
  }
}

• clickwrap: renders a button on the quote to allow the buyer to accept by clicking (no signature).

• esignature: renders a button on the quote that triggers an e-signature flow. This option requires at least one buyer contact to be associated with the quote as a signer. You can add one or more countersigners via the HubSpot UI to capture seller signatures.

• print_and_sign (default): renders fields intended for printing and signing. This option requires at least one buyer contact to be associated with the quote as a signer. You can add one or more countersigners via the HubSpot UI to capture seller signatures.

​

Enable payments

{
  "properties": {
    "hs_title": "Quote with CC payment",
    "hs_expiration_date": "2026-09-30",
    "hs_template_type": "CPQ_QUOTE",
    "hs_acceptance_method": "clickwrap",
    "hs_billing_enabled": true,
    "hs_payment_enabled": true,
    "hs_payment_type": "HUBSPOT",
    "hs_allowed_payment_methods":"CREDIT_OR_DEBIT_CARD",
    "hs_collect_billing_address": true
  }
}

​

Quote associations

​

Set associations when creating a quote

{
  "properties": {
    "hs_title": "My quote",
    "hs_expiration_date": "2026-09-30",
    "hs_template_type": "CPQ_QUOTE"
  },
  "associations": [
    {
      "to": {
        "id": 123456789
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 69
        }
      ]
    },
    {
      "to": {
        "id": 28973222148
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 64
        }
      ]
    },
    {
      "to": {
        "id": 24417508135
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 67
        }
      ]
    }
  ]
}

​

Associating after creation

​

Quote templates

• Retrieve via the quote template editor in HubSpot
• Retrieve all quote templates via the API
• Search for quote templates via the API

​

Retrieve an ID from the quote template editor

​

Retrieve all quote templates via the API

{
  "results": [
    {
      "id": "46470285449",
      "properties": {
        "hs_createdate": "2023-06-12T16:26:34.968Z",
        "hs_lastmodifieddate": "2023-06-12T16:26:34.968Z",
        "hs_object_id": "46470285449",
        "hs_type": "cpq_template"
      },
      "createdAt": "2023-06-12T16:26:34.968Z",
      "updatedAt": "2023-06-12T16:26:34.968Z",
      "archived": false,
      "url": "https://app.hubspot.com/contacts/123456/record/0-64/46470285449"
    }
  ]
}

​

Search for quote templates via the API

{
  "filterGroups": [
    {
      "filters": [
        {
          "propertyName": "hs_type",
          "operator": "CONTAINS_TOKEN",
          "value": "cpq_template"
        }
      ]
    }
  ]
}

{
  "total": 1,
  "results": [
    {
      "id": "46470285449",
      "properties": {
        "hs_createdate": "2023-06-12T16:26:34.968Z",
        "hs_lastmodifieddate": "2023-06-12T16:26:34.968Z",
        "hs_object_id": "46470285449",
        "hs_type": "cpq_template"
      },
      "createdAt": "2023-06-12T16:26:34.968Z",
      "updatedAt": "2023-06-12T16:26:34.968Z",
      "archived": false,
      "url": "https://app.hubspot.com/contacts/123456/record/0-64/46470285449"
    }
  ]
}

​

Editing template source code

• In your HubSpot account, click the Settings icon.
• In the left sidebar menu, navigate to Objects > Quotes.
• Click the Quote templates tab.
• Click the name of the template that you want to edit.
• In the editor, click into a rich text section, such as the Cover letter, Executive summary, or Acceptance section. Then, in the top bar, click Advanced > Source code.

• Add your custom code, then click Save changes.

​

Quote properties