Sample - Stripe API
GET/v1/quotes/{quote}

Retrieve a quote

Retrieves a quote by its identifier. Use expand to include additional fields in the response when needed. The quote includes pricing, customer, tax, collection, and lifecycle information.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
quotestringrequired
The quote identifier to retrieve. Must not exceed 5000 characters.
expandarray<string>optional
Fields to expand in the response. Each value must not exceed 5000 characters.

2 status codes
200Returns the requested quote, including its totals, automatic tax settings, collection method, customer association, status, and lifecycle timestamps.
amount_subtotalintegerrequired
Total before any discounts or taxes are applied.
amount_totalintegerrequired
Total after discounts and taxes are applied.
applicationstringoptional
ID of the Connect Application that created the quote.
application_fee_amountintegeroptional
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.
application_fee_percentnumberoptional
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
automatic_taxobjectrequired
collection_methodstringrequired
Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
Allowed:charge_automaticallysend_invoice
computedobjectrequired
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringoptional
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
customerstringoptional
The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
customer_accountstringoptional
The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it.
default_tax_ratesarray<string>optional
The tax rates applied to this quote.
descriptionstringoptional
A description that will be displayed on the quote PDF.
discountsarray<string>required
The discounts applied to this quote.
expires_atintegerrequired
The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
footerstringoptional
A footer that will be displayed on the quote PDF.
from_quoteobjectoptional
Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details.
headerstringoptional
A header that will be displayed on the quote PDF.
idstringrequired
Unique identifier for the object.
invoicestringoptional
The invoice that was created from this quote.
invoice_settingsobjectrequired
line_itemsobjectoptional
A list of items the customer is being quoted for.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
numberstringoptional
A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize).
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:quote
on_behalf_ofstringoptional
The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.
statusstringrequired
The status of the quote.
Allowed:acceptedcanceleddraftopen
status_transitionsobjectrequired
subscriptionstringoptional
The subscription that was created or updated from this quote.
subscription_dataobjectrequired
subscription_schedulestringoptional
The subscription schedule that was created or updated from this quote.
test_clockstringoptional
ID of the test clock this quote belongs to.
total_detailsobjectrequired
transfer_dataobjectoptional
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.
defaultError response.
errorobjectrequired

Error handling

quote must identify the quote to retrieve and must not exceed 5000 characters. Each expand value must not exceed 5000 characters when provided.