Stripe: Invoices schemas

← Invoices operations · All schemas

Bulk add invoice line items — request body — body lines item price data

Field	Type	Presence	Description and constraints
$	object	Root
currency	string	Required within parent	Format: currency
product	string	Optional	Maximum length: 5000
product_data	Model	Optional	Expand Update an invoice's line item — request body — body price data product data
tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
unit_amount	integer	Optional
unit_amount_decimal	string	Optional	Format: decimal

Referenced models: Update an invoice's line item — request body — body price data product data

Create an invoice — request body — body / payment_settings / payment_method_options / us_bank_account / verification_method: automatic, instant, microdeposits

Field	Type	Presence	Description and constraints
$	object	Root
financial_connections	object	Optional
financial_connections.filters	object	Optional
financial_connections.filters.account_subcategories	array	Optional
financial_connections.filters.account_subcategories[]	string	Each item	One of: checking, savings
financial_connections.permissions	array	Optional
financial_connections.permissions[]	string	Each item	One of: balances, ownership, payment_method, transactions Maximum length: 5000
financial_connections.prefetch	array	Optional
financial_connections.prefetch[]	string	Each item	One of: balances, ownership, transactions
verification_method	string	Optional	One of: automatic, instant, microdeposits

Create an invoice — request body — body payment settings

Field	Type	Presence	Description and constraints
$	object	Root	Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
default_mandate	JSON	Optional
default_mandate (anyOf 1)	string	Alternative	Maximum length: 5000
default_mandate (anyOf 2)	string	Alternative	One of:
payment_method_options	Model	Optional	Expand Create an invoice — request body — body payment settings payment method options
payment_method_types	JSON	Optional
payment_method_types (anyOf 1)	array	Alternative
payment_method_types (anyOf 1)[]	string	Each item	One of: ach_credit_transfer, ach_debit, acss_debit, affirm, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, jp_credit_transfer, kakao_pay, klarna, konbini, kr_card, link, mb_way, multibanco, naver_pay, nz_bank_account, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, satispay, sepa_credit_transfer, sepa_debit, sofort, swish, twint, upi, us_bank_account, wechat_pay
payment_method_types (anyOf 2)	string	Alternative	One of:

Referenced models: Create an invoice — request body — body payment settings payment method options

Create an invoice — request body — body payment settings payment method options

Field	Type	Presence	Description and constraints
$	object	Root
acss_debit	JSON	Optional
acss_debit (anyOf 1)	object	Alternative
acss_debit (anyOf 1).mandate_options	object	Optional
acss_debit (anyOf 1).mandate_options.transaction_type	string	Optional	One of: business, personal
acss_debit (anyOf 1).verification_method	string	Optional	One of: automatic, instant, microdeposits
acss_debit (anyOf 2)	string	Alternative	One of:
bancontact	JSON	Optional
bancontact (anyOf 1)	object	Alternative
bancontact (anyOf 1).preferred_language	string	Optional	One of: de, en, fr, nl
bancontact (anyOf 2)	string	Alternative	One of:
billie	JSON	Optional
billie (anyOf 1)	Model	Alternative	Expand Create an invoice — request body — body payment settings payment method options billie company details, reference
billie (anyOf 2)	string	Alternative	One of:
blik	JSON	Optional
blik (anyOf 1)	object	Alternative
blik (anyOf 2)	string	Alternative	One of:
card	JSON	Optional
card (anyOf 1)	object	Alternative
card (anyOf 1).installments	object	Optional
card (anyOf 1).installments.enabled	boolean	Optional
card (anyOf 1).installments.plan	JSON	Optional
card (anyOf 1).installments.plan (anyOf 1)	object	Alternative
card (anyOf 1).installments.plan (anyOf 1).count	integer	Optional
card (anyOf 1).installments.plan (anyOf 1).interval	string	Optional	One of: month
card (anyOf 1).installments.plan (anyOf 1).type	string	Required within parent	One of: bonus, fixed_count, revolving
card (anyOf 1).installments.plan (anyOf 2)	string	Alternative	One of:
card (anyOf 1).request_three_d_secure	string	Optional	One of: any, automatic, challenge
card (anyOf 2)	string	Alternative	One of:
customer_balance	JSON	Optional
customer_balance (anyOf 1)	object	Alternative
customer_balance (anyOf 1).bank_transfer	object	Optional
customer_balance (anyOf 1).bank_transfer.eu_bank_transfer	object	Optional
customer_balance (anyOf 1).bank_transfer.eu_bank_transfer.country	string	Required within parent	Maximum length: 5000
customer_balance (anyOf 1).bank_transfer.type	string	Optional
customer_balance (anyOf 1).funding_type	string	Optional
customer_balance (anyOf 2)	string	Alternative	One of:
konbini	JSON	Optional
konbini (anyOf 1)	object	Alternative
konbini (anyOf 2)	string	Alternative	One of:
payto	JSON	Optional
payto (anyOf 1)	object	Alternative
payto (anyOf 1).mandate_options	object	Optional
payto (anyOf 1).mandate_options.amount	integer	Optional
payto (anyOf 1).mandate_options.purpose	string	Optional	One of: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility
payto (anyOf 2)	string	Alternative	One of:
pix	JSON	Optional
pix (anyOf 1)	object	Alternative
pix (anyOf 1).amount_includes_iof	string	Optional	One of: always, never
pix (anyOf 1).expires_after_seconds	integer	Optional
pix (anyOf 2)	string	Alternative	One of:
sepa_debit	JSON	Optional
sepa_debit (anyOf 1)	object	Alternative
sepa_debit (anyOf 2)	string	Alternative	One of:
upi	JSON	Optional
upi (anyOf 1)	object	Alternative
upi (anyOf 1).mandate_options	object	Optional
upi (anyOf 1).mandate_options.amount	integer	Optional
upi (anyOf 1).mandate_options.amount_type	string	Optional	One of: fixed, maximum
upi (anyOf 1).mandate_options.description	string	Optional	Maximum length: 20
upi (anyOf 1).mandate_options.end_date	integer	Optional	Format: unix-time
upi (anyOf 2)	string	Alternative	One of:
us_bank_account	JSON	Optional
us_bank_account (anyOf 1)	Model	Alternative	Expand Create an invoice — request body — body / payment_settings / payment_method_options / us_bank_account / verification_method: automatic, instant, microdeposits
us_bank_account (anyOf 2)	string	Alternative	One of:

Referenced models: Create an invoice — request body — body payment settings payment method options billie company details, reference, Create an invoice — request body — body / payment_settings / payment_method_options / us_bank_account / verification_method: automatic, instant, microdeposits

Create an invoice — request body — body payment settings payment method options billie company details, reference

