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.
 
 
 
 
The credit that has been used by the account holder.
 
 
 
 
 
 
 
 
Get expanded front.
 
 
 
 
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
 
 
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
 
 
 
 
The user agent of the browser from which the account representative accepted the service agreement.
 
Whether Stripe automatically declines charges with an incorrect CVC.
 
 
 
The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc.
 
 
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 representative accepted their service agreement.
State, county, province, or region.
 
 
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 front of a document returned by a file upload with a purpose value of additional_verification.
The user agent of the browser from which the beneficial owner attestation was made.
 
 
 
 
 
 
 
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.
 
 
State, county, province, or region.
 
Town or cho-me.
 
 
Town or cho-me.
 
The front of an ID returned by a file upload with a purpose value of identity_document.
The four-digit year of birth.
 
State, county, province, or region.
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
 
A CSS hex color value representing the secondary branding color for this account.
 
 
 
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 the default text that appears on credit card statements when a charge is made (Japan only).
 
 
 
 
 
 
The day of the week when available funds are paid out, specified as monday, tuesday, etc.
 
 
 
The user agent of the browser from which the account representative accepted the service agreement.
 
 
 
 
Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 their service agreement.
State, county, province, or region.
 
 
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 front of a document returned by a file upload with a purpose value of additional_verification.
The user agent of the browser from which the beneficial owner attestation was made.
 
 
 
 
 
 
 
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.
 
 
State, county, province, or region.
 
Town or cho-me.
 
 
Town or cho-me.
 
The front of an ID returned by a file upload with a purpose value of identity_document.
The four-digit year of birth.
 
State, county, province, or region.
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
 
A CSS hex color value representing the secondary branding color for this account.
 
 
 
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 the default text that appears on credit card statements when a charge is made (Japan only).
 
 
 
 
 
 
The day of the week when available funds are paid out, specified as monday, tuesday, etc.
 
 
 
The user agent of the browser from which the account representative accepted the service agreement.
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
When an issued card is used to make a purchase, an Issuing Authorization object is created.
 
 
 
 
 
The fee charged by the ATM for the cash withdrawal.
 
The fee charged by the ATM for the cash withdrawal.
 
 
 
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
This is an object representing your Stripe balance.
 
 
Amount for FPX.
 
Amount for FPX.
 
Amount for FPX.
 
 
Amount for FPX.
 
 
 
Balance transactions represent funds moving through your Stripe account.
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
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.
 
 
 
 
 
 
 
 
This is an object representing a capability for a Stripe account.
 
 
 
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
 
 
 
 
 
 
 
 
 
You can store multiple cards on a customer in order to charge the customer later.
You can create physical or virtual cards that are issued to cardholders.
 
 
A registration number used for customs in Europe.
 
 
Interval (or event) to which the amount applies.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
The user agent of the browser from which the cardholder accepted the Authorized User Terms.
 
 
Get expanded front.
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
The entity's business ID number.
 
 
 
The four-digit year of birth.
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
 
 
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
The entity's business ID number.
 
 
 
The four-digit year of birth.
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
 
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
A case-insensitive Map.
A customer's Cash balance represents real funds.
 
 
 
 
 
 
 
 
To charge a credit or a debit card, you create a Charge object.
 
 
 
 
 
 
 
The predicate to evaluate the payment against.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
Owner's verified shipping address.
 
An indication of various EMV functions performed during the transaction.
 
 
 
 
 
 
 
An indication of various EMV functions performed during the transaction.
 
 
The name of the convenience store chain where the payment was completed.
 
 
 
 
 
 
 
 
 
 
 
 
 
Options to configure Radar.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A portal configuration describes the functionality and behavior of a portal session.
A Configurations object represents how features should be configured for terminal readers.
 
 
 
 
 
 
 
 
Which cancellation reasons will be given as options to the customer.
 
 
The product ID.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Below this amount, fixed amounts will be displayed; above it, percentages will be displayed.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
The product id.
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
The product id.
 
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.
 
 
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
 
 
Stripe needs to collect certain pieces of information about each account created.
 
 
 
 
 
 
 
 
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer.
 
 
 
 
 
 
 
Add all elements to `products` list.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
Issue a credit note to adjust an invoice's amount after the invoice is finalized.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
You can reverse some ReceivedCredits depending on their network and source flow.
 
 
 
 
 
 
 
 
 
This object represents a customer of your business.
 
 
 
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
 
 
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.
 
 
 
 
The full name of the sender, as supplied by the sending bank.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
The value of the custom field.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
 
A recent IP address of the customer used for tax reporting and tax location inference.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
Controls how funds transferred by the customer are applied to payment intents and invoices.
 
 
 
The value of the custom field.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
A recent IP address of the customer used for tax reporting and tax location inference.
 
You can reverse some ReceivedDebits depending on their network and source flow.
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
Get expanded additionalDocumentation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
Date when the product was received.
 
 
 
 
 
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.
 
 
 
 
 
 
 
 
 
 
 
 
Events are our way of letting you know when something interesting happens in your account.
 
 
 
 
 
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.
 
 
 
 
 
 
 
