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.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the 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 statement_descriptor used for charges in Japan.
 
 
 
 
 
 
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.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the capability for the account, if it is not already requested.
 
Passing true requests the 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 statement_descriptor used for charges in Japan.
 
 
 
 
 
 
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.
 
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.
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
Amount of national Sales Tax or VAT included in the transaction amount.
 
 
 
 
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.
 
 
 
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.
 
 
Amount for FPX.
 
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.
 
State/province as an ISO 3166-2 subdivision code, without country prefix.
 
 
 
The tax type, such as vat or sales_tax.
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
 
 
 
 
 
State/province as an ISO 3166-2 subdivision code, without country prefix.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
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.
 
 
 
 
 
 
 
 
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.
 
 
 
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
 
 
 
 
 
 
 
 
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.
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
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.
 
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.
Details of the PaymentMethod collected by Payment Element.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
 
 
 
 
 
 
 
 
 
Owner's verified shipping address.
 
 
 
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
 
 
 
 
 
 
 
 
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.
 
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.
 
 
 
 
 
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).
 
 
 
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 credit note line item object.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Required. The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
 
 
 
 
 
 
 
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 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.
 
 
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.
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The account subcategories to use to filter for possible accounts to link.
 
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 map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
 
 
 
 
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.
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
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.
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
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.
 
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
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.
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
A Location represents a grouping of readers.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Login Links are single-use URLs for a connected account to access the Express Dashboard.
 
 
A Mandate is a record of the permission that your customer gives you to debit their payment method.
 
 
 
The customer accepts the mandate using the user agent of the browser.
 
 
 
 
 
 
 
 
 
 
 
 
Mandate collection method
 
 
 
Common interface for Stripe objects that can store metadata.
A billing meter is a resource that allows you to track usage of a particular event.
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
A billing meter event represents a customer's usage of a product.
A billing meter event adjustment is a resource that allows you to cancel a meter event.
 
 
 
 
 
Unique identifier for the event.
 
 
 
 
 
 
 
A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Base parent class for all OAuth exceptions.
Orders represent your intent to purchase a particular Climate product.
 
The delivery of a specified quantity of carbon for an order.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Use OutboundPayments to send funds to another party's external bank account or FinancialAccount.
 
 
 
 
Get expanded mandate.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
 
 
 
 
Specifies the network rails to be used.
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity.
 
 
 
Get expanded mandate.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
The image_url_svg string used to render QR code.
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 branch name of the account.
 
 
 
 
 
The payment code.
 
 
 
 
 
 
 
The image_url_svg string used to render QR 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.
 
Requested routing priority
 
 
 
The desired country code of the bank account information.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The account subcategories to use to filter for possible accounts to link.
Mandate collection method
 
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.
 
 
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.
 
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.
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
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.
 
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.
 
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.
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
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.
 
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.
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. Type of installment plan, one of fixed_count.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
Get expanded account.
 
Determines the position and visibility of the payment method reuse agreement in the UI.
 
 
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.
 
 
 
 
Text may be up to 1200 characters in length.
 
 
 
 
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
 
 
 
The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.
 
 
 
 
Configures how this subscription behaves during the trial period.
Defines how a subscription behaves when a free trial ends.
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.
 
 
 
 
 
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.
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
A string that identifies the resulting payment as part of a group.
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
 
 
 
 
 
 
 
 
 
Owner's verified shipping address.
 
 
 
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
 
 
 
 
 
 
 
 
The preferred network for the card.
 
The four-digit year of birth.
 
 
 
 
 
 
 
 
 
Options to configure Radar.
 
 
 
Get expanded setupAttempt.
 
 
 
 
 
 
The reason why this PaymentMethod's fingerprint has been blocked
 
 
 
 
PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types.
 
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
The effective display preference value.
 
 
 
 
 
 
 
 
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.
 
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)
 
 
 
 
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.
 
 
 
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.
 
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.
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
State, county, province, or region.
 
 
 
 
The customer's preferred card network for co-branded cards.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
This is an object representing a person associated with a Stripe account.
 
 
The user agent of the browser from which the legal guardian accepted the service agreement.
 
 
 
 
 
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.
 
 
A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
 
 
 
 
 
 
 
 
 
 
 
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 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).
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
You can now model subscriptions more flexibly using the Prices API.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
Up to and including to this quantity will be contained in the tier.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The starting unit amount which can be updated by the customer.
 
 
 
 
 
 
 
 
Required. The marketing feature name.
 
Required. Width, in inches.
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A Quote is a way to model prices that you'd like to provide to a customer.
 
 
Get expanded account.
 
 
 
 
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
Get expanded account.
 
 
 
 
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
ID of the promotion code to create a new discount for.
 
Required. The id of the quote that will be cloned.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Add all map key/value pairs to `extraParams` map.
Required. Type of the account referenced in the request.
 
ID of the promotion code to create a new discount for.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
ID of the promotion code to create a new discount for.
 
 
 
 
 
The number of intervals between subscription billings.
 
 
 
 
 
 
A Reader represents a physical device for accepting payment details.
Represents an action performed by the reader.
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The card number, as a string without any separators.
 
Card Number.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Required. The quantity of the line item being purchased.
 
 
ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire).
 
 
 
 
The routing number for the bank account.
 