Field	Type	Presence	Description and constraints
$	object	Root
company_details	JSON	Optional
company_details (anyOf 1)	Model	Alternative	Expand Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat
company_details (anyOf 2)	string	Alternative	One of:
reference	string	Optional	Maximum length: 5000

Referenced models: Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat

Create an invoice — request body — body rendering

Field	Type	Presence	Description and constraints
$	object	Root	The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.
amount_tax_display	string	Optional	One of: , exclude_tax, include_inclusive_tax
pdf	object	Optional
pdf.page_size	string	Optional	One of: a4, auto, letter
template	string	Optional	Maximum length: 5000
template_version	JSON	Optional
template_version (anyOf 1)	integer	Alternative
template_version (anyOf 2)	string	Alternative	One of:

Create an invoice — request body — body shipping cost shipping rate data

Field	Type	Presence	Description and constraints
$	object	Root
delivery_estimate	object	Optional
delivery_estimate.maximum	object	Optional
delivery_estimate.maximum.unit	string	Required within parent	One of: business_day, day, hour, month, week
delivery_estimate.maximum.value	integer	Required within parent
delivery_estimate.minimum	object	Optional
delivery_estimate.minimum.unit	string	Required within parent	One of: business_day, day, hour, month, week
delivery_estimate.minimum.value	integer	Required within parent
display_name	string	Required within parent	Maximum length: 100
fixed_amount	object	Optional
fixed_amount.amount	integer	Required within parent
fixed_amount.currency	string	Required within parent	Format: currency
fixed_amount.currency_options	object	Optional	Additional keys: see wildcard field
fixed_amount.currency_options.*	object	Additional keys
fixed_amount.currency_options.*.amount	integer	Required within parent
fixed_amount.currency_options.*.tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
metadata	object	Optional	Additional keys: see wildcard field
metadata.*	string	Additional keys
tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
tax_code	string	Optional
type	string	Optional	One of: fixed_amount

Delete a draft invoice — response body

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
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: invoice

