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.
 
 
 
Three-letter ISO currency code, in lowercase.
 
 
 
 
 
 
Get expanded front.
 
 
 
A value indicating the Stripe dashboard this account has access to independent of the Connect application.
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
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.
 
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.
Required. The four-digit year of birth.
 
State, county, province, or region.
 
The person's title (e.g., CEO, Support Engineer).
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
Required.
 
 
 
 
 
 
 
Add all elements to `files` list.
 
 
 
 
 
 
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 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.
 
 
 
Whether to allow platforms to control bank account collection for their connected accounts.
 
Whether to allow platforms to control bank account collection for their connected accounts.
 
Whether to allow creation of standard payouts.
 
 
 
Whether to allow platforms to control bank account collection for their connected accounts.
 
Whether to allow sending refunds.
 
Whether to allow sending refunds.
 
Whether to allow creation of standard payouts.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
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.
 
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.
Required. The four-digit year of birth.
 
State, county, province, or region.
 
The person's title (e.g., CEO, Support Engineer).
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
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.
 
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.
 
An active entitlement describes access to a feature for a customer.
 
 
 
 
 
 
A summary of a customer's active entitlements.
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
When an issued card is used to make a purchase, an Issuing Authorization object is created.
 
 
 
 
 
The amount of cash requested by the cardholder.
 
 
The amount of cash requested by the cardholder.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
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.
 
 
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
 
 
 
 
 
 
 
 
 
The base address to use for the request.
 
 
A Tax Calculation allows you to calculate the tax to collect from your customer.
 
 
 
The value of the tax ID.
 
 
 
The tax type, such as vat or sales_tax.
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
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 user agent of the browser from which the cardholder accepted the Authorized User Terms.
 
Required. 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 user agent of the browser from which the cardholder accepted the Authorized User Terms.
 
Required. 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.
 
 
 
 
 
 
 
 
The Charge object represents a single attempt to move money into your Stripe account.
 
 
 
 
 
 
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.
 
 
The last 4 digits of the card.
 
 
 
 
 
Indicates whether the transaction is eligible for PayPal's seller protection.
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
Required. The product id.
 
A File ID representing an image you would like displayed on the reader.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
Required. The product id.
 
A File ID representing an image you would like displayed on the reader.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
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.
 
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.
Details of the PaymentMethod collected by Payment Element.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Owner's verified shipping address.
 
The preferred network for the card.
 
 
 
 
 
 
 
 
The preferred network for the card.
 
The four-digit year of birth.
 
 
 
 
 
 
 
 
 
 
 
Get expanded setupAttempt.
 
 
 
 
 
The reason why this PaymentMethod's fingerprint has been blocked
 
 
 
 
 
 
 
 
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.
 
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.
 
 
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.
 
 
 
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.
 
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.
 
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.
 
State, county, province, or region.
 
 
 
 
 
 
 
 
 
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.
 
 
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
 
 
 
 
Required. The amount on which tax is calculated, in cents (or local equivalent).
The ID of the shipping rate to use for this order.
 
 
The credit note line item object.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. The amount on which tax is calculated, in cents (or local equivalent).
The ID of the shipping rate to use for this order.
 
 
 
 
 
 
 
 
 
Required. The amount on which tax is calculated, in cents (or local equivalent).
The ID of the shipping rate to use for this order.
 
 
 
 
 
 
 
 
 
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.
 
 
 
Required. The value of the custom field.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
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 client access to Stripe's frontend SDKs (like StripeJs) 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 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.
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
State, county, province, or region.
 
 
 
 
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.
 
 
 
 
 
 
 
 
ExchangeRate 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.
A feature represents a monetizable ability or functionality in your system.
 
 
 
 
 
 
 
 
 
 
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.
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
ABA Records contain U.S.
Restrictions that a Connect Platform has placed on this FinancialAccount.
 
 
 
 
 
 
 
 
 
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 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.
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
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.
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.
The StripeResponseGetterOptions implementation that pulls values from the global options in the Stripe class
 
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.
 
 
 
 
 
Get expanded mandate.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
Get expanded account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Data features requested to be retrieved upon account creation.
 
Page size of invoice pdf.
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
The quantity threshold boundary that applied to the given line item.
 
 
 
 
 
 
 
 
 
 
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.
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. 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 map key/value pairs to `extraParams` map.
 
 
 
 
 
 
Add all elements to `prefetch` list.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
 
 
Indicates if the billing_cycle_anchor should be reset when a threshold is reached.
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Invoice Items represent the component lines of an invoice.
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
Credited invoice line items.
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
A tax code ID.
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
 
 
Indicates if the billing_cycle_anchor should be reset when a threshold is reached.
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
The number of intervals between subscription billings.
 
The number of intervals between subscription billings.
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
 
 
Indicates if the billing_cycle_anchor should be reset when a threshold is reached.
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
The number of intervals between subscription billings.
 
The number of intervals between subscription billings.
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
ID of the promotion code to create a new discount for.
 
Required. The start of the period.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ID of the promotion code to create a new discount for.
 
 
Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
 
 
Indicates if the billing_cycle_anchor should be reset when a threshold is reached.
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
The number of intervals between subscription billings.
 
The number of intervals between subscription billings.
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
Required. Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. Type of installment plan, one of fixed_count.