PostInvoicesInvoiceSend
<p>Stripe will automatically send invoices to customers according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.</p> <p>Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> event.</p>
/v1/invoices/{invoice}/send- Source
openapi/spec3.json- Commit
d70de345383d- Active snapshot
da69df7e6e11
Request
Authorization
Read-onlyCredentials are never accepted or stored on this documentation page.
Send credentials in the Authorization request header using the Basic scheme.
Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>
- Request header
- Authorization
- Scheme
- basic
Send the token in the Authorization request header using the Bearer scheme.
Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>
- Request header
- Authorization
- Scheme
- bearer
- Bearer format
- auth-scheme
Path Parameters
- invoice stringrequired
Body Params
optionalSpecifies which fields in the response should be expanded.
Responses
Successful response.
The country of the business associated with this invoice, most often the business creating the invoice.
The public name of the business associated with this invoice, most often the business creating the invoice.
The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
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`.
The amount, in %s, that was paid.
The amount remaining, in %s, that is due.
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.
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.
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.
Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.
automatic_tax AutomaticTax objectrequired
Whether Stripe automatically computes tax on this invoice.
The status of the most recent automated tax calculation for this invoice.
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.
ID of the latest charge generated for this invoice, if any.
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.
Time at which the object was created. Measured in seconds since the Unix epoch.
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).
custom_fields array[InvoiceSettingCustomField object]optionalnullable Custom fields displayed on the invoice.
Custom fields displayed on the invoice.
items InvoiceSettingCustomField object
The name of the custom field.
The value of the custom field.
The ID of the customer who will be billed.
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.
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.
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.
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.
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.
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 array[InvoicesResourceInvoiceTaxID object]optionalnullable 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.
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.
items InvoicesResourceInvoiceTaxID object
The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `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`, or `unknown`
The value of the tax ID.
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.
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 array[TaxRate object]requiredThe tax rates applied to this invoice, if any.
The tax rates applied to this invoice, if any.
items TaxRate objectTax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Time at which the object was created. Measured in seconds since the Unix epoch.
An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
Unique identifier for the object.
This specifies if the tax rate is inclusive or exclusive.
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
This represents the tax rate percent out of 100.
[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
The high-level tax type, such as `vat` or `sales_tax`.
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
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 displayed on the invoice.
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.
Unique identifier for the object.
The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
lines InvoiceLinesList objectrequiredThe 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.
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.
data array[InvoiceLineItem object]requiredDetails about each object.
Details about each object.
items InvoiceLineItem object
The amount, in %s.
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).
An arbitrary string attached to the object. Often useful for displaying to users.
The amount of discount calculated per discount for this line item.
If true, discounts will apply to this line item. Always false for prorations.
The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
Unique identifier for the object.
The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/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` this will reflect the metadata of the subscription that caused the line item to be created.
String representing the object's type. Objects of the same type share the same value.
The price of the line item.
Whether this is a proration.
The quantity of the subscription, if the line item is a subscription or a proration.
The subscription that the invoice item pertains to, if any.
The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
The amount of tax calculated per tax rate for this line item
The tax rates which apply to the line item.
A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
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.
String representing the object's type. Objects of the same type share the same value.
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://stripe.com/docs/billing/invoices/connect) documentation for details.
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.
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 InvoicesPaymentSettings objectrequired
Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
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).
End of the usage period during which invoice items were added to this invoice.
Start of the usage period during which invoice items were added to this invoice.
Total amount of all post-payment credit notes issued for this invoice.
Total amount of all pre-payment credit notes issued for this invoice.
The quote this invoice was generated from.
This is the transaction number that appears on email receipts sent for this invoice.
Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.
Extra information about an invoice for the customer's credit card statement.
The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
status_transitions InvoicesStatusTransitions objectrequired
The time that the invoice draft was finalized.
The time that the invoice was marked uncollectible.
The time that the invoice was paid.
The time that the invoice was voided.
The subscription that this invoice was prepared for, if any.
Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
threshold_reason InvoiceThresholdReason objectoptional
The total invoice amount threshold boundary if it triggered the threshold invoice.
item_reasons array[InvoiceItemThresholdReason object]requiredIndicates which line items triggered a threshold invoice.
Indicates which line items triggered a threshold invoice.
items InvoiceItemThresholdReason object
The IDs of the line items that triggered the threshold invoice.
The quantity threshold boundary that applied to the given line item.
Total after discounts and taxes.
total_discount_amounts array[DiscountsResourceDiscountAmount object]optionalnullable The aggregate amounts calculated per discount across all line items.
The aggregate amounts calculated per discount across all line items.
items DiscountsResourceDiscountAmount object
The amount, in %s, of the discount.
The discount that was applied to get this discount amount.
total_tax_amounts array[InvoiceTaxAmount object]requiredThe aggregate amounts calculated per tax rate for all line items.
The aggregate amounts calculated per tax rate for all line items.
items InvoiceTaxAmount object
The amount, in %s, of the tax.
Whether this tax amount is inclusive or exclusive.
The tax rate that was applied to get this tax amount.
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.
Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/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.
Error response.
error APIErrors objectrequired
For card errors, the ID of the failed charge.
For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
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.
payment_intent PaymentIntent objectoptionalA 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](https://stripe.com/docs/payments/intents#intent-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](https://stripe.com/docs/payments/payment-intents).
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](https://stripe.com/docs/payments/intents#intent-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](https://stripe.com/docs/payments/payment-intents).
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Amount that can be captured from this PaymentIntent.
Amount that was collected by this PaymentIntent.
ID of the Connect application that created the PaymentIntent.
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
Controls when the funds will be captured from the customer's account.
charges PaymentFlowsPaymentIntentResourceChargeList objectoptionalCharges that were created by this PaymentIntent, if any.
Charges that were created by this PaymentIntent, if any.
This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent).
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled.
Time at which the object was created. Measured in seconds since the Unix epoch.
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).
ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
ID of the invoice that created this PaymentIntent, if it exists.
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
ID of the payment method used in this PaymentIntent.
Payment-method-specific configuration for this PaymentIntent.
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
If present, this property tells you about the processing state of the payment.
Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
ID of the review associated with this PaymentIntent, if any.
Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
Shipping information for this PaymentIntent.
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
payment_method PaymentMethod objectoptionalPaymentMethod objects represent your customer's payment instruments.
They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
Customer objects to store instrument details for future payments.
Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
PaymentMethod objects represent your customer's payment instruments. They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
acss_debit payment_method_acss_debit objectoptional
Name of the bank associated with the bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Institution number of the bank account.
Last four digits of the bank account number.
Transit number of the bank account.
au_becs_debit payment_method_au_becs_debit objectoptional
Six-digit number identifying bank and branch associated with this bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
bacs_debit payment_method_bacs_debit objectoptional
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
Sort code of the bank account. (e.g., `10-20-30`)
billing_details billing_details objectrequired
Billing address.
Email address.
Full name.
Billing phone number (including extension).
boleto payment_method_boleto objectoptional
Uniquely identifies the customer tax id (CNPJ or CPF)
card payment_method_card objectoptional
Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
Checks on Card address and CVC if provided.
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
Two-digit number representing the card's expiration month.
Four-digit number representing the card's expiration year.
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
Details of the original PaymentMethod that created this object.
The last four digits of the card.
Contains information about card networks that can be used to process the payment.
Contains details on how this Card maybe be used for 3D Secure authentication.
If this Card is part of a card wallet, this contains the details of the card wallet.
Time at which the object was created. Measured in seconds since the Unix epoch.
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
eps payment_method_eps objectoptional
The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
fpx payment_method_fpx objectoptional
The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`.
Unique identifier for the object.
ideal payment_method_ideal objectoptional
The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.
The Bank Identifier Code of the customer's bank, if the bank was provided.
klarna payment_method_klarna objectoptional
The customer's date of birth, if provided.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
p24 payment_method_p24 objectoptional
The customer's bank, if provided.
sepa_debit payment_method_sepa_debit objectoptional
Bank code of bank associated with the bank account.
Branch code of bank associated with the bank account.
Two-letter ISO code representing the country the bank account is located in.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Information about the object that generated this PaymentMethod.
Last four characters of the IBAN.
sofort payment_method_sofort objectoptional
Two-letter ISO code representing the country the bank account is located in.
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod 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.
setup_intent SetupIntent objectoptionalA 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](https://stripe.com/docs/api#payment_intents) 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](https://stripe.com/docs/payments/intents#intent-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](/guides/strong-customer-authentication) may need to be run through
[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,
it will automatically attach the resulting payment method to that Customer.
We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-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](https://stripe.com/docs/payments/setup-intents).
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](https://stripe.com/docs/api#payment_intents) 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](https://stripe.com/docs/payments/intents#intent-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](/guides/strong-customer-authentication) may need to be run through [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-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](https://stripe.com/docs/payments/setup-intents).
ID of the Connect application that created the SetupIntent.
Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Time at which the object was created. Measured in seconds since the Unix epoch.
ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
The error encountered in the previous SetupIntent confirmation.
The most recent SetupAttempt for this SetupIntent.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
ID of the multi use Mandate generated by the SetupIntent.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the setup is intended.
ID of the payment method used with this SetupIntent.
Payment-method-specific configuration for this SetupIntent.
The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
ID of the single_use Mandate generated by the SetupIntent.
[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
The source object for errors returned on a request involving a source.
The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`