Pay an invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root	Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice items](https://docs.stripe.com/api#invoiceitems), and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice. If your invoice is configured to be billed by sending an email, then based on your [email settings](https://dashboard.stripe.com/account/billing/automatic), Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice. Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice. More details on the customer's credit balance are [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending)
account_country	JSON	Optional
account_country (anyOf 1)	string	Alternative	The country of the business associated with this invoice, most often the business creating the invoice. Maximum length: 5000
account_country (anyOf 2)	null	Alternative
account_name	JSON	Optional
account_name (anyOf 1)	string	Alternative	The public name of the business associated with this invoice, most often the business creating the invoice. Maximum length: 5000
account_name (anyOf 2)	null	Alternative
account_tax_ids	JSON	Optional
account_tax_ids (anyOf 1)	array	Alternative	The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
account_tax_ids (anyOf 1)[]	JSON	Each item
account_tax_ids (anyOf 1)[] (anyOf 1)	string	Alternative	Maximum length: 5000
account_tax_ids (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Create a tax ID — response body
account_tax_ids (anyOf 1)[] (anyOf 3)	Model	Alternative	Expand Delete a tax ID — response body
account_tax_ids (anyOf 2)	null	Alternative
amount_due	JSON	Required within parent
amount_due (anyOf 1)	integer	Alternative	Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
amount_due (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_overpaid	JSON	Required within parent
amount_overpaid (anyOf 1)	integer	Alternative	Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
amount_overpaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_paid	JSON	Required within parent
amount_paid (anyOf 1)	integer	Alternative	The amount, in cents (or local equivalent), that was paid.
amount_paid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_paid_off_stripe	JSON	Required within parent
amount_paid_off_stripe (anyOf 1)	integer	Alternative	Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
amount_paid_off_stripe (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_remaining	JSON	Required within parent
amount_remaining (anyOf 1)	integer	Alternative	The difference between amount_due and amount_paid, in cents (or local equivalent).
amount_remaining (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_shipping	JSON	Required within parent
amount_shipping (anyOf 1)	integer	Alternative	This is the sum of all the shipping amounts.
amount_shipping (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 invoice.
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
attempt_count	JSON	Required within parent
attempt_count (anyOf 1)	integer	Alternative	Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
attempt_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attempted	boolean	Required within parent	Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
auto_advance	boolean	Required within parent	Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
automatic_tax	Model	Required within parent	Expand Pay an invoice — response body — automatic tax
automatically_finalizes_at	JSON	Optional
automatically_finalizes_at (anyOf 1)	JSON	Alternative
automatically_finalizes_at (anyOf 1) (anyOf 1)	integer	Alternative	The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. Format: unix-time
automatically_finalizes_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
automatically_finalizes_at (anyOf 2)	null	Alternative
billing_reason	JSON	Optional
billing_reason (anyOf 1)	string	Alternative	Indicates the reason why the invoice was created. * `manual`: Unrelated to a subscription, for example, created via the invoice editor. * `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds. * `subscription_create`: A new subscription was created. * `subscription_cycle`: A subscription advanced into a new period. * `subscription_threshold`: A subscription reached a billing threshold. * `subscription_update`: A subscription was updated. * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription. Known values: automatic_pending_invoice_item_invoice, manual, quote_accept, subscription, subscription_create, subscription_cycle, subscription_threshold, subscription_update, upcoming
billing_reason (anyOf 2)	null	Alternative
collection_method	string	Required within parent	Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Known values: charge_automatically, send_invoice
confirmation_secret	JSON	Optional
confirmation_secret (anyOf 1)	JSON	Alternative	The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
confirmation_secret (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — confirmation secret value client secret, type
confirmation_secret (anyOf 2)	null	Alternative
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	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
custom_fields	JSON	Optional
custom_fields (anyOf 1)	array	Alternative	Custom fields 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
customer	JSON	Required within parent	The ID of the customer to bill.
customer (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer (anyOf 3)	Model	Alternative	Expand Delete a customer — response body
customer_account	JSON	Optional
customer_account (anyOf 1)	string	Alternative	The ID of the account representing the customer to bill. Maximum length: 5000
customer_account (anyOf 2)	null	Alternative
customer_address	JSON	Optional
customer_address (anyOf 1)	JSON	Alternative	The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
customer_address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Location — response body — address
customer_address (anyOf 2)	null	Alternative
customer_email	JSON	Optional
customer_email (anyOf 1)	string	Alternative	The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. Maximum length: 5000
customer_email (anyOf 2)	null	Alternative
customer_name	JSON	Optional
customer_name (anyOf 1)	string	Alternative	The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. Maximum length: 5000
customer_name (anyOf 2)	null	Alternative
customer_phone	JSON	Optional
customer_phone (anyOf 1)	string	Alternative	The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. Maximum length: 5000
customer_phone (anyOf 2)	null	Alternative
customer_shipping	JSON	Optional
customer_shipping (anyOf 1)	JSON	Alternative	The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
customer_shipping (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a source — response body — source order shipping
customer_shipping (anyOf 2)	null	Alternative
customer_tax_exempt	JSON	Optional
customer_tax_exempt (anyOf 1)	string	Alternative	The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. Known values: exempt, none, reverse
customer_tax_exempt (anyOf 2)	null	Alternative
customer_tax_ids	JSON	Optional
customer_tax_ids (anyOf 1)	array	Alternative	The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
customer_tax_ids (anyOf 1)[]	Model	Each item	Expand Pay an invoice — response body — customer tax ids array item
customer_tax_ids (anyOf 2)	null	Alternative
default_payment_method	JSON	Optional
default_payment_method (anyOf 1)	JSON	Alternative	ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
default_payment_method (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
default_payment_method (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a Payment Method — response body
default_payment_method (anyOf 2)	null	Alternative
default_source	JSON	Optional
default_source (anyOf 1)	JSON	Alternative	ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
default_source (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
default_source (anyOf 1) (anyOf 2)	Model	Alternative	Expand Retrieve a bank account — response body
default_source (anyOf 1) (anyOf 3)	Model	Alternative	Expand Retrieve a card — customers get Customers Customer Cards Id — response body
default_source (anyOf 1) (anyOf 4)	Model	Alternative	Expand Create a source — response body
default_source (anyOf 2)	null	Alternative
default_tax_rates	array	Required within parent	The tax rates applied to this invoice, if any.
default_tax_rates[]	Model	Each item	Expand Create a tax rate — response body
description	JSON	Optional
description (anyOf 1)	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. Maximum length: 5000
description (anyOf 2)	null	Alternative
discounts	array	Required within parent	The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
discounts[]	JSON	Each item
discounts[] (anyOf 1)	string	Alternative	Maximum length: 5000
discounts[] (anyOf 2)	Model	Alternative	Expand Get Customers Customer Discount — response body
discounts[] (anyOf 3)	Model	Alternative	Expand Delete a subscription discount — response body
due_date	JSON	Optional
due_date (anyOf 1)	JSON	Alternative
due_date (anyOf 1) (anyOf 1)	integer	Alternative	The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. Format: unix-time
due_date (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
due_date (anyOf 2)	null	Alternative
effective_at	JSON	Optional
effective_at (anyOf 1)	JSON	Alternative
effective_at (anyOf 1) (anyOf 1)	integer	Alternative	The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. Format: unix-time
effective_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effective_at (anyOf 2)	null	Alternative
ending_balance	JSON	Optional
ending_balance (anyOf 1)	JSON	Alternative
ending_balance (anyOf 1) (anyOf 1)	integer	Alternative	Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
ending_balance (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ending_balance (anyOf 2)	null	Alternative
footer	JSON	Optional
footer (anyOf 1)	string	Alternative	Footer displayed on the invoice. Maximum length: 5000
footer (anyOf 2)	null	Alternative
from_invoice	JSON	Optional
from_invoice (anyOf 1)	JSON	Alternative	Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
from_invoice (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — from invoice value action, invoice
from_invoice (anyOf 2)	null	Alternative
hosted_invoice_url	JSON	Optional
hosted_invoice_url (anyOf 1)	string	Alternative	The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. Maximum length: 5000
hosted_invoice_url (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. Maximum length: 5000
invoice_pdf	JSON	Optional
invoice_pdf (anyOf 1)	string	Alternative	The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. Maximum length: 5000
invoice_pdf (anyOf 2)	null	Alternative
issuer	Model	Required within parent	Expand Pay an invoice — response body — issuer
last_finalization_error	JSON	Optional
last_finalization_error (anyOf 1)	JSON	Alternative	The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
last_finalization_error (anyOf 1) (anyOf 1)	Model	Alternative	Expand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error
last_finalization_error (anyOf 2)	null	Alternative
latest_revision	JSON	Optional
latest_revision (anyOf 1)	JSON	Alternative	The ID of the most recent non-draft revision of this invoice
latest_revision (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
latest_revision (anyOf 1) (anyOf 2)	Model	Alternative	Expand Pay an invoice — response body
latest_revision (anyOf 2)	null	Alternative
lines	object	Required within parent	The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
lines.data	array	Required within parent	Details about each object.
lines.data[]	Model	Each item	Expand Update an invoice's line item — response body
lines.has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
lines.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
lines.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	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
next_payment_attempt	JSON	Optional
next_payment_attempt (anyOf 1)	JSON	Alternative
next_payment_attempt (anyOf 1) (anyOf 1)	integer	Alternative	The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. Format: unix-time
next_payment_attempt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
next_payment_attempt (anyOf 2)	null	Alternative
number	JSON	Optional
number (anyOf 1)	string	Alternative	A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. 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: invoice
on_behalf_of	JSON	Optional
on_behalf_of (anyOf 1)	JSON	Alternative	The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation 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
parent	JSON	Optional
parent (anyOf 1)	JSON	Alternative	The parent that generated this invoice
parent (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details
parent (anyOf 2)	null	Alternative
payment_settings	Model	Required within parent	Expand Pay an invoice — response body — payment settings
payments	object	Optional	Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.
payments.data	array	Required within parent	Details about each object.
payments.data[]	Model	Each item	Expand Retrieve an Invoice Payment — response body
payments.has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
payments.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
payments.url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000
period_end	JSON	Required within parent
period_end (anyOf 1)	integer	Alternative	The latest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. Format: unix-time
period_end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_start	JSON	Required within parent
period_start (anyOf 1)	integer	Alternative	The earliest timestamp at which invoice items can be associated with this invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. Format: unix-time
period_start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
post_payment_credit_notes_amount	JSON	Required within parent
post_payment_credit_notes_amount (anyOf 1)	integer	Alternative	Total amount of all post-payment credit notes issued for this invoice.
post_payment_credit_notes_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pre_payment_credit_notes_amount	JSON	Required within parent
pre_payment_credit_notes_amount (anyOf 1)	integer	Alternative	Total amount of all pre-payment credit notes issued for this invoice.
pre_payment_credit_notes_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
receipt_number	JSON	Optional
receipt_number (anyOf 1)	string	Alternative	This is the transaction number that appears on email receipts sent for this invoice. Maximum length: 5000
receipt_number (anyOf 2)	null	Alternative
rendering	JSON	Optional
rendering (anyOf 1)	JSON	Alternative	The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.
rendering (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — rendering value amount tax display, pdf, template, template version
rendering (anyOf 2)	null	Alternative
shipping_cost	JSON	Optional
shipping_cost (anyOf 1)	JSON	Alternative	The details of the cost of shipping, including the ShippingRate applied on the invoice.
shipping_cost (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — shipping cost value amount subtotal, amount tax, amount total, shipping rate, taxes
shipping_cost (anyOf 2)	null	Alternative
shipping_details	JSON	Optional
shipping_details (anyOf 1)	JSON	Alternative	Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
shipping_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a source — response body — source order shipping
shipping_details (anyOf 2)	null	Alternative
starting_balance	JSON	Required within parent
starting_balance (anyOf 1)	integer	Alternative	Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
starting_balance (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statement_descriptor	JSON	Optional
statement_descriptor (anyOf 1)	string	Alternative	Extra information about an invoice for the customer's credit card statement. Maximum length: 5000
statement_descriptor (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	string	Alternative	The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) Known values: draft, open, paid, uncollectible, void
status (anyOf 2)	null	Alternative
status_details	Model	Optional	Expand Pay an invoice — response body — status details
status_transitions	Model	Required within parent	Expand Pay an invoice — response body — status transitions
subtotal	JSON	Required within parent
subtotal (anyOf 1)	integer	Alternative	Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subtotal_excluding_tax	JSON	Optional
subtotal_excluding_tax (anyOf 1)	JSON	Alternative
subtotal_excluding_tax (anyOf 1) (anyOf 1)	integer	Alternative	The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
subtotal_excluding_tax (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subtotal_excluding_tax (anyOf 2)	null	Alternative
test_clock	JSON	Optional
test_clock (anyOf 1)	JSON	Alternative	ID of the test clock this invoice 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
threshold_reason	Model	Optional	Expand Pay an invoice — response body — threshold reason
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	Total after discounts and taxes.
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_discount_amounts	JSON	Optional
total_discount_amounts (anyOf 1)	array	Alternative	The aggregate amounts calculated per discount across all line items.
total_discount_amounts (anyOf 1)[]	Model	Each item	Expand Void a credit note — response body — discount amounts item
total_discount_amounts (anyOf 2)	null	Alternative
total_excluding_tax	JSON	Optional
total_excluding_tax (anyOf 1)	JSON	Alternative
total_excluding_tax (anyOf 1) (anyOf 1)	integer	Alternative	The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
total_excluding_tax (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_excluding_tax (anyOf 2)	null	Alternative
total_pretax_credit_amounts	JSON	Optional
total_pretax_credit_amounts (anyOf 1)	array	Alternative	Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
total_pretax_credit_amounts (anyOf 1)[]	Model	Each item	Expand Update an invoice's line item — response body — pretax credit amounts array item
total_pretax_credit_amounts (anyOf 2)	null	Alternative
total_taxes	JSON	Optional
total_taxes (anyOf 1)	array	Alternative	The aggregate tax information of all line items.
total_taxes (anyOf 1)[]	Model	Each item	Expand Update an invoice's line item — response body — taxes The tax information of the line item item
total_taxes (anyOf 2)	null	Alternative
webhooks_delivered_at	JSON	Optional
webhooks_delivered_at (anyOf 1)	JSON	Alternative
webhooks_delivered_at (anyOf 1) (anyOf 1)	integer	Alternative	Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. Format: unix-time
webhooks_delivered_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
webhooks_delivered_at (anyOf 2)	null	Alternative

Referenced models: Create an account — response body, Create a Location — response body — address, Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error, PostApplicationFeesIdRefund — response body — application / object: application, Pay an invoice — response body — automatic tax, Retrieve a bank account — response body, Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details, Update an invoice's line item — response body — taxes The tax information of the line item item, Retrieve a card — customers get Customers Customer Cards Id — response body, Pay an invoice — response body — issuer, Create a customer — response body, Accept a quote — response body — application / value / deleted: True, object: application, Delete a customer — response body, Delete a subscription discount — response body, Delete a tax ID — response body, Get Customers Customer Discount — response body, Void a credit note — response body — discount amounts item, Pay an invoice — response body, Retrieve an Invoice Payment — response body, Pay an invoice — response body — custom fields Custom fields displayed on the invoice item, Pay an invoice — response body — threshold reason, Pay an invoice — response body — payment settings, Pay an invoice — response body — confirmation secret value client secret, type, Pay an invoice — response body — from invoice value action, invoice, Pay an invoice — response body — rendering value amount tax display, pdf, template, template version, Pay an invoice — response body — customer tax ids array item, Update an invoice's line item — response body — pretax credit amounts array item, Pay an invoice — response body — shipping cost value amount subtotal, amount tax, amount total, shipping rate, taxes, Pay an invoice — response body — status details, Pay an invoice — response body — status transitions, Update an invoice's line item — response body, Create a Payment Method — response body, Create a source — response body — source order shipping, Create a source — response body, Create a tax ID — response body, Create a tax rate — response body, Create a test clock — response body

Pay an invoice — response body — automatic tax

Field	Type	Presence	Description and constraints
$	object	Root
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	If Stripe disabled automatic tax, this enum describes why. Known values: finalization_requires_location_inputs, finalization_system_error
disabled_reason (anyOf 2)	null	Alternative
enabled	boolean	Required within parent	Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
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 invoice. Known values: complete, failed, requires_location_inputs
status (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — issuer

Pay an invoice — response body — confirmation secret value client secret, type

Field	Type	Presence	Description and constraints
$	object	Root
client_secret	string	Required within parent	The client_secret of the payment that Stripe creates for the invoice after finalization. Maximum length: 5000
type	string	Required within parent	The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization Maximum length: 5000

Pay an invoice — response body — custom fields Custom fields displayed on the invoice item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	The name of the custom field. Maximum length: 5000
value	string	Required within parent	The value of the custom field. Maximum length: 5000

Pay an invoice — response body — customer tax ids array item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, or `unknown` Known values: ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, ic_nif, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, unknown, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, zw_tin
value	JSON	Optional
value (anyOf 1)	string	Alternative	The value of the tax ID. Maximum length: 5000
value (anyOf 2)	null	Alternative

Pay an invoice — response body — from invoice value action, invoice

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	The relation between this invoice and the cloned invoice Maximum length: 5000
invoice	JSON	Required within parent	The invoice that was cloned.
invoice (anyOf 1)	string	Alternative	Maximum length: 5000
invoice (anyOf 2)	Model	Alternative	Expand Pay an invoice — response body

Referenced models: Pay an invoice — response body

Pay an invoice — response body — issuer

Field	Type	Presence	Description and constraints
$	object	Root
account	JSON	Optional	The connected account being referenced when `type` is `account`.
account (anyOf 1)	string	Alternative	Maximum length: 5000
account (anyOf 2)	Model	Alternative	Expand Create an account — response body
type	string	Required within parent	Type of the account referenced. Known values: account, self

Referenced models: Create an account — response body

Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details

Field	Type	Presence	Description and constraints
$	object	Root
quote_details	JSON	Optional
quote_details (anyOf 1)	JSON	Alternative	Details about the quote that generated this invoice
quote_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details quote details value quote
quote_details (anyOf 2)	null	Alternative
subscription_details	JSON	Optional
subscription_details (anyOf 1)	JSON	Alternative	Details about the subscription that generated this invoice
subscription_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details subscription details value metadata, subscription, subscription proration date
subscription_details (anyOf 2)	null	Alternative
type	string	Required within parent	The type of parent that generated this invoice Known values: quote_details, subscription_details

Referenced models: Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details quote details value quote, Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details subscription details value metadata, subscription, subscription proration date

Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details quote details value quote

Field	Type	Presence	Description and constraints
$	object	Root
quote	string	Required within parent	The quote that generated this invoice Maximum length: 5000

Pay an invoice — response body — parent / The parent that generated this invoice / type: quote details, subscription details subscription details value metadata, subscription, subscription proration date

Field	Type	Presence	Description and constraints
$	object	Root
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. *Note: This attribute is populated only for invoices created on or after June 29, 2023.* Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
subscription	JSON	Required within parent	The subscription that generated this invoice
subscription (anyOf 1)	string	Alternative	Maximum length: 5000
subscription (anyOf 2)	Model	Alternative	Expand Pause a subscription — response body
subscription_proration_date	JSON	Optional
subscription_proration_date (anyOf 1)	integer	Alternative	Only set for upcoming invoices that preview prorations. The time used to calculate prorations. Format: unix-time
subscription_proration_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Pause a subscription — response body

Pay an invoice — response body — payment settings

Field	Type	Presence	Description and constraints
$	object	Root
default_mandate	JSON	Optional
default_mandate (anyOf 1)	string	Alternative	ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. Maximum length: 5000
default_mandate (anyOf 2)	null	Alternative
payment_method_options	JSON	Optional
payment_method_options (anyOf 1)	JSON	Alternative	Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
payment_method_options (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account
payment_method_options (anyOf 2)	null	Alternative
payment_method_types	JSON	Optional
payment_method_types (anyOf 1)	array	Alternative	The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
payment_method_types (anyOf 1)[]	string	Each item	Known values: ach_credit_transfer, ach_debit, acss_debit, affirm, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, jp_credit_transfer, kakao_pay, klarna, konbini, kr_card, link, mb_way, multibanco, naver_pay, nz_bank_account, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, satispay, sepa_credit_transfer, sepa_debit, sofort, swish, twint, upi, us_bank_account, wechat_pay
payment_method_types (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account

Field	Type	Presence	Description and constraints
$	object	Root
acss_debit	JSON	Optional
acss_debit (anyOf 1)	JSON	Alternative	If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
acss_debit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits
acss_debit (anyOf 2)	null	Alternative
bancontact	JSON	Optional
bancontact (anyOf 1)	JSON	Alternative	If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
bancontact (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / bancontact / value / preferred_language: de, en, fr, nl
bancontact (anyOf 2)	null	Alternative
billie	JSON	Optional
billie (anyOf 1)	JSON	Alternative	If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
billie (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference
billie (anyOf 2)	null	Alternative
blik	JSON	Optional
blik (anyOf 1)	JSON	Alternative	If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice’s PaymentIntent.
blik (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Payment Method — response body — zip
blik (anyOf 2)	null	Alternative
card	JSON	Optional
card (anyOf 1)	JSON	Alternative	If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
card (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure
card (anyOf 2)	null	Alternative
customer_balance	JSON	Optional
customer_balance (anyOf 1)	JSON	Alternative	If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
customer_balance (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type
customer_balance (anyOf 2)	null	Alternative
konbini	JSON	Optional
konbini (anyOf 1)	JSON	Alternative	If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
konbini (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Payment Method — response body — zip
konbini (anyOf 2)	null	Alternative
payto	JSON	Optional
payto (anyOf 1)	JSON	Alternative	If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
payto (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options
payto (anyOf 2)	null	Alternative
pix	JSON	Optional
pix (anyOf 1)	JSON	Alternative	If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
pix (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value amount includes iof, expires after seconds
pix (anyOf 2)	null	Alternative
sepa_debit	JSON	Optional
sepa_debit (anyOf 1)	JSON	Alternative	If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
sepa_debit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Payment Method — response body — zip
sepa_debit (anyOf 2)	null	Alternative
upi	JSON	Optional
upi (anyOf 1)	JSON	Alternative	If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
upi (anyOf 1) (anyOf 1)	Model	Alternative	Expand Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account upi mandate options
upi (anyOf 2)	null	Alternative
us_bank_account	JSON	Optional
us_bank_account (anyOf 1)	JSON	Alternative	If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
us_bank_account (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits
us_bank_account (anyOf 2)	null	Alternative

Referenced models: Create a Payment Method — response body — zip, Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits, Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / bancontact / value / preferred_language: de, en, fr, nl, Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference, Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure, Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type, Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options, Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value amount includes iof, expires after seconds, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account upi mandate options, Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference

Field	Type	Presence	Description and constraints
$	object	Root
company_details	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details
reference	JSON	Optional
reference (anyOf 1)	string	Alternative	An identifier or reference that this payment corresponds to. Maximum length: 5000
reference (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details

Field	Type	Presence	Description and constraints
$	object	Root
registered_address	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details registered address
registered_name	JSON	Optional
registered_name (anyOf 1)	string	Alternative	Company or entity name. Maximum length: 5000
registered_name (anyOf 2)	null	Alternative
registration_number	JSON	Optional
registration_number (anyOf 1)	string	Alternative	The official registration number for the given registration type. Maximum length: 5000
registration_number (anyOf 2)	null	Alternative
registration_type	string	Optional	Type of registration the company or entity holds in their registered country. Known values: ch_ein, de_hrb, dk_cvr, es_cif, fi_tunnus, fr_siren, fr_siret, it_rea, nl_kvk, no_org_number, no_pno, se_org_number, se_pno, uk_crn
vat	JSON	Optional
vat (anyOf 1)	string	Alternative	VAT ID number. Maximum length: 5000
vat (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details registered address

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account billie value company details, reference company details registered address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City, district, suburb, town, or village. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code. Maximum length: 5000
country (anyOf 2)	null	Alternative
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Address line 1 (for example, street, PO Box, or company name). Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Address line 2 (for example, apartment, suite, unit, or building). Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State, county, province, or region. Maximum length: 5000
state (anyOf 2)	null	Alternative

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure

Field	Type	Presence	Description and constraints
$	object	Root
installments	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure installments
request_three_d_secure	JSON	Optional
request_three_d_secure (anyOf 1)	string	Alternative	We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. Known values: any, automatic, challenge
request_three_d_secure (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure installments

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account card value installments, request three d secure installments

Field	Type	Presence	Description and constraints
$	object	Root
enabled	JSON	Optional
enabled (anyOf 1)	boolean	Alternative	Whether Installments are enabled for this Invoice.
enabled (anyOf 2)	null	Alternative

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type

Field	Type	Presence	Description and constraints
$	object	Root
bank_transfer	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type bank transfer
funding_type	JSON	Optional
funding_type (anyOf 1)	string	Alternative	The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. Known values: bank_transfer
funding_type (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type bank transfer

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account customer balance value bank transfer, funding type bank transfer

Field	Type	Presence	Description and constraints
$	object	Root
eu_bank_transfer	Model	Optional	Expand Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay customer balance bank transfer eu bank transfer
type	JSON	Optional
type (anyOf 1)	string	Alternative	The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
type (anyOf 2)	null	Alternative

Referenced models: Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay customer balance bank transfer eu bank transfer

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options

Field	Type	Presence	Description and constraints
$	object	Root
mandate_options	Model	Optional	Expand Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options mandate options

Referenced models: Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options mandate options

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account payto value mandate options mandate options

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	JSON	Alternative
amount (anyOf 1) (anyOf 1)	integer	Alternative	The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)	null	Alternative
amount_type	JSON	Optional
amount_type (anyOf 1)	string	Alternative	Only `maximum` is supported. Known values: fixed, maximum
amount_type (anyOf 2)	null	Alternative
purpose	JSON	Optional
purpose (anyOf 1)	string	Alternative	The purpose for which payments are made. Has a default value based on your merchant category code. Known values: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility
purpose (anyOf 2)	null	Alternative

Pay an invoice — response body — payment settings payment method options value acss debit, bancontact, billie, blik, card, customer balance, konbini, payto, pix, sepa debit, upi, us bank account pix value amount includes iof, expires after seconds

Field	Type	Presence	Description and constraints
$	object	Root
amount_includes_iof	JSON	Optional
amount_includes_iof (anyOf 1)	string	Alternative	Determines if the amount includes the IOF tax. Known values: always, never
amount_includes_iof (anyOf 2)	null	Alternative
expires_after_seconds	JSON	Optional
expires_after_seconds (anyOf 1)	integer	Alternative	The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
expires_after_seconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits

Field	Type	Presence	Description and constraints
$	object	Root
mandate_options	Model	Optional	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits mandate options
verification_method	string	Optional	Bank account verification method. The default value is `automatic`. Known values: automatic, instant, microdeposits

Referenced models: Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits mandate options

Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / value / verification_method: automatic, instant, microdeposits mandate options

Field	Type	Presence	Description and constraints
$	object	Root
transaction_type	JSON	Optional
transaction_type (anyOf 1)	string	Alternative	Transaction type of the mandate. Known values: business, personal
transaction_type (anyOf 2)	null	Alternative

Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / bancontact / value / preferred_language: de, en, fr, nl

Field	Type	Presence	Description and constraints
$	object	Root
preferred_language	string	Required within parent	Preferred language of the Bancontact authorization page that the customer is redirected to. Known values: de, en, fr, nl

Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits

Field	Type	Presence	Description and constraints
$	object	Root
financial_connections	Model	Optional	Expand Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits financial connections
verification_method	string	Optional	Bank account verification method. The default value is `automatic`. Known values: automatic, instant, microdeposits

Referenced models: Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits financial connections

Pay an invoice — response body — payment_settings / payment_method_options / value / acss_debit, bancontact, billie, blik, card, customer_balance, konbini, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / value / verification_method: automatic, instant, microdeposits financial connections

Field	Type	Presence	Description and constraints
$	object	Root
filters	Model	Optional	Expand Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay us bank account financial connections filters
permissions	array	Optional	The list of permissions to request. The `payment_method` permission must be included.
permissions[]	string	Each item	Known values: balances, ownership, payment_method, transactions
prefetch	JSON	Optional
prefetch (anyOf 1)	array	Alternative	Data features requested to be retrieved upon account creation.
prefetch (anyOf 1)[]	string	Each item	Known values: balances, ownership, transactions
prefetch (anyOf 2)	null	Alternative

Referenced models: Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay us bank account financial connections filters

Pay an invoice — response body — rendering value amount tax display, pdf, template, template version

Field	Type	Presence	Description and constraints
$	object	Root
amount_tax_display	JSON	Optional
amount_tax_display (anyOf 1)	string	Alternative	How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. Maximum length: 5000
amount_tax_display (anyOf 2)	null	Alternative
pdf	JSON	Optional
pdf (anyOf 1)	JSON	Alternative	Invoice pdf rendering options
pdf (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — rendering value amount tax display, pdf, template, template version pdf Invoice pdf rendering options page size
pdf (anyOf 2)	null	Alternative
template	JSON	Optional
template (anyOf 1)	string	Alternative	ID of the rendering template that the invoice is formatted by. Maximum length: 5000
template (anyOf 2)	null	Alternative
template_version	JSON	Optional
template_version (anyOf 1)	JSON	Alternative
template_version (anyOf 1) (anyOf 1)	integer	Alternative	Version of the rendering template that the invoice is using.
template_version (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
template_version (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — rendering value amount tax display, pdf, template, template version pdf Invoice pdf rendering options page size

Pay an invoice — response body — rendering value amount tax display, pdf, template, template version pdf Invoice pdf rendering options page size

Field	Type	Presence	Description and constraints
$	object	Root
page_size	JSON	Optional
page_size (anyOf 1)	string	Alternative	Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. Known values: a4, auto, letter
page_size (anyOf 2)	null	Alternative

Pay an invoice — response body — shipping cost value amount subtotal, amount tax, amount total, shipping rate, taxes

Field	Type	Presence	Description and constraints
$	object	Root
amount_subtotal	JSON	Required within parent
amount_subtotal (anyOf 1)	integer	Alternative	Total shipping cost before any 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 due to shipping costs. 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 shipping cost after taxes are applied.
amount_total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shipping_rate	JSON	Optional
shipping_rate (anyOf 1)	JSON	Alternative	The ID of the ShippingRate for this invoice.
shipping_rate (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
shipping_rate (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a shipping rate — response body
shipping_rate (anyOf 2)	null	Alternative
taxes	array	Optional	The taxes applied to the shipping 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 taxes item, Create a shipping rate — response body

Pay an invoice — response body — status details

Field	Type	Presence	Description and constraints
$	object	Root
uncollectible	Model	Optional	Expand Pay an invoice — response body — status details uncollectible

Referenced models: Pay an invoice — response body — status details uncollectible

Pay an invoice — response body — status details uncollectible

Field	Type	Presence	Description and constraints
$	object	Root
reason	JSON	Optional
reason (anyOf 1)	string	Alternative	The reason why the invoice is uncollectible. Known values: max_payment_attempts, payment_not_received, subscription_canceled, subscription_paused, user_forgiven
reason (anyOf 2)	null	Alternative

Pay an invoice — response body — status transitions

Field	Type	Presence	Description and constraints
$	object	Root
finalized_at	JSON	Optional
finalized_at (anyOf 1)	JSON	Alternative
finalized_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the invoice draft was finalized. 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
marked_uncollectible_at	JSON	Optional
marked_uncollectible_at (anyOf 1)	JSON	Alternative
marked_uncollectible_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the invoice was marked uncollectible. Format: unix-time
marked_uncollectible_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
marked_uncollectible_at (anyOf 2)	null	Alternative
paid_at	JSON	Optional
paid_at (anyOf 1)	JSON	Alternative
paid_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the invoice was paid. Format: unix-time
paid_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paid_at (anyOf 2)	null	Alternative
voided_at	JSON	Optional
voided_at (anyOf 1)	JSON	Alternative
voided_at (anyOf 1) (anyOf 1)	integer	Alternative	The time that the invoice was voided. Format: unix-time
voided_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
voided_at (anyOf 2)	null	Alternative

Pay an invoice — response body — threshold reason

Field	Type	Presence	Description and constraints
$	object	Root
amount_gte	JSON	Optional
amount_gte (anyOf 1)	JSON	Alternative
amount_gte (anyOf 1) (anyOf 1)	integer	Alternative	The total invoice amount threshold boundary if it triggered the threshold invoice.
amount_gte (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_gte (anyOf 2)	null	Alternative
item_reasons	array	Required within parent	Indicates which line items triggered a threshold invoice.
item_reasons[]	Model	Each item	Expand Pay an invoice — response body — threshold reason item reasons item

Referenced models: Pay an invoice — response body — threshold reason item reasons item

Pay an invoice — response body — threshold reason item reasons item

Field	Type	Presence	Description and constraints
$	object	Root
line_item_ids	array	Required within parent	The IDs of the line items that triggered the threshold invoice.
line_item_ids[]	string	Each item	Maximum length: 5000
usage_gte	JSON	Required within parent
usage_gte (anyOf 1)	integer	Alternative	The quantity threshold boundary that applied to the given line item.
usage_gte (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update an invoice's line item — request body — body price data product data

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Maximum length: 40000
images	array	Optional
images[]	string	Each item
metadata	object	Optional	Additional keys: see wildcard field
metadata.*	string	Additional keys
name	string	Required within parent	Maximum length: 5000
tax_code	string	Optional	Maximum length: 5000
tax_details	object	Optional
tax_details.performance_location	string	Optional	Maximum length: 5000
tax_details.tax_code	JSON	Optional
tax_details.tax_code (anyOf 1)	string	Alternative
tax_details.tax_code (anyOf 2)	string	Alternative	One of:
unit_label	string	Optional	Maximum length: 12

Update an invoice's line item — request body — body tax amounts array item

Field	Type	Presence	Description and constraints
$	object	Root
amount	integer	Required within parent
tax_rate_data	Model	Required within parent	Expand Update an invoice's line item — request body — body tax amounts array item tax rate data
taxability_reason	string	Optional	One of: 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
taxable_amount	integer	Required within parent

Referenced models: Update an invoice's line item — request body — body tax amounts array item tax rate data

Update an invoice's line item — request body — body tax amounts array item tax rate data

Field	Type	Presence	Description and constraints
$	object	Root
country	string	Optional	Maximum length: 5000
description	string	Optional	Maximum length: 5000
display_name	string	Required within parent	Maximum length: 200
inclusive	boolean	Required within parent
jurisdiction	string	Optional	Maximum length: 200
jurisdiction_level	string	Optional	One of: city, country, county, district, multiple, state
percentage	number	Required within parent
state	string	Optional	Maximum length: 5000
tax_type	string	Optional	One of: amusement_tax, communications_tax, digital_excise_tax, gst, hst, igst, jct, lease_tax, mass_transit_parking_tax, parking_tax, pst, qst, retail_delivery_fee, rst, sales_tax, service_tax, utility_users_tax, vat

Update an invoice's line item — response body

Field	Type	Presence	Description and constraints
$	object	Root	Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice. Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount, in cents (or local equivalent).
amount (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. Maximum length: 5000
description (anyOf 2)	null	Alternative
discount_amounts	JSON	Optional
discount_amounts (anyOf 1)	array	Alternative	The amount of discount calculated per discount for this line item.
discount_amounts (anyOf 1)[]	Model	Each item	Expand Void a credit note — response body — discount amounts item
discount_amounts (anyOf 2)	null	Alternative
discountable	boolean	Required within parent	If true, discounts will apply to this line item. Always false for prorations.
discounts	array	Required within parent	The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
discounts[]	JSON	Each item
discounts[] (anyOf 1)	string	Alternative	Maximum length: 5000
discounts[] (anyOf 2)	Model	Alternative	Expand Get Customers Customer Discount — response body
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
invoice	JSON	Optional
invoice (anyOf 1)	string	Alternative	The ID of the invoice that contains this line item. Maximum length: 5000
invoice (anyOf 2)	null	Alternative
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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: line_item
parent	JSON	Optional
parent (anyOf 1)	JSON	Alternative	The parent that generated this line item.
parent (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details
parent (anyOf 2)	null	Alternative
period	Model	Required within parent	Expand Create an invoice item — response body — period
pretax_credit_amounts	JSON	Optional
pretax_credit_amounts (anyOf 1)	array	Alternative	Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
pretax_credit_amounts (anyOf 1)[]	Model	Each item	Expand Update an invoice's line item — response body — pretax credit amounts array item
pretax_credit_amounts (anyOf 2)	null	Alternative
pricing	JSON	Optional
pricing (anyOf 1)	JSON	Alternative	The pricing information of the line item.
pricing (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details
pricing (anyOf 2)	null	Alternative
quantity	JSON	Optional
quantity (anyOf 1)	JSON	Alternative
quantity (anyOf 1) (anyOf 1)	integer	Alternative	Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the line item is a proration or subscription, the quantity of the subscription that the proration was computed for.
quantity (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)	null	Alternative
quantity_decimal	JSON	Optional
quantity_decimal (anyOf 1)	string	Alternative	Non-negative decimal with at most 12 decimal places. The quantity of units for the line item. Format: decimal
quantity_decimal (anyOf 2)	null	Alternative
subscription	JSON	Optional
subscription (anyOf 1)	JSON	Alternative
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
subtotal	JSON	Required within parent
subtotal (anyOf 1)	integer	Alternative	The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxes	JSON	Optional
taxes (anyOf 1)	array	Alternative	The tax information of the line item.
taxes (anyOf 1)[]	Model	Each item	Expand Update an invoice's line item — response body — taxes The tax information of the line item item
taxes (anyOf 2)	null	Alternative

Referenced models: Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details, Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details, Update an invoice's line item — response body — taxes The tax information of the line item item, Get Customers Customer Discount — response body, Void a credit note — response body — discount amounts item, Create an invoice item — response body — period, Update an invoice's line item — response body — pretax credit amounts array item, Pause a subscription — response body

Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details

Field	Type	Presence	Description and constraints
$	object	Root
invoice_item_details	JSON	Optional
invoice_item_details (anyOf 1)	JSON	Alternative	Details about the invoice item that generated this line item
invoice_item_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription
invoice_item_details (anyOf 2)	null	Alternative
subscription_item_details	JSON	Optional
subscription_item_details (anyOf 1)	JSON	Alternative	Details about the subscription item that generated this line item
subscription_item_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details subscription item details value invoice item, proration, proration details, subscription, subscription item
subscription_item_details (anyOf 2)	null	Alternative
type	string	Required within parent	The type of parent that generated this line item Known values: invoice_item_details, subscription_item_details

Referenced models: Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription, Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details subscription item details value invoice item, proration, proration details, subscription, subscription item

Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription

Field	Type	Presence	Description and constraints
$	object	Root
invoice_item	string	Required within parent	The invoice item that generated this line item Maximum length: 5000
proration	boolean	Required within parent	Whether this is a proration
proration_details	JSON	Optional
proration_details (anyOf 1)	JSON	Alternative	Additional details for proration line items
proration_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items
proration_details (anyOf 2)	null	Alternative
subscription	JSON	Optional
subscription (anyOf 1)	string	Alternative	The subscription that the invoice item belongs to Maximum length: 5000
subscription (anyOf 2)	null	Alternative

Referenced models: Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items

Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items

Field	Type	Presence	Description and constraints
$	object	Root
credited_items	JSON	Optional
credited_items (anyOf 1)	JSON	Alternative	For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
credited_items (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items credited items value invoice, invoice line items
credited_items (anyOf 2)	null	Alternative

Referenced models: Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items credited items value invoice, invoice line items

Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items credited items value invoice, invoice line items

Field	Type	Presence	Description and constraints
$	object	Root
invoice	string	Required within parent	Invoice containing the credited invoice line items Maximum length: 5000
invoice_line_items	array	Required within parent	Credited invoice line items
invoice_line_items[]	string	Each item	Maximum length: 5000

Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details subscription item details value invoice item, proration, proration details, subscription, subscription item

Field	Type	Presence	Description and constraints
$	object	Root
invoice_item	JSON	Optional
invoice_item (anyOf 1)	string	Alternative	The invoice item that generated this line item Maximum length: 5000
invoice_item (anyOf 2)	null	Alternative
proration	boolean	Required within parent	Whether this is a proration
proration_details	JSON	Optional
proration_details (anyOf 1)	JSON	Alternative	Additional details for proration line items
proration_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items
proration_details (anyOf 2)	null	Alternative
subscription	JSON	Optional
subscription (anyOf 1)	string	Alternative	The subscription that the subscription item belongs to Maximum length: 5000
subscription (anyOf 2)	null	Alternative
subscription_item	string	Required within parent	The subscription item that generated this line item Maximum length: 5000

Referenced models: Update an invoice's line item — response body — parent / The parent that generated this line item / type: invoice item details, subscription item details invoice item details value invoice item, proration, proration details, subscription proration details Additional details for proration line items credited items

Update an invoice's line item — response body — pretax credit amounts array item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount, in cents (or local equivalent), of the pretax credit amount.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
credit_balance_transaction	JSON	Optional
credit_balance_transaction (anyOf 1)	JSON	Alternative	The credit balance transaction that was applied to get this pretax credit amount.
credit_balance_transaction (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
credit_balance_transaction (anyOf 1) (anyOf 2)	Model	Alternative	Expand Retrieve a credit balance transaction — response body
credit_balance_transaction (anyOf 2)	null	Alternative
discount	JSON	Optional	The discount that was applied to get this pretax credit amount.
discount (anyOf 1)	string	Alternative	Maximum length: 5000
discount (anyOf 2)	Model	Alternative	Expand Get Customers Customer Discount — response body
discount (anyOf 3)	Model	Alternative	Expand Delete a subscription discount — response body
type	string	Required within parent	Type of the pretax credit amount referenced. Known values: credit_balance_transaction, discount

Referenced models: Retrieve a credit balance transaction — response body, Delete a subscription discount — response body, Get Customers Customer Discount — response body

Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details

Field	Type	Presence	Description and constraints
$	object	Root
price_details	Model	Optional	Expand Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details price details
type	string	Required within parent	The type of the pricing details. Known values: price_details
unit_amount_decimal	JSON	Optional
unit_amount_decimal (anyOf 1)	string	Alternative	The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places. Format: decimal
unit_amount_decimal (anyOf 2)	null	Alternative

Referenced models: Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details price details

Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details price details

Field	Type	Presence	Description and constraints
$	object	Root
price	JSON	Required within parent	The ID of the price this item is associated with.
price (anyOf 1)	string	Alternative	Maximum length: 5000
price (anyOf 2)	Model	Alternative	Expand Create a price — response body
product	string	Required within parent	The ID of the product this item is associated with. Maximum length: 5000

Referenced models: Create a price — response body

Update an invoice's line item — response body — taxes The tax information of the line item item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of the tax, in cents (or local equivalent).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_behavior	string	Required within parent	Whether this tax is inclusive or exclusive. Known values: exclusive, inclusive
tax_rate_details	JSON	Optional
tax_rate_details (anyOf 1)	JSON	Alternative	Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
tax_rate_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate
tax_rate_details (anyOf 2)	null	Alternative
taxability_reason	string	Required within parent	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_available, 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
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
type	string	Required within parent	The type of tax information. Known values: tax_rate_details

Referenced models: Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate

Update an invoice's line item — response body — taxes The tax information of the line item item tax rate details value tax rate

Field	Type	Presence	Description and constraints
$	object	Root
tax_rate	JSON	Required within parent	ID of the tax rate
tax_rate (anyOf 1)	string	Alternative	Maximum length: 5000
tax_rate (anyOf 2)	Model	Alternative	Expand Create a tax rate — response body

Referenced models: Create a tax rate — response body