Create a quote

Changed on

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.

post/v1/quotes

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/quotes
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

collection_method'charge_automatically' | 'send_invoice'

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.

customerstring

The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

customer_accountstring

The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.

expandstring[]

Specifies which fields in the response should be expanded.

expires_atinteger

A future timestamp on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your quote template settings will be used.

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.

test_clockstring

ID of the test clock to attach to the quote.

Response

Successful response.

amount_subtotalinteger required

Total before any discounts or taxes are applied.

amount_totalinteger required

Total after discounts and taxes are applied.

application_fee_amountinteger nullable

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_percentnumber nullable

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.

collection_method'charge_automatically' | 'send_invoice' required

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.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring nullable

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_accountstring nullable

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.

descriptionstring nullable

A description that will be displayed on the quote PDF.

expires_atinteger required

The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

footerstring nullable

A footer that will be displayed on the quote PDF.

headerstring nullable

A header that will be displayed on the quote PDF.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

numberstring nullable

A unique number that identifies this particular quote. This number is assigned once the quote is finalized.

object'quote' required

String representing the object's type. Objects of the same type share the same value.

status'accepted' | 'canceled' | 'draft' | 'open' required

The status of the quote.

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the //////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ////////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ///// response property for the response status

    • warning

      added the new final_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ///// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////////////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///////////// to the response with the status

Some revisions have not been checked yet.