List all quotes
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_after
. Each entry in the array is a separate quote object. If no more quotes are available, the resulting array will be empty.
{
"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
}
{...}
{...}
],
}
Accept a quote
Accepts the specified quote.
Parameters
No parameters.
Returns
Returns an accepted quote and creates an invoice, subscription or subscription schedule. Raises an error otherwise.
{
"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
}
Cancel a quote
Cancels the quote.
Parameters
No parameters.
Returns
Returns a canceled quote. Raises an error otherwise.
{
"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
}
Download quote PDF
Download the PDF for a finalized quote. Explanation for special handling can be found here
Parameters
No parameters.
Returns
The PDF file for the quote.
{}
Finalize a quote
Finalizes the quote.
Parameters
No parameters.
More parameters
- expires_
attimestamp
Returns
Returns an open quote. Raises an error otherwise.
{
"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
}