Stripe: Quotes schemas
21 Stripe schemas with complete fields and constraints.
← Quotes operations · All schemas
Accept a quote — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount_subtotal | JSON | Required within parent | |
amount_subtotal (anyOf 1) | integer | Alternative | Total before any discounts or taxes are applied. |
amount_subtotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_total | JSON | Required within parent | |
amount_total (anyOf 1) | integer | Alternative | Total after discounts and taxes are applied. |
amount_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application | JSON | Optional | |
application (anyOf 1) | JSON | Alternative | ID of the Connect Application that created the quote. |
application (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
application (anyOf 1) (anyOf 2) | Model | Alternative | Expand PostApplicationFeesIdRefund — response body — application / object: application |
application (anyOf 1) (anyOf 3) | Model | Alternative | Expand Accept a quote — response body — application / value / deleted: True, object: application |
application (anyOf 2) | null | Alternative | |
application_fee_amount | JSON | Optional | |
application_fee_amount (anyOf 1) | JSON | Alternative | |
application_fee_amount (anyOf 1) (anyOf 1) | integer | Alternative | 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_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application_fee_amount (anyOf 2) | null | Alternative | |
application_fee_percent | JSON | Optional | |
application_fee_percent (anyOf 1) | JSON | Alternative | |
application_fee_percent (anyOf 1) (anyOf 1) | number | Alternative | 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. |
application_fee_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application_fee_percent (anyOf 2) | null | Alternative | |
automatic_tax | Model | Required within parent | Expand Accept a quote — response body — automatic tax |
collection_method | string | Required within parent | 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`. Known values: charge_automatically, send_invoice |
computed | Model | Required within parent | Expand Accept a quote — response body — computed |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | 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). Maximum length: 5000 |
currency (anyOf 2) | null | Alternative | |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. |
customer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a customer — response body |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
customer_account (anyOf 2) | null | Alternative | |
default_tax_rates | array | Optional | The tax rates applied to this quote. |
default_tax_rates[] | JSON | Each item | |
default_tax_rates[] (anyOf 1) | string | Alternative | Maximum length: 5000 |
default_tax_rates[] (anyOf 2) | Model | Alternative | Expand Create a tax rate — response body |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A description that will be displayed on the quote PDF. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
discounts | array | Required within parent | The discounts applied to this quote. |
discounts[] | JSON | Each item | |
discounts[] (anyOf 1) | string | Alternative | Maximum length: 5000 |
discounts[] (anyOf 2) | Model | Alternative | Expand Get Customers Customer Discount — response body |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | integer | Alternative | The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. Format: unix-time |
expires_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
footer | JSON | Optional | |
footer (anyOf 1) | string | Alternative | A footer that will be displayed on the quote PDF. Maximum length: 5000 |
footer (anyOf 2) | null | Alternative | |
from_quote | JSON | Optional | |
from_quote (anyOf 1) | JSON | Alternative | Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. |
from_quote (anyOf 1) (anyOf 1) | Model | Alternative | Expand Accept a quote — response body — from quote value is revision, quote |
from_quote (anyOf 2) | null | Alternative | |
header | JSON | Optional | |
header (anyOf 1) | string | Alternative | A header that will be displayed on the quote PDF. Maximum length: 5000 |
header (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
invoice | JSON | Optional | |
invoice (anyOf 1) | JSON | Alternative | The invoice that was created from this quote. |
invoice (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
invoice (anyOf 1) (anyOf 2) | Model | Alternative | Expand Pay an invoice — response body |
invoice (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a draft invoice — response body |
invoice (anyOf 2) | null | Alternative | |
invoice_settings | Model | Required within parent | Expand Accept a quote — response body — invoice settings |
line_items | object | Optional | A list of items the customer is being quoted for. |
line_items.data | array | Required within parent | Details about each object. |
line_items.data[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item |
line_items.has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
line_items.object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
line_items.url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | 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. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). Maximum length: 5000 |
number (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: quote |
on_behalf_of | JSON | Optional | |
on_behalf_of (anyOf 1) | JSON | Alternative | 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. |
on_behalf_of (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
on_behalf_of (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create an account — response body |
on_behalf_of (anyOf 2) | null | Alternative | |
status | string | Required within parent | The status of the quote. Known values: accepted, canceled, draft, open |
status_transitions | Model | Required within parent | Expand Accept a quote — response body — status transitions |
subscription | JSON | Optional | |
subscription (anyOf 1) | JSON | Alternative | The subscription that was created or updated from this quote. |
subscription (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
subscription (anyOf 1) (anyOf 2) | Model | Alternative | Expand Pause a subscription — response body |
subscription (anyOf 2) | null | Alternative | |
subscription_data | Model | Required within parent | Expand Accept a quote — response body — subscription data |
subscription_schedule | JSON | Optional | |
subscription_schedule (anyOf 1) | JSON | Alternative | The subscription schedule that was created or updated from this quote. |
subscription_schedule (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
subscription_schedule (anyOf 1) (anyOf 2) | Model | Alternative | Expand Cancel a schedule — response body |
subscription_schedule (anyOf 2) | null | Alternative | |
test_clock | JSON | Optional | |
test_clock (anyOf 1) | JSON | Alternative | ID of the test clock this quote belongs to. |
test_clock (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
test_clock (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a test clock — response body |
test_clock (anyOf 2) | null | Alternative | |
total_details | Model | Required within parent | Expand Accept a quote — response body — total details |
transfer_data | JSON | Optional | |
transfer_data (anyOf 1) | JSON | Alternative | 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. |
transfer_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Accept a quote — response body — transfer data value amount, amount percent, destination |
transfer_data (anyOf 2) | null | Alternative |
Referenced models: Create an account — response body, PostApplicationFeesIdRefund — response body — application / object: application, Create a customer — response body, Accept a quote — response body — application / value / deleted: True, object: application, Delete a customer — response body, Delete a draft invoice — response body, Get Customers Customer Discount — response body, Pay an invoice — response body, Accept a quote — response body — invoice settings, Retrieve a quote's line items — response body — data item, Accept a quote — response body — total details, Accept a quote — response body — automatic tax, Accept a quote — response body — computed, Accept a quote — response body — from quote value is revision, quote, Accept a quote — response body — status transitions, Accept a quote — response body — subscription data, Accept a quote — response body — transfer data value amount, amount percent, destination, Pause a subscription — response body, Cancel a schedule — response body, Create a tax rate — response body, Create a test clock — response body
Accept a quote — response body — application / value / deleted: True, object: application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the application. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: application |
Accept a quote — response body — automatic tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enabled | boolean | Required within parent | Automatically calculate taxes |
liability | JSON | Optional | |
liability (anyOf 1) | JSON | Alternative | The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. |
liability (anyOf 1) (anyOf 1) | Model | Alternative | Expand Pay an invoice — response body — issuer |
liability (anyOf 2) | null | Alternative | |
provider | JSON | Optional | |
provider (anyOf 1) | string | Alternative | The tax provider powering automatic tax. Maximum length: 5000 |
provider (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The status of the most recent automated tax calculation for this quote. Known values: complete, failed, requires_location_inputs |
status (anyOf 2) | null | Alternative |
Referenced models: Pay an invoice — response body — issuer
Accept a quote — response body — computed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recurring | JSON | Optional | |
recurring (anyOf 1) | JSON | Alternative | 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. |
recurring (anyOf 1) (anyOf 1) | Model | Alternative | Expand Accept a quote — response body — computed / recurring / value / interval: day, month, week, year |
recurring (anyOf 2) | null | Alternative | |
upfront | Model | Required within parent | Expand Accept a quote — response body — computed upfront |
Referenced models: Accept a quote — response body — computed / recurring / value / interval: day, month, week, year, Accept a quote — response body — computed upfront
Accept a quote — response body — computed / recurring / value / interval: day, month, week, year
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_subtotal | JSON | Required within parent | |
amount_subtotal (anyOf 1) | integer | Alternative | Total before any discounts or taxes are applied. |
amount_subtotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_total | JSON | Required within parent | |
amount_total (anyOf 1) | integer | Alternative | Total after discounts and taxes are applied. |
amount_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interval | string | Required within parent | The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. Known values: day, month, week, year |
interval_count | JSON | Required within parent | |
interval_count (anyOf 1) | integer | Alternative | The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. |
interval_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_details | Model | Required within parent | Expand Accept a quote — response body — total details |
Referenced models: Accept a quote — response body — total details
Accept a quote — response body — computed upfront
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_subtotal | JSON | Required within parent | |
amount_subtotal (anyOf 1) | integer | Alternative | Total before any discounts or taxes are applied. |
amount_subtotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_total | JSON | Required within parent | |
amount_total (anyOf 1) | integer | Alternative | Total after discounts and taxes are applied. |
amount_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
line_items | object | Optional | The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. |
line_items.data | array | Required within parent | Details about each object. |
line_items.data[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item |
line_items.has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
line_items.object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
line_items.url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
total_details | Model | Required within parent | Expand Accept a quote — response body — total details |
Referenced models: Retrieve a quote's line items — response body — data item, Accept a quote — response body — total details
Accept a quote — response body — from quote value is revision, quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_revision | boolean | Required within parent | Whether this quote is a revision of a different quote. |
quote | JSON | Required within parent | The quote that was cloned. |
quote (anyOf 1) | string | Alternative | Maximum length: 5000 |
quote (anyOf 2) | Model | Alternative | Expand Accept a quote — response body |
Referenced models: Accept a quote — response body
Accept a quote — response body — invoice settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | A list of up to 4 custom fields to be displayed on the invoice. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Pay an invoice — response body — custom fields Custom fields displayed on the invoice item |
custom_fields (anyOf 2) | null | Alternative | |
days_until_due | JSON | Optional | |
days_until_due (anyOf 1) | JSON | Alternative | |
days_until_due (anyOf 1) (anyOf 1) | integer | Alternative | Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. |
days_until_due (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
days_until_due (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
footer | JSON | Optional | |
footer (anyOf 1) | string | Alternative | Footer to be displayed on the invoice. Maximum length: 5000 |
footer (anyOf 2) | null | Alternative | |
issuer | Model | Required within parent | Expand Pay an invoice — response body — issuer |
Referenced models: Pay an invoice — response body — issuer, Pay an invoice — response body — custom fields Custom fields displayed on the invoice item
Accept a quote — response body — status transitions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accepted_at | JSON | Optional | |
accepted_at (anyOf 1) | JSON | Alternative | |
accepted_at (anyOf 1) (anyOf 1) | integer | Alternative | The time that the quote was accepted. Measured in seconds since Unix epoch. Format: unix-time |
accepted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
accepted_at (anyOf 2) | null | Alternative | |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | The time that the quote was canceled. Measured in seconds since Unix epoch. Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
finalized_at | JSON | Optional | |
finalized_at (anyOf 1) | JSON | Alternative | |
finalized_at (anyOf 1) (anyOf 1) | integer | Alternative | The time that the quote was finalized. Measured in seconds since Unix epoch. Format: unix-time |
finalized_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
finalized_at (anyOf 2) | null | Alternative |
Accept a quote — response body — subscription data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_mode | Model | Required within parent | Expand Accept a quote — response body — subscription data billing mode |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | JSON | Alternative | |
effective_date (anyOf 1) (anyOf 1) | integer | Alternative | 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. Format: unix-time |
effective_date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
effective_date (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
trial_period_days | JSON | Optional | |
trial_period_days (anyOf 1) | JSON | Alternative | |
trial_period_days (anyOf 1) (anyOf 1) | integer | Alternative | Integer representing the number of trial period days before the customer is charged for the first time. |
trial_period_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
trial_period_days (anyOf 2) | null | Alternative |
Referenced models: Accept a quote — response body — subscription data billing mode
Accept a quote — response body — subscription data billing mode
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The billing mode of the quote. |
flexible | Model | Optional | Expand Accept a quote — response body — subscription data billing mode flexible |
type | string | Required within parent | Controls how prorations and invoices for subscriptions are calculated and orchestrated. Known values: classic, flexible |
Referenced models: Accept a quote — response body — subscription data billing mode flexible
Accept a quote — response body — subscription data billing mode flexible
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
proration_discounts | string | Optional | Controls how invoices and invoice items display proration amounts and discount amounts. Known values: included, itemized |
Accept a quote — response body — total details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_discount | JSON | Required within parent | |
amount_discount (anyOf 1) | integer | Alternative | This is the sum of all the discounts. |
amount_discount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_shipping | JSON | Optional | |
amount_shipping (anyOf 1) | JSON | Alternative | |
amount_shipping (anyOf 1) (anyOf 1) | integer | Alternative | This is the sum of all the shipping amounts. |
amount_shipping (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_shipping (anyOf 2) | null | Alternative | |
amount_tax | JSON | Required within parent | |
amount_tax (anyOf 1) | integer | Alternative | This is the sum of all the tax amounts. |
amount_tax (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
breakdown | Model | Optional | Expand Accept a quote — response body — total details breakdown |
Referenced models: Accept a quote — response body — total details breakdown
Accept a quote — response body — total details breakdown
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discounts | array | Required within parent | The aggregated discounts. |
discounts[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item discounts item |
taxes | array | Required within parent | The aggregated tax amounts by rate. |
taxes[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item taxes item |
Referenced models: Retrieve a quote's line items — response body — data item discounts item, Retrieve a quote's line items — response body — data item taxes item
Accept a quote — response body — transfer data value amount, amount percent, destination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
amount_percent | JSON | Optional | |
amount_percent (anyOf 1) | JSON | Alternative | |
amount_percent (anyOf 1) (anyOf 1) | number | Alternative | 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 destination account. By default, the entire amount will be transferred to the destination. |
amount_percent (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_percent (anyOf 2) | null | Alternative | |
destination | JSON | Required within parent | The account where funds from the payment will be transferred to upon payment success. |
destination (anyOf 1) | string | Alternative | Maximum length: 5000 |
destination (anyOf 2) | Model | Alternative | Expand Create an account — response body |
Referenced models: Create an account — response body
Create a quote — request body — body invoice settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | All invoices will be billed using the specified settings. |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | |
custom_fields (anyOf 1)[] | object | Each item | |
custom_fields (anyOf 1)[].name | string | Required within parent | Maximum length: 40 |
custom_fields (anyOf 1)[].value | string | Required within parent | Maximum length: 140 |
custom_fields (anyOf 2) | string | Alternative | One of: |
days_until_due | integer | Optional | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Maximum length: 500 |
description (anyOf 2) | string | Alternative | One of: |
footer | JSON | Optional | |
footer (anyOf 1) | string | Alternative | Maximum length: 5000 |
footer (anyOf 2) | string | Alternative | One of: |
issuer | object | Optional | |
issuer.account | string | Optional | |
issuer.type | string | Required within parent | One of: account, self |
Create a quote — request body — body line items item price data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | Format: currency |
product | string | Required within parent | Maximum length: 5000 |
recurring | object | Optional | |
recurring.interval | string | Required within parent | One of: day, month, week, year |
recurring.interval_count | integer | Optional | |
tax_behavior | string | Optional | One of: exclusive, inclusive, unspecified |
unit_amount | integer | Optional | |
unit_amount_decimal | string | Optional | Format: decimal |
Retrieve a quote's line items — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A line item. |
adjustable_quantity | JSON | Optional | |
adjustable_quantity (anyOf 1) | JSON | Alternative | |
adjustable_quantity (anyOf 1) (anyOf 1) | Model | Alternative | Expand Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum |
adjustable_quantity (anyOf 2) | null | Alternative | |
amount_discount | JSON | Required within parent | |
amount_discount (anyOf 1) | integer | Alternative | Total discount amount applied. If no discounts were applied, defaults to 0. |
amount_discount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_subtotal | JSON | Required within parent | |
amount_subtotal (anyOf 1) | integer | Alternative | Total before any discounts or taxes are applied. |
amount_subtotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_tax | JSON | Required within parent | |
amount_tax (anyOf 1) | integer | Alternative | Total tax amount applied. If no tax was applied, defaults to 0. |
amount_tax (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_total | JSON | Required within parent | |
amount_total (anyOf 1) | integer | Alternative | Total after discounts and taxes. |
amount_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | 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). Format: currency |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
discounts | array | Optional | The discounts applied to the line item. |
discounts[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item discounts item |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | 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. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: item |
price | JSON | Optional | |
price (anyOf 1) | JSON | Alternative | The price used to generate the line item. |
price (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a price — response body |
price (anyOf 2) | null | Alternative | |
quantity | JSON | Optional | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | integer | Alternative | The quantity of products being purchased. |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
taxes | array | Optional | The taxes applied to the line item. |
taxes[] | Model | Each item | Expand Retrieve a quote's line items — response body — data item taxes item |
Referenced models: Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum, Retrieve a quote's line items — response body — data item discounts item, Retrieve a quote's line items — response body — data item taxes item, Create a price — response body
Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enabled | boolean | Required within parent | |
maximum | JSON | Optional | |
maximum (anyOf 1) | JSON | Alternative | |
maximum (anyOf 1) (anyOf 1) | integer | Alternative | |
maximum (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maximum (anyOf 2) | null | Alternative | |
minimum | JSON | Optional | |
minimum (anyOf 1) | JSON | Alternative | |
minimum (anyOf 1) (anyOf 1) | integer | Alternative | |
minimum (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minimum (anyOf 2) | null | Alternative |
Retrieve a quote's line items — response body — data item discounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The amount discounted. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
discount | Model | Required within parent | Expand Get Customers Customer Discount — response body |
Referenced models: Get Customers Customer Discount — response body
Retrieve a quote's line items — response body — data item taxes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount of tax applied for this rate. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate | Model | Required within parent | Expand Create a tax rate — response body |
taxability_reason | JSON | Optional | |
taxability_reason (anyOf 1) | string | Alternative | The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Known values: customer_exempt, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated |
taxability_reason (anyOf 2) | null | Alternative | |
taxable_amount | JSON | Optional | |
taxable_amount (anyOf 1) | JSON | Alternative | |
taxable_amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount on which tax is calculated, in cents (or local equivalent). |
taxable_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
taxable_amount (anyOf 2) | null | Alternative |
Referenced models: Create a tax rate — response body