StripeAPI.Types.Invoice

account_country: The country of the business associated with this invoice, most often the business creating the invoice.

Constraints:

• Maximum length of 5000

account_name: The public name of the business associated with this invoice, most often the business creating the invoice.

Constraints:

• Maximum length of 5000

account_tax_ids: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

amount_due: 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_paid: The amount, in %s, that was paid.

amount_remaining: The difference between amount_due and amount_paid, in %s.

application: ID of the Connect Application that created the invoice.

application_fee_amount: The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.

attempt_count: 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.

attempted: 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: Controls whether Stripe will perform automatic collection of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.

automatic_tax:

billing_reason: Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.

charge: ID of the latest charge generated for this invoice, if any.

collection_method: 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.

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

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

custom_fields: Custom fields displayed on the invoice.

customer: The ID of the customer who will be billed.

customer_address: 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_email: 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.

Constraints:

• Maximum length of 5000

customer_name: 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.

Constraints:

• Maximum length of 5000

customer_phone: 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.

Constraints:

• Maximum length of 5000

customer_shipping: 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_tax_exempt: 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.

customer_tax_ids: 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.

default_payment_method: 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_source: 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_tax_rates: The tax rates applied to this invoice, if any.

description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

Constraints:

• Maximum length of 5000

discount: Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.

discounts: The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.

due_date: The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.

ending_balance: 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.

footer: Footer displayed on the invoice.

Constraints:

• Maximum length of 5000

hosted_invoice_url: 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.

Constraints:

• Maximum length of 5000

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

invoice_pdf: The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

Constraints:

• Maximum length of 5000

last_finalization_error: The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.

lines: The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

next_payment_attempt: The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.

number: 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.

Constraints:

• Maximum length of 5000

on_behalf_of: 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 documentation for details.

paid: Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.

paid_out_of_band: Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.

payment_intent: The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.

payment_settings:

period_end: End of the usage period during which invoice items were added to this invoice.

period_start: Start of the usage period during which invoice items were added to this invoice.

post_payment_credit_notes_amount: Total amount of all post-payment credit notes issued for this invoice.

pre_payment_credit_notes_amount: Total amount of all pre-payment credit notes issued for this invoice.

quote: The quote this invoice was generated from.

receipt_number: This is the transaction number that appears on email receipts sent for this invoice.

Constraints:

• Maximum length of 5000

rendering_options: Options for invoice PDF rendering.

starting_balance: Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.

statement_descriptor: Extra information about an invoice for the customer's credit card statement.

Constraints:

• Maximum length of 5000

status: The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more

status_transitions:

subscription: The subscription that this invoice was prepared for, if any.

subscription_proration_date: Only set for upcoming invoices that preview prorations. The time used to calculate prorations.

subtotal: 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_excluding_tax: The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated

tax: The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.

test_clock: ID of the test clock this invoice belongs to.

threshold_reason:

total: Total after discounts and taxes.

total_discount_amounts: The aggregate amounts calculated per discount across all line items.

total_excluding_tax: The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.

total_tax_amounts: The aggregate amounts calculated per tax rate for all line items.

transfer_data: The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.

webhooks_delivered_at: Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. 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.

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

address:

carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

Constraints:

• Maximum length of 5000

name: Recipient name.

Constraints:

• Maximum length of 5000

phone: Recipient phone (including extension).

Constraints:

• Maximum length of 5000

tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

Constraints:

• Maximum length of 5000

checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

Constraints:

• Maximum length of 5000

coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

customer: The ID of the customer associated with this discount.

end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

Constraints:

• Maximum length of 5000

invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

Constraints:

• Maximum length of 5000

invoice_item: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

Constraints:

• Maximum length of 5000

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

promotion_code: The promotion code applied to create this discount.

start: Date that the coupon was applied.

subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

Constraints:

• Maximum length of 5000

charge: For card errors, the ID of the failed charge.

Constraints:

• Maximum length of 5000

code: For some errors that could be handled programmatically, a short string indicating the error code reported.

Constraints:

• Maximum length of 5000

decline_code: For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

Constraints:

• Maximum length of 5000

doc_url: A URL to more information about the error code reported.

Constraints:

• Maximum length of 5000

message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

Constraints:

• Maximum length of 40000

param: If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

Constraints:

• Maximum length of 5000

payment_intent: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API.

payment_method: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

payment_method_type: If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

Constraints:

• Maximum length of 5000

setup_intent: A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.

Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.

By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.

Related guide: Setup Intents API.

source: The source object for errors returned on a request involving a source.

type: The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`

account: The ID of the account that the bank account is associated with.

account_holder_name: The name of the person or business that owns the bank account.

Constraints:

• Maximum length of 5000

account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

Constraints:

• Maximum length of 5000

account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.

Constraints:

• Maximum length of 5000

ach_credit_transfer

ach_debit

acss_debit

address_city: City/District/Suburb/Town/Village.

Constraints:

• Maximum length of 5000

address_country: Billing address country, if provided when creating card.

Constraints:

• Maximum length of 5000

address_line1: Address line 1 (Street address/PO Box/Company name).

Constraints:

• Maximum length of 5000

address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

Constraints:

• Maximum length of 5000

address_line2: Address line 2 (Apartment/Suite/Unit/Building).

Constraints:

• Maximum length of 5000

address_state: State/County/Province/Region.

Constraints:

• Maximum length of 5000

address_zip: ZIP or postal code.

Constraints:

• Maximum length of 5000

address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

Constraints:

• Maximum length of 5000

alipay

amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

au_becs_debit

available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

bancontact

bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

Constraints:

• Maximum length of 5000

brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

Constraints:

• Maximum length of 5000

card

card_present

client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

Constraints:

• Maximum length of 5000

code_verification:

country: Two-letter ISO code representing the country the bank account is located in.

Constraints:

• Maximum length of 5000

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

currency: Three-letter ISO code for the currency paid out to the bank account.

customer: The ID of the customer that the bank account is associated with.

cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

Constraints:

• Maximum length of 5000

default_for_currency: Whether this bank account is the default external account for its currency.

dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

Constraints:

• Maximum length of 5000

eps

exp_month: Two-digit number representing the card's expiration month.

exp_year: Four-digit number representing the card's expiration year.

fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

Constraints:

• Maximum length of 5000

flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

Constraints:

• Maximum length of 5000

funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

Constraints:

• Maximum length of 5000

giropay

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

ideal

klarna

last4: The last four digits of the bank account number.

Constraints:

• Maximum length of 5000

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

multibanco

name: Cardholder name.

Constraints:

• Maximum length of 5000

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

owner: Information about the owner of the payment instrument that may be used or required by particular source types.

p24

receiver:

recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

redirect:

routing_number: The routing transit number for the bank account.

Constraints:

• Maximum length of 5000

sepa_debit

sofort

source_order:

statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

Constraints:

• Maximum length of 5000

status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

Constraints:

• Maximum length of 5000

three_d_secure

tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

Constraints:

• Maximum length of 5000

type: The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

Constraints:

• Maximum length of 5000

wechat

address: Owner's address.

email: Owner's email address.

Constraints:

• Maximum length of 5000

name: Owner's full name.

Constraints:

• Maximum length of 5000

phone: Owner's phone number (including extension).

Constraints:

• Maximum length of 5000

verified_address: Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

verified_email: Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_name: Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_phone: Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

amount_tax_display: How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.

Constraints:

• Maximum length of 5000

amount: The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.

destination: The account where funds from the payment will be transferred to upon payment success.