The Quote object

Attributes

id string Unique identifier for the object.
line _ items object Includable A list of items the customer is being quoted for.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

More attributes

object string, value is "quote"
amount _ subtotal integer
amount _ total integer
application nullable string Expandable Connect only
application _ fee _ amount nullable integer Connect only
application _ fee _ percent nullable number Connect only
automatic _ tax object
collection _ method enum
computed object
created timestamp
currency nullable string
customer nullable string Expandable
customer _ account nullable string
default _ tax _ rates array of strings Expandable
description nullable string
discounts array of strings Expandable
expires _ at timestamp
footer nullable string
from _ quote nullable object
header nullable string
invoice nullable string Expandable
invoice _ settings object
livemode boolean
number nullable string
on _ behalf _ of nullable string Expandable Connect only
status enum
status _ transitions object
subscription nullable string Expandable
subscription _ data object
subscription _ schedule nullable string Expandable
test _ clock nullable string Expandable
total _ details object
transfer _ data nullable object Connect only

The Quote object

{ "id": "qt_1Mr7wVLkdIwHu7ixJYSiPTGq", "object": "quote", "amount_subtotal": 2198, "amount_total": 2198, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": null, "status": null }, "collection_method": "charge_automatically", "computed": { "recurring": null, "upfront": { "amount_subtotal": 2198, "amount_total": 2198, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 } } }, "created": 1680130691, "currency": "usd", "customer": "cus_NcMfB0SSFHINCV", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682722691, "footer": null, "from_quote": null, "header": null, "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": null, "on_behalf_of": null, "status": "draft", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": null }, "subscription": null, "subscription_data": { "description": null, "effective_date": null, "trial_period_days": null }, "subscription_schedule": null, "test_clock": null, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 }, "transfer_data": null}

Create a quote

POST / v1 / quotes

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

Parameters

line _ items array of objects A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

application _ fee _ amount integer Connect only
application _ fee _ percent number Connect only
automatic _ tax object
collection _ method enum
customer string
customer _ account string
default _ tax _ rates array of strings
description string
discounts array of objects
expires _ at timestamp
footer string
from _ quote object
header string
invoice _ settings object
on _ behalf _ of string Connect only
subscription _ data object
test _ clock string
transfer _ data object Connect only

Returns

Returns the quote object.

Response

{ "id": "qt_1Mr7wVLkdIwHu7ixJYSiPTGq", "object": "quote", "amount_subtotal": 2198, "amount_total": 2198, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": null, "status": null }, "collection_method": "charge_automatically", "computed": { "recurring": null, "upfront": { "amount_subtotal": 2198, "amount_total": 2198, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 } } }, "created": 1680130691, "currency": "usd", "customer": "cus_NcMfB0SSFHINCV", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682722691, "footer": null, "from_quote": null, "header": null, "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": null, "on_behalf_of": null, "status": "draft", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": null }, "subscription": null, "subscription_data": { "description": null, "effective_date": null, "trial_period_days": null }, "subscription_schedule": null, "test_clock": null, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 }, "transfer_data": null}

Update a quote

POST / v1 / quotes /:id

A quote models prices and services for a customer.

Parameters

line _ items array of objects A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

application _ fee _ amount integer Connect only
application _ fee _ percent number Connect only
automatic _ tax object
collection _ method enum
customer string
customer _ account string
default _ tax _ rates array of strings
description string
discounts array of objects
expires _ at timestamp
footer string
header string
invoice _ settings object
on _ behalf _ of string Connect only
subscription _ data object
transfer _ data object Connect only

Returns

Returns the updated quote object.

Response

{ "id": "qt_1Mr7wVLkdIwHu7ixJYSiPTGq", "object": "quote", "amount_subtotal": 2198, "amount_total": 2198, "application": null, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": null, "status": null }, "collection_method": "charge_automatically", "computed": { "recurring": null, "upfront": { "amount_subtotal": 2198, "amount_total": 2198, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 } } }, "created": 1680130691, "currency": "usd", "customer": "cus_NcMfB0SSFHINCV", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682722691, "footer": null, "from_quote": null, "header": null, "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": { "order_id": "6735" }, "number": null, "on_behalf_of": null, "status": "draft", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": null }, "subscription": null, "subscription_data": { "description": null, "effective_date": null, "trial_period_days": null }, "subscription_schedule": null, "test_clock": null, "total_details": { "amount_discount": 0, "amount_shipping": 0, "amount_tax": 0 }, "transfer_data": null}