Exchange Rate objects allow you to determine the rates that Stripe is currently using to convert from one currency to another.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Creates type adapter for interface ExternalAccount able to deserialize raw JSON to subtype implementation based on discriminator field object.
Unknown subtype of ExternalAccount.
 
 
 
 
Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `metadata` map.
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.
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
ABA Records contain U.S.
Restrictions that a Connect Platform has placed on this FinancialAccount.
 
 
 
 
 
 
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
 
 
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 a feature.
Additional details on the FinancialAccount Features information.
InboundTransfers contains inbound transfers features for a FinancialAccount.
Toggle settings for enabling/disabling an 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 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 ACH specific feature.
Additional details on the FinancialAccount Features information.
Toggle settings for enabling/disabling a feature.
Additional details on the FinancialAccount Features information.
 
 
 
 
 
 
 
 
 
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
 
 
 
 
 
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
Whether the FinancialAccount should have the Feature.
 
Whether the FinancialAccount should have the Feature.
 
 
 
 
 
Whether the FinancialAccount should have the Feature.
 
 
 
 
Each customer has a balance that is automatically applied to future invoices and payments using the customer_balance payment method.
 
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
Zengin Records contain Japan bank account details per the Zengin format.
 
Base 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.
 
 
 
 
 
Routing number of the bank account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The list of permissions to request.
 
 
 
The quantity threshold boundary that applied to the given line item.
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
 
The value of the custom field.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
Add all elements to `permissions` list.
 
 
 
 
 
 
 
 
Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle.
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The start of the period.
 
 
 
 
 
 
 
 
Credited invoice line items.
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
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.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The start of the period.
 
 
 
The number of intervals between subscription billings.
 
 
 
 
Usage threshold that triggers the subscription to advance to a new billing period.
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
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.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The start of the period.
 
 
 
The number of intervals between subscription billings.
 
 
 
 
Usage threshold that triggers the subscription to advance to a new billing period.
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
 
The value of the custom field.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
Add all elements to `permissions` list.
 
 
 
 
 
 
 
A KeyValuePair holds a key and a value.
A line item.
 
 
 
 
A Location represents a grouping of readers.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A Mandate is a record of the permission a customer has given you to debit their payment method.
 
 
 
The user agent of the browser from which the Mandate was accepted by the customer.
 
 
 
 
 
 
Frequency indicator of each recurring payment.
 
 
 
 
 
 
Common interface for Stripe objects that can store metadata.
 
 
 
Base parent class for all OAuth exceptions.
Use OutboundPayments to send funds to another party's external bank account or FinancialAccount.
 
 
 
 
Routing number of the bank account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
 
 
 
 
The US bank account network that must be used for this OutboundPayment.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity.
 
 
 
Routing number of the bank account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Provides an Iterable<T> target that automatically iterates across all API pages and which is suitable for use with a foreach loop.
 
A PaymentIntent guides you through the process of collecting a payment from your customer.
 
 
Portion of the amount that corresponds to a tip.
 
 
 
 
 
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
Zengin Records contain Japan bank account details per the Zengin format.
The branch name of the account.
 
 
 
 
 
The payment code.
 
 
 
 
 
 
 
 
An universal link that redirect to WeChat Pay app.
 
 
Transaction type of the mandate.
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
Specifies the type of mandates supported.
 
 
 
The desired country code of the bank account information.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
For webview integrations only.
Indicates that you intend to make future payments with this PaymentIntent's payment method.
 
 
If customer approval is required, they need to provide approval before this time.
 
 
 
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
 
 
 
 
 
 
The user agent of the browser from which the Mandate was accepted by the customer.
 
 
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.
 
Sort code of the bank account.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
Add all map key/value pairs to `extraParams` map.
 
 
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.
 
 
 
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.
 
A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
 
IBAN of the bank account.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible.
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
The user agent of the browser from which the Mandate was accepted by the customer.
 
 
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.
 
Sort code of the bank account.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
Add all map key/value pairs to `extraParams` map.
 
 
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.
 
 
 
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.
 
A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
 
IBAN of the bank account.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible.
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
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.
 
Sort code of the bank account.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
Add all map key/value pairs to `extraParams` map.
 
 
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.
 
 
 
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.
 
A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
 
IBAN of the bank account.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible.
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
The URL the customer will be redirected to after the purchase is complete.
 
 
 
 
Text may be up to 1000 characters in length.
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The URL the customer will be redirected to after the purchase is complete.
 
 
Add all map key/value pairs to `extraParams` map.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
Text may be up to 1000 characters in length.
 
Text may be up to 1000 characters in length.
 
 
 
The minimum quantity the customer can purchase.
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
The ID of the Shipping Rate to use for this shipping option.
 
Integer representing the number of trial period days before the customer is charged for the first time.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
The URL the customer will be redirected to after the purchase is complete.
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
Text may be up to 1000 characters in length.
 
Text may be up to 1000 characters in length.
 
 
 
 
 
The minimum quantity the customer can purchase.
 
 
PaymentMethod objects represent your customer's payment instruments.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Owner's verified shipping address.
 
 
 
 
 
 
 
 
 
The four-digit year of birth.
 
 
 
 
 
 
Options to configure Radar.
 
 
Get expanded setupAttempt.
 
 
All supported networks.
 
 
 
 
 
 
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.
 
Sort code of the bank account.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
Add all map key/value pairs to `extraParams` map.
 
 
The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers).
 
The card number, as a string without any separators.
 
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 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.
 
A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
 
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.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
 
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.