Expand description
Autogenerated types shared between async-stripe-* crates. If you find yourself needing to depend on this crate, please open an issue, as all useful types should be reexported.
Re-exports§
pub use api_version::ApiVersion;
Modules§
Structs§
- Account
- This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
- Account
Annual Revenue - Account
Annual Revenue Builder - Account
Bacs Debit Payments Settings - Account
Bacs Debit Payments Settings Builder - Account
Branding Settings - Account
Branding Settings Builder - Account
Builder - Account
Business Profile - Account
Business Profile Builder - Account
Capabilities - Account
Capabilities Builder - Account
Capability Future Requirements - Account
Capability Future Requirements Builder - Account
Capability Requirements - Account
Capability Requirements Builder - Account
Card Issuing Settings - Account
Card Issuing Settings Builder - Account
Card Payments Settings - Account
Card Payments Settings Builder - Account
Dashboard Settings - Account
Dashboard Settings Builder - Account
Decline Charge On - Account
Decline Charge OnBuilder - Account
Future Requirements - Account
Future Requirements Builder - Account
Group Membership - Account
Group Membership Builder - Account
Id - Account
Invoices Settings - Account
Invoices Settings Builder - Account
Monthly Estimated Revenue - Account
Monthly Estimated Revenue Builder - Account
Payments Settings - Account
Payments Settings Builder - Account
Payout Settings - Account
Payout Settings Builder - Account
Requirements - Account
Requirements Alternative - Account
Requirements Alternative Builder - Account
Requirements Builder - Account
Requirements Error - Account
Requirements Error Builder - Account
Sepa Debit Payments Settings - Account
Sepa Debit Payments Settings Builder - Account
Settings - Account
Settings Builder - Account
Terms OfService - Account
Terms OfService Builder - Account
TosAcceptance - Account
TosAcceptance Builder - Account
Treasury Settings - Account
Treasury Settings Builder - Account
Unification Account Controller - Account
Unification Account Controller Builder - Account
Unification Account Controller Fees - Account
Unification Account Controller Fees Builder - Account
Unification Account Controller Losses - Account
Unification Account Controller Losses Builder - Account
Unification Account Controller Stripe Dashboard - Account
Unification Account Controller Stripe Dashboard Builder - Address
- Address
Builder - Amazon
PayUnderlying Payment Method Funding Details - Amazon
PayUnderlying Payment Method Funding Details Builder - ApiErrors
- ApiErrors
Builder - Application
- Application
Builder - Application
Fee - For more details see <https://stripe.com/docs/api/application_fees/object>.
- Application
FeeBuilder - Application
FeeId - Application
FeeRefund Application Fee Refund
objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.- Application
FeeRefund Builder - Application
FeeRefund Id - Application
Id - Automatic
Tax - Automatic
TaxBuilder - Balance
Transaction - Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
- Balance
Transaction Builder - Balance
Transaction Id - Balance
Transaction Source Builder - Bank
Account - These bank accounts are payment methods on
Customer
objects. - Bank
Account Builder - Bank
Account Id - Billing
Bill Resource Invoicing Lines Common Credited Items - Billing
Bill Resource Invoicing Lines Common Credited Items Builder - Billing
Bill Resource Invoicing Lines Common Proration Details - Billing
Bill Resource Invoicing Lines Common Proration Details Builder - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Invoice Item Parent - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Invoice Item Parent Builder - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Parent - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Parent Builder - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Subscription Item Parent - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Subscription Item Parent Builder - Billing
Bill Resource Invoicing Parents Invoice Parent - Billing
Bill Resource Invoicing Parents Invoice Parent Builder - Billing
Bill Resource Invoicing Parents Invoice Quote Parent - Billing
Bill Resource Invoicing Parents Invoice Quote Parent Builder - Billing
Bill Resource Invoicing Parents Invoice Subscription Parent - Billing
Bill Resource Invoicing Parents Invoice Subscription Parent Builder - Billing
Bill Resource Invoicing Pricing Pricing - Billing
Bill Resource Invoicing Pricing Pricing Builder - Billing
Bill Resource Invoicing Pricing Pricing Price Details - Billing
Bill Resource Invoicing Pricing Pricing Price Details Builder - Billing
Bill Resource Invoicing Taxes Tax - Billing
Bill Resource Invoicing Taxes TaxBuilder - Billing
Bill Resource Invoicing Taxes TaxRate Details - Billing
Bill Resource Invoicing Taxes TaxRate Details Builder - Billing
Clocks Resource Status Details Advancing Status Details - Billing
Clocks Resource Status Details Advancing Status Details Builder - Billing
Clocks Resource Status Details Status Details - Billing
Clocks Resource Status Details Status Details Builder - Billing
Credit Balance Transaction - A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
- Billing
Credit Balance Transaction Builder - Billing
Credit Balance Transaction Id - Billing
Credit Grant - A credit grant is an API resource that documents the allocation of some billing credits to a customer.
- Billing
Credit Grant Builder - Billing
Credit Grant Id - Billing
Credit Grants Resource Amount - Billing
Credit Grants Resource Amount Builder - Billing
Credit Grants Resource Applicability Config - Billing
Credit Grants Resource Applicability Config Builder - Billing
Credit Grants Resource Applicable Price - Billing
Credit Grants Resource Applicable Price Builder - Billing
Credit Grants Resource Applicable Price Id - Billing
Credit Grants Resource Balance Credit - Billing
Credit Grants Resource Balance Credit Builder - Billing
Credit Grants Resource Balance Credits Application Invoice Voided - Billing
Credit Grants Resource Balance Credits Application Invoice Voided Builder - Billing
Credit Grants Resource Balance Credits Applied - Billing
Credit Grants Resource Balance Credits Applied Builder - Billing
Credit Grants Resource Balance Debit - Billing
Credit Grants Resource Balance Debit Builder - Billing
Credit Grants Resource Monetary Amount - Billing
Credit Grants Resource Monetary Amount Builder - Billing
Credit Grants Resource Scope - Billing
Credit Grants Resource Scope Builder - Billing
Details - Billing
Details Builder - Cancellation
Details - Cancellation
Details Builder - Capability
- This is an object representing a capability for a Stripe account.
- Capability
Builder - Capability
Id - Card
- You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
- Card
Builder - Card
Generated From Payment Method Details - Card
Generated From Payment Method Details Builder - CardId
- Card
Issuing Account Terms OfService - Card
Issuing Account Terms OfService Builder - Card
Mandate Payment Method Details - Card
Mandate Payment Method Details Builder - Cash
Balance - A customer’s
Cash balance
represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - Cash
Balance Builder - Charge
- The
Charge
object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. - Charge
Builder - Charge
Fraud Details - Charge
Fraud Details Builder - Charge
Id - Charge
Outcome - Charge
Outcome Builder - Charge
Transfer Data - Charge
Transfer Data Builder - Checkout
Acss Debit Mandate Options - Checkout
Acss Debit Mandate Options Builder - Checkout
Acss Debit Payment Method Options - Checkout
Acss Debit Payment Method Options Builder - Checkout
Affirm Payment Method Options - Checkout
Affirm Payment Method Options Builder - Checkout
Afterpay Clearpay Payment Method Options - Checkout
Afterpay Clearpay Payment Method Options Builder - Checkout
Alipay Payment Method Options - Checkout
Alipay Payment Method Options Builder - Checkout
Amazon PayPayment Method Options - Checkout
Amazon PayPayment Method Options Builder - Checkout
AuBecs Debit Payment Method Options - Checkout
AuBecs Debit Payment Method Options Builder - Checkout
Bacs Debit Payment Method Options - Checkout
Bacs Debit Payment Method Options Builder - Checkout
Bancontact Payment Method Options - Checkout
Bancontact Payment Method Options Builder - Checkout
Boleto Payment Method Options - Checkout
Boleto Payment Method Options Builder - Checkout
Card Installments Options - Checkout
Card Installments Options Builder - Checkout
Card Payment Method Options - Checkout
Card Payment Method Options Builder - Checkout
Cashapp Payment Method Options - Checkout
Cashapp Payment Method Options Builder - Checkout
Customer Balance Bank Transfer Payment Method Options - Checkout
Customer Balance Bank Transfer Payment Method Options Builder - Checkout
Customer Balance Payment Method Options - Checkout
Customer Balance Payment Method Options Builder - Checkout
EpsPayment Method Options - Checkout
EpsPayment Method Options Builder - Checkout
FpxPayment Method Options - Checkout
FpxPayment Method Options Builder - Checkout
Giropay Payment Method Options - Checkout
Giropay Payment Method Options Builder - Checkout
Grab PayPayment Method Options - Checkout
Grab PayPayment Method Options Builder - Checkout
Ideal Payment Method Options - Checkout
Ideal Payment Method Options Builder - Checkout
Kakao PayPayment Method Options - Checkout
Kakao PayPayment Method Options Builder - Checkout
Klarna Payment Method Options - Checkout
Klarna Payment Method Options Builder - Checkout
Konbini Payment Method Options - Checkout
Konbini Payment Method Options Builder - Checkout
KrCard Payment Method Options - Checkout
KrCard Payment Method Options Builder - Checkout
Link Payment Method Options - Checkout
Link Payment Method Options Builder - Checkout
Link Wallet Options - Checkout
Link Wallet Options Builder - Checkout
Mobilepay Payment Method Options - Checkout
Mobilepay Payment Method Options Builder - Checkout
Multibanco Payment Method Options - Checkout
Multibanco Payment Method Options Builder - Checkout
Naver PayPayment Method Options - Checkout
Naver PayPayment Method Options Builder - Checkout
Oxxo Payment Method Options - Checkout
Oxxo Payment Method Options Builder - Checkout
P24Payment Method Options - Checkout
P24Payment Method Options Builder - Checkout
Payco Payment Method Options - Checkout
Payco Payment Method Options Builder - Checkout
Payment Method Options Mandate Options Bacs Debit - Checkout
Payment Method Options Mandate Options Bacs Debit Builder - Checkout
Payment Method Options Mandate Options Sepa Debit - Checkout
Payment Method Options Mandate Options Sepa Debit Builder - Checkout
Paynow Payment Method Options - Checkout
Paynow Payment Method Options Builder - Checkout
Paypal Payment Method Options - Checkout
Paypal Payment Method Options Builder - Checkout
PixPayment Method Options - Checkout
PixPayment Method Options Builder - Checkout
Revolut PayPayment Method Options - Checkout
Revolut PayPayment Method Options Builder - Checkout
Samsung PayPayment Method Options - Checkout
Samsung PayPayment Method Options Builder - Checkout
Sepa Debit Payment Method Options - Checkout
Sepa Debit Payment Method Options Builder - Checkout
Session - A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.
- Checkout
Session Builder - Checkout
Session Id - Checkout
Session Item - A line item.
- Checkout
Session Item Builder - Checkout
Session Item Id - Checkout
Session Payment Method Options - Checkout
Session Payment Method Options Builder - Checkout
Session Wallet Options - Checkout
Session Wallet Options Builder - Checkout
Sofort Payment Method Options - Checkout
Sofort Payment Method Options Builder - Checkout
Swish Payment Method Options - Checkout
Swish Payment Method Options Builder - Checkout
UsBank Account Payment Method Options - Checkout
UsBank Account Payment Method Options Builder - Connect
Account Reference - Connect
Account Reference Builder - Connect
Collection Transfer - Connect
Collection Transfer Builder - Connect
Collection Transfer Id - 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.
- Coupon
Applies To - Coupon
Applies ToBuilder - Coupon
Builder - Coupon
Currency Option - Coupon
Currency Option Builder - Coupon
Id - Credit
Note - Issue a credit note to adjust an invoice’s amount after the invoice is finalized.
- Credit
Note Builder - Credit
Note Id - Credit
Note Line Item - The credit note line item object
- Credit
Note Line Item Builder - Credit
Note Line Item Id - Credit
Note Refund - Credit
Note Refund Builder - Credit
Notes Pretax Credit Amount - Credit
Notes Pretax Credit Amount Builder - Currency
Option - Currency
Option Builder - Custom
Unit Amount - Custom
Unit Amount Builder - Customer
- This object represents a customer of your business. Use it to create recurring charges, save payment and contact information,. and track payments that belong to the same customer.
- Customer
Acceptance - Customer
Acceptance Builder - Customer
Balance Customer Balance Settings - Customer
Balance Customer Balance Settings Builder - Customer
Balance Resource Cash Balance Transaction Resource Adjusted ForOverdraft - Customer
Balance Resource Cash Balance Transaction Resource Adjusted ForOverdraft Builder - Customer
Balance Resource Cash Balance Transaction Resource Applied ToPayment Transaction - Customer
Balance Resource Cash Balance Transaction Resource Applied ToPayment Transaction Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource EuBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource EuBank Transfer Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource GbBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource GbBank Transfer Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource JpBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource JpBank Transfer Builder - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource UsBank Transfer - Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource UsBank Transfer Builder - Customer
Balance Resource Cash Balance Transaction Resource Refunded From Payment Transaction - Customer
Balance Resource Cash Balance Transaction Resource Refunded From Payment Transaction Builder - Customer
Balance Resource Cash Balance Transaction Resource Transferred ToBalance - Customer
Balance Resource Cash Balance Transaction Resource Transferred ToBalance Builder - Customer
Balance Resource Cash Balance Transaction Resource Unapplied From Payment Transaction - Customer
Balance Resource Cash Balance Transaction Resource Unapplied From Payment Transaction Builder - Customer
Balance Transaction - Each customer has a Balance value,.
which denotes a debit or credit that’s automatically applied to their next invoice upon finalization.
You may modify the value directly by using the update customer API,.
or by creating a Customer Balance Transaction, which increments or decrements the customer’s
balance
by the specifiedamount
. - Customer
Balance Transaction Builder - Customer
Balance Transaction Id - Customer
Builder - Customer
Cash Balance Transaction - Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions. represent when funds are moved into or out of this balance. This includes funding by the customer, allocation. to payments, and refunds to the customer.
- Customer
Cash Balance Transaction Builder - Customer
Cash Balance Transaction Id - Customer
Id - Customer
Tax - Customer
TaxBuilder - Customer
TaxLocation - Customer
TaxLocation Builder - Deleted
Account - Deleted
Account Builder - Deleted
Bank Account - Deleted
Bank Account Builder - Deleted
Card - Deleted
Card Builder - Deleted
Coupon - Deleted
Coupon Builder - Deleted
Customer - Deleted
Customer Builder - Deleted
Discount - Deleted
Discount Builder - Deleted
External Account Builder - Deleted
Invoice - Deleted
Invoice Builder - Deleted
Payment Source Builder - Deleted
Person - Deleted
Person Builder - Deleted
Plan - Deleted
Plan Builder - Deleted
Product - Deleted
Product Builder - Deleted
Subscription Item - Deleted
Subscription Item Builder - Deleted
TaxId - Deleted
TaxId Builder - Deleted
Test Helpers Test Clock - Deleted
Test Helpers Test Clock Builder - Destination
Details Unimplemented - Destination
Details Unimplemented Builder - Discount
- A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
- Discount
Builder - Discount
Id - Discounts
Resource Discount Amount - Discounts
Resource Discount Amount Builder - Discounts
Resource Stackable Discount - Discounts
Resource Stackable Discount Builder - Dispute
- A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
- Dispute
Builder - Dispute
Enhanced Eligibility - Dispute
Enhanced Eligibility Builder - Dispute
Enhanced Eligibility Visa Compelling Evidence3 - Dispute
Enhanced Eligibility Visa Compelling Evidence3 Builder - Dispute
Enhanced Eligibility Visa Compliance - Dispute
Enhanced Eligibility Visa Compliance Builder - Dispute
Enhanced Evidence - Dispute
Enhanced Evidence Builder - Dispute
Enhanced Evidence Visa Compelling Evidence3 - Dispute
Enhanced Evidence Visa Compelling Evidence3 Builder - Dispute
Enhanced Evidence Visa Compliance - Dispute
Enhanced Evidence Visa Compliance Builder - Dispute
Evidence - For more details see <https://stripe.com/docs/api/disputes/evidence_object>.
- Dispute
Evidence Builder - Dispute
Evidence Details - Dispute
Evidence Details Builder - Dispute
Id - Dispute
Payment Method Details - Dispute
Payment Method Details Amazon Pay - Dispute
Payment Method Details Amazon PayBuilder - Dispute
Payment Method Details Builder - Dispute
Payment Method Details Card - Dispute
Payment Method Details Card Builder - Dispute
Payment Method Details Klarna - Dispute
Payment Method Details Klarna Builder - Dispute
Payment Method Details Paypal - Dispute
Payment Method Details Paypal Builder - Dispute
Transaction Shipping Address - Dispute
Transaction Shipping Address Builder - Dispute
Visa Compelling Evidence3 Disputed Transaction - Dispute
Visa Compelling Evidence3 Disputed Transaction Builder - Dispute
Visa Compelling Evidence3 Prior Undisputed Transaction - Dispute
Visa Compelling Evidence3 Prior Undisputed Transaction Builder - Email
Sent - Email
Sent Builder - Entitlements
Feature - A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
- Entitlements
Feature Builder - Entitlements
Feature Id - Error
- An error response from the Stripe API
- Error
Builder - Event
- Events are our way of letting you know when something interesting happens in
your account. When an interesting event occurs, we create a new
Event
object. For example, when a charge succeeds, we create acharge.succeeded
event, and when an invoice payment attempt fails, we create aninvoice.payment_failed
event. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both acustomer.subscription.created
event and acharge.succeeded
event. - Event
Builder - EventId
- External
Account Builder - External
Account Requirements - External
Account Requirements Builder - Fee
- FeeBuilder
- File
- This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).
- File
Builder - FileId
- File
Link - To share the contents of a
File
object with non-Stripe users, you can create aFileLink
.FileLink
s contain a URL that you can use to retrieve the contents of the file without authentication. - File
Link Builder - File
Link Id - Funding
Instructions - Each customer has a
balance
that is. automatically applied to future invoices and payments using thecustomer_balance
payment method. Customers can fund this balance by initiating a bank transfer to any account in thefinancial_addresses
field. Related guide: Customer balance funding instructions. - Funding
Instructions Bank Transfer - Funding
Instructions Bank Transfer AbaRecord - ABA Records contain U.S. bank account details per the ABA format.
- Funding
Instructions Bank Transfer AbaRecord Builder - Funding
Instructions Bank Transfer Builder - Funding
Instructions Bank Transfer Financial Address - FinancialAddresses contain identifying information that resolves to a FinancialAccount.
- Funding
Instructions Bank Transfer Financial Address Builder - Funding
Instructions Bank Transfer Iban Record - Iban Records contain E.U. bank account details per the SEPA format.
- Funding
Instructions Bank Transfer Iban Record Builder - Funding
Instructions Bank Transfer Sort Code Record - Sort Code Records contain U.K. bank account details per the sort code format.
- Funding
Instructions Bank Transfer Sort Code Record Builder - Funding
Instructions Bank Transfer Spei Record - SPEI Records contain Mexico bank account details per the SPEI format.
- Funding
Instructions Bank Transfer Spei Record Builder - Funding
Instructions Bank Transfer Swift Record - SWIFT Records contain U.S. bank account details per the SWIFT format.
- Funding
Instructions Bank Transfer Swift Record Builder - Funding
Instructions Bank Transfer Zengin Record - Zengin Records contain Japan bank account details per the Zengin format.
- Funding
Instructions Bank Transfer Zengin Record Builder - Funding
Instructions Builder - Internal
Card - Internal
Card Builder - Invoice
- Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
- Invoice
Builder - Invoice
Id - Invoice
Installments Card - Invoice
Installments Card Builder - Invoice
Item Threshold Reason - Invoice
Item Threshold Reason Builder - Invoice
Line Item - Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
- Invoice
Line Item Builder - Invoice
Line Item Id - Invoice
Line Item Period - Invoice
Line Item Period Builder - Invoice
Mandate Options Card - Invoice
Mandate Options Card Builder - Invoice
Payment - The invoice payment object
- Invoice
Payment Builder - Invoice
Payment Id - Invoice
Payment Method Options Acss Debit - Invoice
Payment Method Options Acss Debit Builder - Invoice
Payment Method Options Acss Debit Mandate Options - Invoice
Payment Method Options Acss Debit Mandate Options Builder - Invoice
Payment Method Options Bancontact - Invoice
Payment Method Options Bancontact Builder - Invoice
Payment Method Options Card - Invoice
Payment Method Options Card Builder - Invoice
Payment Method Options Customer Balance - Invoice
Payment Method Options Customer Balance Bank Transfer - Invoice
Payment Method Options Customer Balance Bank Transfer Builder - Invoice
Payment Method Options Customer Balance Bank Transfer EuBank Transfer - Invoice
Payment Method Options Customer Balance Bank Transfer EuBank Transfer Builder - Invoice
Payment Method Options Customer Balance Builder - Invoice
Payment Method Options Konbini - Invoice
Payment Method Options Konbini Builder - Invoice
Payment Method Options Sepa Debit - Invoice
Payment Method Options Sepa Debit Builder - Invoice
Payment Method Options UsBank Account - Invoice
Payment Method Options UsBank Account Builder - Invoice
Payment Method Options UsBank Account Linked Account Options - Invoice
Payment Method Options UsBank Account Linked Account Options Builder - Invoice
Payment Method Options UsBank Account Linked Account Options Filters - Invoice
Payment Method Options UsBank Account Linked Account Options Filters Builder - Invoice
Rendering Pdf - Invoice
Rendering PdfBuilder - Invoice
Setting Checkout Rendering Options - Invoice
Setting Checkout Rendering Options Builder - Invoice
Setting Custom Field - Invoice
Setting Custom Field Builder - Invoice
Setting Customer Rendering Options - Invoice
Setting Customer Rendering Options Builder - Invoice
Setting Customer Setting - Invoice
Setting Customer Setting Builder - Invoice
Setting Subscription Schedule Phase Setting - Invoice
Setting Subscription Schedule Phase Setting Builder - Invoice
Setting Subscription Schedule Setting - Invoice
Setting Subscription Schedule Setting Builder - Invoice
Threshold Reason - Invoice
Threshold Reason Builder - Invoices
Payment Method Options - Invoices
Payment Method Options Builder - Invoices
Payment Settings - Invoices
Payment Settings Builder - Invoices
Payments Invoice Payment Associated Payment - Invoices
Payments Invoice Payment Associated Payment Builder - Invoices
Payments Invoice Payment Status Transitions - Invoices
Payments Invoice Payment Status Transitions Builder - Invoices
Resource Confirmation Secret - Invoices
Resource Confirmation Secret Builder - Invoices
Resource From Invoice - Invoices
Resource From Invoice Builder - Invoices
Resource Invoice Rendering - Invoices
Resource Invoice Rendering Builder - Invoices
Resource Invoice TaxId - Invoices
Resource Invoice TaxId Builder - Invoices
Resource Pretax Credit Amount - Invoices
Resource Pretax Credit Amount Builder - Invoices
Resource Shipping Cost - Invoices
Resource Shipping Cost Builder - Invoices
Resource Status Transitions - Invoices
Resource Status Transitions Builder - Issuing
Authorization - When an issued card is used to make a purchase, an Issuing
Authorization
. object is created. Authorizations must be approved for the. purchase to be completed successfully. - Issuing
Authorization Amount Details - Issuing
Authorization Amount Details Builder - Issuing
Authorization Authentication Exemption - Issuing
Authorization Authentication Exemption Builder - Issuing
Authorization Builder - Issuing
Authorization Fleet Cardholder Prompt Data - Issuing
Authorization Fleet Cardholder Prompt Data Builder - Issuing
Authorization Fleet Data - Issuing
Authorization Fleet Data Builder - Issuing
Authorization Fleet Fuel Price Data - Issuing
Authorization Fleet Fuel Price Data Builder - Issuing
Authorization Fleet NonFuel Price Data - Issuing
Authorization Fleet NonFuel Price Data Builder - Issuing
Authorization Fleet Reported Breakdown - Issuing
Authorization Fleet Reported Breakdown Builder - Issuing
Authorization Fleet TaxData - Issuing
Authorization Fleet TaxData Builder - Issuing
Authorization Fraud Challenge - Issuing
Authorization Fraud Challenge Builder - Issuing
Authorization Fuel Data - Issuing
Authorization Fuel Data Builder - Issuing
Authorization Id - Issuing
Authorization Merchant Data - Issuing
Authorization Merchant Data Builder - Issuing
Authorization Network Data - Issuing
Authorization Network Data Builder - Issuing
Authorization Pending Request - Issuing
Authorization Pending Request Builder - Issuing
Authorization Request - Issuing
Authorization Request Builder - Issuing
Authorization ThreeD Secure - Issuing
Authorization ThreeD Secure Builder - Issuing
Authorization Treasury - Issuing
Authorization Treasury Builder - Issuing
Authorization Verification Data - Issuing
Authorization Verification Data Builder - Issuing
Card - You can create physical or virtual cards that are issued to cardholders.
- Issuing
Card Apple Pay - Issuing
Card Apple PayBuilder - Issuing
Card Authorization Controls - Issuing
Card Authorization Controls Builder - Issuing
Card Builder - Issuing
Card Google Pay - Issuing
Card Google PayBuilder - Issuing
Card Id - Issuing
Card Shipping - Issuing
Card Shipping Address Validation - Issuing
Card Shipping Address Validation Builder - Issuing
Card Shipping Builder - Issuing
Card Shipping Customs - Issuing
Card Shipping Customs Builder - Issuing
Card Spending Limit - Issuing
Card Spending Limit Builder - Issuing
Card Wallets - Issuing
Card Wallets Builder - Issuing
Cardholder - An Issuing
Cardholder
object represents an individual or business entity who is issued cards. - Issuing
Cardholder Address - Issuing
Cardholder Address Builder - Issuing
Cardholder Authorization Controls - Issuing
Cardholder Authorization Controls Builder - Issuing
Cardholder Builder - Issuing
Cardholder Card Issuing - Issuing
Cardholder Card Issuing Builder - Issuing
Cardholder Company - Issuing
Cardholder Company Builder - Issuing
Cardholder Id - Issuing
Cardholder IdDocument - Issuing
Cardholder IdDocument Builder - Issuing
Cardholder Individual - Issuing
Cardholder Individual Builder - Issuing
Cardholder Individual Dob - Issuing
Cardholder Individual DobBuilder - Issuing
Cardholder Requirements - Issuing
Cardholder Requirements Builder - Issuing
Cardholder Spending Limit - Issuing
Cardholder Spending Limit Builder - Issuing
Cardholder User Terms Acceptance - Issuing
Cardholder User Terms Acceptance Builder - Issuing
Cardholder Verification - Issuing
Cardholder Verification Builder - Issuing
Dispute - As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
- Issuing
Dispute Builder - Issuing
Dispute Canceled Evidence - Issuing
Dispute Canceled Evidence Builder - Issuing
Dispute Duplicate Evidence - Issuing
Dispute Duplicate Evidence Builder - Issuing
Dispute Evidence - Issuing
Dispute Evidence Builder - Issuing
Dispute Fraudulent Evidence - Issuing
Dispute Fraudulent Evidence Builder - Issuing
Dispute Id - Issuing
Dispute Merchandise NotAs Described Evidence - Issuing
Dispute Merchandise NotAs Described Evidence Builder - Issuing
Dispute NoValid Authorization Evidence - Issuing
Dispute NoValid Authorization Evidence Builder - Issuing
Dispute NotReceived Evidence - Issuing
Dispute NotReceived Evidence Builder - Issuing
Dispute Other Evidence - Issuing
Dispute Other Evidence Builder - Issuing
Dispute Service NotAs Described Evidence - Issuing
Dispute Service NotAs Described Evidence Builder - Issuing
Dispute Treasury - Issuing
Dispute Treasury Builder - Issuing
Network Token Address - Issuing
Network Token Address Builder - Issuing
Network Token Device - Issuing
Network Token Device Builder - Issuing
Network Token Mastercard - Issuing
Network Token Mastercard Builder - Issuing
Network Token Network Data - Issuing
Network Token Network Data Builder - Issuing
Network Token Visa - Issuing
Network Token Visa Builder - Issuing
Network Token Wallet Provider - Issuing
Network Token Wallet Provider Builder - Issuing
Personalization Design - A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
- Issuing
Personalization Design Builder - Issuing
Personalization Design Carrier Text - Issuing
Personalization Design Carrier Text Builder - Issuing
Personalization Design Id - Issuing
Personalization Design Preferences - Issuing
Personalization Design Preferences Builder - Issuing
Personalization Design Rejection Reasons - Issuing
Personalization Design Rejection Reasons Builder - Issuing
Physical Bundle - A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
- Issuing
Physical Bundle Builder - Issuing
Physical Bundle Features - Issuing
Physical Bundle Features Builder - Issuing
Physical Bundle Id - Issuing
Token - An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens through Stripe.
- Issuing
Token Builder - Issuing
Token Id - Issuing
Transaction - Any use of an issued card that results in funds entering or leaving.
your Stripe account, such as a completed purchase or refund, is represented by an Issuing
Transaction
object. - Issuing
Transaction Amount Details - Issuing
Transaction Amount Details Builder - Issuing
Transaction Builder - Issuing
Transaction Fleet Cardholder Prompt Data - Issuing
Transaction Fleet Cardholder Prompt Data Builder - Issuing
Transaction Fleet Data - Issuing
Transaction Fleet Data Builder - Issuing
Transaction Fleet Fuel Price Data - Issuing
Transaction Fleet Fuel Price Data Builder - Issuing
Transaction Fleet NonFuel Price Data - Issuing
Transaction Fleet NonFuel Price Data Builder - Issuing
Transaction Fleet Reported Breakdown - Issuing
Transaction Fleet Reported Breakdown Builder - Issuing
Transaction Fleet TaxData - Issuing
Transaction Fleet TaxData Builder - Issuing
Transaction Flight Data - Issuing
Transaction Flight Data Builder - Issuing
Transaction Flight Data Leg - Issuing
Transaction Flight Data LegBuilder - Issuing
Transaction Fuel Data - Issuing
Transaction Fuel Data Builder - Issuing
Transaction Id - Issuing
Transaction Lodging Data - Issuing
Transaction Lodging Data Builder - Issuing
Transaction Network Data - Issuing
Transaction Network Data Builder - Issuing
Transaction Purchase Details - Issuing
Transaction Purchase Details Builder - Issuing
Transaction Receipt Data - Issuing
Transaction Receipt Data Builder - Issuing
Transaction Treasury - Issuing
Transaction Treasury Builder - Klarna
Address - Klarna
Address Builder - Klarna
Payer Details - Klarna
Payer Details Builder - Legal
Entity Company - Legal
Entity Company Builder - Legal
Entity Company Verification - Legal
Entity Company Verification Builder - Legal
Entity Company Verification Document - Legal
Entity Company Verification Document Builder - Legal
Entity Directorship Declaration - Legal
Entity Directorship Declaration Builder - Legal
Entity Dob - Legal
Entity DobBuilder - Legal
Entity Japan Address - Legal
Entity Japan Address Builder - Legal
Entity Person Verification - Legal
Entity Person Verification Builder - Legal
Entity Person Verification Document - Legal
Entity Person Verification Document Builder - Legal
Entity Registration Date - Legal
Entity Registration Date Builder - Legal
Entity UboDeclaration - Legal
Entity UboDeclaration Builder - Level3
- Level3
Builder - Level3
Line Items - Level3
Line Items Builder - Line
Items Discount Amount - Line
Items Discount Amount Builder - Line
Items TaxAmount - Line
Items TaxAmount Builder - Linked
Account Options Common - Linked
Account Options Common Builder - Mandate
- A Mandate is a record of the permission that your customer gives you to debit their payment method.
- Mandate
Acss Debit - Mandate
Acss Debit Builder - Mandate
Amazon Pay - Mandate
Amazon PayBuilder - Mandate
AuBecs Debit - Mandate
AuBecs Debit Builder - Mandate
Bacs Debit - Mandate
Bacs Debit Builder - Mandate
Builder - Mandate
Cashapp - Mandate
Cashapp Builder - Mandate
Id - Mandate
Kakao Pay - Mandate
Kakao PayBuilder - Mandate
KrCard - Mandate
KrCard Builder - Mandate
Link - Mandate
Link Builder - Mandate
Multi Use - Mandate
Multi UseBuilder - Mandate
Naver Pay - Mandate
Naver PayBuilder - Mandate
NzBank Account - Mandate
NzBank Account Builder - Mandate
Payment Method Details - Mandate
Payment Method Details Builder - Mandate
Paypal - Mandate
Paypal Builder - Mandate
Revolut Pay - Mandate
Revolut PayBuilder - Mandate
Sepa Debit - Mandate
Sepa Debit Builder - Mandate
Single Use - Mandate
Single UseBuilder - Mandate
UsBank Account - Mandate
UsBank Account Builder - Networks
- Networks
Builder - Notification
Event Data - Notification
Event Data Builder - Notification
Event Request - Notification
Event Request Builder - Offline
Acceptance - Offline
Acceptance Builder - Online
Acceptance - Online
Acceptance Builder - Package
Dimensions - Package
Dimensions Builder - Payment
Flows Amount Details - Payment
Flows Amount Details Builder - Payment
Flows Amount Details Client Resource Tip - Payment
Flows Amount Details Client Resource TipBuilder - Payment
Flows Automatic Payment Methods Payment Intent - Payment
Flows Automatic Payment Methods Payment Intent Builder - Payment
Flows Automatic Payment Methods Setup Intent - Payment
Flows Automatic Payment Methods Setup Intent Builder - Payment
Flows Payment Intent Presentment Details - Payment
Flows Payment Intent Presentment Details Builder - Payment
Flows Private Payment Methods Alipay - Payment
Flows Private Payment Methods Alipay Builder - Payment
Flows Private Payment Methods Alipay Details - Payment
Flows Private Payment Methods Alipay Details Builder - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Extended Authorization Extended Authorization - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Extended Authorization Extended Authorization Builder - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Incremental Authorization Incremental Authorization - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Incremental Authorization Incremental Authorization Builder - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Overcapture Overcapture - Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Overcapture Overcapture Builder - Payment
Flows Private Payment Methods Card Details ApiResource Multicapture - Payment
Flows Private Payment Methods Card Details ApiResource Multicapture Builder - Payment
Flows Private Payment Methods Card Present Common Wallet - Payment
Flows Private Payment Methods Card Present Common Wallet Builder - Payment
Flows Private Payment Methods Financial Connections Common Linked Account Options Filters - Payment
Flows Private Payment Methods Financial Connections Common Linked Account Options Filters Builder - Payment
Flows Private Payment Methods Kakao PayPayment Method Options - Payment
Flows Private Payment Methods Kakao PayPayment Method Options Builder - Payment
Flows Private Payment Methods Klarna Dob - Payment
Flows Private Payment Methods Klarna DobBuilder - Payment
Flows Private Payment Methods Naver PayPayment Method Options - Payment
Flows Private Payment Methods Naver PayPayment Method Options Builder - Payment
Flows Private Payment Methods Payco Payment Method Options - Payment
Flows Private Payment Methods Payco Payment Method Options Builder - Payment
Flows Private Payment Methods Samsung PayPayment Method Options - Payment
Flows Private Payment Methods Samsung PayPayment Method Options Builder - 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.
- Payment
Intent Builder - Payment
Intent Card Processing - Payment
Intent Card Processing Builder - Payment
Intent Id - Payment
Intent Next Action - Payment
Intent Next Action Alipay Handle Redirect - Payment
Intent Next Action Alipay Handle Redirect Builder - Payment
Intent Next Action Boleto - Payment
Intent Next Action Boleto Builder - Payment
Intent Next Action Builder - Payment
Intent Next Action Card Await Notification - Payment
Intent Next Action Card Await Notification Builder - Payment
Intent Next Action Cashapp Handle Redirect OrDisplay QrCode - Payment
Intent Next Action Cashapp Handle Redirect OrDisplay QrCode Builder - Payment
Intent Next Action Cashapp QrCode - Payment
Intent Next Action Cashapp QrCode Builder - Payment
Intent Next Action Display Bank Transfer Instructions - Payment
Intent Next Action Display Bank Transfer Instructions Builder - Payment
Intent Next Action Display Multibanco Details - Payment
Intent Next Action Display Multibanco Details Builder - Payment
Intent Next Action Display Oxxo Details - Payment
Intent Next Action Display Oxxo Details Builder - Payment
Intent Next Action Konbini - Payment
Intent Next Action Konbini Builder - Payment
Intent Next Action Konbini Familymart - Payment
Intent Next Action Konbini Familymart Builder - Payment
Intent Next Action Konbini Lawson - Payment
Intent Next Action Konbini Lawson Builder - Payment
Intent Next Action Konbini Ministop - Payment
Intent Next Action Konbini Ministop Builder - Payment
Intent Next Action Konbini Seicomart - Payment
Intent Next Action Konbini Seicomart Builder - Payment
Intent Next Action Konbini Stores - Payment
Intent Next Action Konbini Stores Builder - Payment
Intent Next Action Paynow Display QrCode - Payment
Intent Next Action Paynow Display QrCode Builder - Payment
Intent Next Action PixDisplay QrCode - Payment
Intent Next Action PixDisplay QrCode Builder - Payment
Intent Next Action Promptpay Display QrCode - Payment
Intent Next Action Promptpay Display QrCode Builder - Payment
Intent Next Action Redirect ToUrl - Payment
Intent Next Action Redirect ToUrl Builder - Payment
Intent Next Action Swish Handle Redirect OrDisplay QrCode - Payment
Intent Next Action Swish Handle Redirect OrDisplay QrCode Builder - Payment
Intent Next Action Swish QrCode - Payment
Intent Next Action Swish QrCode Builder - Payment
Intent Next Action Verify With Microdeposits - Payment
Intent Next Action Verify With Microdeposits Builder - Payment
Intent Next Action Wechat PayDisplay QrCode - Payment
Intent Next Action Wechat PayDisplay QrCode Builder - Payment
Intent Next Action Wechat PayRedirect ToAndroid App - Payment
Intent Next Action Wechat PayRedirect ToAndroid AppBuilder - Payment
Intent Next Action Wechat PayRedirect ToIos App - Payment
Intent Next Action Wechat PayRedirect ToIos AppBuilder - Payment
Intent Payment Method Options - Payment
Intent Payment Method Options Acss Debit - Payment
Intent Payment Method Options Acss Debit Builder - Payment
Intent Payment Method Options AuBecs Debit - Payment
Intent Payment Method Options AuBecs Debit Builder - Payment
Intent Payment Method Options Bacs Debit - Payment
Intent Payment Method Options Bacs Debit Builder - Payment
Intent Payment Method Options Blik - Payment
Intent Payment Method Options Blik Builder - Payment
Intent Payment Method Options Builder - Payment
Intent Payment Method Options Card - Payment
Intent Payment Method Options Card Builder - Payment
Intent Payment Method Options Eps - Payment
Intent Payment Method Options EpsBuilder - Payment
Intent Payment Method Options Link - Payment
Intent Payment Method Options Link Builder - Payment
Intent Payment Method Options Mandate Options Acss Debit - Payment
Intent Payment Method Options Mandate Options Acss Debit Builder - Payment
Intent Payment Method Options Mandate Options Bacs Debit - Payment
Intent Payment Method Options Mandate Options Bacs Debit Builder - Payment
Intent Payment Method Options Mandate Options Sepa Debit - Payment
Intent Payment Method Options Mandate Options Sepa Debit Builder - Payment
Intent Payment Method Options Mobilepay - Payment
Intent Payment Method Options Mobilepay Builder - Payment
Intent Payment Method Options NzBank Account - Payment
Intent Payment Method Options NzBank Account Builder - Payment
Intent Payment Method Options Sepa Debit - Payment
Intent Payment Method Options Sepa Debit Builder - Payment
Intent Payment Method Options Swish - Payment
Intent Payment Method Options Swish Builder - Payment
Intent Payment Method Options UsBank Account - Payment
Intent Payment Method Options UsBank Account Builder - Payment
Intent Processing - Payment
Intent Processing Builder - Payment
Intent Processing Customer Notification - Payment
Intent Processing Customer Notification Builder - Payment
Link - A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
- Payment
Link Builder - Payment
Link Id - Payment
Links Resource After Completion - Payment
Links Resource After Completion Builder - Payment
Links Resource Automatic Tax - Payment
Links Resource Automatic TaxBuilder - Payment
Links Resource Completed Sessions - Payment
Links Resource Completed Sessions Builder - Payment
Links Resource Completion Behavior Confirmation Page - Payment
Links Resource Completion Behavior Confirmation Page Builder - Payment
Links Resource Completion Behavior Redirect - Payment
Links Resource Completion Behavior Redirect Builder - Payment
Links Resource Consent Collection - Payment
Links Resource Consent Collection Builder - Payment
Links Resource Custom Fields - Payment
Links Resource Custom Fields Builder - Payment
Links Resource Custom Fields Dropdown - Payment
Links Resource Custom Fields Dropdown Builder - Payment
Links Resource Custom Fields Dropdown Option - Payment
Links Resource Custom Fields Dropdown Option Builder - Payment
Links Resource Custom Fields Label - Payment
Links Resource Custom Fields Label Builder - Payment
Links Resource Custom Fields Numeric - Payment
Links Resource Custom Fields Numeric Builder - Payment
Links Resource Custom Fields Text - Payment
Links Resource Custom Fields Text Builder - Payment
Links Resource Custom Text - Payment
Links Resource Custom Text Builder - Payment
Links Resource Custom Text Position - Payment
Links Resource Custom Text Position Builder - Payment
Links Resource Invoice Creation - Payment
Links Resource Invoice Creation Builder - Payment
Links Resource Invoice Settings - Payment
Links Resource Invoice Settings Builder - Payment
Links Resource Optional Item - Payment
Links Resource Optional Item Adjustable Quantity - Payment
Links Resource Optional Item Adjustable Quantity Builder - Payment
Links Resource Optional Item Builder - Payment
Links Resource Payment Intent Data - Payment
Links Resource Payment Intent Data Builder - Payment
Links Resource Payment Method Reuse Agreement - Payment
Links Resource Payment Method Reuse Agreement Builder - Payment
Links Resource Phone Number Collection - Payment
Links Resource Phone Number Collection Builder - Payment
Links Resource Restrictions - Payment
Links Resource Restrictions Builder - Payment
Links Resource Shipping Address Collection - Payment
Links Resource Shipping Address Collection Builder - Payment
Links Resource Shipping Option - Payment
Links Resource Shipping Option Builder - Payment
Links Resource Subscription Data - Payment
Links Resource Subscription Data Builder - Payment
Links Resource Subscription Data Invoice Settings - Payment
Links Resource Subscription Data Invoice Settings Builder - Payment
Links Resource TaxId Collection - Payment
Links Resource TaxId Collection Builder - Payment
Links Resource Transfer Data - Payment
Links Resource Transfer Data Builder - 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.
- Payment
Method Acss Debit - Payment
Method Acss Debit Builder - Payment
Method Affirm - Payment
Method Affirm Builder - Payment
Method Afterpay Clearpay - Payment
Method Afterpay Clearpay Builder - Payment
Method Alma - Payment
Method Alma Builder - Payment
Method Amazon Pay - Payment
Method Amazon PayBuilder - Payment
Method AuBecs Debit - Payment
Method AuBecs Debit Builder - Payment
Method Bacs Debit - Payment
Method Bacs Debit Builder - Payment
Method Bancontact - Payment
Method Bancontact Builder - Payment
Method Billie - Payment
Method Billie Builder - Payment
Method Blik - Payment
Method Blik Builder - Payment
Method Boleto - Payment
Method Boleto Builder - Payment
Method Builder - Payment
Method Card - Payment
Method Card Builder - Payment
Method Card Checks - Payment
Method Card Checks Builder - Payment
Method Card Generated Card - Payment
Method Card Generated Card Builder - Payment
Method Card Present - Payment
Method Card Present Builder - Payment
Method Card Present Networks - Payment
Method Card Present Networks Builder - Payment
Method Card Wallet - Payment
Method Card Wallet Amex Express Checkout - Payment
Method Card Wallet Amex Express Checkout Builder - Payment
Method Card Wallet Apple Pay - Payment
Method Card Wallet Apple PayBuilder - Payment
Method Card Wallet Builder - Payment
Method Card Wallet Google Pay - Payment
Method Card Wallet Google PayBuilder - Payment
Method Card Wallet Link - Payment
Method Card Wallet Link Builder - Payment
Method Card Wallet Masterpass - Payment
Method Card Wallet Masterpass Builder - Payment
Method Card Wallet Samsung Pay - Payment
Method Card Wallet Samsung PayBuilder - Payment
Method Card Wallet Visa Checkout - Payment
Method Card Wallet Visa Checkout Builder - Payment
Method Cashapp - Payment
Method Cashapp Builder - Payment
Method Config BizPayment Method Configuration Details - Payment
Method Config BizPayment Method Configuration Details Builder - Payment
Method Customer Balance - Payment
Method Customer Balance Builder - Payment
Method Details - Payment
Method Details AchCredit Transfer - Payment
Method Details AchCredit Transfer Builder - Payment
Method Details AchDebit - Payment
Method Details AchDebit Builder - Payment
Method Details Acss Debit - Payment
Method Details Acss Debit Builder - Payment
Method Details Affirm - Payment
Method Details Affirm Builder - Payment
Method Details Afterpay Clearpay - Payment
Method Details Afterpay Clearpay Builder - Payment
Method Details Alma - Payment
Method Details Alma Builder - Payment
Method Details Amazon Pay - Payment
Method Details Amazon PayBuilder - Payment
Method Details AuBecs Debit - Payment
Method Details AuBecs Debit Builder - Payment
Method Details Bacs Debit - Payment
Method Details Bacs Debit Builder - Payment
Method Details Bancontact - Payment
Method Details Bancontact Builder - Payment
Method Details Billie - Payment
Method Details Billie Builder - Payment
Method Details Blik - Payment
Method Details Blik Builder - Payment
Method Details Boleto - Payment
Method Details Boleto Builder - Payment
Method Details Builder - Payment
Method Details Card - Payment
Method Details Card Builder - Payment
Method Details Card Checks - Payment
Method Details Card Checks Builder - Payment
Method Details Card Installments - Payment
Method Details Card Installments Builder - Payment
Method Details Card Installments Plan - Payment
Method Details Card Installments Plan Builder - Payment
Method Details Card Network Token - Payment
Method Details Card Network Token Builder - Payment
Method Details Card Present - Payment
Method Details Card Present Builder - Payment
Method Details Card Present Offline - Payment
Method Details Card Present Offline Builder - Payment
Method Details Card Present Receipt - Payment
Method Details Card Present Receipt Builder - Payment
Method Details Card Wallet - Payment
Method Details Card Wallet Amex Express Checkout - Payment
Method Details Card Wallet Amex Express Checkout Builder - Payment
Method Details Card Wallet Apple Pay - Payment
Method Details Card Wallet Apple PayBuilder - Payment
Method Details Card Wallet Builder - Payment
Method Details Card Wallet Google Pay - Payment
Method Details Card Wallet Google PayBuilder - Payment
Method Details Card Wallet Link - Payment
Method Details Card Wallet Link Builder - Payment
Method Details Card Wallet Masterpass - Payment
Method Details Card Wallet Masterpass Builder - Payment
Method Details Card Wallet Samsung Pay - Payment
Method Details Card Wallet Samsung PayBuilder - Payment
Method Details Card Wallet Visa Checkout - Payment
Method Details Card Wallet Visa Checkout Builder - Payment
Method Details Cashapp - Payment
Method Details Cashapp Builder - Payment
Method Details Customer Balance - Payment
Method Details Customer Balance Builder - Payment
Method Details Eps - Payment
Method Details EpsBuilder - Payment
Method Details Fpx - Payment
Method Details FpxBuilder - Payment
Method Details Giropay - Payment
Method Details Giropay Builder - Payment
Method Details Grabpay - Payment
Method Details Grabpay Builder - Payment
Method Details Ideal - Payment
Method Details Ideal Builder - Payment
Method Details Interac Present - Payment
Method Details Interac Present Builder - Payment
Method Details Interac Present Receipt - Payment
Method Details Interac Present Receipt Builder - Payment
Method Details Kakao Pay - Payment
Method Details Kakao PayBuilder - Payment
Method Details Klarna - Payment
Method Details Klarna Builder - Payment
Method Details Konbini - Payment
Method Details Konbini Builder - Payment
Method Details Konbini Store - Payment
Method Details Konbini Store Builder - Payment
Method Details KrCard - Payment
Method Details KrCard Builder - Payment
Method Details Link - Payment
Method Details Link Builder - Payment
Method Details Mobilepay - Payment
Method Details Mobilepay Builder - Payment
Method Details Multibanco - Payment
Method Details Multibanco Builder - Payment
Method Details Naver Pay - Payment
Method Details Naver PayBuilder - Payment
Method Details NzBank Account - Payment
Method Details NzBank Account Builder - Payment
Method Details Oxxo - Payment
Method Details Oxxo Builder - Payment
Method Details P24 - Payment
Method Details P24Builder - Payment
Method Details Passthrough Card - Payment
Method Details Passthrough Card Builder - Payment
Method Details PayBy Bank - Payment
Method Details PayBy Bank Builder - Payment
Method Details Payco - Payment
Method Details Payco Builder - Payment
Method Details Paynow - Payment
Method Details Paynow Builder - Payment
Method Details Paypal - Payment
Method Details Paypal Builder - Payment
Method Details Pix - Payment
Method Details PixBuilder - Payment
Method Details Promptpay - Payment
Method Details Promptpay Builder - Payment
Method Details Revolut Pay - Payment
Method Details Revolut PayBuilder - Payment
Method Details Samsung Pay - Payment
Method Details Samsung PayBuilder - Payment
Method Details Satispay - Payment
Method Details Satispay Builder - Payment
Method Details Sepa Credit Transfer - Payment
Method Details Sepa Credit Transfer Builder - Payment
Method Details Sepa Debit - Payment
Method Details Sepa Debit Builder - Payment
Method Details Sofort - Payment
Method Details Sofort Builder - Payment
Method Details Stripe Account - Payment
Method Details Stripe Account Builder - Payment
Method Details Swish - Payment
Method Details Swish Builder - Payment
Method Details Twint - Payment
Method Details Twint Builder - Payment
Method Details UsBank Account - Payment
Method Details UsBank Account Builder - Payment
Method Details Wechat - Payment
Method Details Wechat Builder - Payment
Method Details Wechat Pay - Payment
Method Details Wechat PayBuilder - Payment
Method Details Zip - Payment
Method Details ZipBuilder - Payment
Method Eps - Payment
Method EpsBuilder - Payment
Method Fpx - Payment
Method FpxBuilder - Payment
Method Giropay - Payment
Method Giropay Builder - Payment
Method Grabpay - Payment
Method Grabpay Builder - Payment
Method Id - Payment
Method Ideal - Payment
Method Ideal Builder - Payment
Method Interac Present - Payment
Method Interac Present Builder - Payment
Method Kakao Pay - Payment
Method Kakao PayBuilder - Payment
Method Klarna - Payment
Method Klarna Builder - Payment
Method Konbini - Payment
Method Konbini Builder - Payment
Method KrCard - Payment
Method KrCard Builder - Payment
Method Link - Payment
Method Link Builder - Payment
Method Mobilepay - Payment
Method Mobilepay Builder - Payment
Method Multibanco - Payment
Method Multibanco Builder - Payment
Method Naver Pay - Payment
Method Naver PayBuilder - Payment
Method NzBank Account - Payment
Method NzBank Account Builder - Payment
Method Options Affirm - Payment
Method Options Affirm Builder - Payment
Method Options Afterpay Clearpay - Payment
Method Options Afterpay Clearpay Builder - Payment
Method Options Alipay - Payment
Method Options Alipay Builder - Payment
Method Options Alma - Payment
Method Options Alma Builder - Payment
Method Options Amazon Pay - Payment
Method Options Amazon PayBuilder - Payment
Method Options Bancontact - Payment
Method Options Bancontact Builder - Payment
Method Options Billie - Payment
Method Options Billie Builder - Payment
Method Options Boleto - Payment
Method Options Boleto Builder - Payment
Method Options Card Installments - Payment
Method Options Card Installments Builder - Payment
Method Options Card Mandate Options - Payment
Method Options Card Mandate Options Builder - Payment
Method Options Card Present - Payment
Method Options Card Present Builder - Payment
Method Options Card Present Routing - Payment
Method Options Card Present Routing Builder - Payment
Method Options Cashapp - Payment
Method Options Cashapp Builder - Payment
Method Options Customer Balance - Payment
Method Options Customer Balance Bank Transfer - Payment
Method Options Customer Balance Bank Transfer Builder - Payment
Method Options Customer Balance Builder - Payment
Method Options Customer Balance EuBank Account - Payment
Method Options Customer Balance EuBank Account Builder - Payment
Method Options Fpx - Payment
Method Options FpxBuilder - Payment
Method Options Giropay - Payment
Method Options Giropay Builder - Payment
Method Options Grabpay - Payment
Method Options Grabpay Builder - Payment
Method Options Ideal - Payment
Method Options Ideal Builder - Payment
Method Options Interac Present - Payment
Method Options Interac Present Builder - Payment
Method Options Klarna - Payment
Method Options Klarna Builder - Payment
Method Options Konbini - Payment
Method Options Konbini Builder - Payment
Method Options KrCard - Payment
Method Options KrCard Builder - Payment
Method Options Multibanco - Payment
Method Options Multibanco Builder - Payment
Method Options Oxxo - Payment
Method Options Oxxo Builder - Payment
Method Options P24 - Payment
Method Options P24Builder - Payment
Method Options PayBy Bank - Payment
Method Options PayBy Bank Builder - Payment
Method Options Paynow - Payment
Method Options Paynow Builder - Payment
Method Options Paypal - Payment
Method Options Paypal Builder - Payment
Method Options Pix - Payment
Method Options PixBuilder - Payment
Method Options Promptpay - Payment
Method Options Promptpay Builder - Payment
Method Options Revolut Pay - Payment
Method Options Revolut PayBuilder - Payment
Method Options Sofort - Payment
Method Options Sofort Builder - Payment
Method Options Twint - Payment
Method Options Twint Builder - Payment
Method Options UsBank Account Mandate Options - Payment
Method Options UsBank Account Mandate Options Builder - Payment
Method Options Wechat Pay - Payment
Method Options Wechat PayBuilder - Payment
Method Options Zip - Payment
Method Options ZipBuilder - Payment
Method Oxxo - Payment
Method Oxxo Builder - Payment
Method P24 - Payment
Method P24Builder - Payment
Method PayBy Bank - Payment
Method PayBy Bank Builder - Payment
Method Payco - Payment
Method Payco Builder - Payment
Method Paynow - Payment
Method Paynow Builder - Payment
Method Paypal - Payment
Method Paypal Builder - Payment
Method Pix - Payment
Method PixBuilder - Payment
Method Promptpay - Payment
Method Promptpay Builder - Payment
Method Revolut Pay - Payment
Method Revolut PayBuilder - Payment
Method Samsung Pay - Payment
Method Samsung PayBuilder - Payment
Method Satispay - Payment
Method Satispay Builder - Payment
Method Sepa Debit - Payment
Method Sepa Debit Builder - Payment
Method Sofort - Payment
Method Sofort Builder - Payment
Method Swish - Payment
Method Swish Builder - Payment
Method Twint - Payment
Method Twint Builder - Payment
Method UsBank Account - Payment
Method UsBank Account Blocked - Payment
Method UsBank Account Blocked Builder - Payment
Method UsBank Account Builder - Payment
Method UsBank Account Status Details - Payment
Method UsBank Account Status Details Builder - Payment
Method Wechat Pay - Payment
Method Wechat PayBuilder - Payment
Method Zip - Payment
Method ZipBuilder - Payment
Pages Checkout Session Adaptive Pricing - Payment
Pages Checkout Session Adaptive Pricing Builder - Payment
Pages Checkout Session After Expiration - Payment
Pages Checkout Session After Expiration Builder - Payment
Pages Checkout Session After Expiration Recovery - Payment
Pages Checkout Session After Expiration Recovery Builder - Payment
Pages Checkout Session Automatic Tax - Payment
Pages Checkout Session Automatic TaxBuilder - Payment
Pages Checkout Session Checkout Address Details - Payment
Pages Checkout Session Checkout Address Details Builder - Payment
Pages Checkout Session Collected Information - Payment
Pages Checkout Session Collected Information Builder - Payment
Pages Checkout Session Consent - Payment
Pages Checkout Session Consent Builder - Payment
Pages Checkout Session Consent Collection - Payment
Pages Checkout Session Consent Collection Builder - Payment
Pages Checkout Session Currency Conversion - Payment
Pages Checkout Session Currency Conversion Builder - Payment
Pages Checkout Session Custom Fields - Payment
Pages Checkout Session Custom Fields Builder - Payment
Pages Checkout Session Custom Fields Dropdown - Payment
Pages Checkout Session Custom Fields Dropdown Builder - Payment
Pages Checkout Session Custom Fields Label - Payment
Pages Checkout Session Custom Fields Label Builder - Payment
Pages Checkout Session Custom Fields Numeric - Payment
Pages Checkout Session Custom Fields Numeric Builder - Payment
Pages Checkout Session Custom Fields Option - Payment
Pages Checkout Session Custom Fields Option Builder - Payment
Pages Checkout Session Custom Fields Text - Payment
Pages Checkout Session Custom Fields Text Builder - Payment
Pages Checkout Session Custom Text - Payment
Pages Checkout Session Custom Text Builder - Payment
Pages Checkout Session Custom Text Position - Payment
Pages Checkout Session Custom Text Position Builder - Payment
Pages Checkout Session Customer Details - Payment
Pages Checkout Session Customer Details Builder - Payment
Pages Checkout Session Discount - Payment
Pages Checkout Session Discount Builder - Payment
Pages Checkout Session Invoice Creation - Payment
Pages Checkout Session Invoice Creation Builder - Payment
Pages Checkout Session Invoice Settings - Payment
Pages Checkout Session Invoice Settings Builder - Payment
Pages Checkout Session Optional Item - Payment
Pages Checkout Session Optional Item Adjustable Quantity - Payment
Pages Checkout Session Optional Item Adjustable Quantity Builder - Payment
Pages Checkout Session Optional Item Builder - Payment
Pages Checkout Session Payment Method Reuse Agreement - Payment
Pages Checkout Session Payment Method Reuse Agreement Builder - Payment
Pages Checkout Session Permissions - Payment
Pages Checkout Session Permissions Builder - Payment
Pages Checkout Session Phone Number Collection - Payment
Pages Checkout Session Phone Number Collection Builder - Payment
Pages Checkout Session Saved Payment Method Options - Payment
Pages Checkout Session Saved Payment Method Options Builder - Payment
Pages Checkout Session Shipping Address Collection - Payment
Pages Checkout Session Shipping Address Collection Builder - Payment
Pages Checkout Session Shipping Cost - Payment
Pages Checkout Session Shipping Cost Builder - Payment
Pages Checkout Session Shipping Option - Payment
Pages Checkout Session Shipping Option Builder - Payment
Pages Checkout Session TaxId - Payment
Pages Checkout Session TaxId Builder - Payment
Pages Checkout Session TaxId Collection - Payment
Pages Checkout Session TaxId Collection Builder - Payment
Pages Checkout Session Total Details - Payment
Pages Checkout Session Total Details Builder - Payment
Pages Checkout Session Total Details Resource Breakdown - Payment
Pages Checkout Session Total Details Resource Breakdown Builder - Payment
Pages Private Card Payment Method Options Resource Restrictions - Payment
Pages Private Card Payment Method Options Resource Restrictions Builder - Payment
Source Builder - Payout
- A
Payout
object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry. - Payout
Builder - Payout
Id - Payouts
Trace Id - Payouts
Trace IdBuilder - Paypal
Seller Protection - Paypal
Seller Protection Builder - Person
- This is an object representing a person associated with a Stripe account.
- Person
Additional TosAcceptance - Person
Additional TosAcceptance Builder - Person
Additional TosAcceptances - Person
Additional TosAcceptances Builder - Person
Builder - Person
Ethnicity Details - Person
Ethnicity Details Builder - Person
Future Requirements - Person
Future Requirements Builder - Person
Id - Person
Race Details - Person
Race Details Builder - Person
Relationship - Person
Relationship Builder - Person
Requirements - Person
Requirements Builder - Person
UsCfpb Data - Person
UsCfpb Data Builder - Plan
- You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
- Plan
Builder - PlanId
- Plan
Tier - Plan
Tier Builder - Platform
Earning FeeSource - Platform
Earning FeeSource Builder - Price
- Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
- Price
Builder - PriceId
- Price
Tier - Price
Tier Builder - Product
- Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.
- Product
Builder - Product
Id - Product
Marketing Feature - Product
Marketing Feature Builder - Promotion
Code - A Promotion Code represents a customer-redeemable code for a coupon. It can be used to. create multiple codes for a single coupon.
- Promotion
Code Builder - Promotion
Code Currency Option - Promotion
Code Currency Option Builder - Promotion
Code Id - Promotion
Codes Resource Restrictions - Promotion
Codes Resource Restrictions Builder - Radar
Radar Options - Options to configure Radar. See Radar Session for more information.
- Radar
Radar Options Builder - Radar
Review Resource Location - Radar
Review Resource Location Builder - Radar
Review Resource Session - Radar
Review Resource Session Builder - Recurring
- Recurring
Builder - Refund
- Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.
- Refund
Builder - Refund
Destination Details - Refund
Destination Details Blik - Refund
Destination Details Blik Builder - Refund
Destination Details BrBank Transfer - Refund
Destination Details BrBank Transfer Builder - Refund
Destination Details Builder - Refund
Destination Details Card - Refund
Destination Details Card Builder - Refund
Destination Details EuBank Transfer - Refund
Destination Details EuBank Transfer Builder - Refund
Destination Details GbBank Transfer - Refund
Destination Details GbBank Transfer Builder - Refund
Destination Details JpBank Transfer - Refund
Destination Details JpBank Transfer Builder - Refund
Destination Details Multibanco - Refund
Destination Details Multibanco Builder - Refund
Destination Details MxBank Transfer - Refund
Destination Details MxBank Transfer Builder - Refund
Destination Details P24 - Refund
Destination Details P24Builder - Refund
Destination Details Swish - Refund
Destination Details Swish Builder - Refund
Destination Details ThBank Transfer - Refund
Destination Details ThBank Transfer Builder - Refund
Destination Details UsBank Transfer - Refund
Destination Details UsBank Transfer Builder - Refund
Id - Refund
Next Action - Refund
Next Action Builder - Refund
Next Action Display Details - Refund
Next Action Display Details Builder - Reserve
Transaction - Reserve
Transaction Builder - Reserve
Transaction Id - Review
- Reviews can be used to supplement automated fraud detection with human expertise.
- Review
Builder - Review
Id - Revolut
PayUnderlying Payment Method Funding Details - Revolut
PayUnderlying Payment Method Funding Details Builder - Rule
- Rule
Builder - RuleId
- Schedules
Phase Automatic Tax - Schedules
Phase Automatic TaxBuilder - Sepa
Debit Generated From - Sepa
Debit Generated From Builder - Setup
Attempt - A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
- Setup
Attempt Builder - Setup
Attempt Id - Setup
Attempt Payment Method Details - Setup
Attempt Payment Method Details Acss Debit - Setup
Attempt Payment Method Details Acss Debit Builder - Setup
Attempt Payment Method Details Amazon Pay - Setup
Attempt Payment Method Details Amazon PayBuilder - Setup
Attempt Payment Method Details AuBecs Debit - Setup
Attempt Payment Method Details AuBecs Debit Builder - Setup
Attempt Payment Method Details Bacs Debit - Setup
Attempt Payment Method Details Bacs Debit Builder - Setup
Attempt Payment Method Details Bancontact - Setup
Attempt Payment Method Details Bancontact Builder - Setup
Attempt Payment Method Details Boleto - Setup
Attempt Payment Method Details Boleto Builder - Setup
Attempt Payment Method Details Builder - Setup
Attempt Payment Method Details Card - Setup
Attempt Payment Method Details Card Builder - Setup
Attempt Payment Method Details Card Checks - Setup
Attempt Payment Method Details Card Checks Builder - Setup
Attempt Payment Method Details Card Present - Setup
Attempt Payment Method Details Card Present Builder - Setup
Attempt Payment Method Details Card Wallet - Setup
Attempt Payment Method Details Card Wallet Builder - Setup
Attempt Payment Method Details Cashapp - Setup
Attempt Payment Method Details Cashapp Builder - Setup
Attempt Payment Method Details Ideal - Setup
Attempt Payment Method Details Ideal Builder - Setup
Attempt Payment Method Details Kakao Pay - Setup
Attempt Payment Method Details Kakao PayBuilder - Setup
Attempt Payment Method Details Klarna - Setup
Attempt Payment Method Details Klarna Builder - Setup
Attempt Payment Method Details KrCard - Setup
Attempt Payment Method Details KrCard Builder - Setup
Attempt Payment Method Details Link - Setup
Attempt Payment Method Details Link Builder - Setup
Attempt Payment Method Details Naver Pay - Setup
Attempt Payment Method Details Naver PayBuilder - Setup
Attempt Payment Method Details NzBank Account - Setup
Attempt Payment Method Details NzBank Account Builder - Setup
Attempt Payment Method Details Paypal - Setup
Attempt Payment Method Details Paypal Builder - Setup
Attempt Payment Method Details Revolut Pay - Setup
Attempt Payment Method Details Revolut PayBuilder - Setup
Attempt Payment Method Details Sepa Debit - Setup
Attempt Payment Method Details Sepa Debit Builder - Setup
Attempt Payment Method Details Sofort - Setup
Attempt Payment Method Details Sofort Builder - Setup
Attempt Payment Method Details UsBank Account - Setup
Attempt Payment Method Details UsBank Account Builder - 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 can 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.
- Setup
Intent Builder - Setup
Intent Id - Setup
Intent Next Action - Setup
Intent Next Action Builder - Setup
Intent Next Action Redirect ToUrl - Setup
Intent Next Action Redirect ToUrl Builder - Setup
Intent Next Action Verify With Microdeposits - Setup
Intent Next Action Verify With Microdeposits Builder - Setup
Intent Payment Method Options - Setup
Intent Payment Method Options Acss Debit - Setup
Intent Payment Method Options Acss Debit Builder - Setup
Intent Payment Method Options Amazon Pay - Setup
Intent Payment Method Options Amazon PayBuilder - Setup
Intent Payment Method Options Bacs Debit - Setup
Intent Payment Method Options Bacs Debit Builder - Setup
Intent Payment Method Options Builder - Setup
Intent Payment Method Options Card - Setup
Intent Payment Method Options Card Builder - Setup
Intent Payment Method Options Card Mandate Options - Setup
Intent Payment Method Options Card Mandate Options Builder - Setup
Intent Payment Method Options Card Present - Setup
Intent Payment Method Options Card Present Builder - Setup
Intent Payment Method Options Link - Setup
Intent Payment Method Options Link Builder - Setup
Intent Payment Method Options Mandate Options Acss Debit - Setup
Intent Payment Method Options Mandate Options Acss Debit Builder - Setup
Intent Payment Method Options Mandate Options Bacs Debit - Setup
Intent Payment Method Options Mandate Options Bacs Debit Builder - Setup
Intent Payment Method Options Mandate Options Sepa Debit - Setup
Intent Payment Method Options Mandate Options Sepa Debit Builder - Setup
Intent Payment Method Options Paypal - Setup
Intent Payment Method Options Paypal Builder - Setup
Intent Payment Method Options Sepa Debit - Setup
Intent Payment Method Options Sepa Debit Builder - Setup
Intent Payment Method Options UsBank Account - Setup
Intent Payment Method Options UsBank Account Builder - Shipping
- Shipping
Builder - Shipping
Rate - Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.
- Shipping
Rate Builder - Shipping
Rate Currency Option - Shipping
Rate Currency Option Builder - Shipping
Rate Delivery Estimate - Shipping
Rate Delivery Estimate Bound - Shipping
Rate Delivery Estimate Bound Builder - Shipping
Rate Delivery Estimate Builder - Shipping
Rate Fixed Amount - Shipping
Rate Fixed Amount Builder - Shipping
Rate Id - Source
Source
objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like aCard
object: once chargeable, they can be charged, or can be attached to customers.- Source
Builder - Source
Code Verification Flow - Source
Code Verification Flow Builder - Source
Id - Source
Order - Source
Order Builder - Source
Order Item - Source
Order Item Builder - Source
Owner - Source
Owner Builder - Source
Receiver Flow - Source
Receiver Flow Builder - Source
Redirect Flow - Source
Redirect Flow Builder - Source
Transaction - Some payment methods have no required amount that a customer must send. Customers can be instructed to send any amount, and it can be made up of multiple transactions. As such, sources can have multiple associated transactions.
- Source
Transaction AchCredit Transfer Data - Source
Transaction AchCredit Transfer Data Builder - Source
Transaction Builder - Source
Transaction ChfCredit Transfer Data - Source
Transaction ChfCredit Transfer Data Builder - Source
Transaction GbpCredit Transfer Data - Source
Transaction GbpCredit Transfer Data Builder - Source
Transaction Id - Source
Transaction Paper Check Data - Source
Transaction Paper Check Data Builder - Source
Transaction Sepa Credit Transfer Data - Source
Transaction Sepa Credit Transfer Data Builder - Source
Type AchCredit Transfer - Source
Type AchCredit Transfer Builder - Source
Type AchDebit - Source
Type AchDebit Builder - Source
Type Acss Debit - Source
Type Acss Debit Builder - Source
Type Alipay - Source
Type Alipay Builder - Source
Type AuBecs Debit - Source
Type AuBecs Debit Builder - Source
Type Bancontact - Source
Type Bancontact Builder - Source
Type Card - Source
Type Card Builder - Source
Type Card Present - Source
Type Card Present Builder - Source
Type Eps - Source
Type EpsBuilder - Source
Type Giropay - Source
Type Giropay Builder - Source
Type Ideal - Source
Type Ideal Builder - Source
Type Klarna - Source
Type Klarna Builder - Source
Type Multibanco - Source
Type Multibanco Builder - Source
Type P24 - Source
Type P24Builder - Source
Type Sepa Credit Transfer - Source
Type Sepa Credit Transfer Builder - Source
Type Sepa Debit - Source
Type Sepa Debit Builder - Source
Type Sofort - Source
Type Sofort Builder - Source
Type ThreeD Secure - Source
Type ThreeD Secure Builder - Source
Type Wechat - Source
Type Wechat Builder - Subscription
- Subscriptions allow you to charge a customer on a recurring basis.
- Subscription
Automatic Tax - Subscription
Automatic TaxBuilder - Subscription
Builder - Subscription
Id - Subscription
Item - Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
- Subscription
Item Builder - Subscription
Item Id - Subscription
Payment Method Options Card - Subscription
Payment Method Options Card Builder - Subscription
Pending Invoice Item Interval - Subscription
Pending Invoice Item Interval Builder - Subscription
Schedule - A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
- Subscription
Schedule AddInvoice Item - An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.
- Subscription
Schedule AddInvoice Item Builder - Subscription
Schedule Builder - Subscription
Schedule Configuration Item - A phase item describes the price and quantity of a phase.
- Subscription
Schedule Configuration Item Builder - Subscription
Schedule Current Phase - Subscription
Schedule Current Phase Builder - Subscription
Schedule Id - Subscription
Schedule Phase Configuration - A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.
- Subscription
Schedule Phase Configuration Builder - Subscription
Schedules Resource Default Settings - Subscription
Schedules Resource Default Settings Automatic Tax - Subscription
Schedules Resource Default Settings Automatic TaxBuilder - Subscription
Schedules Resource Default Settings Builder - Subscription
Transfer Data - Subscription
Transfer Data Builder - Subscriptions
Resource Billing Cycle Anchor Config - Subscriptions
Resource Billing Cycle Anchor Config Builder - Subscriptions
Resource Pause Collection - The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription. should be paused.
- Subscriptions
Resource Pause Collection Builder - Subscriptions
Resource Payment Method Options - Subscriptions
Resource Payment Method Options Builder - Subscriptions
Resource Payment Settings - Subscriptions
Resource Payment Settings Builder - Subscriptions
Resource Pending Update - Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
- Subscriptions
Resource Pending Update Builder - Subscriptions
Resource Subscription Invoice Settings - Subscriptions
Resource Subscription Invoice Settings Builder - Subscriptions
Trials Resource EndBehavior - Defines how a subscription behaves when a free trial ends.
- Subscriptions
Trials Resource EndBehavior Builder - Subscriptions
Trials Resource Trial Settings - Configures how this subscription behaves during the trial period.
- Subscriptions
Trials Resource Trial Settings Builder - TaxCode
- Tax codes classify goods and services for tax purposes.
- TaxCode
Builder - TaxCode
Id - TaxDeducted
AtSource - TaxDeducted
AtSource Builder - TaxDeducted
AtSource Id - TaxI
DsOwner - TaxI
DsOwner Builder - TaxId
- You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.
- TaxId
Builder - TaxIdId
- TaxId
Verification - TaxId
Verification Builder - TaxRate
- Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
- TaxRate
Builder - TaxRate
Flat Amount - The amount of the tax rate when the
rate_type`` is
flat_amount. Tax rates with
rate_typecan vary based on the transaction, resulting in this field being
null`. This field exposes the amount and currency of the flat tax rate. - TaxRate
Flat Amount Builder - TaxRate
Id - Test
Helpers Test Clock - A test clock enables deterministic control over objects in testmode. With a test clock, you can create. objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,. you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
- Test
Helpers Test Clock Builder - Test
Helpers Test Clock Id - ThreeD
Secure Details - ThreeD
Secure Details Builder - ThreeD
Secure Details Charge - ThreeD
Secure Details Charge Builder - ThreeD
Secure Usage - ThreeD
Secure Usage Builder - Token
Card Networks - Token
Card Networks Builder - Topup
- To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.
- Topup
Builder - TopupId
- Transfer
- A
Transfer
object is created when you move funds between Stripe accounts as part of Connect. - Transfer
Builder - Transfer
Data - Transfer
Data Builder - Transfer
Id - Transfer
Reversal - Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform’s balance and subtract from the destination account’s balance.
- Transfer
Reversal Builder - Transfer
Reversal Id - Transfer
Schedule - Transfer
Schedule Builder - Transform
Quantity - Transform
Quantity Builder - Transform
Usage - Transform
Usage Builder - UsBank
Account Networks - UsBank
Account Networks Builder
Enums§
- Account
Business Profile Minority Owned Business Designation - Whether the business is a minority-owned, women-owned, and/or LGBTQI+-owned business.
- Account
Business Type - Account
Capabilities Status - Account
Capability Future Requirements Disabled Reason - This is typed as an enum for consistency with
requirements.disabled_reason
, but it safe to assumefuture_requirements.disabled_reason
is null because fields infuture_requirements
will never disable the account. - Account
Capability Requirements Disabled Reason - Description of why the capability is disabled. Learn more about handling verification issues.
- Account
Future Requirements Disabled Reason - This is typed as an enum for consistency with
requirements.disabled_reason
. - Account
Invoices Settings Hosted Payment Method Save - Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
- Account
Requirements Disabled Reason - If the account is disabled, this enum describes why. Learn more about handling verification issues.
- Account
Requirements Error Code - The code for the type of error.
- Account
Type - The Stripe account type. Can be
standard
,express
,custom
, ornone
. - Account
Unification Account Controller Fees Payer - A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts.
- Account
Unification Account Controller Losses Payments - A value indicating who is liable when this account can’t pay back negative balances from payments.
- Account
Unification Account Controller Requirement Collection - A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
- Account
Unification Account Controller Stripe Dashboard Type - A value indicating the Stripe dashboard this account has access to independent of the Connect application.
- Account
Unification Account Controller Type - The controller type.
Can be
application
, if a Connect application controls the account, oraccount
, if the account controls itself. - Amazon
PayUnderlying Payment Method Funding Details Type - funding type of the underlying payment method.
- ApiErrors
Code - For some errors that could be handled programmatically, a short string indicating the error code reported.
- ApiErrors
Type - The type of error returned.
One of
api_error
,card_error
,idempotency_error
, orinvalid_request_error
. - Automatic
TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Automatic
TaxStatus - The status of the most recent automated tax calculation for this invoice.
- Balance
Transaction Source - The resource representing a Stripe Polymorphic
- Balance
Transaction Type - Transaction type:
adjustment
,advance
,advance_funding
,anticipation_repayment
,application_fee
,application_fee_refund
,charge
,climate_order_purchase
,climate_order_refund
,connect_collection_transfer
,contribution
,issuing_authorization_hold
,issuing_authorization_release
,issuing_dispute
,issuing_transaction
,obligation_outbound
,obligation_reversal_inbound
,payment
,payment_failure_refund
,payment_network_reserve_hold
,payment_network_reserve_release
,payment_refund
,payment_reversal
,payment_unreconciled
,payout
,payout_cancel
,payout_failure
,payout_minimum_balance_hold
,payout_minimum_balance_release
,refund
,refund_failure
,reserve_transaction
,reserved_funds
,stripe_fee
,stripe_fx_fee
,stripe_balance_payment_debit
,stripe_balance_payment_debit_reversal
,tax_fee
,topup
,topup_reversal
,transfer
,transfer_cancel
,transfer_failure
, ortransfer_refund
. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considerreporting_category
instead. - Bank
Account 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. - Billing
Bill Resource Invoicing Lines Parents Invoice Line Item Parent Type - The type of parent that generated this line item
- Billing
Bill Resource Invoicing Parents Invoice Parent Type - The type of parent that generated this invoice
- Billing
Bill Resource Invoicing Pricing Pricing Type - The type of the pricing details.
- Billing
Bill Resource Invoicing Taxes TaxTax Behavior - Whether this tax is inclusive or exclusive.
- Billing
Bill Resource Invoicing Taxes TaxTaxability Reason - 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.
- Billing
Bill Resource Invoicing Taxes TaxType - The type of tax information.
- Billing
Credit Balance Transaction Type - The type of credit balance transaction (credit or debit).
- Billing
Credit Grant Category - Billing
Credit Grants Resource Amount Type - The type of this amount. We currently only support
monetary
billing credits. - Billing
Credit Grants Resource Balance Credit Type - The type of credit transaction.
- Billing
Credit Grants Resource Balance Debit Type - The type of debit transaction.
- Billing
Credit Grants Resource Scope Price Type - The price type that credit grants can apply to.
We currently only support the
metered
price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination withprices
. - Cancellation
Details Feedback - The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
- Cancellation
Details Reason - Why this subscription was canceled.
- Capability
Status - The status of the capability.
- Card
Allow Redisplay - This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
- Card
Available Payout Methods - A set of available payout methods for this card.
Only values from this set should be passed as the
method
when creating a payout. - Card
Regulated Status - Status of a card based on the card issuer.
- Charge
Outcome Advice Code - An enumerated value providing a more detailed explanation on how to proceed with an error.
- Charge
Status - The status of the payment is either
succeeded
,pending
, orfailed
. - Checkout
Acss Debit Mandate Options Default For - List of Stripe products where this mandate can be selected automatically.
Returned when the Session is in
setup
mode. - Checkout
Acss Debit Mandate Options Payment Schedule - Payment schedule for the mandate.
- Checkout
Acss Debit Mandate Options Transaction Type - Transaction type of the mandate.
- Checkout
Acss Debit Payment Method Options Currency - Currency supported by the bank account. Returned when the Session is in
setup
mode. - Checkout
Acss Debit Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Acss Debit Payment Method Options Verification Method - Bank account verification method.
- Checkout
Affirm Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Afterpay Clearpay Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Alipay Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Amazon PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
AuBecs Debit Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Bacs Debit Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Bancontact Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Boleto Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Card Payment Method Options Request Extended Authorization - Request ability to capture beyond the standard authorization validity window for this CheckoutSession.
- Checkout
Card Payment Method Options Request Incremental Authorization - Request ability to increment the authorization for this CheckoutSession.
- Checkout
Card Payment Method Options Request Multicapture - Request ability to make multiple captures for this CheckoutSession.
- Checkout
Card Payment Method Options Request Overcapture - Request ability to overcapture for this CheckoutSession.
- Checkout
Card Payment Method Options Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. - Checkout
Card Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Cashapp Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Customer Balance Bank Transfer Payment Method Options Requested Address Types - List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
- Checkout
Customer Balance Bank Transfer Payment Method Options Type - The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include:
eu_bank_transfer
,gb_bank_transfer
,jp_bank_transfer
,mx_bank_transfer
, orus_bank_transfer
. - Checkout
Customer Balance Payment Method Options Funding Type - The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include:
bank_transfer
. - Checkout
Customer Balance Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
EpsPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
FpxPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Giropay Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Grab PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Ideal Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Kakao PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
Kakao PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Klarna Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Konbini Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
KrCard Payment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
KrCard Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Link Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Link Wallet Options Display - Describes whether Checkout should display Link. Defaults to
auto
. - Checkout
Mobilepay Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Multibanco Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Naver PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
Oxxo Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
P24Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Payco Payment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
Paynow Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Paypal Payment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
Paypal Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Revolut PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Samsung PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Checkout
Sepa Debit Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
Session Billing Address Collection - Checkout
Session Customer Creation - Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
- Checkout
Session Locale - Checkout
Session Mode - Checkout
Session Payment Method Collection - Configure whether a Checkout Session should collect a payment method. Defaults to
always
. - Checkout
Session Payment Status - The payment status of the Checkout Session, one of
paid
,unpaid
, orno_payment_required
. You can use this value to decide when to fulfill your customer’s order. - Checkout
Session Redirect OnCompletion - Checkout
Session Status - Checkout
Session Submit Type - Checkout
Session UiMode - Checkout
Sofort Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
UsBank Account Payment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Checkout
UsBank Account Payment Method Options Verification Method - Bank account verification method.
- Connect
Account Reference Type - Type of the account referenced.
- Coupon
Duration - Credit
Note Line Item Type - The type of the credit note line item, one of
invoice_line_item
orcustom_line_item
. When the type isinvoice_line_item
there is an additionalinvoice_line_item
property on the resource the value of which is the id of the credited line item on the invoice. - Credit
Note Reason - Credit
Note Status - Status of this credit note, one of
issued
orvoid
. Learn more about voiding credit notes. - Credit
Note Type - Type of this credit note, one of
pre_payment
orpost_payment
. Apre_payment
credit note means it was issued when the invoice was open. Apost_payment
credit note means it was issued when the invoice was paid. - Credit
Notes Pretax Credit Amount Type - Type of the pretax credit amount referenced.
- Currency
Option TaxBehavior - Only required if a default tax behavior was not provided in the Stripe Tax settings.
Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
One of
inclusive
,exclusive
, orunspecified
. Once specified as eitherinclusive
orexclusive
, it cannot be changed. - Customer
Acceptance Type - The mandate includes the type of customer acceptance information, such as:
online
oroffline
. - Customer
Balance Customer Balance Settings Reconciliation Mode - The configuration for how funds that land in the customer cash balance are reconciled.
- Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Resource UsBank Transfer Network - The banking network used for this funding.
- Customer
Balance Resource Cash Balance Transaction Resource Funded Transaction Resource Bank Transfer Type - The funding method type used to fund the customer balance.
Permitted values include:
eu_bank_transfer
,gb_bank_transfer
,jp_bank_transfer
,mx_bank_transfer
, orus_bank_transfer
. - Customer
Balance Transaction Type - Transaction type:
adjustment
,applied_to_invoice
,credit_note
,initial
,invoice_overpaid
,invoice_too_large
,invoice_too_small
,unspent_receiver_credit
,unapplied_from_invoice
,checkout_session_subscription_payment
, orcheckout_session_subscription_payment_canceled
. See the Customer Balance page to learn more about transaction types. - Customer
Cash Balance Transaction Type - The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
- Customer
TaxAutomatic Tax - Surfaces if automatic tax computation is possible given the current customer location information.
- Customer
TaxExempt - Customer
TaxLocation Source - The data source used to infer the customer’s location.
- Deleted
External Account - The resource representing a Stripe Polymorphic
- Deleted
Payment Source - The resource representing a Stripe Polymorphic
- Dispute
Enhanced Eligibility Types - List of eligibility types that are included in
enhanced_evidence
. - Dispute
Enhanced Eligibility Visa Compelling Evidence3 Required Actions - List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
- Dispute
Enhanced Eligibility Visa Compelling Evidence3 Status - Visa Compelling Evidence 3.0 eligibility status.
- Dispute
Enhanced Eligibility Visa Compliance Status - Visa compliance eligibility status.
- Dispute
Payment Method Details Amazon PayDispute Type - The AmazonPay dispute type, chargeback or claim
- Dispute
Payment Method Details Card Case Type - The type of dispute opened. Different case types may have varying fees and financial impact.
- Dispute
Payment Method Details Type - Payment method type.
- Dispute
Status - Current status of dispute.
Possible values are
warning_needs_response
,warning_under_review
,warning_closed
,needs_response
,under_review
,won
, orlost
. - Dispute
Visa Compelling Evidence3 Disputed Transaction Merchandise OrServices - Categorization of disputed payment.
- Event
Type - Description of the event (for example,
invoice.created
orcharge.refunded
). - External
Account - The resource representing a Stripe Polymorphic
- File
Purpose - Funding
Instructions Bank Transfer Financial Address Supported Networks - The payment networks supported by this FinancialAddress
- Funding
Instructions Bank Transfer Financial Address Type - The type of financial address
- Funding
Instructions Bank Transfer Type - The bank_transfer type
- Funding
Instructions Funding Type - The
funding_type
of the returned instructions - Invoice
Billing Reason - Indicates the reason why the invoice was created.
- Invoice
Collection Method - Invoice
Customer TaxExempt - 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. - Invoice
Mandate Options Card Amount Type - One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. - Invoice
Payment Method Options Acss Debit Mandate Options Transaction Type - Transaction type of the mandate.
- Invoice
Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Invoice
Payment Method Options Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
- Invoice
Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
- Invoice
Payment Method Options Customer Balance Bank Transfer EuBank Transfer Country - The desired country code of the bank account information.
Permitted values include:
BE
,DE
,ES
,FR
,IE
, orNL
. - Invoice
Payment Method Options Customer Balance Funding Type - The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include:
bank_transfer
. - Invoice
Payment Method Options UsBank Account Linked Account Options Filters Account Subcategories - The account subcategories to use to filter for possible accounts to link.
Valid subcategories are
checking
andsavings
. - Invoice
Payment Method Options UsBank Account Linked Account Options Permissions - The list of permissions to request. The
payment_method
permission must be included. - Invoice
Payment Method Options UsBank Account Linked Account Options Prefetch - Data features requested to be retrieved upon account creation.
- Invoice
Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Invoice
Rendering PdfPage Size - 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.
- Invoice
Status - Invoices
Payment Settings Payment Method Types - 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.
- Invoices
Payments Invoice Payment Associated Payment Type - Type of payment object associated with this invoice payment.
- Invoices
Resource Invoice TaxId Type - 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
,tw_vat
,th_vat
,jp_cn
,jp_rn
,jp_trn
,li_uid
,li_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
, orunknown
. - Invoices
Resource Pretax Credit Amount Type - Type of the pretax credit amount referenced.
- Issuing
Authorization Authentication Exemption Claimed By - The entity that requested the exemption, either the acquiring merchant or the Issuing user.
- Issuing
Authorization Authentication Exemption Type - The specific exemption claimed for this authorization.
- Issuing
Authorization Authorization Method - Issuing
Authorization Fleet Data Purchase Type - The type of purchase.
- Issuing
Authorization Fleet Data Service Type - The type of fuel service.
- Issuing
Authorization Fraud Challenge Channel - The method by which the fraud challenge was delivered to the cardholder.
- Issuing
Authorization Fraud Challenge Status - The status of the fraud challenge.
- Issuing
Authorization Fraud Challenge Undeliverable Reason - If the challenge is not deliverable, the reason why.
- Issuing
Authorization Fuel Data Type - The type of fuel that was purchased.
- Issuing
Authorization Fuel Data Unit - The units for
quantity_decimal
. - Issuing
Authorization Request Reason - When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
- Issuing
Authorization Status - Issuing
Authorization ThreeD Secure Result - The outcome of the 3D Secure authentication request.
- Issuing
Authorization Verification Data Address Line1 Check - Whether the cardholder provided an address first line and if it matched the cardholder’s
billing.address.line1
. - Issuing
Authorization Verification Data Address Postal Code Check - Whether the cardholder provided a postal code and if it matched the cardholder’s
billing.address.postal_code
. - Issuing
Authorization Verification Data CvcCheck - Whether the cardholder provided a CVC and if it matched Stripe’s record.
- Issuing
Authorization Verification Data Expiry Check - Whether the cardholder provided an expiry date and if it matched Stripe’s record.
- Issuing
Card Apple PayIneligible Reason - Reason the card is ineligible for Apple Pay
- Issuing
Card Authorization Controls Allowed Categories - Array of strings containing categories of authorizations to allow.
All other categories will be blocked.
Cannot be set with
blocked_categories
. - Issuing
Card Authorization Controls Blocked Categories - Array of strings containing categories of authorizations to decline.
All other categories will be allowed.
Cannot be set with
allowed_categories
. - Issuing
Card Cancellation Reason - The reason why the card was canceled.
- Issuing
Card Google PayIneligible Reason - Reason the card is ineligible for Google Pay
- Issuing
Card Replacement Reason - Issuing
Card Shipping Address Validation Mode - The address validation capabilities to use.
- Issuing
Card Shipping Address Validation Result - The validation result for the shipping address.
- Issuing
Card Shipping Carrier - The delivery company that shipped a card.
- Issuing
Card Shipping Service - Shipment service, such as
standard
orexpress
. - Issuing
Card Shipping Status - The delivery status of the card.
- Issuing
Card Shipping Type - Packaging options.
- Issuing
Card Spending Limit Categories - Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
- Issuing
Card Spending Limit Interval - Interval (or event) to which the amount applies.
- Issuing
Card Status - Issuing
Card Type - Issuing
Cardholder Authorization Controls Allowed Categories - Array of strings containing categories of authorizations to allow.
All other categories will be blocked.
Cannot be set with
blocked_categories
. - Issuing
Cardholder Authorization Controls Blocked Categories - Array of strings containing categories of authorizations to decline.
All other categories will be allowed.
Cannot be set with
allowed_categories
. - Issuing
Cardholder Preferred Locales - Issuing
Cardholder Requirements Disabled Reason - If
disabled_reason
is present, all cards will decline authorizations withcardholder_verification_required
reason. - Issuing
Cardholder Requirements Past Due - Array of fields that need to be collected in order to verify and re-enable the cardholder.
- Issuing
Cardholder Spending Limit Categories - Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
- Issuing
Cardholder Spending Limit Interval - Interval (or event) to which the amount applies.
- Issuing
Cardholder Status - Issuing
Cardholder Type - Issuing
Dispute Canceled Evidence Product Type - Whether the product was a merchandise or service.
- Issuing
Dispute Canceled Evidence Return Status - Result of cardholder’s attempt to return the product.
- Issuing
Dispute Evidence Reason - The reason for filing the dispute. Its value will match the field containing the evidence.
- Issuing
Dispute Loss Reason - The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
- Issuing
Dispute Merchandise NotAs Described Evidence Return Status - Result of cardholder’s attempt to return the product.
- Issuing
Dispute NotReceived Evidence Product Type - Whether the product was a merchandise or service.
- Issuing
Dispute Other Evidence Product Type - Whether the product was a merchandise or service.
- Issuing
Dispute Status - Issuing
Network Token Device Type - The type of device used for tokenization.
- Issuing
Network Token Network Data Type - The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
- Issuing
Network Token Wallet Provider Card Number Source - The method used for tokenizing a card.
- Issuing
Network Token Wallet Provider Reason Codes - The reasons for suggested tokenization given by the card network.
- Issuing
Network Token Wallet Provider Suggested Decision - The recommendation on responding to the tokenization request.
- Issuing
Personalization Design Rejection Reasons Card Logo - The reason(s) the card logo was rejected.
- Issuing
Personalization Design Rejection Reasons Carrier Text - The reason(s) the carrier text was rejected.
- Issuing
Personalization Design Status - Issuing
Physical Bundle Features Card Logo - The policy for how to use card logo images in a card design with this physical bundle.
- Issuing
Physical Bundle Features Carrier Text - The policy for how to use carrier letter text in a card design with this physical bundle.
- Issuing
Physical Bundle Features Second Line - The policy for how to use a second line on a card with this physical bundle.
- Issuing
Physical Bundle Status - Issuing
Physical Bundle Type - Issuing
Token Network - The token service provider / card network associated with the token.
- Issuing
Token Status - Issuing
Token Wallet Provider - The digital wallet for this token, if one was used.
- Issuing
Transaction Type - Issuing
Transaction Wallet - The digital wallet used for this transaction. One of
apple_pay
,google_pay
, orsamsung_pay
. - Legal
Entity Company Ownership Exemption Reason - This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details.
- Legal
Entity Company Structure - The category identifying the legal structure of the company or legal entity.
Also available for accounts where controller.requirement_collection is
stripe
. See Business structure for more details. - Line
Items TaxAmount Taxability Reason - 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.
- Linked
Account Options Common Permissions - The list of permissions to request. The
payment_method
permission must be included. - Linked
Account Options Common Prefetch - Data features requested to be retrieved upon account creation.
- Mandate
Acss Debit Default For - List of Stripe products where this mandate can be selected automatically.
- Mandate
Acss Debit Payment Schedule - Payment schedule for the mandate.
- Mandate
Acss Debit Transaction Type - Transaction type of the mandate.
- Mandate
Bacs Debit Network Status - The status of the mandate on the Bacs network.
Can be one of
pending
,revoked
,refused
, oraccepted
. - Mandate
Bacs Debit Revocation Reason - When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
- Mandate
Status - The mandate status indicates whether or not you can use it to initiate a payment.
- Mandate
Type - The type of the mandate.
- Mandate
UsBank Account Collection Method - Mandate collection method
- Payment
Flows Automatic Payment Methods Payment Intent Allow Redirects - Controls whether this PaymentIntent will accept redirect-based payment methods.
- Payment
Flows Automatic Payment Methods Setup Intent Allow Redirects - Controls whether this SetupIntent will accept redirect-based payment methods.
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Extended Authorization Extended Authorization Status - Indicates whether or not the capture window is extended beyond the standard authorization.
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Incremental Authorization Incremental Authorization Status - Indicates whether or not the incremental authorization feature is supported.
- Payment
Flows Private Payment Methods Card Details ApiResource Enterprise Features Overcapture Overcapture Status - Indicates whether or not the authorized amount can be over-captured.
- Payment
Flows Private Payment Methods Card Details ApiResource Multicapture Status - Indicates whether or not multiple captures are supported.
- Payment
Flows Private Payment Methods Card Present Common Wallet Type - The type of mobile wallet, one of
apple_pay
,google_pay
,samsung_pay
, orunknown
. - Payment
Flows Private Payment Methods Financial Connections Common Linked Account Options Filters Account Subcategories - The account subcategories to use to filter for possible accounts to link.
Valid subcategories are
checking
andsavings
. - Payment
Flows Private Payment Methods Kakao PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Kakao PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Flows Private Payment Methods Naver PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Naver PayPayment Method Options Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Flows Private Payment Methods Payco Payment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Flows Private Payment Methods Samsung PayPayment Method Options Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Cancellation Reason - Reason for cancellation of this PaymentIntent, either user-provided (
duplicate
,fraudulent
,requested_by_customer
, orabandoned
) or generated by Stripe internally (failed_invoice
,void_invoice
,automatic
, orexpired
). - Payment
Intent Capture Method - Payment
Intent Confirmation Method - Payment
Intent Next Action Display Bank Transfer Instructions Type - Type of bank transfer
- Payment
Intent Next Action Verify With Microdeposits Microdeposit Type - The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
- Payment
Intent Payment Method Options Acss Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Payment
Intent Payment Method Options AuBecs Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Bacs Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Blik Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Card Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Card Network - Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.
- Payment
Intent Payment Method Options Card Request Extended Authorization - Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Incremental Authorization - Request ability to increment the authorization for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Multicapture - Request ability to make multiple captures for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request Overcapture - Request ability to overcapture for this PaymentIntent.
- Payment
Intent Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. - Payment
Intent Payment Method Options Card Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options EpsSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Link Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Link Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Mandate Options Acss Debit Payment Schedule - Payment schedule for the mandate.
- Payment
Intent Payment Method Options Mandate Options Acss Debit Transaction Type - Transaction type of the mandate.
- Payment
Intent Payment Method Options Mobilepay Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Intent Payment Method Options Mobilepay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options NzBank Account Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Sepa Debit Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options Swish Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options UsBank Account Preferred Settlement Speed - Preferred transaction settlement speed
- Payment
Intent Payment Method Options UsBank Account Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Intent Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Payment
Intent Processing Type - Type of the payment method for which payment is in
processing
state, one ofcard
. - Payment
Intent Setup Future Usage - Payment
Intent Status - Status of this PaymentIntent, one of
requires_payment_method
,requires_confirmation
,requires_action
,processing
,requires_capture
,canceled
, orsucceeded
. Read more about each PaymentIntent status. - Payment
Link Billing Address Collection - Payment
Link Customer Creation - Configuration for Customer creation during checkout.
- Payment
Link Payment Method Collection - Configuration for collecting a payment method during checkout. Defaults to
always
. - Payment
Link Payment Method Types - Payment
Link Submit Type - Payment
Links Resource After Completion Type - The specified behavior after the purchase is complete.
- Payment
Links Resource Consent Collection Promotions - If set to
auto
, enables the collection of customer consent for promotional communications. - Payment
Links Resource Consent Collection Terms OfService - If set to
required
, it requires cutomers to accept the terms of service before being able to pay. If set tonone
, customers won’t be shown a checkbox to accept the terms of service. - Payment
Links Resource Custom Fields Label Type - The type of the label.
- Payment
Links Resource Custom Fields Type - The type of the field.
- Payment
Links Resource Payment Intent Data Capture Method - Indicates when the funds will be captured from the customer’s account.
- Payment
Links Resource Payment Intent Data Setup Future Usage - Indicates that you intend to make future payments with the payment method collected during checkout.
- Payment
Links Resource Payment Method Reuse Agreement Position - Determines the position and visibility of the payment method reuse agreement in the UI.
When set to
auto
, Stripe’s defaults will be used. - Payment
Links Resource Shipping Address Collection Allowed Countries - An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.
Unsupported country codes:
AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI
. - Payment
Links Resource TaxId Collection Required - Payment
Method Allow Redisplay - Payment
Method Card Present Read Method - How card details were read in this transaction.
- Payment
Method Card Regulated Status - Status of a card based on the card issuer.
- Payment
Method Card Wallet Type - The type of the card wallet, one of
amex_express_checkout
,apple_pay
,google_pay
,masterpass
,samsung_pay
,visa_checkout
, orlink
. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - Payment
Method Details AchDebit Account Holder Type - Type of entity that holds the account. This can be either
individual
orcompany
. - Payment
Method Details Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of
en
,de
,fr
, ornl
- Payment
Method Details Card Installments Plan Interval - For
fixed_count
installment plans, this is the interval between installment payments your customer will make to their credit card. One ofmonth
. - Payment
Method Details Card Installments Plan Type - Type of installment plan, one of
fixed_count
. - Payment
Method Details Card Present Offline Type - The method used to process this payment method offline. Only deferred is allowed.
- Payment
Method Details Card Present Read Method - How card details were read in this transaction.
- Payment
Method Details Card Present Receipt Account Type - The type of account being debited or credited
- Payment
Method Details Card Regulated Status - Status of a card based on the card issuer.
- Payment
Method Details Card Wallet Type - The type of the card wallet, one of
amex_express_checkout
,apple_pay
,google_pay
,masterpass
,samsung_pay
,visa_checkout
, orlink
. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - Payment
Method Details EpsBank - 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
,deutsche_bank_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
, orvr_bank_braunau
. - Payment
Method Details FpxAccount Holder Type - Account holder type, if provided. Can be one of
individual
orcompany
. - Payment
Method Details FpxBank - The customer’s bank.
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
,pb_enterprise
, orbank_of_china
. - Payment
Method Details Ideal Bank - The customer’s bank.
Can be one of
abn_amro
,asn_bank
,bunq
,handelsbanken
,ing
,knab
,moneyou
,n26
,nn
,rabobank
,regiobank
,revolut
,sns_bank
,triodos_bank
,van_lanschot
, oryoursafe
. - Payment
Method Details Ideal Bic - The Bank Identifier Code of the customer’s bank.
- Payment
Method Details Interac Present Read Method - How card details were read in this transaction.
- Payment
Method Details Interac Present Receipt Account Type - The type of account being debited or credited
- Payment
Method Details Konbini Store Chain - The name of the convenience store chain where the payment was completed.
- Payment
Method Details KrCard Brand - The local credit or debit card brand.
- Payment
Method Details P24Bank - The customer’s bank.
Can be one of
ing
,citi_handlowy
,tmobile_usbugi_bankowe
,plus_bank
,etransfer_pocztowy24
,banki_spbdzielcze
,bank_nowy_bfg_sa
,getin_bank
,velobank
,blik
,noble_pay
,ideabank
,envelobank
,santander_przelew24
,nest_przelew
,mbank_mtransfer
,inteligo
,pbac_z_ipko
,bnp_paribas
,credit_agricole
,toyota_bank
,bank_pekao_sa
,volkswagen_bank
,bank_millennium
,alior_bank
, orboz
. - Payment
Method Details Sofort Preferred Language - Preferred language of the SOFORT authorization page that the customer is redirected to.
Can be one of
de
,en
,es
,fr
,it
,nl
, orpl
- Payment
Method Details UsBank Account Account Holder Type - Account holder type: individual or company.
- Payment
Method Details UsBank Account Account Type - Account type: checkings or savings. Defaults to checking if omitted.
- Payment
Method EpsBank - 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
,deutsche_bank_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
, orvr_bank_braunau
. - Payment
Method FpxAccount Holder Type - Account holder type, if provided. Can be one of
individual
orcompany
. - Payment
Method FpxBank - 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
,pb_enterprise
, orbank_of_china
. - Payment
Method Ideal Bank - The customer’s bank, if provided.
Can be one of
abn_amro
,asn_bank
,bunq
,handelsbanken
,ing
,knab
,moneyou
,n26
,nn
,rabobank
,regiobank
,revolut
,sns_bank
,triodos_bank
,van_lanschot
, oryoursafe
. - Payment
Method Ideal Bic - The Bank Identifier Code of the customer’s bank, if the bank was provided.
- Payment
Method Interac Present Read Method - How card details were read in this transaction.
- Payment
Method KrCard Brand - The local credit or debit card brand.
- Payment
Method Naver PayFunding - Whether to fund this transaction with Naver Pay points or a card.
- Payment
Method Options Affirm Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Affirm Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Afterpay Clearpay Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Afterpay Clearpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Alipay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Alma Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Amazon PayCapture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Amazon PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
- Payment
Method Options Bancontact Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Boleto Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Card Mandate Options Amount Type - One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. - Payment
Method Options Card Mandate Options Interval - Specifies payment frequency. One of
day
,week
,month
,year
, orsporadic
. - Payment
Method Options Card Mandate Options Supported Types - Specifies the type of mandates supported. Possible values are
india
. - Payment
Method Options Card Present Routing Requested Priority - Requested routing priority
- Payment
Method Options Cashapp Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Cashapp Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Customer Balance Bank Transfer Requested Address Types - List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
- Payment
Method Options Customer Balance Bank Transfer Type - The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include:
eu_bank_transfer
,gb_bank_transfer
,jp_bank_transfer
,mx_bank_transfer
, orus_bank_transfer
. - Payment
Method Options Customer Balance EuBank Account Country - The desired country code of the bank account information.
Permitted values include:
BE
,DE
,ES
,FR
,IE
, orNL
. - Payment
Method Options Customer Balance Funding Type - The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include:
bank_transfer
. - Payment
Method Options Customer Balance Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options FpxSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Giropay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Grabpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Ideal Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Klarna Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Klarna Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Konbini Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options KrCard Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options KrCard Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Multibanco Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Oxxo Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options P24Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Paynow Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Paypal Capture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Paypal Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options PixSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Promptpay Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Revolut PayCapture Method - Controls when the funds will be captured from the customer’s account.
- Payment
Method Options Revolut PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Sofort Preferred Language - Preferred language of the SOFORT authorization page that the customer is redirected to.
- Payment
Method Options Sofort Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options Twint Setup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options UsBank Account Mandate Options Collection Method - Mandate collection method
- Payment
Method Options Wechat PayClient - The client type that the end customer will pay from
- Payment
Method Options Wechat PaySetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method Options ZipSetup Future Usage - Indicates that you intend to make future payments with this PaymentIntent’s payment method.
- Payment
Method P24Bank - The customer’s bank, if provided.
- Payment
Method Type - 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.
- Payment
Method UsBank Account Account Holder Type - Account holder type: individual or company.
- Payment
Method UsBank Account Account Type - Account type: checkings or savings. Defaults to checking if omitted.
- Payment
Method UsBank Account Blocked Network Code - The ACH network code that resulted in this block.
- Payment
Method UsBank Account Blocked Reason - The reason why this PaymentMethod’s fingerprint has been blocked
- Payment
Pages Checkout Session Automatic TaxStatus - The status of the most recent automated tax calculation for this session.
- Payment
Pages Checkout Session Consent Collection Promotions - If set to
auto
, enables the collection of customer consent for promotional communications. The Checkout. Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants. - Payment
Pages Checkout Session Consent Collection Terms OfService - If set to
required
, it requires customers to accept the terms of service before being able to pay. - Payment
Pages Checkout Session Consent Promotions - If
opt_in
, the customer consents to receiving promotional communications from the merchant about this Checkout Session. - Payment
Pages Checkout Session Consent Terms OfService - If
accepted
, the customer in this Checkout Session has agreed to the merchant’s terms of service. - Payment
Pages Checkout Session Custom Fields Label Type - The type of the label.
- Payment
Pages Checkout Session Custom Fields Type - The type of the field.
- Payment
Pages Checkout Session Customer Details TaxExempt - The customer’s tax exempt status after a completed Checkout Session.
- Payment
Pages Checkout Session Payment Method Reuse Agreement Position - Determines the position and visibility of the payment method reuse agreement in the UI.
When set to
auto
, Stripe’s defaults will be used. - Payment
Pages Checkout Session Permissions Update Shipping Details - Determines which entity is allowed to update the shipping details.
- Payment
Pages Checkout Session Saved Payment Method Options Allow Redisplay Filters - Uses the
allow_redisplay
value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. - Payment
Pages Checkout Session Saved Payment Method Options Payment Method Remove - Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
- Payment
Pages Checkout Session Saved Payment Method Options Payment Method Save - Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
- Payment
Pages Checkout Session Shipping Address Collection Allowed Countries - An array of two-letter ISO country codes representing which countries Checkout should provide as options for.
shipping locations.
Unsupported country codes:
AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI
. - Payment
Pages Checkout Session TaxId Collection Required - Indicates whether a tax ID is required on the payment page
- Payment
Pages Checkout Session TaxId Type - 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
,tw_vat
,th_vat
,jp_cn
,jp_rn
,jp_trn
,li_uid
,li_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
, orunknown
. - Payment
Pages Private Card Payment Method Options Resource Restrictions Brands Blocked - Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session.
- Payment
Source - The resource representing a Stripe Polymorphic
- Payout
Reconciliation Status - If
completed
, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. - Payout
Type - Can be
bank_account
orcard
. - Paypal
Seller Protection Dispute Categories - An array of conditions that are covered for the transaction, if applicable.
- Paypal
Seller Protection Status - Indicates whether the transaction is eligible for PayPal’s seller protection.
- Person
Ethnicity Details Ethnicity - The persons ethnicity
- Person
Political Exposure - Person
Race Details Race - The persons race.
- Plan
Billing Scheme - Plan
Interval - Plan
Tiers Mode - Plan
Usage Type - Platform
Earning FeeSource Type - Type of object that created the application fee.
- Price
Billing Scheme - Price
TaxBehavior - Price
Tiers Mode - Price
Type - Product
Type - Recurring
Interval - The frequency at which a subscription is billed. One of
day
,week
,month
oryear
. - Recurring
Usage Type - Configures how the quantity per period should be determined.
Can be either
metered
orlicensed
.licensed
automatically bills thequantity
set when adding it to a subscription.metered
aggregates the total usage based on usage records. Defaults tolicensed
. - Refund
Destination Details Card Type - The type of refund. This can be
refund
,reversal
, orpending
. - Refund
Pending Reason - Provides the reason for why the refund is pending.
Possible values are:
processing
,insufficient_funds
, orcharge_pending
. - Refund
Reason - Reason for the refund, which is either user-provided (
duplicate
,fraudulent
, orrequested_by_customer
) or generated by Stripe internally (expired_uncaptured_charge
). - Review
Closed Reason - The reason the review was closed, or null if it has not yet been closed.
One of
approved
,refunded
,refunded_as_fraud
,disputed
,redacted
, orcanceled
. - Review
Opened Reason - The reason the review was opened. One of
rule
ormanual
. - Revolut
PayUnderlying Payment Method Funding Details Type - funding type of the underlying payment method.
- Schedules
Phase Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Setup
Attempt Flow Directions - Indicates the directions of money movement for which this payment method is intended to be used.
- Setup
Attempt Payment Method Details Bancontact Preferred Language - Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of
en
,de
,fr
, ornl
- Setup
Attempt Payment Method Details Card Wallet Type - The type of the card wallet, one of
apple_pay
,google_pay
, orlink
. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. - Setup
Attempt Payment Method Details Ideal Bank - The customer’s bank.
Can be one of
abn_amro
,asn_bank
,bunq
,handelsbanken
,ing
,knab
,moneyou
,n26
,nn
,rabobank
,regiobank
,revolut
,sns_bank
,triodos_bank
,van_lanschot
, oryoursafe
. - Setup
Attempt Payment Method Details Ideal Bic - The Bank Identifier Code of the customer’s bank.
- Setup
Attempt Payment Method Details Sofort Preferred Language - Preferred language of the Sofort authorization page that the customer is redirected to.
Can be one of
en
,de
,fr
, ornl
- Setup
Intent Cancellation Reason - Setup
Intent Flow Directions - Setup
Intent Next Action Verify With Microdeposits Microdeposit Type - The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
- Setup
Intent Payment Method Options Acss Debit Currency - Currency supported by the bank account
- Setup
Intent Payment Method Options Acss Debit Verification Method - Bank account verification method.
- Setup
Intent Payment Method Options Card Mandate Options Amount Type - One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param. - Setup
Intent Payment Method Options Card Mandate Options Interval - Specifies payment frequency. One of
day
,week
,month
,year
, orsporadic
. - Setup
Intent Payment Method Options Card Mandate Options Supported Types - Specifies the type of mandates supported. Possible values are
india
. - Setup
Intent Payment Method Options Card Network - Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
- Setup
Intent Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. - Setup
Intent Payment Method Options Mandate Options Acss Debit Default For - List of Stripe products where this mandate can be selected automatically.
- Setup
Intent Payment Method Options Mandate Options Acss Debit Payment Schedule - Payment schedule for the mandate.
- Setup
Intent Payment Method Options Mandate Options Acss Debit Transaction Type - Transaction type of the mandate.
- Setup
Intent Payment Method Options UsBank Account Verification Method - Bank account verification method.
- Setup
Intent Status - Status of this SetupIntent, one of
requires_payment_method
,requires_confirmation
,requires_action
,processing
,canceled
, orsucceeded
. - Shipping
Rate Currency Option TaxBehavior - Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
One of
inclusive
,exclusive
, orunspecified
. - Shipping
Rate Delivery Estimate Bound Unit - A unit of time.
- Shipping
Rate TaxBehavior - Shipping
Rate Type - Source
Allow Redisplay - This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
- Source
Transaction Type - The type of source this transaction is attached to.
- Source
Type - The
type
of the source. Thetype
is a payment method, one ofach_credit_transfer
,ach_debit
,alipay
,bancontact
,card
,card_present
,eps
,giropay
,ideal
,multibanco
,klarna
,p24
,sepa_debit
,sofort
,three_d_secure
, orwechat
. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used. - Subscription
Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Subscription
Collection Method - Subscription
Payment Method Options Card Network - Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
- Subscription
Payment Method Options Card Request ThreeD Secure - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
- Subscription
Pending Invoice Item Interval Interval - Specifies invoicing frequency. Either
day
,week
,month
oryear
. - Subscription
Schedule EndBehavior - Subscription
Schedule Phase Configuration Billing Cycle Anchor - Possible values are
phase_start
orautomatic
. Ifphase_start
then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. Ifautomatic
then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation. - Subscription
Schedule Phase Configuration Collection Method - Either
charge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription asactive
. - Subscription
Schedule Phase Configuration Proration Behavior - If the subscription schedule will prorate when transitioning to this phase.
Possible values are
create_prorations
andnone
. - Subscription
Schedule Status - The present status of the subscription schedule.
Possible values are
not_started
,active
,completed
,released
, andcanceled
. You can read more about the different states in our behavior guide. - Subscription
Schedules Resource Default Settings Automatic TaxDisabled Reason - If Stripe disabled automatic tax, this enum describes why.
- Subscription
Schedules Resource Default Settings Billing Cycle Anchor - Possible values are
phase_start
orautomatic
. Ifphase_start
then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. Ifautomatic
then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation. - Subscription
Schedules Resource Default Settings Collection Method - Either
charge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription asactive
. - Subscription
Status - Possible values are
incomplete
,incomplete_expired
,trialing
,active
,past_due
,canceled
,unpaid
, orpaused
. - Subscriptions
Resource Pause Collection Behavior - The payment collection behavior for this subscription while paused.
One of
keep_as_draft
,mark_uncollectible
, orvoid
. - Subscriptions
Resource Payment Settings Payment Method Types - The list of payment method types to provide to every invoice created by the subscription. 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.
- Subscriptions
Resource Payment Settings Save Default Payment Method - Configure whether Stripe updates
subscription.default_payment_method
when payment succeeds. Defaults tooff
. - Subscriptions
Trials Resource EndBehavior Missing Payment Method - Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
- TaxI
DsOwner Type - Type of owner referenced.
- TaxId
Type - Type of the tax ID, one of
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
,gb_vat
,ge_vat
,gn_nif
,hk_br
,hr_oib
,hu_tin
,id_npwp
,il_vat
,in_gst
,is_vat
,jp_cn
,jp_rn
,jp_trn
,ke_pin
,kg_tin
,kh_tin
,kr_brn
,kz_bin
,la_tin
,li_uid
,li_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
,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
,us_ein
,uy_ruc
,uz_tin
,uz_vat
,ve_rif
,vn_tin
,za_vat
,zm_tin
, orzw_tin
. Note that some legacy tax IDs have typeunknown
. - TaxId
Verification Status - Verification status, one of
pending
,verified
,unverified
, orunavailable
. - TaxRate
Jurisdiction Level - The level of the jurisdiction that imposes this tax rate.
Will be
null
for manually defined tax rates. - TaxRate
Rate Type - Indicates the type of tax rate applied to the taxable amount.
This value can be
null
when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. - TaxRate
TaxType - Test
Helpers Test Clock Status - The status of the Test Clock.
- ThreeD
Secure Details Authentication Flow - For authenticated transactions: how the customer was authenticated by the issuing bank.
- ThreeD
Secure Details Charge Authentication Flow - For authenticated transactions: how the customer was authenticated by the issuing bank.
- ThreeD
Secure Details Charge Electronic Commerce Indicator - The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
- ThreeD
Secure Details Charge Exemption Indicator - The exemption requested via 3DS and accepted by the issuer at authentication time.
- ThreeD
Secure Details Charge Result - Indicates the outcome of 3D Secure authentication.
- ThreeD
Secure Details Charge Result Reason - Additional information about why 3D Secure succeeded or failed based
on the
result
. - ThreeD
Secure Details Charge Version - The version of 3D Secure that was used.
- ThreeD
Secure Details Electronic Commerce Indicator - The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
- ThreeD
Secure Details Result - Indicates the outcome of 3D Secure authentication.
- ThreeD
Secure Details Result Reason - Additional information about why 3D Secure succeeded or failed based
on the
result
. - ThreeD
Secure Details Version - The version of 3D Secure that was used.
- Topup
Status - The status of the top-up is either
canceled
,failed
,pending
,reversed
, orsucceeded
. - Transform
Quantity Round - After division, either round the result
up
ordown
. - Transform
Usage Round - After division, either round the result
up
ordown
. - UsBank
Account Networks Supported - All supported networks.