The type of the source flow that originated the ReceivedCredit.
 
 
 
 
 
 
The bank account's routing number.
 
 
 
 
 
 
 
 
 
 
 
 
 
ReceivedDebits represent funds pulled from a FinancialAccount.
 
 
 
 
The routing number for the bank account.
 
 
 
 
 
 
 
The bank account's routing number.
 
 
 
 
 
 
 
 
 
 
Refund objects allow you to refund a previously created charge that isn't refunded yet.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
Two-letter CA province code (ISO 3166-2).
 
 
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
 
 
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
 
 
Place of supply scheme used in an EU standard registration.
 
 
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
 
Place of supply scheme used in an EU standard registration.
 
Place of supply scheme used in an EU standard registration.
 
 
 
 
A FIPS code representing the local jurisdiction.
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The Report Run object represents an instance of a report type generated with specific run parameters.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
If you have scheduled a Sigma query, you'll receive a sigma.scheduled_query_run.created webhook each time the query runs.
 
 
 
 
 
 
 
Provides an Iterable<T> target that automatically iterates across all API pages and which is suitable for use with a foreach loop.
 
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session.
 
Get expanded account.
 
 
Determines the position and visibility of the payment method reuse agreement in the UI.
Text may be up to 1200 characters in length.
 
 
 
 
The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer.
 
 
The value entered by the customer.
 
 
 
 
 
 
 
 
 
The URL the customer will be redirected to after the flow is completed.
 
 
The ID of the coupon to be offered.
 
 
 
The value of the tax ID.
 
 
 
 
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
 
 
 
Transaction type of the mandate.
 
 
 
 
 
 
 
 
 
Indicates if installments are enabled.
 
 
 
The desired country code of the bank account information.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The account subcategories to use to filter for possible accounts to link.
 
 
 
 
The amount on which tax is calculated, in cents (or local equivalent).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
The number of intervals between subscription billings.
 
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.
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
You can use Tax Settings to manage configurations used by Stripe Tax calculations.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful.
 
 
 
 
 
 
 
 
 
 
 
 
 
The type of the card wallet, one of apple_pay, google_pay, or link.
 
The method used to process this payment method offline.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
 
 
 
 
The image_url_svg string used to render QR code.
 
The type of the microdeposit sent to the customer.
 
 
 
Transaction type of the mandate.
 
 
 
 
Specifies the type of mandates supported.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
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.
 
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.
 
 
 
 
 
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. 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.
 
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.
 
 
 
 
 
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.
 
[Deprecated] This is a legacy parameter that no longer has any function.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
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.
 
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.
 
 
 
 
 
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.
 
[Deprecated] This is a legacy parameter that no longer has any function.
 
Add all map key/value pairs to `extraParams` map.
 
 
 
Add all map key/value pairs to `extraParams` map.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Shipping rates describe the price of shipping presented to your customers and applied to a purchase.
 
 
 
Must be greater than 0.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The type of this order item.
 
 
 
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.
 
 
 
 
 
 
 
 
Some payment methods have no required amount that a customer must send.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
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 StripeResponseGetter
 
Provides 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.
 
 
Get expanded account.
 
 
 
 
The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
The account subcategories to use to filter for possible accounts to link.
Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
 
Configures how this subscription behaves during the trial period.
Defines how a subscription behaves when a free trial ends.
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Required. Type of the account referenced in the request.
 
The second of the minute the billing_cycle_anchor should be.
 
 
Required. Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Get expanded account.
 
 
Get expanded account.
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.
 
Get expanded promotionCode.
 
Get expanded account.
 
 
 
A phase item describes the price and quantity of a phase.
 
 
Get expanded promotionCode.
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
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.
 
 
 
Indicates if the billing_cycle_anchor should be reset when a threshold is reached.
 
 
 
 
Required. Type of the account referenced in the request.
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
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.
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 supplier of carbon removal.
 
 
 
 
 
 
 
Tax codes classify goods and services for tax purposes.
 
 
 
 
 
 
 
You can add one or multiple tax IDs to a customer or account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A test clock enables deterministic control over objects in testmode.
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
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.
 
 
 
 
 
 
 
 
 
 
 
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).
 
 
 
 
 
The front of an ID returned by a file upload with a purpose value of identity_document.
 
 
 
 
 
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.
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.
 
Change to a FinancialAccount's balance.
 
 
 
 
 
 
 
 
 
 
 
 
 
Amount of national Sales Tax or VAT included in the transaction amount.
 
Whether a stopover is allowed on this flight.
 
 
The value of the tax ID.
 
 
State/province as an ISO 3166-2 subdivision code, without country prefix.
 
 
 
 
 
 
The unit cost of the item in cents.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
 
 
 
 
 
 
Maximum value to filter by (inclusive).
 
Maximum value to filter by (inclusive).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.
Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices.
 
 
 
 
 
 
 
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.
 
Point in Time.
Point in Time.
Result from a email check.
 
Result from an id_number check.
Point in Time.
 
A human-readable message giving the reason for the failure.
 
 
Result from a phone check.
 
Result from a selfie check.
 
 
 
 
 
 
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.
 
 
 
 
 
Request one time password verification of provided_details.phone.
 
 
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.