Quote
A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.
The Quote object
Attributes
- idstring
Unique identifier for the object.
- line_
itemsobjectExpandable A list of items the customer is being quoted for.
- metadataobject
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
- objectstring
- amount_
subtotalinteger - amount_
totalinteger - applicationnullable stringExpandableConnect only
- application_
fee_ amountnullable integerConnect only - application_
fee_ percentnullable floatConnect only - automatic_
taxobject - collection_
methodenum - computedobject
- createdtimestamp
- currencynullable string
- customernullable stringExpandable
- default_
tax_ ratesarray of stringsExpandable - descriptionnullable string
- discountsarray of stringsExpandable
- expires_
attimestamp - footernullable string
- from_
quotenullable object - headernullable string
- invoicenullable stringExpandable
- invoice_
settingsobject - livemodeboolean
- numbernullable string
- on_
behalf_ ofnullable stringExpandableConnect only - statusenum
- status_
transitionsobject - subscriptionnullable stringExpandable
- subscription_
dataobject - subscription_
schedulenullable stringExpandable - test_
clocknullable stringExpandable - total_
detailsobject - transfer_
datanullable objectConnect only
{
"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
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_
itemsarray 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.
- metadataobject
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_ amountintegerConnect only - application_
fee_ percentfloatConnect only - automatic_
taxobject - collection_
methodenum - customerstring
- default_
tax_ ratesarray of strings - descriptionstring
- discountsarray of objects
- expires_
attimestamp - footerstring
- from_
quoteobject - headerstring
- invoice_
settingsobject - on_
behalf_ ofstringConnect only - subscription_
dataobject - test_
clockstring - transfer_
dataobjectConnect only
Returns
Returns 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
}
Update a quote
A quote models prices and services for a customer.
Parameters
- line_
itemsarray 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.
- metadataobject
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_ amountintegerConnect only - application_
fee_ percentfloatConnect only - automatic_
taxobject - collection_
methodenum - customerstring
- default_
tax_ ratesarray of strings - descriptionstring
- discountsarray of objects
- expires_
attimestamp - footerstring
- headerstring
- invoice_
settingsobject - on_
behalf_ ofstringConnect only - subscription_
dataobject - transfer_
dataobjectConnect only
Returns
Returns the updated 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": {
"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
}
Retrieve a quote's line items
When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
quote line items, starting after Line Item starting_after
. Each entry in the array is a separate Line Item object. If no more line items are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/quotes/qt_1Mr7wVLkdIwHu7ixJYSiPTGq/line_items",
"has_more": false,
"data": [
{
"id": "li_1Mr7wVLkdIwHu7ixBJJ8ww4j",
"object": "item",
"amount_discount": 0,
"amount_subtotal": 2198,
"amount_tax": 0,
"amount_total": 2198,
"currency": "usd",
"description": "T-shirt",
"price": {
"id": "price_1Mr7wULkdIwHu7ixhPkIEN2w",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 1680130690,
"currency": "usd",
"custom_unit_amount": null,
"livemode": false,
"lookup_key": null,
"metadata": {},
"nickname": null,
"product": "prod_NcMfZX1FelgpZm",
"recurring": null,
"tax_behavior": "unspecified",
"tiers_mode": null,
"transform_quantity": null,
"type": "one_time",
"unit_amount": 1099,
"unit_amount_decimal": "1099"
},
"quantity": 2
}
{...}
{...}
],
}