All Classes and Interfaces
Class
Description
This is an object representing a Stripe account.
A Financial Connections Account represents an account that exists outside of Stripe, to which you
have been granted some degree of access.
For more details about AccountHolder, please refer to the API Reference.
For more details about Balance, please refer to the API
Reference.
For more details about Cash, please refer to the API
Reference.
For more details about Credit, please refer to the API
Reference.
For more details about BalanceRefresh, please refer to the API Reference.
For more details about BusinessProfile, please refer to the API Reference.
For more details about AnnualRevenue, please refer to the API Reference.
For more details about MonthlyEstimatedRevenue, please refer to the API Reference.
For more details about Capabilities, please refer to the API Reference.
For more details about Company, please refer to the API
Reference.
For more details about AddressKana, please refer to the API Reference.
For more details about AddressKanji, please refer to the API Reference.
For more details about DirectorshipDeclaration, please refer to the API Reference.
For more details about OwnershipDeclaration, please refer to the API Reference.
For more details about Verification, please refer to the API Reference.
For more details about Document, please refer to the API Reference.
For more details about Configuration, please refer to the API Reference.
For more details about Customer, please refer to the API Reference.
For more details about AutomaticIndirectTax, please refer to the API Reference.
For more details about Location, please refer to the API Reference.
For more details about Billing, please refer to the API Reference.
For more details about Invoice, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about Rendering, please refer to the API Reference.
For more details about Capabilities, please refer to the API Reference.
For more details about AutomaticIndirectTax, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about Shipping, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about Merchant, please refer to the API Reference.
For more details about BacsDebitPayments, please refer to the API Reference.
For more details about Branding, please refer to the API Reference.
For more details about Capabilities, please refer to the API Reference.
For more details about AchDebitPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AcssDebitPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AffirmPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AfterpayClearpayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AlmaPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AmazonPayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about AuBecsDebitPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about BacsDebitPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about BancontactPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about BlikPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about BoletoPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about CardPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about CartesBancairesPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about CashappPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about EpsPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about FpxPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about GbBankTransferPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about GrabpayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about IdealPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about JcbPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about JpBankTransferPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about KakaoPayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about KlarnaPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about KonbiniPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about KrCardPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about LinkPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about MobilepayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about MultibancoPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about MxBankTransferPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about NaverPayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about OxxoPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about P24Payments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about PayByBankPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about PaycoPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about PaynowPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about PromptpayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about RevolutPayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about SamsungPayPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about SepaBankTransferPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about SepaDebitPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about SwishPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about TwintPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about UsBankTransferPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about ZipPayments, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about CardPayments, please refer to the API Reference.
For more details about DeclineOn, please refer to the API Reference.
For more details about SepaDebitPayments, please refer to the API Reference.
For more details about StatementDescriptor, please refer to the API Reference.
For more details about Support, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about Recipient, please refer to the API Reference.
For more details about Capabilities, please refer to the API Reference.
For more details about BankAccounts, please refer to the API Reference.
For more details about Local, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about Wire, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about Cards, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about StripeTransfers, please refer to the API Reference.
For more details about StatusDetail, please refer to the API Reference.
For more details about DefaultOutboundDestination, please refer to the API Reference.
For more details about Controller, please refer to the API Reference.
For more details about Application, please refer to the API Reference.
For more details about Dashboard, please refer to the API Reference.
For more details about Fees, please refer to the API
Reference.
For more details about Losses, please refer to the API
Reference.
For more details about StripeDashboard, please refer to the API Reference.
For more details about Defaults, please refer to the API
Reference.
For more details about Responsibilities, please refer to the API Reference.
For more details about FutureRequirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about Groups, please refer to the API
Reference.
For more details about Identity, please refer to the API
Reference.
For more details about Attestations, please refer to the API Reference.
For more details about DirectorshipDeclaration, please refer to the API Reference.
For more details about OwnershipDeclaration, please refer to the API Reference.
For more details about PersonsProvided, please refer to the API Reference.
For more details about TermsOfService, please refer to the API Reference.
For more details about InnerAccount, please refer to the API Reference.
For more details about BusinessDetails, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about AnnualRevenue, please refer to the API Reference.
For more details about Documents, please refer to the API Reference.
For more details about BankAccountOwnershipVerification, please refer to the API Reference.
For more details about CompanyLicense, please refer to the API Reference.
For more details about CompanyMemorandumOfAssociation, please refer to the API Reference.
For more details about CompanyMinisterialDecree, please refer to the API Reference.
For more details about CompanyRegistrationVerification, please refer to the API Reference.
For more details about CompanyTaxIdVerification, please refer to the API Reference.
For more details about PrimaryVerification, please refer to the API Reference.
For more details about FrontBack, please refer to the API Reference.
For more details about ProofOfRegistration, please refer to the API Reference.
For more details about ProofOfUltimateBeneficialOwnership, please refer to the API Reference.
For more details about IdNumber, please refer to the API Reference.
For more details about MonthlyEstimatedRevenue, please refer to the API Reference.
For more details about ScriptAddresses, please refer to the API Reference.
For more details about Kana, please refer to the API Reference.
For more details about Kanji, please refer to the API Reference.
For more details about ScriptNames, please refer to the API Reference.
For more details about Kana, please refer to the API Reference.
For more details about Kanji, please refer to the API Reference.
For more details about Individual, please refer to the API Reference.
For more details about AdditionalAddress, please refer to the API Reference.
For more details about AdditionalName, please refer to the API Reference.
For more details about AdditionalTermsOfService, please refer to the API Reference.
For more details about InnerAccount, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about DateOfBirth, please refer to the API Reference.
For more details about Documents, please refer to the API Reference.
For more details about CompanyAuthorization, please refer to the API Reference.
For more details about Passport, please refer to the API Reference.
For more details about PrimaryVerification, please refer to the API Reference.
For more details about FrontBack, please refer to the API Reference.
For more details about SecondaryVerification, please refer to the API Reference.
For more details about FrontBack, please refer to the API Reference.
For more details about Visa, please refer to the API Reference.
For more details about IdNumber, please refer to the API Reference.
For more details about Relationship, please refer to the API Reference.
For more details about ScriptAddresses, please refer to the API Reference.
For more details about Kana, please refer to the API Reference.
For more details about Kanji, please refer to the API Reference.
For more details about ScriptNames, please refer to the API Reference.
For more details about Kana, please refer to the API Reference.
For more details about Kanji, please refer to the API Reference.
For more details about InferredBalancesRefresh, please refer to the API Reference.
For more details about OwnershipRefresh, please refer to the API Reference.
For more details about Requirements, please refer to the API Reference.
For more details about Requirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Entry, please refer to the API
Reference.
For more details about Errors, please refer to the API Reference.
For more details about Impact, please refer to the API Reference.
For more details about RestrictsCapability, please refer to the API Reference.
For more details about Deadline, please refer to the API Reference.
For more details about RestrictsPayouts, please refer to the API Reference.
For more details about Deadline, please refer to the API Reference.
For more details about MinimumDeadline, please refer to the API Reference.
For more details about Reference, please refer to the API Reference.
For more details about RequestedReason, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about Summary, please refer to the API
Reference.
For more details about MinimumDeadline, please refer to the API Reference.
For more details about RiskControls, please refer to the API Reference.
For more details about Charges, please refer to the API
Reference.
For more details about Payouts, please refer to the API
Reference.
For more details about Settings, please refer to the API
Reference.
For more details about BacsDebitPayments, please refer to the API Reference.
For more details about BankBcaOnboarding, please refer to the API Reference.
For more details about Branding, please refer to the API Reference.
For more details about Capital, please refer to the API
Reference.
For more details about CardIssuing, please refer to the API Reference.
For more details about TosAcceptance, please refer to the API Reference.
For more details about CardPayments, please refer to the API Reference.
For more details about DeclineOn, please refer to the API Reference.
For more details about Dashboard, please refer to the API Reference.
For more details about Invoices, please refer to the API Reference.
For more details about Payments, please refer to the API Reference.
For more details about Payouts, please refer to the API
Reference.
For more details about Schedule, please refer to the API Reference.
For more details about SepaDebitPayments, please refer to the API Reference.
For more details about TaxForms, please refer to the API Reference.
For more details about Treasury, please refer to the API Reference.
For more details about TosAcceptance, please refer to the API Reference.
For more details about TosAcceptance, please refer to the API Reference.
For more details about TransactionRefresh, please refer to the API Reference.
State, county, province, or region.
Required. The close-out date of the preceding fiscal year in ISO 8601
format.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the account representative accepted their service
agreement.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
The user agent of the browser from which the directorship declaration attestation was
made.
The user agent of the browser from which the beneficial owner attestation was made.
ID of the invoice rendering template to use for future invoices.
Required. To request a new Capability for an account, pass true.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
A CSS hex color value representing the secondary branding color for the merchant.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Required. To request a new Capability for an account, pass true.
Add all map key/value pairs to `extraParams` map.
Default text that appears on statements for card charges outside of Japan, prefixing
any dynamic statement_descriptor_suffix specified on the charge.
Town or cho-me.
Whether the controller has pricing controls for this account.
Required. To request a new Capability for an account, pass true.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
The user agent of the browser from which the director attestation was made.
The user agent of the browser from which the beneficial owner attestation was made.
The user agent of the browser from which the Account's representative accepted the
terms of service.
The close-out date of the preceding fiscal year in ISO 8601 format.
Required. A file upload token
representing the front of the verification document.
Required. The format of the document.
Add all map key/value pairs to `extraParams` map.
Town or cho-me.
Registered name of the business.
Registered name of the business.
Required. The year of birth.
Required. A file upload token
representing the front of the verification document.
Required. A file upload token
representing the front of the verification document.
Required. The format of the document.
The person's last or family name.
The person's title (e.g., CEO, Support Engineer).
Town or cho-me.
The person's last or family name.
The group the account is in to determine their payments pricing, and null if the account is
on customized pricing.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
To request to pause a risk control, pass
true.To request to pause a risk control, pass
true.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A CSS hex color value representing the secondary branding color for this account.
Add all map key/value pairs to `payoutDestinationSelector` map.
The user agent of the browser from which the account representative accepted the
service agreement.
Add all map key/value pairs to `extraParams` map.
The Kanji variation of
statement_descriptor used for charges in Japan.The day of the week when available funds are paid out, specified as
monday,
tuesday, etc.Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the account representative accepted the
service agreement.
Required.
Add all elements to `files` list.
A historical balance for the account on a particular day.
Account Links are the means by which a Connect platform grants a connected account permission to
access Stripe-hosted applications, such as Connect Onboarding.
For more details about UseCase, please refer to the API
Reference.
For more details about AccountOnboarding, please refer to the API Reference.
For more details about AccountUpdate, please refer to the API Reference.
A notice to a Connected account.
For more details about Email, please refer to the API
Reference.
For more details about LinkedObjects, please refer to the API Reference.
Describes an owner of an account.
Describes a snapshot of the owners of an account at a particular point in time.
The user agent of the browser from which the account representative accepted the service
agreement.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
The user agent of the browser from which the account representative accepted the service
agreement.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
An AccountSession allows a Connect platform to grant access to a connected account in Connect
embedded components.
For more details about Components, please refer to the API Reference.
For more details about AccountManagement, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about AccountOnboarding, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about Balances, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about CapitalFinancing, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about CapitalFinancingApplication, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about CapitalFinancingPromotion, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about Documents, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about FinancialAccount, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about FinancialAccountTransactions, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about IssuingCard, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about IssuingCardsList, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about NotificationBanner, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about PaymentDetails, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about Payments, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about Payouts, please refer to the API
Reference.
For more details about Features, please refer to the API Reference.
For more details about PayoutsList, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about TaxRegistrations, please refer to the API Reference.
For more details about Features, please refer to the API Reference.
For more details about TaxSettings, please refer to the API Reference.
State, county, province, or region.
Required. The close-out date of the preceding fiscal year in ISO 8601
format.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the account representative accepted their service
agreement.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
Passing true requests the capability for the account, if it is not already requested.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
The user agent of the browser from which the directorship declaration attestation was
made.
The user agent of the browser from which the beneficial owner attestation was made.
ID of the invoice rendering template to use for future invoices.
To request a new Capability for an account, pass true.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
A CSS hex color value representing the secondary branding color for the merchant.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
To request a new Capability for an account, pass true.
Add all map key/value pairs to `extraParams` map.
Default text that appears on statements for card charges outside of Japan, prefixing
any dynamic statement_descriptor_suffix specified on the charge.
Town or cho-me.
To request a new Capability for an account, pass true.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
The user agent of the browser from which the director attestation was made.
The user agent of the browser from which the beneficial owner attestation was made.
The user agent of the browser from which the Account's representative accepted the
terms of service.
The close-out date of the preceding fiscal year in ISO 8601 format.
A file upload
token representing the front of the verification document.
Required. The format of the document.
Add all map key/value pairs to `extraParams` map.
Town or cho-me.
Registered name of the business.
Registered name of the business.
Required. The year of birth.
A file upload
token representing the front of the verification document.
A file upload
token representing the front of the verification document.
Required. The format of the document.
The person's last or family name.
The person's title (e.g., CEO, Support Engineer).
Town or cho-me.
The person's last or family name.
The group the account is in to determine their payments pricing, and null if the account is
on customized pricing.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
To request to pause a risk control, pass
true.To request to pause a risk control, pass
true.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A CSS hex color value representing the secondary branding color for this account.
Add all map key/value pairs to `payoutDestinationSelector` map.
The user agent of the browser from which the account representative accepted the
service agreement.
Add all map key/value pairs to `extraParams` map.
The Kanji variation of
statement_descriptor used for charges in Japan.The day of the week when available funds are paid out, specified as
monday,
tuesday, etc.Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the account representative accepted the
service agreement.
An active entitlement describes access to a feature for a customer.
A summary of a customer's active entitlements.
For more details about AdjustedFlow, please refer to the API Reference.
A billing alert is a resource that notifies you when a certain usage threshold on a meter is
crossed.
The usage threshold alert configuration enables setting up alerts for when a certain usage
threshold on a specific meter is crossed.
For more details about Filter, please refer to the API
Reference.
Error returned when user tries to cancel an OutboundPayment that was already canceled.
ApiKeyMissingException is thrown when the API key is not set for a request.Super class to all api request params objects.
Interface implemented by all enum parameter to get the actual string value that Stripe API
expects.
The base class for all services.
For more details about FeeSource, please refer to the API
Reference.
A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf
based on the PaymentIntent input.
Represents a request authentication mechanism.
When an issued card is used to make a purchase, an
Issuing
Authorization object is created.For more details about AmountDetails, please refer to the API Reference.
For more details about Fleet, please refer to the API
Reference.
For more details about CardholderPromptData, please refer to the API Reference.
For more details about ReportedBreakdown, please refer to the API Reference.
For more details about Fuel, please refer to the API
Reference.
For more details about NonFuel, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about FraudChallenge, please refer to the API Reference.
For more details about Fuel, please refer to the API
Reference.
For more details about MerchantData, please refer to the API Reference.
For more details about NetworkData, please refer to the API Reference.
For more details about PendingRequest, please refer to the API Reference.
For more details about AmountDetails, please refer to the API Reference.
For more details about RequestHistory, please refer to the API Reference.
For more details about AmountDetails, please refer to the API Reference.
For more details about Treasury, please refer to the API
Reference.
For more details about VerificationData, please refer to the API Reference.
For more details about AuthenticationExemption, please refer to the API Reference.
For more details about ThreeDSecure, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
Amount of national Sales Tax or VAT included in the transaction amount.
Vehicle number.
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive
of taxes.
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
Add all map key/value pairs to `extraParams` map.
Amount of national Sales Tax or VAT included in the transaction amount.
Vehicle number.
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive
of taxes.
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
Maximum value to filter by (inclusive).
This is an object representing your Stripe balance.
For more details about Available, please refer to the API
Reference.
For more details about SourceTypes, please refer to the API Reference.
For more details about ConnectReserved, please refer to the API Reference.
For more details about SourceTypes, please refer to the API Reference.
For more details about InstantAvailable, please refer to the API Reference.
For more details about NetAvailable, please refer to the API Reference.
For more details about SourceTypes, please refer to the API Reference.
For more details about SourceTypes, please refer to the API Reference.
For more details about Issuing, please refer to the API
Reference.
For more details about Available, please refer to the API Reference.
For more details about SourceTypes, please refer to the API Reference.
For more details about Pending, please refer to the API
Reference.
For more details about SourceTypes, please refer to the API Reference.
Options for customizing account balances within Stripe.
For more details about Payouts, please refer to the API
Reference.
For more details about Schedule, please refer to the API Reference.
For more details about SettlementTiming, please refer to the API Reference.
The day of the week when available funds are paid out (required and applicable only if
interval is weekly.).Balance transactions represent funds moving through your Stripe account.
For more details about FeeDetail, please refer to the API
Reference.
Creates type adapter for interface
BalanceTransactionSource able to deserialize raw JSON
to subtype implementation based on discriminator field object.Unknown subtype of
BalanceTransactionSource.These bank accounts are payment methods on
Customer objects.For more details about FutureRequirements, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about Requirements, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
The base address to use for the request.
Returned if an InboundTransfer is not allowed for risk, legal, regulatory or other unforeseen
reasons.
A Tax Calculation allows you to calculate the tax to collect from your customer.
For more details about CustomerDetails, please refer to the API Reference.
For more details about Address, please refer to the API
Reference.
For more details about TaxId, please refer to the API
Reference.
For more details about ShipFromDetails, please refer to the API Reference.
For more details about Address, please refer to the API
Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about TaxBreakdown, please refer to the API Reference.
For more details about Jurisdiction, please refer to the API Reference.
For more details about TaxRateDetails, please refer to the API Reference.
For more details about TaxBreakdown, please refer to the API Reference.
For more details about TaxRateDetails, please refer to the API Reference.
The amount of the tax rate when the
rate_type`` is flat_amount. Tax rates
with rate_typepercentagecan vary based on the transaction, resulting in
this field beingnull`.State, county, province, or region.
State/province as an ISO 3166-2
subdivision code, without country prefix.
For more details about TaxBreakdown, please refer to the API Reference.
For more details about Jurisdiction, please refer to the API Reference.
For more details about TaxRateDetails, please refer to the API Reference.
This is an object representing a capability for a Stripe account.
For more details about FutureRequirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about Requirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
You can store multiple cards on a customer in order to charge the customer later.
A gift card represents a single gift card owned by a customer, including the remaining balance,
gift card code, and whether or not it is active.
You can create physical or virtual cards that are
issued to cardholders.
For more details about CreatedBy, please refer to the API
Reference.
For more details about Checkout, please refer to the API Reference.
For more details about Order, please refer to the API
Reference.
For more details about Payment, please refer to the API
Reference.
For more details about Networks, please refer to the API
Reference.
For more details about Shipping, please refer to the API
Reference.
For more details about AddressValidation, please refer to the API Reference.
For more details about Customs, please refer to the API
Reference.
For more details about SpendingControls, please refer to the API Reference.
For more details about SpendingLimit, please refer to the API Reference.
For more details about Wallets, please refer to the API
Reference.
For more details about ApplePay, please refer to the API Reference.
For more details about GooglePay, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
An Issuing
Cardholder object represents an individual or business entity who is issued cards.For more details about Billing, please refer to the API
Reference.
For more details about Company, please refer to the API
Reference.
For more details about Individual, please refer to the API Reference.
For more details about CardIssuing, please refer to the API Reference.
For more details about UserTermsAcceptance, please refer to the API Reference.
For more details about Dob, please refer to the API
Reference.
For more details about Verification, please refer to the API Reference.
For more details about Document, please refer to the API Reference.
For more details about Requirements, please refer to the API Reference.
For more details about SpendingControls, please refer to the API Reference.
For more details about SpendingLimit, please refer to the API Reference.
State, county, province, or region.
The entity's business ID number.
The user agent of the browser from which the cardholder accepted the Authorized User
Terms.
Required. The four-digit year of birth.
Maximum value to filter by (inclusive).
State, county, province, or region.
The entity's business ID number.
The user agent of the browser from which the cardholder accepted the Authorized User
Terms.
Required. The four-digit year of birth.
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
A case-insensitive
Map.A customer's
Cash balance represents real funds.For more details about Settings, please refer to the API
Reference.
The
Charge object represents a single attempt to move money into your Stripe account.For more details about BillingDetails, please refer to the API Reference.
For more details about FraudDetails, please refer to the API Reference.
For more details about Level3, please refer to the API
Reference.
For more details about LineItem, please refer to the API Reference.
For more details about Outcome, please refer to the API
Reference.
For more details about Rule, please refer to the API
Reference.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about AchCreditTransfer, please refer to the API Reference.
For more details about AchDebit, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Checks, please refer to the API Reference.
For more details about DecrementalAuthorization, please refer to the API Reference.
For more details about ExtendedAuthorization, please refer to the API Reference.
For more details about IncrementalAuthorization, please refer to the API Reference.
For more details about Installments, please refer to the API Reference.
For more details about Plan, please refer to the API Reference.
For more details about Multicapture, please refer to the API Reference.
For more details about NetworkToken, please refer to the API Reference.
For more details about Overcapture, please refer to the API Reference.
For more details about PartialAuthorization, please refer to the API Reference.
For more details about ThreeDSecure, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about AmexExpressCheckout, please refer to the API Reference.
For more details about ApplePay, please refer to the API Reference.
For more details about GooglePay, please refer to the API Reference.
For more details about Link, please refer to the API Reference.
For more details about Masterpass, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about VisaCheckout, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about PayerDetails, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about Store, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about SellerProtection, please refer to the API Reference.
For more details about Payto, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about Rechnung, please refer to the API Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about Satispay, please refer to the API Reference.
For more details about SepaCreditTransfer, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about Shopeepay, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeAccount, please refer to the API Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about Wechat, please refer to the API
Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
For more details about PresentmentDetails, please refer to the API Reference.
Options to configure Radar.
For more details about TransferData, please refer to the API Reference.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
A portal configuration describes the functionality and behavior of a portal session.
A Configurations object represents how features should be configured for terminal readers.
For more details about BbposWiseposE, please refer to the API Reference.
For more details about BusinessProfile, please refer to the API Reference.
For more details about Features, please refer to the API
Reference.
For more details about CustomerUpdate, please refer to the API Reference.
For more details about InvoiceHistory, please refer to the API Reference.
For more details about PaymentMethodUpdate, please refer to the API Reference.
For more details about SubscriptionCancel, please refer to the API Reference.
For more details about CancellationReason, please refer to the API Reference.
For more details about SubscriptionUpdate, please refer to the API Reference.
For more details about Product, please refer to the API Reference.
For more details about ScheduleAtPeriodEnd, please refer to the API Reference.
For more details about Condition, please refer to the API Reference.
For more details about LoginPage, please refer to the API
Reference.
For more details about Offline, please refer to the API
Reference.
For more details about RebootWindow, please refer to the API Reference.
For more details about StripeS700, please refer to the API Reference.
For more details about Tipping, please refer to the API
Reference.
For more details about Aud, please refer to the API
Reference.
For more details about Cad, please refer to the API
Reference.
For more details about Chf, please refer to the API
Reference.
For more details about Czk, please refer to the API
Reference.
For more details about Dkk, please refer to the API
Reference.
For more details about Eur, please refer to the API
Reference.
For more details about Gbp, please refer to the API
Reference.
For more details about Hkd, please refer to the API
Reference.
For more details about Jpy, please refer to the API
Reference.
For more details about Myr, please refer to the API
Reference.
For more details about Nok, please refer to the API
Reference.
For more details about Nzd, please refer to the API
Reference.
For more details about Pln, please refer to the API
Reference.
For more details about Sek, please refer to the API
Reference.
For more details about Sgd, please refer to the API
Reference.
For more details about Usd, please refer to the API
Reference.
For more details about VerifoneP400, please refer to the API Reference.
For more details about Wifi, please refer to the API
Reference.
For more details about EnterpriseEapPeap, please refer to the API Reference.
For more details about EnterpriseEapTls, please refer to the API Reference.
For more details about PersonalPsk, please refer to the API Reference.
A link to the business’s publicly available terms of service.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The type of condition.
A File ID representing an image to display on the reader.
Add all map key/value pairs to `extraParams` map.
Required. Integer between 0 to 23 that represents the start hour of the
reboot time window.
A File ID representing an image you would like displayed on the reader.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
A File ID representing an image you would like displayed on the reader.
A link to the business’s publicly available terms of service.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The type of condition.
A File ID representing an image to display on the reader.
Add all map key/value pairs to `extraParams` map.
Required. Integer between 0 to 23 that represents the start hour of the
reboot time window.
A File ID representing an image you would like displayed on the reader.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
A File ID representing an image you would like displayed on the reader.
ConfirmationTokens help transport client side data collected by Stripe JS over to your server for
confirming a PaymentIntent or SetupIntent.
Data used for generating a Mandate.
This hash contains details about the customer acceptance of the Mandate.
This hash contains details about the online acceptance.
Payment-method-specific configuration.
This hash contains the card payment method options.
Installment configuration for payments.
For more details about Plan, please refer to the API Reference.
Details of the PaymentMethod collected by Payment Element.
For more details about AcssDebit, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Checks, please refer to the API Reference.
For more details about GeneratedFrom, please refer to the API Reference.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about ThreeDSecureUsage, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about AmexExpressCheckout, please refer to the API Reference.
For more details about ApplePay, please refer to the API Reference.
For more details about GooglePay, please refer to the API Reference.
For more details about Link, please refer to the API Reference.
For more details about Masterpass, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about VisaCheckout, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Dob, please refer to the API
Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about Rechnung, please refer to the API Reference.
For more details about Dob, please refer to the API
Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about Satispay, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about GeneratedFrom, please refer to the API Reference.
For more details about Shopeepay, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Blocked, please refer to the API Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
For more details about Shipping, please refer to the API
Reference.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Required. Type of installment plan, one of
fixed_count.A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Returned when the PayoutMethodBankAccount object is controlled by the Stripe Dashboard, and
cannot be archived.
Stripe needs to collect certain pieces of information about each account created.
For more details about VerificationFields, please refer to the API Reference.
For more details about Company, please refer to the API
Reference.
For more details about Individual, please refer to the API Reference.
A coupon contains information about a percent-off or amount-off discount you might want to apply
to a customer.
For more details about AppliesTo, please refer to the API
Reference.
For more details about CurrencyOption, please refer to the API Reference.
Add all elements to `products` list.
Add all map key/value pairs to `extraParams` map.
Indicates the billing credit balance for billing credits granted to a customer.
For more details about Balance, please refer to the API
Reference.
For more details about AvailableBalance, please refer to the API Reference.
For more details about Monetary, please refer to the API Reference.
For more details about LedgerBalance, please refer to the API Reference.
For more details about Monetary, please refer to the API Reference.
A credit balance transaction is a resource representing a transaction (either a credit or a
debit) against an existing credit grant.
For more details about Credit, please refer to the API
Reference.
For more details about Amount, please refer to the API
Reference.
For more details about Monetary, please refer to the API Reference.
For more details about CreditsApplicationInvoiceVoided, please refer to the API Reference.
For more details about Debit, please refer to the API
Reference.
For more details about Amount, please refer to the API
Reference.
For more details about Monetary, please refer to the API Reference.
For more details about CreditsApplied, please refer to the API Reference.
A credit grant is an API resource that documents the allocation of some billing credits to a
customer.
For more details about Amount, please refer to the API
Reference.
For more details about Monetary, please refer to the API Reference.
For more details about ApplicabilityConfig, please refer to the API Reference.
For more details about Scope, please refer to the API
Reference.
For more details about Price, please refer to the API
Reference.
Required. A positive integer representing the amount of the credit
grant.
Required. The price ID this credit grant should apply to.
Issue a credit note to adjust an invoice's amount after the invoice is finalized.
For more details about DiscountAmount, please refer to the API Reference.
For more details about PretaxCreditAmount, please refer to the API Reference.
For more details about Refund, please refer to the API
Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about TotalTax, please refer to the API
Reference.
For more details about TaxRateDetails, please refer to the API Reference.
The ID of the shipping rate to use for this order.
Required. The amount on which tax is calculated, in cents (or local
equivalent).
ID of an existing refund to link this credit note to.
The credit note line item object.
For more details about DiscountAmount, please refer to the API Reference.
For more details about PretaxCreditAmount, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about TaxRateDetails, please refer to the API Reference.
For more details about TaxCalculationReference, please refer to the API Reference.
The ID of the shipping rate to use for this order.
Required. The amount on which tax is calculated, in cents (or local
equivalent).
ID of an existing refund to link this credit note to.
The ID of the shipping rate to use for this order.
Required. The amount on which tax is calculated, in cents (or local
equivalent).
ID of an existing refund to link this credit note to.
You can reverse some ReceivedCredits
depending on their network and source flow.
For more details about StatusTransitions, please refer to the API Reference.
Every time an applicant submits an application for a Charge Card product your platform offers, or
every time your platform takes a proactive credit decision on an existing account, you must
record the decision by creating a new
CreditUnderwritingRecord object on a connected
account.For more details about Application, please refer to the API Reference.
For more details about CreditUser, please refer to the API Reference.
For more details about Decision, please refer to the API
Reference.
For more details about ApplicationRejected, please refer to the API Reference.
For more details about CreditLimitApproved, please refer to the API Reference.
For more details about CreditLimitDecreased, please refer to the API Reference.
For more details about CreditLineClosed, please refer to the API Reference.
For more details about UnderwritingException, please refer to the API Reference.
Required. Full name of the company or person.
Add all map key/value pairs to `extraParams` map.
Required. Full name of the company or person.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
This object represents a customer of your business.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about RenderingOptions, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about Location, please refer to the API Reference.
Each customer has a Balance value,
which denotes a debit or credit that's automatically applied to their next invoice upon
finalization.
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.
For more details about AdjustedForOverdraft, please refer to the API Reference.
For more details about AppliedToPayment, please refer to the API Reference.
For more details about Funded, please refer to the API
Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about GbBankTransfer, please refer to the API Reference.
For more details about JpBankTransfer, please refer to the API Reference.
For more details about UsBankTransfer, please refer to the API Reference.
For more details about RefundedFromPayment, please refer to the API Reference.
For more details about TransferredToBalance, please refer to the API Reference.
For more details about UnappliedFromPayment, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Controls how funds transferred by the customer are applied to payment intents and
invoices.
Required. The value of the custom field.
ID of the invoice rendering template to use for future invoices.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
control over a Customer.
Configuration for the components supported by this Customer Session.
This hash contains whether the buy button is enabled.
This hash contains whether the Payment Element is enabled and the features it supports.
This hash contains the features the Payment Element supports.
This hash contains whether the pricing table is enabled.
State, county, province, or region.
Controls how funds transferred by the customer are applied to payment intents and
invoices.
Required. The value of the custom field.
ID of the invoice rendering template to use for future invoices.
State, county, province, or region.
You can reverse some ReceivedDebits
depending on their network and source flow.
For more details about LinkedFlows, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
A discount represents the actual application of a coupon or promotion code.
A dispute occurs when a customer questions your charge with their card issuer.
As a card issuer, you can dispute transactions that
the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
For more details about Evidence, please refer to the API
Reference.
For more details about Evidence, please refer to the API
Reference.
For more details about Canceled, please refer to the API Reference.
For more details about Duplicate, please refer to the API Reference.
For more details about EnhancedEvidence, please refer to the API Reference.
For more details about VisaCompellingEvidence3, please refer to the API Reference.
For more details about DisputedTransaction, please refer to the API Reference.
For more details about ShippingAddress, please refer to the API Reference.
For more details about PriorUndisputedTransaction, please refer to the API Reference.
Dispute.Evidence.EnhancedEvidence.VisaCompellingEvidence3.PriorUndisputedTransaction.ShippingAddress
For more details about ShippingAddress, please refer to the API Reference.
For more details about VisaCompliance, please refer to the API Reference.
For more details about Fraudulent, please refer to the API Reference.
For more details about MerchandiseNotAsDescribed, please refer to the API Reference.
For more details about NotReceived, please refer to the API Reference.
For more details about NoValidAuthorization, please refer to the API Reference.
For more details about Other, please refer to the API
Reference.
For more details about ServiceNotAsDescribed, please refer to the API Reference.
For more details about EvidenceDetails, please refer to the API Reference.
For more details about EnhancedEligibility, please refer to the API Reference.
For more details about VisaCompellingEvidence3, please refer to the API Reference.
For more details about VisaCompliance, please refer to the API Reference.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Treasury, please refer to the API
Reference.
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Date when the product was received.
Maximum value to filter by (inclusive).
Represents a record from the card network of a money movement or change in state for an Issuing
dispute.
For more details about NetworkData, please refer to the API Reference.
An early fraud warning indicates that the card issuer has notified us that a charge may be
fraudulent.
An empty entity for API methods with a void return type.
Events are our way of letting you know when something interesting happens in your account.
For more details about Data, please refer to the API
Reference.
For more details about Reason, please refer to the API
Reference.
For more details about Reason, please refer to the API
Reference.
For more details about AutomationAction, please refer to the API Reference.
For more details about StripeSendWebhookCustomEvent, please refer to the API Reference.
For more details about Request, please refer to the API
Reference.
For more details about Request, please refer to the API
Reference.
For more details about Request, please refer to the API
Reference.
Event data class look up used in event deserialization.
Event data class look up used in event deserialization.
Deserialization helper to get
StripeObject and handle failure due to schema
incompatibility between the data object and the model classes.Definition of event data object JSON transformation to be compatible to API version of the
library.
For more details about AmazonEventbridge, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Disabled, please refer to the API Reference.
For more details about WebhookEndpoint, please refer to the API Reference.
Required. The URL of the webhook endpoint.
Add all map key/value pairs to `extraParams` map.
Required. The URL of the webhook endpoint.
This is a template for defining new examples.
ExchangeRate objects allow you to determine the rates that Stripe is currently using to
convert from one currency to another.Required.
Creates type adapter for interface
ExternalAccount able to deserialize raw JSON to
subtype implementation based on discriminator field object.Unknown subtype of
ExternalAccount.Add all elements to `files` list.
A feature represents a monetizable ability or functionality in your system.
Error returned when recipient does not have the active features required to receive funds from
this OutboundPayment request.
Application Fee Refund objects allow you to refund an application fee that has previously
been created but not yet refunded.This object represents files hosted on Stripe's servers.
Set of key-value pairs that you can
attach to an object.
To share the contents of a
File object with non-Stripe users, you can create a
FileLink.Maximum value to filter by (inclusive).
Stripe Treasury provides users with a container for money called a FinancialAccount that is
separate from their Payments balance.
Balance information for the FinancialAccount.
For more details about Balance, please refer to the API
Reference.
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
ABA Records contain U.S.
For more details about Other, please refer to the API
Reference.
Restrictions that a Connect Platform has placed on this FinancialAccount.
For more details about StatusDetails, please refer to the API Reference.
For more details about Closed, please refer to the API
Reference.
For more details about Storage, please refer to the API
Reference.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Encodes whether a FinancialAccount has access to a particular Feature, with a
status enum
and associated status_details.Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
Settings related to Financial Addresses features on a Financial Account.
Toggle settings for enabling/disabling the ABA address feature.
Additional details on the FinancialAccount Features information.
InboundTransfers contains inbound transfers features for a FinancialAccount.
Toggle settings for enabling/disabling an inbound ACH specific feature.
Additional details on the FinancialAccount Features information.
Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
Settings related to Outbound Payments features on a Financial Account.
Toggle settings for enabling/disabling an outbound ACH specific feature.
Additional details on the FinancialAccount Features information.
Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
OutboundTransfers contains outbound transfers features for a FinancialAccount.
Toggle settings for enabling/disabling an outbound ACH specific feature.
Additional details on the FinancialAccount Features information.
Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
Required. Whether the FinancialAccount should have the Feature.
For more details about Credentials, please refer to the API Reference.
For more details about GbBankAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.
This is an object representing the terms of an offer of financing from Stripe Capital to a
Connected account.
This is an object representing the terms of an offer of financing from Stripe Capital to a
Connected account.
Maximum value to filter by (inclusive).
A financing object describes an account's current financing state.
For more details about Details, please refer to the API
Reference.
The current repayment interval for the Connected account.
This is an object representing the details of a transaction on a Capital financing object.
This is an object representing a transaction on a Capital financing offer.
This is an object representing a linked transaction on a Capital Financing Transaction.
Tax forms are legal documents which are delivered to one or more tax authorities for information
reporting purposes.
For more details about AuSerr, please refer to the API
Reference.
For more details about CaMrdp, please refer to the API
Reference.
For more details about EuDac7, please refer to the API
Reference.
For more details about FilingStatus, please refer to the API Reference.
For more details about Jurisdiction, please refer to the API Reference.
For more details about GbMrdp, please refer to the API
Reference.
For more details about NzMrdp, please refer to the API
Reference.
For more details about Payee, please refer to the API
Reference.
For more details about Us1099K, please refer to the API
Reference.
For more details about Us1099Misc, please refer to the API Reference.
For more details about Us1099Nec, please refer to the API
Reference.
A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on
Issuing transactions.
Each customer has a
balance
that is automatically applied to future invoices and payments using the customer_balance
payment method.For more details about BankTransfer, please refer to the API Reference.
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
ABA Records contain U.S.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
SWIFT Records contain U.S.
Zengin Records contain Japan bank account details per the Zengin format.
For more details about ConfirmationOfPayee, please refer to the API Reference.
For more details about Result, please refer to the API
Reference.
For more details about Matched, please refer to the API Reference.
For more details about Provided, please refer to the API Reference.
The
StripeResponseGetterOptions implementation that pulls values from the global options
in the Stripe classBase abstract class for HTTP clients used to send requests to Stripe's API.
Represents the content of an HTTP request, i.e.
A read-only view of a set of HTTP headers.
Use InboundTransfers
to add funds to your FinancialAccount via a PaymentMethod
that is owned by you.
For more details about FailureDetails, please refer to the API Reference.
For more details about From, please refer to the API
Reference.
For more details about PaymentMethod, please refer to the API Reference.
For more details about LinkedFlows, please refer to the API Reference.
For more details about OriginPaymentMethodDetails, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about To, please refer to the API
Reference.
For more details about TransferHistory, please refer to the API Reference.
For more details about BankDebitFailed, please refer to the API Reference.
For more details about BankDebitProcessing, please refer to the API Reference.
For more details about BankDebitQueued, please refer to the API Reference.
For more details about BankDebitReturned, please refer to the API Reference.
For more details about BankDebitSucceeded, please refer to the API Reference.
Required. ID of the Payment Method using which IBT will be made.
An institution represents a financial institution to which an end user can connect using the
Financial Connections authentication flow.
For more details about Features, please refer to the API
Reference.
For more details about Balances, please refer to the API Reference.
For more details about Ownership, please refer to the API Reference.
For more details about PaymentMethod, please refer to the API Reference.
For more details about Transactions, please refer to the API Reference.
Error returned when the balance of provided financial account and balance type in the
OutboundPayment request does not have enough funds.
InvalidClientException is raised when authentication fails.
InvalidGrantException is raised when a specified code doesn't exist, is expired, has been used,
or doesn't belong to you; a refresh token doesn't exist, or doesn't belong to you; or if an API
key's mode (live or test) doesn't match the mode of a code or refresh token.
Returned in cases where the bank account provided is not valid (wrong format of account number or
a routing number that does not correspond to a banking institution).
Returned in cases where the ID provided doesn't correspond to a valid payout method.
InvalidRequestException is raised when a code, refresh token, or grant type parameter is not
provided, but was required.
InvalidScopeException is raised when an invalid scope parameter is provided.
Invoices are statements of amounts owed by a customer, and are either generated one-off, or
generated periodically from a subscription.
For more details about AmountsDue, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about ConfirmationSecret, please refer to the API Reference.
For more details about CustomerTaxId, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about FromInvoice, please refer to the API Reference.
For more details about Issuer, please refer to the API
Reference.
For more details about Parent, please refer to the API
Reference.
For more details about QuoteDetails, please refer to the API Reference.
For more details about SubscriptionDetails, please refer to the API Reference.
The Pause Collection settings determine how we will pause collection for this subscription
and for how long the subscription should be paused.
For more details about PaymentSettings, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Installments, please refer to the API Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Konbini, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about Rendering, please refer to the API
Reference.
For more details about Pdf, please refer to the API
Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about ThresholdReason, please refer to the API Reference.
For more details about ItemReason, please refer to the API Reference.
For more details about TotalDiscountAmount, please refer to the API Reference.
For more details about TotalMarginAmount, please refer to the API Reference.
For more details about TotalPretaxCreditAmount, please refer to the API Reference.
For more details about TotalTax, please refer to the API
Reference.
For more details about TaxRateDetails, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. The value of the custom field.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of installment plan, one of
fixed_count.InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Prefetch
ID of the institution to use to filter for selectable accounts.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State, county, province, or region.
Required. Type of the account referenced in the request.
State, county, province, or region.
State, county, province, or region.
A recent IP address of the customer used for tax reporting and tax location inference.
Required. The number of intervals, as an whole number greater than 0.
Required. The number of intervals, as an whole number greater than
0.
Required. The start of the period.
Add all map key/value pairs to `extraParams` map.
Required. The position of the previous amendment in the
amendments array after which this amendment should begin.Add all map key/value pairs to `extraParams` map.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. The type of calculation made to determine when the
discount ends.
The ID of a promotion code to remove from the
discounts array.An ID of an existing promotion code to replace the
discounts array with.Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. ID of a price to remove.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. The number of intervals, as an whole number greater than
0.
Required. The number of intervals, as an whole number greater
than 0.
Same as
unit_amount, but accepts a decimal value in cents (or local
equivalent) with at most 12 decimal places.Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Required. This is used to determine the number of billing cycles to
prebill.
Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Invoice Items represent the component lines of an invoice.
For more details about Parent, please refer to the API
Reference.
For more details about SubscriptionDetails, please refer to the API Reference.
For more details about Period, please refer to the API
Reference.
For more details about Pricing, please refer to the API
Reference.
For more details about PriceDetails, please refer to the API Reference.
Required. The number of intervals, as an whole number greater than 0.
Required. The start of the period.
The ID of the price object.
Required. The number of intervals, as an whole number greater than 0.
Required. The start of the period.
The ID of the price object.
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an
invoice.
For more details about DiscountAmount, please refer to the API Reference.
For more details about MarginAmount, please refer to the API Reference.
For more details about Parent, please refer to the API
Reference.
For more details about InvoiceItemDetails, please refer to the API Reference.
For more details about ProrationDetails, please refer to the API Reference.
For more details about CreditedItems, please refer to the API Reference.
For more details about SubscriptionItemDetails, please refer to the API Reference.
For more details about ProrationDetails, please refer to the API Reference.
For more details about CreditedItems, please refer to the API Reference.
For more details about Period, please refer to the API
Reference.
For more details about PretaxCreditAmount, please refer to the API Reference.
For more details about Pricing, please refer to the API
Reference.
For more details about PriceDetails, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about TaxRateDetails, please refer to the API Reference.
For more details about TaxCalculationReference, please refer to the API Reference.
Required. The number of intervals, as an whole number greater than 0.
Required. The start of the period.
A tax code ID.
The ID of the price object.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
The invoice payment object.
For more details about Payment, please refer to the API
Reference.
For more details about StatusTransitions, please refer to the API Reference.
Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the
PDF.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. The value of the custom field.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of installment plan, one of
fixed_count.InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Prefetch
ID of the institution to use to filter for selectable accounts.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State, county, province, or region.
A KeyValuePair holds a key and a value.
A line item.
For more details about AdjustableQuantity, please refer to the API Reference.
For more details about Discount, please refer to the API
Reference.
For more details about Display, please refer to the API
Reference.
For more details about Tax, please refer to the API
Reference.
For more details about TaxCalculationReference, please refer to the API Reference.
A Location represents a grouping of readers.
Login Links are single-use URLs that takes an Express account to the login page for their Stripe
dashboard.
A Mandate is a record of the permission that your customer gives you to debit their payment
method.
For more details about CustomerAcceptance, please refer to the API Reference.
For more details about Offline, please refer to the API
Reference.
For more details about Online, please refer to the API
Reference.
For more details about MultiUse, please refer to the API
Reference.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about SingleUse, please refer to the API
Reference.
A (partner) margin represents a specific discount distributed in partner reseller programs to
business partners who resell products and services and earn a discount (margin) for doing so.
Common interface for Stripe objects that can store metadata.
Meters specify how to aggregate meter events over a billing period.
For more details about CustomerMapping, please refer to the API Reference.
For more details about DefaultAggregation, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about ValueSettings, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
For more details about Reason, please refer to the API
Reference.
For more details about ErrorType, please refer to the API Reference.
For more details about SampleError, please refer to the API Reference.
For more details about ApiRequest, please refer to the API Reference.
For more details about RelatedObject, please refer to the API Reference.
Meter events represent actions that customers take in your system.
A billing meter event adjustment is a resource that allows you to cancel a meter event.
For more details about Cancel, please refer to the API
Reference.
For more details about Cancel, please refer to the API
Reference.
Unique identifier for the event.
Required. Unique identifier for the event.
Use the high-throughput meter event stream API to report create billing meter events.
A billing meter event summary represents an aggregated view of a customer's billing meter events
within a specified timeframe.
Error returned when user tries to cancel an OutboundPayment that is not cancelable.
Base parent class for all OAuth exceptions.
Orders represent your intent to purchase a particular Climate product.
An Order describes a purchase being made by a customer, including the products & quantities
being purchased, the order status, the payment information, and the billing/shipping details.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Beneficiary, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about Credit, please refer to the API
Reference.
For more details about GiftCard, please refer to the API Reference.
The delivery of a specified quantity of carbon for an order.
For more details about Location, please refer to the API Reference.
For more details about Payment, please refer to the API
Reference.
For more details about Settings, please refer to the API Reference.
For more details about AutomaticPaymentMethods, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API Reference.
For more details about Klarna, please refer to the API Reference.
For more details about Link, please refer to the API Reference.
For more details about Oxxo, please refer to the API Reference.
For more details about P24, please refer to the API
Reference.
For more details about Paypal, please refer to the API Reference.
For more details about LineItem, please refer to the API Reference.
For more details about Tax, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Sofort, please refer to the API Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about TransferData, please refer to the API Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about ShippingDetails, please refer to the API Reference.
For more details about TaxDetails, please refer to the API Reference.
For more details about TaxId, please refer to the API
Reference.
For more details about TotalDetails, please refer to the API Reference.
For more details about Breakdown, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
Add all map key/value pairs to `extraParams` map.
State/province as an ISO 3166-2
subdivision code, without country prefix.
ID of the promotion code to create a new discount for.
Add all map key/value pairs to `extraParams` map.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State/province as an ISO 3166-2
subdivision code, without country prefix.
Add all map key/value pairs to `extraParams` map.
State/province as an ISO 3166-2
subdivision code, without country prefix.
ID of the promotion code to create a new discount for.
Add all map key/value pairs to `extraParams` map.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State/province as an ISO 3166-2
subdivision code, without country prefix.
Use OutboundPayments
to send funds to another party's external bank account or FinancialAccount.
For more details about DeliveryOptions, please refer to the API Reference.
For more details about DestinationPaymentMethodDetails, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about FinancialAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about EndUserDetails, please refer to the API Reference.
For more details about From, please refer to the API
Reference.
For more details about RecipientNotification, please refer to the API Reference.
For more details about ReturnedDetails, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Failed, please refer to the API
Reference.
For more details about Returned, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about To, please refer to the API
Reference.
For more details about TraceId, please refer to the API
Reference.
For more details about TrackingDetails, please refer to the API Reference.
For more details about Ach, please refer to the API
Reference.
For more details about UsDomesticWire, please refer to the API Reference.
State, county, province, or region.
Specifies the network rails to be used.
Required. The FinancialAccount that funds were pulled from.
Maximum value to filter by (inclusive).
For more details about DeliveryOptions, please refer to the API Reference.
For more details about EstimatedFee, please refer to the API Reference.
For more details about From, please refer to the API
Reference.
For more details about FxQuote, please refer to the API
Reference.
For more details about Rate, please refer to the API
Reference.
For more details about To, please refer to the API
Reference.
Required. The FinancialAccount that funds were pulled from.
For more details about NextAction, please refer to the API Reference.
For more details about ConfirmationOfPayee, please refer to the API Reference.
Required. The card number.
Use OutboundTransfers
to transfer funds from a FinancialAccount to a PaymentMethod
belonging to the same entity.
For more details about DeliveryOptions, please refer to the API Reference.
For more details about DestinationPaymentMethodDetails, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about FinancialAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about From, please refer to the API
Reference.
For more details about NetworkDetails, please refer to the API Reference.
For more details about Ach, please refer to the API
Reference.
For more details about ReturnedDetails, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Failed, please refer to the API
Reference.
For more details about Returned, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about To, please refer to the API
Reference.
For more details about TraceId, please refer to the API
Reference.
For more details about TrackingDetails, please refer to the API Reference.
For more details about Ach, please refer to the API
Reference.
For more details about UsDomesticWire, please refer to the API Reference.
Specifies the network rails to be used.
Required. The FinancialAccount that funds were pulled from.
Provides an
Iterable<T>foreachA Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
Information about the customer for this payment.
Details about the Payment Method used in this payment attempt.
For more details about AchCreditTransfer, please refer to the API Reference.
For more details about AchDebit, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
Billing details used by the customer for this payment.
A representation of a physical address.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
Details of the card used for this payment attempt.
For more details about Checks, please refer to the API Reference.
For more details about NetworkToken, please refer to the API Reference.
For more details about ThreeDSecure, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
Custom Payment Methods represent Payment Method types not modeled directly in the Stripe API.
For more details about CustomerBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about PayerDetails, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about Store, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about SellerProtection, please refer to the API Reference.
For more details about Payto, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about Rechnung, please refer to the API Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about Satispay, please refer to the API Reference.
For more details about SepaCreditTransfer, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about Shopeepay, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeAccount, please refer to the API Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about Wechat, please refer to the API
Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
The customer's shipping information associated with this payment.
A representation of a physical address.
A PaymentIntent guides you through the process of collecting a payment from your customer.
For more details about AmountDetails, please refer to the API Reference.
For more details about Tip, please refer to the API
Reference.
For more details about AsyncWorkflows, please refer to the API Reference.
For more details about Inputs, please refer to the API
Reference.
For more details about Tax, please refer to the API
Reference.
For more details about AutomaticPaymentMethods, please refer to the API Reference.
For more details about NextAction, please refer to the API Reference.
For more details about AlipayHandleRedirect, please refer to the API Reference.
For more details about BoletoDisplayDetails, please refer to the API Reference.
For more details about CardAwaitNotification, please refer to the API Reference.
For more details about CashappHandleRedirectOrDisplayQrCode, please refer to the API Reference.
For more details about QrCode, please refer to the API Reference.
For more details about DisplayBankTransferInstructions, please refer to the API Reference.
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
ABA Records contain U.S.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
SWIFT Records contain U.S.
Zengin Records contain Japan bank account details per the Zengin format.
For more details about KonbiniDisplayDetails, please refer to the API Reference.
For more details about Stores, please refer to the API Reference.
For more details about Familymart, please refer to the API Reference.
For more details about Lawson, please refer to the API Reference.
For more details about Ministop, please refer to the API Reference.
For more details about Seicomart, please refer to the API Reference.
For more details about MultibancoDisplayDetails, please refer to the API Reference.
For more details about OxxoDisplayDetails, please refer to the API Reference.
For more details about PaynowDisplayQrCode, please refer to the API Reference.
For more details about PixDisplayQrCode, please refer to the API Reference.
For more details about PromptpayDisplayQrCode, please refer to the API Reference.
For more details about RedirectToUrl, please refer to the API Reference.
For more details about SwishHandleRedirectOrDisplayQrCode, please refer to the API Reference.
For more details about QrCode, please refer to the API Reference.
For more details about VerifyWithMicrodeposits, please refer to the API Reference.
For more details about WechatPayDisplayQrCode, please refer to the API Reference.
For more details about WechatPayRedirectToAndroidApp, please refer to the API Reference.
For more details about WechatPayRedirectToIosApp, please refer to the API Reference.
For more details about PaymentDetails, please refer to the API Reference.
For more details about CarRental, please refer to the API Reference.
For more details about Affiliate, please refer to the API Reference.
For more details about Delivery, please refer to the API Reference.
For more details about Recipient, please refer to the API Reference.
For more details about Driver, please refer to the API Reference.
For more details about EventDetails, please refer to the API Reference.
For more details about Affiliate, please refer to the API Reference.
For more details about Delivery, please refer to the API Reference.
For more details about Recipient, please refer to the API Reference.
For more details about Subscription, please refer to the API Reference.
For more details about Affiliate, please refer to the API Reference.
For more details about BillingInterval, please refer to the API Reference.
For more details about PaymentMethodConfigurationDetails, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Installments, please refer to the API Reference.
For more details about AvailablePlan, please refer to the API Reference.
For more details about Plan, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about StatementDetails, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Routing, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about LineItem, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about Rechnung, please refer to the API Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Shopeepay, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about ManualEntry, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
For more details about PresentmentDetails, please refer to the API Reference.
For more details about Processing, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about CustomerNotification, please refer to the API Reference.
For more details about TransferData, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the Mandate was accepted by the customer.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Required. Type of installment plan, one of
fixed_count.State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Routing requested priority.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The user agent of the browser from which the Mandate was
accepted by the customer.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Required. Type of installment plan, one of
fixed_count.State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Routing requested priority.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Request partial authorization on this PaymentIntent.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the Mandate was accepted by the customer.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
State, county, province, or region.
Required. Full name of the person or entity on the car reservation.
State, county, province, or region.
State, county, province, or region.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Full name of the person or entity on the flight reservation.
The fare class for the segment.
State, county, province, or region.
Required. Full name of the person or entity on the lodging
reservation.
Required. The name of the affiliate that originated the purchase.
The phone number of the recipient the ticket is delivered to.
Required. Specifies a type of interval unit.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Required. Type of installment plan, one of
fixed_count.State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Routing requested priority.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
State, county, province, or region.
A payment link is a shareable URL that will take your customers to a hosted payment page.
For more details about AfterCompletion, please refer to the API Reference.
For more details about HostedConfirmation, please refer to the API Reference.
For more details about Redirect, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about ConsentCollection, please refer to the API Reference.
For more details about PaymentMethodReuseAgreement, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about Dropdown, please refer to the API Reference.
For more details about Option, please refer to the API Reference.
For more details about Label, please refer to the API
Reference.
For more details about Numeric, please refer to the API
Reference.
For more details about Text, please refer to the API
Reference.
For more details about CustomText, please refer to the API Reference.
For more details about AfterSubmit, please refer to the API Reference.
For more details about ShippingAddress, please refer to the API Reference.
For more details about Submit, please refer to the API
Reference.
For more details about TermsOfServiceAcceptance, please refer to the API Reference.
For more details about InvoiceCreation, please refer to the API Reference.
For more details about InvoiceData, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
For more details about RenderingOptions, please refer to the API Reference.
For more details about OptionalItem, please refer to the API Reference.
For more details about AdjustableQuantity, please refer to the API Reference.
For more details about PaymentIntentData, please refer to the API Reference.
For more details about PhoneNumberCollection, please refer to the API Reference.
For more details about Restrictions, please refer to the API Reference.
For more details about CompletedSessions, please refer to the API Reference.
For more details about ShippingAddressCollection, please refer to the API Reference.
For more details about ShippingOption, please refer to the API Reference.
For more details about SubscriptionData, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
Configures how this subscription behaves during the trial period.
Defines how a subscription behaves when a free trial ends.
For more details about TaxIdCollection, please refer to the API Reference.
For more details about TransferData, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
Required. The URL the customer will be redirected to after the purchase
is complete.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. The value for this option, not displayed to the customer,
used by your integration to reconcile the option selected by the customer.
The minimum character length requirement for the customer's input.
The minimum character length requirement for the customer's input.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Add all map key/value pairs to `extraParams` map.
The minimum quantity the customer can purchase.
The minimum quantity of this item the customer must purchase, if they choose to purchase
it.
Add all map key/value pairs to `extraParams` map.
Required. The maximum number of checkout sessions that can be completed
for the
completed_sessions restriction to be met.The ID of the Shipping Rate to use for this shipping option.
Required. Type of the account referenced in the request.
Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
Add all map key/value pairs to `extraParams` map.
Required. The URL the customer will be redirected to after the purchase
is complete.
Required. Type of the account referenced in the request.
Required. The value for this option, not displayed to the customer,
used by your integration to reconcile the option selected by the customer.
The minimum character length requirement for the customer's input.
The minimum character length requirement for the customer's input.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Add all map key/value pairs to `extraParams` map.
The minimum quantity the customer can purchase.
A string that identifies the resulting payment as part of a group.
Add all map key/value pairs to `extraParams` map.
Required. The maximum number of checkout sessions that can be completed
for the
completed_sessions restriction to be met.Required. Type of the account referenced in the request.
Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
PaymentMethod objects represent your customer's payment instruments.
For more details about AcssDebit, please refer to the API
Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API
Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API
Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Checks, please refer to the API
Reference.
For more details about GeneratedFrom, please refer to the API Reference.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about ThreeDSecureUsage, please refer to the API Reference.
For more details about Wallet, please refer to the API
Reference.
For more details about AmexExpressCheckout, please refer to the API Reference.
For more details about ApplePay, please refer to the API Reference.
For more details about GooglePay, please refer to the API Reference.
For more details about Link, please refer to the API
Reference.
For more details about Masterpass, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about VisaCheckout, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about Offline, please refer to the API
Reference.
For more details about Wallet, please refer to the API
Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about KakaoPay, please refer to the API
Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Dob, please refer to the API
Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API
Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API
Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API
Reference.
For more details about Qris, please refer to the API
Reference.
Options to configure Radar.
For more details about Rechnung, please refer to the API
Reference.
For more details about Dob, please refer to the API
Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about Satispay, please refer to the API
Reference.
For more details about SepaDebit, please refer to the API
Reference.
For more details about GeneratedFrom, please refer to the API Reference.
For more details about Shopeepay, please refer to the API
Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about Networks, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Blocked, please refer to the API Reference.
For more details about WechatPay, please refer to the API
Reference.
For more details about Zip, please refer to the API
Reference.
PaymentMethodConfigurations control which payment methods are displayed to your customers when
you don't explicitly specify payment method types.
For more details about AcssDebit, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Alma, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about AmazonPay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about ApplePay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about BacsDebit, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Blik, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about CartesBancaires, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about GooglePay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Jcb, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Link, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Mobilepay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about P24, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about PayByBank, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Payto, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Promptpay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Satispay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about SepaDebit, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Shopeepay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Twint, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about WechatPay, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
For more details about DisplayPreference, please refer to the API Reference.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
The account's preference for whether or not to display this payment method.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or CNPJ
for businesses consumers)
The customer's preferred card network for co-branded cards.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple
Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card:
{token: "tok_visa"}.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A payment method domain represents a web domain that you have registered with Stripe.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
Indicates the status of a specific payment method on a payment method domain.
Contains additional details about the status of a payment method for a specific payment
method domain.
State, county, province, or region.
The customer's preferred card network for co-branded cards.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
A Payment Record is a resource that allows you to represent payments that occur on- or
off-Stripe.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
A representation of an amount of money, consisting of an amount and a currency.
Information about the customer for this payment.
Details about the Payment Method used in this payment attempt.
For more details about AchCreditTransfer, please refer to the API Reference.
For more details about AchDebit, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Billie, please refer to the API
Reference.
Billing details used by the customer for this payment.
A representation of a physical address.
For more details about Blik, please refer to the API
Reference.
For more details about Boleto, please refer to the API
Reference.
Details of the card used for this payment attempt.
For more details about Checks, please refer to the API Reference.
For more details about NetworkToken, please refer to the API Reference.
For more details about ThreeDSecure, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
Custom Payment Methods represent Payment Method types not modeled directly in the Stripe API.
For more details about CustomerBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Gopay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about InteracPresent, please refer to the API Reference.
For more details about Receipt, please refer to the API Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about PayerDetails, please refer to the API Reference.
For more details about Address, please refer to the API Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about Store, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about MbWay, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about PayByBank, please refer to the API Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about SellerProtection, please refer to the API Reference.
For more details about Payto, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Promptpay, please refer to the API Reference.
For more details about Qris, please refer to the API
Reference.
For more details about Rechnung, please refer to the API Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about Funding, please refer to the API Reference.
For more details about Card, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about Satispay, please refer to the API Reference.
For more details about SepaCreditTransfer, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about Shopeepay, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeAccount, please refer to the API Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about Swish, please refer to the API
Reference.
For more details about Twint, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about Wechat, please refer to the API
Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
The customer's shipping information associated with this payment.
A representation of a physical address.
Required. When the reported payment failed.
State, county, province, or region.
Required. When the reported payment was guaranteed.
State, county, province, or region.
The custom payment method type associated with this payment.
Required. A positive integer representing the amount in the smallest currency unit for
example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
State, county, province, or region.
The customer's phone number.
Required. When the reported payment failed.
Required. When the reported payment was guaranteed.
State, county, province, or region.
The custom payment method type associated with this payment.
Creates type adapter for interface
PaymentSource able to deserialize raw JSON to subtype
implementation based on discriminator field object.Unknown subtype of
PaymentSource.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.For more details about TraceId, please refer to the API
Reference.
Maximum value to filter by (inclusive).
For more details about BankAccount, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about UsageStatus, please refer to the API Reference.
For more details about Country, please refer to the API
Reference.
For more details about Field, please refer to the API
Reference.
For more details about LocalNameHuman, please refer to the API Reference.
This is an object representing a person associated with a Stripe account.
For more details about AdditionalAddress, please refer to the API Reference.
For more details about AdditionalName, please refer to the API Reference.
For more details about AdditionalTermsOfService, please refer to the API Reference.
For more details about Account, please refer to the API
Reference.
For more details about AdditionalTosAcceptances, please refer to the API Reference.
For more details about Account, please refer to the API
Reference.
For more details about Address, please refer to the API
Reference.
For more details about AddressKana, please refer to the API Reference.
For more details about AddressKanji, please refer to the API Reference.
For more details about DateOfBirth, please refer to the API Reference.
For more details about Dob, please refer to the API
Reference.
For more details about Documents, please refer to the API
Reference.
For more details about CompanyAuthorization, please refer to the API Reference.
For more details about Passport, please refer to the API Reference.
For more details about PrimaryVerification, please refer to the API Reference.
For more details about FrontBack, please refer to the API Reference.
For more details about SecondaryVerification, please refer to the API Reference.
For more details about FrontBack, please refer to the API Reference.
For more details about Visa, please refer to the API
Reference.
For more details about FutureRequirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about IdNumber, please refer to the API
Reference.
For more details about Relationship, please refer to the API Reference.
For more details about Relationship, please refer to the API Reference.
For more details about Requirements, please refer to the API Reference.
For more details about Alternative, please refer to the API Reference.
For more details about Errors, please refer to the API
Reference.
For more details about ScriptAddresses, please refer to the API Reference.
For more details about Kana, please refer to the API
Reference.
For more details about Kanji, please refer to the API
Reference.
For more details about ScriptNames, please refer to the API Reference.
For more details about Kana, please refer to the API
Reference.
For more details about Kanji, please refer to the API
Reference.
For more details about Verification, please refer to the API Reference.
For more details about AdditionalDocument, please refer to the API Reference.
For more details about Document, please refer to the API Reference.
A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text
that represents a product line.
For more details about CarrierText, please refer to the API Reference.
For more details about Preferences, please refer to the API Reference.
For more details about RejectionReasons, please refer to the API Reference.
The header title text of the carrier letter.
Only return the personalization design that is set as the Connect platform's default.
The header title text of the carrier letter.
The user agent of the browser from which the account representative accepted the service
agreement.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
The user agent of the browser from which the Account's representative accepted the terms
of service.
Required. The year of birth.
Required. A file upload token
representing the front of the verification document.
Required. A file upload token
representing the front of the verification document.
Required. The format of the document.
The person's last or family name.
The title or position the person holds in the associated legal entity.
Town or cho-me.
The person's last or family name.
The user agent of the browser from which the account representative accepted the service
agreement.
The user agent of the browser from which the Account's representative accepted the terms
of service.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
Required. The year of birth.
Add all elements to `files` list.
A file upload
token representing the front of the verification document.
A file upload
token representing the front of the verification document.
Add all elements to `files` list.
Required. The format of the document.
The person's last or family name.
Add all elements to `files` list.
State, county, province, or region.
The title or position the person holds in the associated legal entity.
Town or cho-me.
The person's last or family name.
The person's title (e.g., CEO, Support Engineer).
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.
For more details about Features, please refer to the API
Reference.
You can now model subscriptions more flexibly using the Prices API.
For more details about Tier, please refer to the API
Reference.
For more details about TransformUsage, please refer to the API Reference.
A label that represents units of this product.
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and
one-time purchases of products.
For more details about CurrencyOption, please refer to the API Reference.
For more details about CustomUnitAmount, please refer to the API Reference.
For more details about Tier, please refer to the API
Reference.
For more details about CustomUnitAmount, please refer to the API Reference.
For more details about MigrateTo, please refer to the API
Reference.
For more details about Recurring, please refer to the API
Reference.
For more details about Tier, please refer to the API
Reference.
For more details about TransformQuantity, please refer to the API Reference.
The starting unit amount which can be updated by the customer.
The starting unit amount which can be updated by the customer.
A label that represents units of this product.
Maximum value to filter by (inclusive).
The starting unit amount which can be updated by the customer.
A Climate product represents a type of carbon removal unit available for reservation.
Products describe the specific goods or services you offer to your customers.
For more details about CurrentPricesPerMetricTon, please refer to the API Reference.
For more details about MarketingFeature, please refer to the API Reference.
For more details about PackageDimensions, please refer to the API Reference.
For more details about Provisioning, please refer to the API Reference.
For more details about GiftCard, please refer to the API Reference.
For more details about FixedAmount, please refer to the API Reference.
The starting unit amount which can be updated by the customer.
The starting unit amount which can be updated by the customer.
Required. The marketing feature name.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
A product_feature represents an attachment between a feature and a product.
Maximum value to filter by (inclusive).
Required. The marketing feature name.
A Promotion Code represents a customer-redeemable code for a coupon.
For more details about Restrictions, please refer to the API Reference.
For more details about CurrencyOption, please refer to the API Reference.
Error returned when the recipient's recent total amount in outbound payments has exceeded its
limit.
A Quote is a way to model prices that you'd like to provide to a customer.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about Computed, please refer to the API
Reference.
For more details about LastReestimationDetails, please refer to the API Reference.
For more details about Failed, please refer to the API Reference.
For more details about Recurring, please refer to the API Reference.
For more details about TotalDetails, please refer to the API Reference.
For more details about Breakdown, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Tax, please refer to the API Reference.
For more details about Upfront, please refer to the API
Reference.
For more details about TotalDetails, please refer to the API Reference.
For more details about Breakdown, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Tax, please refer to the API Reference.
For more details about FromQuote, please refer to the API
Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API
Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Canceled, please refer to the API Reference.
For more details about Stale, please refer to the API
Reference.
For more details about LastReason, please refer to the API Reference.
For more details about LinesInvalid, please refer to the API Reference.
For more details about SubscriptionChanged, please refer to the API Reference.
For more details about SubscriptionScheduleChanged, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about SubscriptionData, please refer to the API Reference.
For more details about BillOnAcceptance, please refer to the API Reference.
For more details about BillFrom, please refer to the API Reference.
For more details about LineStartsAt, please refer to the API Reference.
For more details about BillUntil, please refer to the API Reference.
For more details about Duration, please refer to the API Reference.
For more details about LineEndsAt, please refer to the API Reference.
For more details about Prebilling, please refer to the API Reference.
For more details about SubscriptionDataOverride, please refer to the API Reference.
For more details about AppliesTo, please refer to the API Reference.
For more details about BillOnAcceptance, please refer to the API Reference.
For more details about BillFrom, please refer to the API Reference.
For more details about LineStartsAt, please refer to the API Reference.
For more details about BillUntil, please refer to the API Reference.
For more details about Duration, please refer to the API Reference.
For more details about LineEndsAt, please refer to the API Reference.
For more details about SubscriptionSchedule, please refer to the API Reference.
For more details about AppliesTo, please refer to the API Reference.
For more details about TotalDetails, please refer to the API Reference.
For more details about Breakdown, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about TransferData, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than 0.
Required. The
id of the quote that will be cloned.Required. Type of the account referenced in the request.
Required. The type of calculation made to determine when the
discount ends.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
The ID of a promotion code to remove from the
discounts array.Required. ID of a price to remove.
An ID of an existing promotion code to replace the
discounts array with.Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The position of the previous quote line in the
lines array after which this
line should begin.Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Required. This is used to determine the number of billing cycles to
prebill.
The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.A quote line defines a set of changes, in the order provided, that will be applied upon quote
acceptance.
For more details about Action, please refer to the API
Reference.
For more details about AddDiscount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about AddItem, please refer to the API
Reference.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about Trial, please refer to the API
Reference.
For more details about RemoveDiscount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about RemoveItem, please refer to the API Reference.
For more details about SetDiscount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about SetItem, please refer to the API
Reference.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about Trial, please refer to the API
Reference.
For more details about AppliesTo, please refer to the API
Reference.
Configures the immediate cancellation settings for a subscription schedule via quotes.
For more details about EndsAt, please refer to the API
Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about Duration, please refer to the API Reference.
Configures the pause collection settings for a subscription during a phase.
The Pause Collection settings specify how to pause collection for a subscription during a
phase by modifying the behavior of the invoices that are generated during the paused period.
For more details about StartsAt, please refer to the API
Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about LineEndsAt, please refer to the API Reference.
Configures how the scheduled subscription behaves during the trial period.
Defines how the scheduled subscription behaves when a trial ends.
Invoices are statements of amounts owed by a customer, and are either generated one-off, or
generated periodically from a subscription.
For more details about AmountsDue, please refer to the API Reference.
For more details about AppliesTo, please refer to the API
Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about ConfirmationSecret, please refer to the API Reference.
For more details about CustomerTaxId, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about FromInvoice, please refer to the API Reference.
For more details about Issuer, please refer to the API
Reference.
For more details about Parent, please refer to the API
Reference.
For more details about QuoteDetails, please refer to the API Reference.
For more details about SubscriptionDetails, please refer to the API Reference.
The Pause Collection settings determine how we will pause collection for this subscription
and for how long the subscription should be paused.
For more details about PaymentSettings, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Installments, please refer to the API Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
QuotePreviewInvoice.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer
For more details about EuBankTransfer, please refer to the API Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Konbini, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about Rendering, please refer to the API
Reference.
For more details about Pdf, please refer to the API
Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about ThresholdReason, please refer to the API Reference.
For more details about ItemReason, please refer to the API Reference.
For more details about TotalDiscountAmount, please refer to the API Reference.
For more details about TotalMarginAmount, please refer to the API Reference.
For more details about TotalPretaxCreditAmount, please refer to the API Reference.
For more details about TotalTax, please refer to the API
Reference.
For more details about TaxRateDetails, please refer to the API Reference.
For more details about AppliesTo, please refer to the API
Reference.
For more details about CurrentPhase, please refer to the API Reference.
For more details about DefaultSettings, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
For more details about TransferData, please refer to the API Reference.
For more details about LastPriceMigrationError, please refer to the API Reference.
For more details about FailedTransition, please refer to the API Reference.
A phase describes the plans, coupon, and trialing status of a subscription for a predefined
time period.
An Add Invoice Item describes the prices and quantities that will be added as pending invoice
items when entering a phase.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
A phase item describes the price and quantity of a phase.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about Trial, please refer to the API
Reference.
The Pause Collection settings specify how to pause collection for a subscription during a
phase by modifying the behavior of the invoices that are generated during the paused period.
For more details about TransferData, please refer to the API Reference.
Configures how the scheduled subscription behaves during the trial period.
Defines how the scheduled subscription behaves when a trial ends.
Prebilling stores the time period and invoice for a Subscription billed in advance.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of the account referenced in the request.
Required. The type of calculation made to determine when the
discount ends.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
The ID of a promotion code to remove from the
discounts array.Required. ID of a price to remove.
An ID of an existing promotion code to replace the
discounts array with.Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The position of the previous quote line in the
lines array after which this
line should begin.Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Required. This is used to determine the number of billing cycles to
prebill.
The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.A Reader represents a physical device for accepting payment details.
Represents an action performed by the reader.
Represents a reader action to collect customer inputs.
Represents an input to be collected using the reader.
Represents custom text to be displayed when collecting the input using a reader.
Information about a email being collected using a reader.
Information about a number being collected using a reader.
Information about a phone number being collected using a reader.
Information about a selection being collected using a reader.
Choice to be selected on a Reader.
Information about a signature being collected using a reader.
Information about text being collected using a reader.
Information about an input's toggle.
Represents a reader action to collect a payment method.
Represents a per-transaction override of a reader configuration.
Represents a per-transaction tipping configuration.
Represents a reader action to confirm a payment.
Represents a reader action to process a payment intent.
Represents a per-transaction override of a reader configuration.
Represents a per-transaction tipping configuration.
Represents a reader action to process a setup intent.
Represents a per-setup override of a reader configuration.
Represents a reader action to refund a payment.
Represents a per-transaction override of a reader configuration.
Represents a reader action to set the reader display.
Represents a cart to be displayed on the reader.
Represents a line item to be displayed on the reader.
Returns data collected by Terminal readers.
Represents magstripe data collected by the reader.
The card number, as a string without any separators.
Card Number.
Add all map key/value pairs to `extraParams` map.
Required. The quantity of the line item being purchased.
ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH
or wire).
For more details about BalanceTransfer, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about GbBankAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about CardSpend, please refer to the API
Reference.
For more details about Dispute, please refer to the API
Reference.
For more details about Refund, please refer to the API
Reference.
For more details about InitiatingPaymentMethodDetails, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about FinancialAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about LinkedFlows, please refer to the API Reference.
For more details about SourceFlowDetails, please refer to the API Reference.
For more details about NetworkDetails, please refer to the API Reference.
For more details about Ach, please refer to the API
Reference.
For more details about ReversalDetails, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Failed, please refer to the API
Reference.
For more details about Returned, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
The bank account's routing number.
Add all map key/value pairs to `extraParams` map.
ReceivedDebits represent funds pulled from a FinancialAccount.
For more details about BankTransfer, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about CardSpend, please refer to the API
Reference.
For more details about Authorization, please refer to the API Reference.
For more details about CardTransaction, please refer to the API Reference.
For more details about InitiatingPaymentMethodDetails, please refer to the API Reference.
For more details about BillingDetails, please refer to the API Reference.
For more details about FinancialAccount, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about LinkedFlows, please refer to the API Reference.
For more details about NetworkDetails, please refer to the API Reference.
For more details about Ach, please refer to the API
Reference.
For more details about ReversalDetails, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Failed, please refer to the API
Reference.
For more details about StatusTransitions, please refer to the API Reference.
The bank account's routing number.
Add all map key/value pairs to `extraParams` map.
Error returned when the user enables notifications in the OutboundPayment request, but an email
is not set up on the recipient account.
Redaction Jobs store the status of a redaction request.
Add all elements to `setupIntents` list.
The objects to redact, grouped by type.
Validation errors.
Refund objects allow you to refund a previously created charge that isn't refunded yet.
For more details about DestinationDetails, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about Alma, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBankTransfer, please refer to the API Reference.
For more details about Blik, please refer to the API
Reference.
For more details about BrBankTransfer, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerCashBalance, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about GbBankTransfer, please refer to the API Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about JpBankTransfer, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about MxBankTransfer, please refer to the API Reference.
For more details about NzBankTransfer, please refer to the API Reference.
For more details about P24, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Pix, please refer to the API
Reference.
For more details about Revolut, please refer to the API
Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about Swish, please refer to the API
Reference.
For more details about ThBankTransfer, please refer to the API Reference.
For more details about UsBankTransfer, please refer to the API Reference.
For more details about WechatPay, please refer to the API Reference.
For more details about Zip, please refer to the API
Reference.
For more details about NextAction, please refer to the API Reference.
For more details about DisplayDetails, please refer to the API Reference.
For more details about EmailSent, please refer to the API Reference.
For more details about PresentmentDetails, please refer to the API Reference.
A Tax
Registration lets us know that your business is registered to collect tax on
payments within a region, enabling you to automatically
collect tax.For more details about CountryOptions, please refer to the API Reference.
For more details about Ae, please refer to the API
Reference.
For more details about Al, please refer to the API
Reference.
For more details about Am, please refer to the API
Reference.
For more details about Ao, please refer to the API
Reference.
For more details about At, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Au, please refer to the API
Reference.
For more details about Ba, please refer to the API
Reference.
For more details about Bb, please refer to the API
Reference.
For more details about Be, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Bg, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Bh, please refer to the API
Reference.
For more details about Bs, please refer to the API
Reference.
For more details about By, please refer to the API
Reference.
For more details about Ca, please refer to the API
Reference.
For more details about ProvinceStandard, please refer to the API Reference.
For more details about Cd, please refer to the API
Reference.
For more details about Ch, please refer to the API
Reference.
For more details about Cl, please refer to the API
Reference.
For more details about Co, please refer to the API
Reference.
For more details about Cr, please refer to the API
Reference.
For more details about Cy, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Cz, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about De, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Dk, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Ec, please refer to the API
Reference.
For more details about Ee, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Eg, please refer to the API
Reference.
For more details about Es, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Fi, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Fr, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Gb, please refer to the API
Reference.
For more details about Ge, please refer to the API
Reference.
For more details about Gn, please refer to the API
Reference.
For more details about Gr, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Hr, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Hu, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Id, please refer to the API
Reference.
For more details about Ie, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about In, please refer to the API
Reference.
For more details about Is, please refer to the API
Reference.
For more details about It, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Jp, please refer to the API
Reference.
For more details about Ke, please refer to the API
Reference.
For more details about Kh, please refer to the API
Reference.
For more details about Kr, please refer to the API
Reference.
For more details about Kz, please refer to the API
Reference.
For more details about Lt, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Lu, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Lv, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Ma, please refer to the API
Reference.
For more details about Md, please refer to the API
Reference.
For more details about Me, please refer to the API
Reference.
For more details about Mk, please refer to the API
Reference.
For more details about Mr, please refer to the API
Reference.
For more details about Mt, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Mx, please refer to the API
Reference.
For more details about My, please refer to the API
Reference.
For more details about Ng, please refer to the API
Reference.
For more details about Nl, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about No, please refer to the API
Reference.
For more details about Np, please refer to the API
Reference.
For more details about Nz, please refer to the API
Reference.
For more details about Om, please refer to the API
Reference.
For more details about Pe, please refer to the API
Reference.
For more details about Pl, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Pt, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Ro, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Rs, please refer to the API
Reference.
For more details about Ru, please refer to the API
Reference.
For more details about Sa, please refer to the API
Reference.
For more details about Se, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Sg, please refer to the API
Reference.
For more details about Si, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Sk, please refer to the API
Reference.
For more details about Standard, please refer to the API Reference.
For more details about Sn, please refer to the API
Reference.
For more details about Sr, please refer to the API
Reference.
For more details about Th, please refer to the API
Reference.
For more details about Tj, please refer to the API
Reference.
For more details about Tr, please refer to the API
Reference.
For more details about Tz, please refer to the API
Reference.
For more details about Ug, please refer to the API
Reference.
For more details about Us, please refer to the API
Reference.
For more details about LocalAmusementTax, please refer to the API Reference.
For more details about LocalLeaseTax, please refer to the API Reference.
For more details about StateSalesTax, please refer to the API Reference.
For more details about Election, please refer to the API Reference.
For more details about Uy, please refer to the API
Reference.
For more details about Uz, please refer to the API
Reference.
For more details about Vn, please refer to the API
Reference.
For more details about Za, please refer to the API
Reference.
For more details about Zm, please refer to the API
Reference.
For more details about Zw, please refer to the API
Reference.
Required. Type of registration to be created in
country.Required. Two-letter CA province code (ISO 3166-2).
Required. A FIPS code
representing the local jurisdiction.
Required. A FIPS code
representing the local jurisdiction.
Required. The type of the election for the state sales tax
registration.
The Report Run object represents an instance of a report type generated with specific run
parameters.
For more details about Parameters, please refer to the API Reference.
The Report Type resource corresponds to a particular type of report, such as the "Activity
summary" or "Itemized payouts" reports.
Instructs Stripe to make a request on your behalf using the destination URL.
Metadata about the forwarded request.
Details about the request forwarded to the destination endpoint.
Header data.
Details about the response from the destination endpoint.
Header data.
Required. The header value.
Reviews can be used to supplement automated fraud detection with human expertise.
For more details about IpAddressLocation, please refer to the API Reference.
For more details about Session, please refer to the API
Reference.
If you have scheduled a Sigma
query, you'll receive a
sigma.scheduled_query_run.created webhook each time the query
runs.For more details about Errors, please refer to the API
Reference.
Provides an
Iterable<T>foreachSecret Store is an API that allows Stripe Apps developers to securely persist secrets for use by
UI Extensions and app backends.
For more details about Scope, please refer to the API
Reference.
The Billing customer portal is a Stripe-hosted UI for subscription and billing management.
A Checkout Session represents your customer's session as they pay for one-time purchases or
subscriptions through Checkout or Payment Links.
A Financial Connections Session is the secure way to programmatically launch the client-side
Stripe.js modal that lets your users link their accounts.
For more details about AccountHolder, please refer to the API Reference.
For more details about AdaptivePricing, please refer to the API Reference.
For more details about AfterExpiration, please refer to the API Reference.
For more details about Recovery, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about CollectedInformation, please refer to the API Reference.
For more details about ShippingDetails, please refer to the API Reference.
For more details about TaxId, please refer to the API
Reference.
For more details about Consent, please refer to the API
Reference.
For more details about ConsentCollection, please refer to the API Reference.
For more details about PaymentMethodReuseAgreement, please refer to the API Reference.
For more details about CurrencyConversion, please refer to the API Reference.
For more details about CustomerDetails, please refer to the API Reference.
For more details about TaxId, please refer to the API
Reference.
For more details about CustomField, please refer to the API Reference.
For more details about Dropdown, please refer to the API Reference.
For more details about Option, please refer to the API Reference.
For more details about Label, please refer to the API
Reference.
For more details about Numeric, please refer to the API
Reference.
For more details about Text, please refer to the API
Reference.
For more details about CustomText, please refer to the API Reference.
For more details about AfterSubmit, please refer to the API Reference.
For more details about ShippingAddress, please refer to the API Reference.
For more details about Submit, please refer to the API
Reference.
For more details about TermsOfServiceAcceptance, please refer to the API Reference.
For more details about Discount, please refer to the API
Reference.
For more details about Filters, please refer to the API
Reference.
For more details about Flow, please refer to the API
Reference.
For more details about AfterCompletion, please refer to the API Reference.
For more details about HostedConfirmation, please refer to the API Reference.
For more details about Redirect, please refer to the API Reference.
For more details about SubscriptionCancel, please refer to the API Reference.
For more details about Retention, please refer to the API Reference.
For more details about CouponOffer, please refer to the API Reference.
For more details about SubscriptionUpdate, please refer to the API Reference.
For more details about SubscriptionUpdateConfirm, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Item, please refer to the API
Reference.
For more details about InvoiceCreation, please refer to the API Reference.
For more details about InvoiceData, please refer to the API Reference.
For more details about CustomField, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
For more details about RenderingOptions, please refer to the API Reference.
For more details about Limits, please refer to the API
Reference.
For more details about ManualEntry, please refer to the API Reference.
For more details about OptionalItem, please refer to the API Reference.
For more details about AdjustableQuantity, please refer to the API Reference.
For more details about PaymentMethodConfigurationDetails, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Affirm, please refer to the API
Reference.
For more details about AfterpayClearpay, please refer to the API Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Installments, please refer to the API Reference.
For more details about Restrictions, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Fpx, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Grabpay, please refer to the API
Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Konbini, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about Mobilepay, please refer to the API Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about Oxxo, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about Payco, please refer to the API
Reference.
For more details about Paynow, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Pix, please refer to the API
Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SamsungPay, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about Swish, please refer to the API
Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about ManualEntry, please refer to the API Reference.
For more details about Permissions, please refer to the API Reference.
For more details about Update, please refer to the API
Reference.
For more details about PhoneNumberCollection, please refer to the API Reference.
For more details about PresentmentDetails, please refer to the API Reference.
For more details about SavedPaymentMethodOptions, please refer to the API Reference.
For more details about ShippingAddressCollection, please refer to the API Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about ShippingOption, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Cancelled, please refer to the API Reference.
For more details about TaxIdCollection, please refer to the API Reference.
For more details about TotalDetails, please refer to the API Reference.
For more details about Breakdown, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about WalletOptions, please refer to the API Reference.
For more details about Link, please refer to the API
Reference.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. Text may be up to 1200 characters in length.
Required. The value for this option, not displayed to the customer,
used by your integration to reconcile the option selected by the customer.
The minimum character length requirement for the customer's input.
The minimum character length requirement for the customer's input.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Required. Text may be up to 1200 characters in length.
Add all map key/value pairs to `extraParams` map.
Required. The URL the customer will be redirected to after the flow is
completed.
Add all map key/value pairs to `extraParams` map.
Required. The ID of the subscription to be updated.
The ID of a promotion code to apply to this subscription update.
Quantity for this item
that the customer should subscribe to through this flow.
The ID of a promotion code to apply to this Session.
Add all map key/value pairs to `extraParams` map.
The minimum quantity the customer must purchase for the Checkout Session.
Add all map key/value pairs to `extraParams` map.
The number of intervals between subscription billings.
The minimum quantity of this item the customer must purchase, if they choose to purchase
it.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Prefix used to generate the Mandate reference.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
The order reference that will be displayed to customers in the Swish application.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
Add all map key/value pairs to `extraParams` map.
The Stripe account for which the setup is intended.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
Required. Type of the account referenced in the request.
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
The minimum quantity the customer must purchase for the Checkout Session.
You can use Tax
Settings to manage configurations used by Stripe Tax calculations.For more details about Defaults, please refer to the API
Reference.
For more details about HeadOffice, please refer to the API Reference.
For more details about StatusDetails, please refer to the API Reference.
For more details about Active, please refer to the API
Reference.
For more details about Pending, please refer to the API
Reference.
When a non-stripe BIN is used, any use of an issued
card must be settled directly with the card network.
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation
is successful or unsuccessful.
For more details about PaymentMethodDetails, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Boleto, please refer to the API
Reference.
For more details about Card, please refer to the API
Reference.
For more details about Checks, please refer to the API Reference.
For more details about ThreeDSecure, please refer to the API Reference.
For more details about Wallet, please refer to the API Reference.
For more details about ApplePay, please refer to the API Reference.
For more details about GooglePay, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Offline, please refer to the API Reference.
For more details about Cashapp, please refer to the API
Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about KakaoPay, please refer to the API Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about KrCard, please refer to the API
Reference.
For more details about Link, please refer to the API
Reference.
For more details about NaverPay, please refer to the API Reference.
For more details about NzBankAccount, please refer to the API Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about RevolutPay, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about StripeBalance, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
A SetupIntent guides you through the process of setting up and saving a customer's payment
credentials for future payments.
For more details about AutomaticPaymentMethods, please refer to the API Reference.
For more details about NextAction, please refer to the API Reference.
For more details about CashappHandleRedirectOrDisplayQrCode, please refer to the API Reference.
For more details about QrCode, please refer to the API Reference.
For more details about RedirectToUrl, please refer to the API Reference.
For more details about VerifyWithMicrodeposits, please refer to the API Reference.
For more details about PaymentMethodConfigurationDetails, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about AmazonPay, please refer to the API Reference.
For more details about BacsDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about Link, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Payto, please refer to the API
Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about ManualEntry, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
The user agent of the browser from which the Mandate was accepted by the customer.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
SetupIntentConfirmParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.ManualEntry.Builder
Add all map key/value pairs to `extraParams` map.
Required. The user agent of the browser from which the Mandate was
accepted by the customer.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
[Deprecated] This is a legacy parameter that no longer has any function.
Add all elements to `subsellers` list.
Date, in YYYY-MM-DD format, from which payments will be collected.
Prefix used to generate the Mandate reference.
Add all elements to `requested` list.
Add all elements to `requested` list.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Sort code of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Required. The tax ID of the customer (CPF for individual consumers or
CNPJ for businesses consumers)
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The suffix of the bank account number.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The PayID alias for the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. The four-digit year of birth.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Prefix used to generate the Mandate reference.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
[Deprecated] This is a legacy parameter that no longer has any function.
Add all elements to `subsellers` list.
Date, in YYYY-MM-DD format, from which payments will be collected.
Prefix used to generate the Mandate reference.
Shipping rates describe the price of shipping presented to your customers and applied to a
purchase.
For more details about DeliveryEstimate, please refer to the API Reference.
For more details about Maximum, please refer to the API
Reference.
For more details about Minimum, please refer to the API
Reference.
For more details about FixedAmount, please refer to the API Reference.
For more details about CurrencyOption, please refer to the API Reference.
Required. Must be greater than 0.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
Source objects allow you to accept a variety of payment methods.For more details about AchCreditTransfer, please refer to the API Reference.
For more details about AchDebit, please refer to the API
Reference.
For more details about AcssDebit, please refer to the API
Reference.
For more details about Alipay, please refer to the API
Reference.
For more details about AuBecsDebit, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about CardPresent, please refer to the API Reference.
For more details about CodeVerification, please refer to the API Reference.
For more details about Eps, please refer to the API
Reference.
For more details about Giropay, please refer to the API
Reference.
For more details about Ideal, please refer to the API
Reference.
For more details about Klarna, please refer to the API
Reference.
For more details about Multibanco, please refer to the API Reference.
For more details about Owner, please refer to the API
Reference.
For more details about P24, please refer to the API
Reference.
For more details about Paypal, please refer to the API
Reference.
For more details about Receiver, please refer to the API
Reference.
For more details about Redirect, please refer to the API
Reference.
For more details about SepaCreditTransfer, please refer to the API Reference.
For more details about SepaDebit, please refer to the API
Reference.
For more details about Sofort, please refer to the API
Reference.
For more details about SourceOrder, please refer to the API Reference.
For more details about Item, please refer to the API
Reference.
For more details about ThreeDSecure, please refer to the API Reference.
For more details about Wechat, please refer to the API
Reference.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the mandate was accepted or refused by the
customer.
State, county, province, or region.
Required. The URL you provide to redirect the customer back to you after
they authenticated their payment.
Source mandate notifications should be created when a notification related to a source mandate
must be sent to the payer.
For more details about AcssDebit, please refer to the API
Reference.
For more details about BacsDebit, please refer to the API
Reference.
For more details about SepaDebit, please refer to the API
Reference.
Some payment methods have no required amount that a customer must send.
For more details about AchCreditTransfer, please refer to the API Reference.
For more details about ChfCreditTransfer, please refer to the API Reference.
For more details about GbpCreditTransfer, please refer to the API Reference.
For more details about PaperCheck, please refer to the API Reference.
For more details about SepaCreditTransfer, please refer to the API Reference.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the mandate was accepted or refused by the
customer.
State, county, province, or region.
This class provides a set of methods and properties that can be used to accurately measure
elapsed time.
Represents a
StripeObject that has properties or method that can make HTTP requests.This is the primary entrypoint to make requests against Stripe's API.
Provides a representation of a single page worth of data from the Stripe API.
Provides a representation of a single page worth of data from the Stripe API.
Fallback class for when we do not recognize the object that we have received.
A request to Stripe's API.
A response from Stripe's API, with body represented as a String.
Controls how the request is sent by
StripeResponseGetterProvides a representation of a single page worth of data from a Stripe API search method.
Subscriptions allow you to charge a customer on a recurring basis.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about BillingCycleAnchorConfig, please refer to the API Reference.
For more details about CancellationDetails, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API
Reference.
For more details about LastPriceMigrationError, please refer to the API Reference.
For more details about FailedTransition, please refer to the API Reference.
The Pause Collection settings determine how we will pause collection for this subscription and
for how long the subscription should be paused.
For more details about PaymentSettings, please refer to the API Reference.
For more details about PaymentMethodOptions, please refer to the API Reference.
For more details about AcssDebit, please refer to the API Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about Bancontact, please refer to the API Reference.
For more details about Card, please refer to the API
Reference.
For more details about MandateOptions, please refer to the API Reference.
For more details about CustomerBalance, please refer to the API Reference.
For more details about BankTransfer, please refer to the API Reference.
For more details about EuBankTransfer, please refer to the API Reference.
For more details about IdBankTransfer, please refer to the API Reference.
For more details about Konbini, please refer to the API Reference.
For more details about SepaDebit, please refer to the API Reference.
For more details about UsBankAccount, please refer to the API Reference.
For more details about FinancialConnections, please refer to the API Reference.
For more details about Filters, please refer to the API Reference.
For more details about PendingInvoiceItemInterval, please refer to the API Reference.
Pending Updates store the changes pending from a previous update that will be applied to the
Subscription upon successful payment.
Prebilling stores the time period and invoice for a Subscription billed in advance.
For more details about TransferData, please refer to the API Reference.
Configures how this subscription behaves during the trial period.
Defines how a subscription behaves when a free trial ends.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Required. Type of the account referenced in the request.
Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
The second of the minute the billing_cycle_anchor should be.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
ID of the institution to use to filter for selectable accounts.
Add all map key/value pairs to `extraParams` map.
Subscription items allow you to create customer subscriptions with more than one plan, making it
easy to represent complex billing relationships.
For more details about Trial, please refer to the API
Reference.
Required. The number of intervals, as an whole number greater than 0.
Required. The number of intervals, as an whole number greater than 0.
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
A subscription schedule allows you to create and manage the lifecycle of a subscription by
predefining expected changes.
For more details about CurrentPhase, please refer to the API Reference.
For more details about DefaultSettings, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
For more details about TransferData, please refer to the API Reference.
For more details about LastPriceMigrationError, please refer to the API Reference.
For more details about FailedTransition, please refer to the API Reference.
A phase describes the plans, coupon, and trialing status of a subscription for a predefined
time period.
An Add Invoice Item describes the prices and quantities that will be added as pending invoice
items when entering a phase.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about AutomaticTax, please refer to the API Reference.
For more details about Liability, please refer to the API Reference.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about InvoiceSettings, please refer to the API Reference.
For more details about Issuer, please refer to the API Reference.
A phase item describes the price and quantity of a phase.
For more details about Discount, please refer to the API Reference.
For more details about DiscountEnd, please refer to the API Reference.
For more details about Trial, please refer to the API
Reference.
The Pause Collection settings specify how to pause collection for a subscription during a
phase by modifying the behavior of the invoices that are generated during the paused period.
For more details about TransferData, please refer to the API Reference.
Configures how the scheduled subscription behaves during the trial period.
Defines how the scheduled subscription behaves when a trial ends.
Prebilling stores the time period and invoice for a Subscription billed in advance.
Add all map key/value pairs to `extraParams` map.
Required. The position of the previous amendment in the
amendments array after which this amendment should begin.Add all map key/value pairs to `extraParams` map.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. The type of calculation made to determine when the
discount ends.
The ID of a promotion code to remove from the
discounts array.An ID of an existing promotion code to replace the
discounts array with.Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. ID of a price to remove.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. The position of the amendment in the
amendments
array with which prebilling should begin.Required. The position of the amendment in the
amendments
array at which prebilling should end.Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of the account referenced in the request.
Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
ID of the institution to use to filter for selectable accounts.
Add all map key/value pairs to `extraParams` map.
A supplier of carbon removal.
For more details about Location, please refer to the API
Reference.
Tax codes classify goods and services
for tax purposes.
You can add one or multiple tax IDs to a customer or account.
For more details about Owner, please refer to the API
Reference.
For more details about Verification, please refer to the API Reference.
The amount of the tax rate when the
rate_type`` is flat_amount. Tax rates with
rate_typepercentagecan vary based on the transaction, resulting in this field
beingnull`.The temporary session token has expired.
A test clock enables deterministic control over objects in testmode.
For more details about StatusDetails, please refer to the API Reference.
For more details about Advancing, please refer to the API Reference.
ThinEvent represents the json that's delivered from an Event Destination.
Receive and process thin events like the v1.billing.meter.error_report_triggered event.
Represents a type that cannot properly be generated, due to a problem with the generator or a
non-standard API definition.
An issuing token object is created when an issued card is added to a digital wallet.
Tokenization is the process Stripe uses to collect sensitive card or bank account details, or
personally identifiable information (PII), directly from your customers in a secure manner.
For more details about NetworkData, please refer to the API Reference.
For more details about Device, please refer to the API
Reference.
For more details about Mastercard, please refer to the API Reference.
For more details about Visa, please refer to the API
Reference.
For more details about WalletProvider, please refer to the API Reference.
For more details about CardholderAddress, please refer to the API Reference.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
The user agent of the browser from which the directorship declaration attestation was
made.
The user agent of the browser from which the beneficial owner attestation was made.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
The customer's preferred card network for co-branded cards.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the account representative accepted the
service agreement.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
Add all elements to `files` list.
Add all elements to `files` list.
Add all elements to `files` list.
State, county, province, or region.
The person's title (e.g., CEO, Support Engineer).
Maximum value to filter by (inclusive).
To top up your Stripe balance, you create a top-up object.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
A Transaction represents a real transaction that affects a Financial Connections Account balance.
A gift card transaction represents a single transaction on a referenced gift card.
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.A Tax Transaction records the tax collected from or refunded to your customer.
Transactions represent changes to a FinancialAccount's balance.
For more details about AmountDetails, please refer to the API Reference.
Change to a FinancialAccount's balance.
For more details about BalanceImpact, please refer to the API Reference.
For more details about CreatedBy, please refer to the API
Reference.
For more details about Checkout, please refer to the API Reference.
For more details about Order, please refer to the API
Reference.
For more details about Payment, please refer to the API
Reference.
For more details about CustomerDetails, please refer to the API Reference.
For more details about Address, please refer to the API
Reference.
For more details about TaxId, please refer to the API
Reference.
For more details about Flow, please refer to the API
Reference.
For more details about FlowDetails, please refer to the API Reference.
For more details about MerchantData, please refer to the API Reference.
For more details about NetworkData, please refer to the API Reference.
For more details about PurchaseDetails, please refer to the API Reference.
For more details about Fleet, please refer to the API
Reference.
For more details about CardholderPromptData, please refer to the API Reference.
For more details about ReportedBreakdown, please refer to the API Reference.
For more details about Fuel, please refer to the API Reference.
For more details about NonFuel, please refer to the API Reference.
For more details about Tax, please refer to the API
Reference.
For more details about Flight, please refer to the API
Reference.
For more details about Segment, please refer to the API Reference.
For more details about Fuel, please refer to the API
Reference.
For more details about Lodging, please refer to the API
Reference.
For more details about Receipt, please refer to the API
Reference.
For more details about Reversal, please refer to the API
Reference.
For more details about ShipFromDetails, please refer to the API Reference.
For more details about Address, please refer to the API
Reference.
For more details about ShippingCost, please refer to the API Reference.
For more details about TaxBreakdown, please refer to the API Reference.
For more details about Jurisdiction, please refer to the API Reference.
For more details about TaxRateDetails, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about StatusTransitions, please refer to the API Reference.
For more details about Treasury, please refer to the API
Reference.
Add all map key/value pairs to `extraParams` map.
Required. A custom identifier for this line item in the reversal
transaction, such as 'L1-refund'.
TransactionEntries represent individual units of money movements within a single Transaction.
Change to a FinancialAccount's balance.
For more details about BalanceImpact, please refer to the API Reference.
For more details about FlowDetails, please refer to the API Reference.
For more details about TransactionDetails, please refer to the API Reference.
For more details about Flow, please refer to the API
Reference.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
For more details about Reversal, please refer to the API
Reference.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
A
Transfer object is created when you move funds between Stripe accounts as part of
Connect.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.
UnsupportedGrantTypeException is raised when an unuspported grant type parameter is specified.
UnsupportedResponseTypeException is raised when an unsupported response type parameter is
specified.
Deserializer to convert JSON object into an untyped map.
Value lists allow you to group values together which can then be referenced in rules.
Value list items allow you to add specific values to a given Radar value list, which can then be
used in rules.
A VerificationReport is the result of an attempt to collect and verify data from a user.
Result from a document check.
Point in Time.
For more details about Errors, please refer to the API
Reference.
Point in Time.
Point in Time.
Result from a email check.
For more details about Errors, please refer to the API
Reference.
Result from an id_number check.
Point in Time.
For more details about Errors, please refer to the API
Reference.
For more details about Options, please refer to the API
Reference.
For more details about Document, please refer to the API Reference.
For more details about IdNumber, please refer to the API Reference.
Result from a phone check.
For more details about Errors, please refer to the API
Reference.
Result from a selfie check.
For more details about Errors, please refer to the API
Reference.
Maximum value to filter by (inclusive).
A VerificationSession guides you through the process of collecting and verifying the identities
of your users.
Shows last VerificationSession error.
For more details about Options, please refer to the API
Reference.
For more details about Document, please refer to the API Reference.
For more details about Email, please refer to the API
Reference.
For more details about IdNumber, please refer to the API Reference.
For more details about Phone, please refer to the API
Reference.
For more details about ProvidedDetails, please refer to the API Reference.
For more details about Redaction, please refer to the API
Reference.
For more details about VerifiedOutputs, please refer to the API Reference.
Point in Time.
Capture a face image and perform a selfie check
comparing a photo ID and a picture of your user’s face.
Phone number of user being verified.
Maximum value to filter by (inclusive).
Capture a face image and perform a selfie check
comparing a photo ID and a picture of your user’s face.
Phone number of user being verified.
You can configure webhook endpoints via the API
to be notified about events that happen in your Stripe account or connected accounts.