Skip to navigation

Quote templates

Quote templates pre-fill new quotes with reusable defaults: a pricing plan, subscription terms, quote content, and attached documents. Use them to cut manual entry and keep quotes consistent across your sales and billing teams.


Why this matters

If your team sends similar quotes repeatedly (same plan, same terms, same supporting documents), configuring each quote by hand is slow and error-prone. A template captures those defaults once. New quotes created from the template start pre-populated, and the sales rep only adjusts what’s specific to the deal.

What a template can define

Every field on a template is optional; a template can define as much or as little as you like. A field you don’t set is omitted from the template entirely (not stored as null), so it leaves the corresponding quote field untouched.

AreaFieldDescription
Pricing plan schedulepricing_plan_schedule.pricing_plan_version_idThe pricing plan version the quote’s schedule is created with.
Subscriptionpricing_plan_subscription.billing_currencyDefault billing currency (alphabetic currency code).
Subscriptionpricing_plan_subscription.initial_termDefault initial subscription term, as a period (type + value).
Subscriptionpricing_plan_subscription.renewal_termDefault renewal term after the initial term.
Subscriptionpricing_plan_subscription.auto_renewalWhether the resulting subscription renews automatically.
Quote versionquote_version.contentContent of the initial quote version.
Quote versionquote_version.document_idsDocuments attached to the initial quote version.
Signingsigning_requiredWhether quotes built from this template must be signed before they can be converted. Overrides the platform default.

Templates follow the standard resource lifecycle: they are created in DRAFT status, must be activated before they can be used, and can be archived when no longer needed.

Creating a template

Via API

Create a template with POST /v1/quote-templates. Only name and reference are required:

POST
/v:version/quote-templates
curl -X POST https://test.api.solvimon.com/v1/quote-templates \
-H "X-API-KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"name": "Enterprise annual agreement",
"reference": "enterprise_annual",
"description": "Twelve-month Enterprise agreement on the Enterprise pricing plan",
"status": "DRAFT"
}'
Response
{
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"status": "DRAFT",
"signing_required": true,
"pricing_plan_subscription": {
"billing_currency": "AED",
"initial_term": {
"type": "DAY",
"value": 1
},
"renewal_term": {
"type": "DAY",
"value": 1
},
"auto_renewal": true
},
"pricing_plan_schedule": {
"pricing_plan_version_id": "string"
},
"quote_version": {
"content": {
"type": "DEFAULT",
"default": {
"header": "string",
"footer": "string"
},
"tiptap": "string"
},
"document_ids": [
"string"
]
},
"created_at": "string",
"updated_at": "string",
"agent_context": {
"guidance": "string"
}
}

The template is created in DRAFT status. Activate it with POST /v1/quote-templates/{ref}/activate before using it:

POST
/v:version/quote-templates/:resourceIdOrReference/activate
curl -X POST https://test.api.solvimon.com/v1/quote-templates//activate \
-H "X-API-KEY: <apiKey>"

To change a template later, use PATCH /v1/quote-templates/{ref}. To retire one, use POST /v1/quote-templates/{ref}/archive. Both accept the resource ID or your own reference.

Via Desk

Open the quote template settings in the quote configuration section of Desk and fill in any of the fields above: optionally select a pricing plan version, set the subscription defaults, write the quote version content in the content editor, and attach documents. When you save, only the fields you set are stored; re-opening the template loads the saved values back into the form.

Using a template when creating a quote

Pass the template’s ID as template_id when creating a quote with POST /v1/quotes. The quote starts pre-populated with the template’s pricing plan, subscription terms, content and attachments, all of which can be adjusted before the quote is sent:

POST
/v:version/quotes
curl -X POST https://test.api.solvimon.com/v1/quotes \
-H "X-API-KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "cust_UwDeeN0vxxHxMTCJeF1K",
"owner_user_id": "user_swDeeN0vxxHyvoCpE81A",
"name": "Northwind Robotics – Enterprise renewal 2027",
"description": "Twelve-month Enterprise agreement with committed spend and discounted lumen-4 rates"
}'
Response
{
"object_type": "string",
"id": "string",
"created_at": "string",
"updated_at": "string",
"status": "string",
"customer_id": "string",
"customer": {
"object_type": "string",
"id": "string",
"created_at": "string",
"parent_customer_id": "string",
"parent_customer_ids": [
"string"
],
"reference": "string",
"status": "DRAFT",
"timezone": "string",
"type": "ORGANIZATION",
"email": "string",
"notification_preferences": [
{
"type": "INVOICE",
"channels": [
{
"type": "EMAIL",
"enabled": true
}
]
}
],
"locale": "string",
"individual": {
"name": {
"first_name": "string",
"last_name": "string",
"infix": "string"
},
"residential_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
},
"organization": {
"legal_name": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"tax_exempt": true,
"tax_exempt_note": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"tax_registrations": [
{
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
}
]
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"pricing_plan_subscription_selector": {
"data": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"value": "string"
}
],
"rules": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS"
}
],
"filters": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS",
"value": "string"
}
],
"fallback": "LATEST"
},
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"roles": [
"DEFAULT"
],
"seller_details": {
"default_billing_entity_id": "string"
},
"processing_only": true
},
"name": "string",
"description": "string",
"contact_id": "string",
"owner_user_id": "string",
"owner_user": {
"object_type": "string",
"id": "string",
"entity_id": "string",
"created_at": "string",
"status": "INVITED",
"username": "string",
"password": "string",
"invite_expired": true,
"active": true,
"account_memberships": [
{
"object_type": "string",
"id": "string",
"account_id": "string",
"account": {
"id": "string",
"reference": "string",
"account_type_code": "string",
"environment": "string",
"account_group_id": "string",
"parent_id": "string",
"platform_id": "string"
},
"type": "ADMIN",
"role_ids": [
"string"
],
"account_reference": "string",
"environment": "string",
"roles": [
{
"object_type": "string",
"id": "string",
"name": "string",
"description": "string",
"entity_id": "string",
"child_role_ids": [
"string"
],
"child_roles": [
{}
]
}
]
}
],
"team_memberships": [
{
"team_id": "string",
"start_at": "2024-01-15T09:30:00Z",
"end_at": "2024-01-15T09:30:00Z",
"account_memberships": [
{
"object_type": "string",
"id": "string",
"account_id": "string",
"account": {
"id": "string",
"reference": "string",
"account_type_code": "string",
"environment": "string",
"account_group_id": "string",
"parent_id": "string",
"platform_id": "string"
},
"type": "ADMIN",
"role_ids": [
"string"
],
"account_reference": "string",
"environment": "string",
"roles": [
{
"object_type": "string",
"id": "string",
"name": "string",
"description": "string",
"entity_id": "string",
"child_role_ids": [
"string"
],
"child_roles": [
{}
]
}
]
}
]
}
]
},
"quote_version_infos": [
{
"version": 1,
"id": "string",
"status": "string",
"pricing_plan_subscription_ids": [
"string"
],
"pricing_plan_subscription_id": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"template_id": "string"
}

In Desk, select the template in the quote creation form to pre-fill it the same way.

A template only sets the starting values of a quote. Editing a template later does not change quotes already created from it.

Require signing

By default a quote can be converted into a subscription as soon as the customer accepts it, whether or not anyone signed. signing_required makes signing mandatory: a quote that needs a signature can only be converted from SIGNED, never from ACCEPTED.

The value is resolved once, when the first version of a quote is created:

Where it comes fromFieldApplies
Quote templatesigning_requiredWhen the quote was created from a template that sets it
Platformquote_settings.signing_requiredOtherwise. Defaults to false
Quote versionsigning_requiredRead-only. Reports the value that was resolved

Set the platform default with PATCH /v1/platforms/{id}:

Require signing for every quote on the platform
curl -X PATCH https://test.api.solvimon.com/v1/platforms/plat_ewD9iZ0uD4L5FRCZUu1Q \
-H "X-API-KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"quote_settings": { "signing_required": true }
}'

Override it per template, in either direction, with PATCH /v1/quote-templates/{ref}:

Let quotes from this template convert on acceptance alone
curl -X PATCH https://test.api.solvimon.com/v1/quote-templates/quote_template_renewals \
-H "X-API-KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"signing_required": false
}'

A template that leaves signing_required unset falls through to the platform default, as every other template field does. A template that sets it to false deliberately exempts its quotes from a platform that otherwise requires signing, which is how low-value renewals are usually handled.

What it changes at conversion

Converting a quote version normally accepts a version that is ACCEPTED or SIGNED. With signing required, only SIGNED is accepted. A version in ACCEPTED is refused with a validation error on status:

Response
{
"error": "INVALID_REQUEST",
"reason": "INVALID_FIELD",
"field": "status",
"message": "quote must be SIGNED when signing is required"
}

Nothing else in the flow changes. Signers are still added to the version and the signature is still collected in the portal, in Desk or through DocuSign. The setting only decides whether that step can be skipped.

Later versions of the same quote inherit the value from the version before them, not from the template or the platform. Changing either one therefore never changes a quote that is already in progress: a quote that was rejected and continued as a new version keeps the rule it started under. A quote version can never set the value itself, so a single quote cannot switch signing off for its own conversion.

Attachments

Documents listed in quote_version.document_ids are carried onto the initial version of every quote created from the template. Use this for recurring supporting documents, such as standard terms or product sheets, so they don’t have to be attached by hand each time.

Edge cases

  • Only ACTIVE templates can be used to create quotes. A DRAFT template must be activated first; an ARCHIVED template can no longer be selected.
  • All defaulting fields are optional. A template that only sets, say, a billing currency leaves everything else for the rep to fill in.
  • If default subscription settings are also configured in the Settings menu, the template’s values take precedence for quotes created from it.

See also: Quotes, Approval policy and Subscriptions.