GetQuotes
<p>Returns a list of your quotes.</p>
/v1/quotes- Source
openapi/spec3.json- Commit
d70de345383d- Active snapshot
da69df7e6e11
Request
Authorization
Read-onlyCredentials are never accepted or stored on this documentation page.
Send credentials in the Authorization request header using the Basic scheme.
Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>
- Request header
- Authorization
- Scheme
- basic
Send the token in the Authorization request header using the Bearer scheme.
Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>
- Request header
- Authorization
- Scheme
- bearer
- Bearer format
- auth-scheme
Query Parameters
- customer stringoptional
The ID of the customer whose quotes will be retrieved.
- ending_before stringoptional
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
- expand array[string]optional
Specifies which fields in the response should be expanded.
- limit integeroptional
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after stringoptional
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
- status stringoptional
The status of the quote.
Body Params
optionalResponses
Successful response.
data array[Quote object]required
items Quote objectA 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.
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.
Total before any discounts or taxes are applied.
Total after discounts and taxes are applied.
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.
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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_tax QuotesResourceAutomaticTax objectrequired
Automatically calculate taxes
The status of the most recent automated tax calculation for this quote.
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. Defaults to `charge_automatically`.
computed QuotesResourceComputed objectrequired
The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
Time at which the object was created. Measured in seconds since the Unix epoch.
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).
The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
The tax rates applied to this quote.
A description that will be displayed on the quote PDF.
The discounts applied to this quote.
The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
A footer that will be displayed on the quote PDF.
Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
A header that will be displayed on the quote PDF.
Unique identifier for the object.
The invoice that was created from this quote.
All invoices will be billed using the specified settings.
line_items QuotesResourceListLineItems objectoptionalA list of items the customer is being quoted for.
A list of items the customer is being quoted for.
Details about each object.
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).
String representing the object's type. Objects of the same type share the same value.
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.
The status of the quote.
status_transitions QuotesResourceStatusTransitions objectrequired
The time that the quote was accepted. Measured in seconds since Unix epoch.
The time that the quote was canceled. Measured in seconds since Unix epoch.
The time that the quote was finalized. Measured in seconds since Unix epoch.
The subscription that was created or updated from this quote.
subscription_data QuotesResourceSubscriptionData objectrequired
When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
Integer representing the number of trial period days before the customer is charged for the first time.
The subscription schedule that was created or updated from this quote.
total_details QuotesResourceTotalDetails objectrequired
This is the sum of all the line item discounts.
This is the sum of all the line item shipping amounts.
This is the sum of all the line item tax amounts.
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.
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
Error response.
error APIErrors objectrequired
For card errors, the ID of the failed charge.
For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
payment_intent PaymentIntent objectoptionalA PaymentIntent guides you through the process of collecting a payment from your customer.
We recommend that you create exactly one PaymentIntent for each order or
customer session in your system. You can reference the PaymentIntent later to
see the history of payment attempts for a particular session.
A PaymentIntent transitions through
[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
throughout its lifetime as it interfaces with Stripe.js to perform
authentication flows and ultimately creates at most one successful charge.
Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Amount that can be captured from this PaymentIntent.
Amount that was collected by this PaymentIntent.
ID of the Connect application that created the PaymentIntent.
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. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
Controls when the funds will be captured from the customer's account.
charges PaymentFlowsPaymentIntentResourceChargeList objectoptionalCharges that were created by this PaymentIntent, if any.
Charges that were created by this PaymentIntent, if any.
This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent).
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled.
Time at which the object was created. Measured in seconds since the Unix epoch.
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).
ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
ID of the invoice that created this PaymentIntent, if it exists.
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
ID of the payment method used in this PaymentIntent.
Payment-method-specific configuration for this PaymentIntent.
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
If present, this property tells you about the processing state of the payment.
Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
ID of the review associated with this PaymentIntent, if any.
Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
Shipping information for this PaymentIntent.
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
payment_method PaymentMethod objectoptionalPaymentMethod objects represent your customer's payment instruments.
They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
Customer objects to store instrument details for future payments.
Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
PaymentMethod objects represent your customer's payment instruments. They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
acss_debit payment_method_acss_debit objectoptional
Name of the bank associated with the bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Institution number of the bank account.
Last four digits of the bank account number.
Transit number of the bank account.
au_becs_debit payment_method_au_becs_debit objectoptional
Six-digit number identifying bank and branch associated with this bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
bacs_debit payment_method_bacs_debit objectoptional
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
Sort code of the bank account. (e.g., `10-20-30`)
billing_details billing_details objectrequired
Billing address.
Email address.
Full name.
Billing phone number (including extension).
boleto payment_method_boleto objectoptional
Uniquely identifies the customer tax id (CNPJ or CPF)
card payment_method_card objectoptional
Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
Checks on Card address and CVC if provided.
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
Two-digit number representing the card's expiration month.
Four-digit number representing the card's expiration year.
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
Details of the original PaymentMethod that created this object.
The last four digits of the card.
Contains information about card networks that can be used to process the payment.
Contains details on how this Card maybe be used for 3D Secure authentication.
If this Card is part of a card wallet, this contains the details of the card wallet.
Time at which the object was created. Measured in seconds since the Unix epoch.
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
eps payment_method_eps objectoptional
The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
fpx payment_method_fpx objectoptional
The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`.
Unique identifier for the object.
ideal payment_method_ideal objectoptional
The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.
The Bank Identifier Code of the customer's bank, if the bank was provided.
klarna payment_method_klarna objectoptional
The customer's date of birth, if provided.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
p24 payment_method_p24 objectoptional
The customer's bank, if provided.
sepa_debit payment_method_sepa_debit objectoptional
Bank code of bank associated with the bank account.
Branch code of bank associated with the bank account.
Two-letter ISO code representing the country the bank account is located in.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Information about the object that generated this PaymentMethod.
Last four characters of the IBAN.
sofort payment_method_sofort objectoptional
Two-letter ISO code representing the country the bank account is located in.
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
setup_intent SetupIntent objectoptionalA SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
you through the setup process.
Successful SetupIntents result in payment credentials that are optimized for future payments.
For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through
[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,
it will automatically attach the resulting payment method to that Customer.
We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
even as regulations change over time.
Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time. Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
ID of the Connect application that created the SetupIntent.
Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Time at which the object was created. Measured in seconds since the Unix epoch.
ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
The error encountered in the previous SetupIntent confirmation.
The most recent SetupAttempt for this SetupIntent.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
ID of the multi use Mandate generated by the SetupIntent.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the setup is intended.
ID of the payment method used with this SetupIntent.
Payment-method-specific configuration for this SetupIntent.
The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
ID of the single_use Mandate generated by the SetupIntent.
[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
The source object for errors returned on a request involving a source.
The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`