When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront 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 upfront line items, starting after Line Item starting_. Each entry in the array is a separate Line Item object. If no more upfront line items are available, the resulting array will be empty.
Response
{ "object": "list", "data": [ { "id": "li_1Mr7wVLkdIwHu7ixMMjVsIUH", "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 } ], "has_more": false, "url": "/v1/quotes/qt_1Mr7wVLkdIwHu7ixJYSiPTGq/computed_upfront_line_items"}Retrieves the quote with the given ID.
Parameters
No parameters.
Returns
Returns a quote if a valid quote ID was provided. Raises an error otherwise.
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}Returns a list of your quotes.
Parameters
- customerstring
The ID of the customer whose quotes will be retrieved.
- statusenum
The status of the quote.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring - test_
clockstring
Returns
A dictionary with a data property that contains an array of up to limit quotes, starting after quote starting_. Each entry in the array is a separate quote object. If no more quotes are available, the resulting array will be empty.
Response
{ "object": "list", "url": "/v1/quotes", "has_more": false, "data": [ { "id": "qt_1Mr7SqLkdIwHu7ixpI1ClZ6z", "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": 1680128852, "currency": "usd", "customer": "cus_NcMBZUWCIOEgEW", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682720852, "footer": null, "from_quote": null, "header": null, "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": "QT-5B9DA057-0001-1", "on_behalf_of": null, "status": "open", "status_transitions": { "accepted_at": null, "canceled_at": null, "finalized_at": 1680128853 }, "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 } ]}Accepts the specified quote.
Parameters
No parameters.
Returns
Returns an accepted quote and creates an invoice, subscription or subscription schedule. Raises an error otherwise.
Response
{ "id": "qt_1Mr7YsLkdIwHu7ixoRgFs97D", "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": 1680129226, "currency": "usd", "customer": "cus_NcMHflMGStIAoB", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682721226, "footer": null, "from_quote": null, "header": null, "invoice": "in_1Mr7YtLkdIwHu7ixzgJJpJ3L", "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": "QT-7F68F7D2-0001-1", "on_behalf_of": null, "status": "accepted", "status_transitions": { "accepted_at": 1680129227, "canceled_at": null, "finalized_at": 1680129227 }, "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}Cancels the quote.
Parameters
No parameters.
Returns
Returns a canceled quote. Raises an error otherwise.
Response
{ "id": "qt_1Mr7ZYLkdIwHu7ixvsdZr97I", "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": 1680129268, "currency": "usd", "customer": "cus_NcMIIkPfQZQEHR", "default_tax_rates": [], "description": null, "discounts": [], "expires_at": 1682721268, "footer": null, "from_quote": null, "header": null, "invoice": null, "invoice_settings": { "days_until_due": null, "issuer": { "type": "self" } }, "livemode": false, "metadata": {}, "number": "QT-FF4741D9-0001-1", "on_behalf_of": null, "status": "canceled", "status_transitions": { "accepted_at": null, "canceled_at": 1680129269, "finalized_at": 1680129269 }, "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}