POST /v1/quotes/{quote}

A quote models prices and services for a customer.

Servers

Path parameters

Name Type Required Description
quote String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
application_fee_percent No

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. There must be at least 1 line item with a recurring price to use this field.

discounts No

The discounts applied to the quote.

description No

A description that will be displayed on the quote PDF.

expand[] Array No

Specifies which fields in the response should be expanded.

automatic_tax Object No

Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.

automatic_tax.enabled Boolean Yes
automatic_tax.liability Object No
automatic_tax.liability.account String No
automatic_tax.liability.type String Yes

Possible values:

  • "account"
  • "self"
application_fee_amount No

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. There cannot be any line items with recurring prices when using this field.

metadata Object No

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.

collection_method String No

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.

Possible values:

  • "send_invoice"
  • "charge_automatically"
footer No

A footer that will be displayed on the quote PDF.

on_behalf_of No

The account on behalf of which to charge.

customer String No

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

line_items[] Array No

A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.

line_items[].id String No
line_items[].discounts No
line_items[].price String No
line_items[].tax_rates No
line_items[].price_data Object No
line_items[].price_data.unit_amount Integer No
line_items[].price_data.unit_amount_decimal String No
line_items[].price_data.product String Yes
line_items[].price_data.recurring Object No
line_items[].price_data.recurring.interval String Yes

Possible values:

  • "month"
  • "day"
  • "week"
  • "year"
line_items[].price_data.recurring.interval_count Integer No
line_items[].price_data.tax_behavior String No

Possible values:

  • "inclusive"
  • "unspecified"
  • "exclusive"
line_items[].price_data.currency String Yes
line_items[].quantity Integer No
default_tax_rates No

The tax rates that will apply to any line item that does not have tax_rates set.

header No

A header that will be displayed on the quote PDF.

transfer_data No

The data with which to automatically create a Transfer for each of the invoices.

expires_at Integer No

A future timestamp on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

subscription_data Object No

When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if subscription_data[effective_date] is present and in the future, otherwise a subscription is created.

subscription_data.description No
subscription_data.effective_date No
subscription_data.trial_period_days No
subscription_data.metadata Object No
invoice_settings Object No

All invoices will be billed using the specified settings.

invoice_settings.days_until_due Integer No
invoice_settings.issuer Object No
invoice_settings.issuer.account String No
invoice_settings.issuer.type String Yes

Possible values:

  • "account"
  • "self"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.