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.Whether this account has access to the full Stripe dashboard (
full), to the Express
dashboard (express), or to no dashboard (none).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.
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.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
The user agent of the browser from which the beneficial owner attestation was made.
Whether the controller has pricing controls for this account.
Whether this account should have access to the full Stripe dashboard (
full) or no
dashboard (none).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.
Required. The four-digit year of birth.
State, county, province, or region.
A CSS hex color value representing the secondary branding color for this account.
The user agent of the browser from which the account representative accepted the
service agreement.
Add all map key/value pairs to `extraParams` map.
The Kanji variation of the default text that appears on credit card statements when a
charge is made (Japan only).
The day of the week when available funds are paid out, specified as
monday,
tuesday, etc.The user agent of the browser from which the account representative accepted the
service agreement.
Account Links are the means by which a Connect platform grants a connected account permission to
access Stripe-hosted applications, such as Connect Onboarding.
Describes an owner of an account.
Describes a snapshot of the owners of an account at a particular point in time.
An AccountSession allows a Connect platform to grant access to a connected account in Connect
embedded components.
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.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
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.
Required. The four-digit year of birth.
State, county, province, or region.
A CSS hex color value representing the secondary branding color for this account.
The user agent of the browser from which the account representative accepted the
service agreement.
Add all map key/value pairs to `extraParams` map.
The Kanji variation of the default text that appears on credit card statements when a
charge is made (Japan only).
The day of the week when available funds are paid out, specified as
monday,
tuesday, etc.The user agent of the browser from which the account representative accepted the
service agreement.
ApiKeyMissingException is thrown when the API key is not set for a request.Super class to all api request params objects.
Interface implemented by all enum parameter to get the actual string value that Stripe API
expects.
When an issued card is used to make a purchase, an
Issuing
Authorization object is created.The fee charged by the ATM for the cash withdrawal.
The fee charged by the ATM for the cash withdrawal.
Maximum value to filter by (inclusive).
This is an object representing your Stripe balance.
Amount for FPX.
Amount for FPX.
Amount for FPX.
Amount for FPX.
Balance transactions represent funds moving through your Stripe account.
Maximum value to filter by (inclusive).
Creates type adapter for interface
BalanceTransactionSource able to deserialize raw JSON
to subtype implementation based on discriminator field object.Unknown subtype of
BalanceTransactionSource.These bank accounts are payment methods on
Customer objects.The specific user onboarding requirement field (in the requirements hash) that needs to be
resolved.
A Tax Calculation allows you to calculate the tax to collect from your customer.
The value of the tax ID.
The tax type, such as
vat or sales_tax.State/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.
A gift card represents a single gift card owned by a customer, including the remaining balance,
gift card code, and whether or not it is active.
You can create physical or virtual cards that
are issued to cardholders.
A registration number used for customs in Europe.
Interval (or event) to which the amount applies.
A Card 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.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
A Card Design is a logical grouping of a Card Bundle, card logo, and carrier text that represents
a product line.
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.
Maximum value to filter by (inclusive).
State, county, province, or region.
The entity's business ID number.
The user agent of the browser from which the cardholder accepted the Authorized User
Terms.
Required. The four-digit year of birth.
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
A case-insensitive
Map.A customer's
Cash balance represents real funds.The
Charge object represents a single attempt to move money into your Stripe account.The predicate to evaluate the payment against.
Type of installment plan, one of
fixed_count.Owner's verified shipping address.
An indication of various EMV functions performed during the transaction.
An indication of various EMV functions performed during the transaction.
The name of the convenience store chain where the payment was completed.
Indicates whether the transaction is eligible for PayPal's seller protection.
Options to configure Radar.
State, county, province, or region.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
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.
State, county, province, or region.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
A portal configuration describes the functionality and behavior of a portal session.
A Configurations object represents how features should be configured for terminal readers.
Which cancellation reasons will be given as options to the customer.
The product ID.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
A link to the business’s publicly available terms of service.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The product id.
A File ID representing an image you would like displayed on the reader.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
A link to the business’s publicly available terms of service.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The product id.
A File ID representing an image you would like displayed on the reader.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
Below this amount, fixed amounts will be displayed; above it, percentages will be
displayed.
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Stripe needs to collect certain pieces of information about each account created.
A coupon contains information about a percent-off or amount-off discount you might want to apply
to a customer.
Add all elements to `products` list.
Add all map key/value pairs to `extraParams` map.
Issue a credit note to adjust an invoice's amount after the invoice is finalized.
The amount on which tax is calculated, in %s.
The ID of the shipping rate to use for this order.
The ID of the shipping rate to use for this order.
You can reverse some ReceivedCredits
depending on their network and source flow.
This object represents a customer of your business.
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
Each customer has a Balance value,
which denotes a debit or credit that's automatically applied to their next invoice upon
finalization.
Customers with certain payments enabled have a cash balance, representing funds that were paid by
the customer to a merchant, but have not yet been allocated to a payment.
The full name of the sender, as supplied by the sending bank.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Controls how funds transferred by the customer are applied to payment intents and
invoices.
Required. The value of the custom field.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
A recent IP address of the customer used for tax reporting and tax location inference.
A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)
control over a customer.
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.
A recent IP address of the customer used for tax reporting and tax location inference.
You can reverse some ReceivedDebits
depending on their network and source flow.
A discount represents the actual application of a coupon or promotion code.
A dispute occurs when a customer questions your charge with their card issuer.
As a card issuer, you can dispute transactions that
the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
Get expanded
additionalDocumentation.Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of.
Add all map key/value pairs to `extraParams` map.
Date when the product was received.
Maximum value to filter by (inclusive).
An early fraud warning indicates that the card issuer has notified us that a charge may be
fraudulent.
Events are our way of letting you know when something interesting happens in your account.
Deserialization helper to get
StripeObject and handle failure due to schema
incompatibility between the data object and the model classes.Definition of event data object JSON transformation to be compatible to API version of the
library.
Exchange Rate objects allow you to determine the rates that Stripe is currently using to
convert from one currency to another.Creates type adapter for interface
ExternalAccount able to deserialize raw JSON to
subtype implementation based on discriminator field object.Unknown subtype of
ExternalAccount.Application Fee Refund objects allow you to refund an application fee that has previously
been created but not yet refunded.This is an object representing a file 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.
This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.
This is an object representing the terms of an offer of financing from Stripe Capital to a
Connected account.
This is an object representing the terms of an offer of financing from Stripe Capital to a
Connected account.
Maximum value to filter by (inclusive).
A financing object describes an account's current financing state.
The current repayment interval for the Connected account.
This is an object representing the details of a transaction on a Capital financing object.
This is an object representing a transaction on a Capital financing offer.
This is an object representing a linked transaction on a Capital Financing Transaction.
Tax forms are legal documents which are delivered to one or more tax authorities for information
reporting purposes.
Each customer has a
balance
that is automatically applied to future invoices and payments using the customer_balance
payment method.FinancialAddresses contain identifying information that resolves to a FinancialAccount.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
Zengin Records contain Japan bank account details per the Zengin format.
Base abstract class for HTTP clients used to send requests to Stripe's API.
Represents the content of an HTTP request, i.e.
A read-only view of a set of HTTP headers.
Use InboundTransfers
to add funds to your FinancialAccount via a PaymentMethod
that is owned by you.
Routing number of the bank account.
A historical balance for the account on a particular day.
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.
Data features requested to be retrieved upon account creation.
The amount on which tax is calculated, in %s.
The Pause Collection settings determine how we will pause collection for this subscription
and for how long the subscription should be paused.
The time after which the subscription will resume collecting payments.
The quantity threshold boundary that applied to the given line item.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The value of the custom field.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of installment plan, one of
fixed_count.InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
InvoiceCreateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Prefetch
Add all elements to `prefetch` list.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State, county, province, or region.
Invoice Items represent the component lines of an invoice.
Required. The number of intervals, as an whole number greater than 0.
Required. The start of the period.
Required. The number of intervals, as an whole number greater than 0.
Required. The start of the period.
Credited invoice line items.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
State, county, province, or region.
A recent IP address of the customer used for tax reporting and tax location inference.
Required. The number of intervals, as an whole number greater than 0.
Required. The number of intervals, as an whole number greater than
0.
Required. The start of the period.
Required. This is used to determine the number of billing cycles to
prebill.
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)
Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
State, county, province, or region.
A recent IP address of the customer used for tax reporting and tax location inference.
Required. The number of intervals, as an whole number greater than 0.
Required. The number of intervals, as an whole number greater than
0.
Required. The start of the period.
Required. This is used to determine the number of billing cycles to
prebill.
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)
Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The value of the custom field.
Required. The number of intervals, as an whole number greater than 0.
Required. Type of installment plan, one of
fixed_count.InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransfer
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
InvoiceUpdateParams.PaymentSettings.PaymentMethodOptions.UsBankAccount.FinancialConnections.Prefetch
Add all elements to `prefetch` list.
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 login link for an Express account to access their Stripe dashboard.
A Mandate is a record of the permission a customer has given you to debit their payment method.
The user agent of the browser from which the Mandate was accepted by the customer.
Frequency indicator of each recurring payment.
Common interface for Stripe objects that can store metadata.
Base parent class for all OAuth exceptions.
An Order describes a purchase being made by a customer, including the products & quantities
being purchased, the order status, the payment information, and the billing/shipping details.
The token of the gift card applied to the order.
Get expanded
destination.The amount on which tax is calculated, in %s.
The value of the tax ID.
Add all map key/value pairs to `extraParams` map.
State/province as an ISO 3166-2
subdivision code, without country prefix.
ID of the promotion code to create a new discount for.
Add all map key/value pairs to `extraParams` map.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State/province as an ISO 3166-2
subdivision code, without country prefix.
Add all map key/value pairs to `extraParams` map.
State/province as an ISO 3166-2
subdivision code, without country prefix.
ID of the promotion code to create a new discount for.
Add all map key/value pairs to `extraParams` map.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
State/province as an ISO 3166-2
subdivision code, without country prefix.
Use OutboundPayments to send funds to another party's external bank account or FinancialAccount.
Routing number of the bank account.
State, county, province, or region.
The US bank account network that must be used for this OutboundPayment.
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod
belonging to the same entity.
Routing number of the bank account.
ACH Addenda record.
Designate the OutboundTransfer as using a US bank account network configuration.
Provides an
Iterable<T>foreachA 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.
Iban Records contain E.U.
Sort Code Records contain U.K.
SPEI Records contain Mexico bank account details per the SPEI format.
Zengin Records contain Japan bank account details per the Zengin format.
The branch name of the account.
The payment code.
An universal link that redirect to WeChat Pay app.
Indicates whether the goods or services are tax-exempt or tax is not collected.
Transaction type of the mandate.
Type of installment plan, one of
fixed_count.State, county, province, or region.
The desired country code of the bank account information.
Settings for configuring manual entry of account details.
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.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
State, county, province, or region.
Required. The user agent of the browser from which the Mandate was
accepted by the customer.
State, county, province, or region.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
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.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
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.
Required. Type of installment plan, one of
fixed_count.Request ability to increment
this PaymentIntent if the combination of MCC and card brand is eligible.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
Add all map key/value pairs to `extraParams` map.
Required. The user agent of the browser from which the Mandate was
accepted by the customer.
State, county, province, or region.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
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.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
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.
Required. Type of installment plan, one of
fixed_count.Request ability to increment
this PaymentIntent if the combination of MCC and card brand is eligible.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
The user agent of the browser from which the Mandate was accepted by the customer.
State, county, province, or region.
State, county, province, or region.
The fare class for the segment.
State, county, province, or region.
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.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
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.
Required. Type of installment plan, one of
fixed_count.Request ability to increment
this PaymentIntent if the combination of MCC and card brand is eligible.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Indicates that you intend to make future payments with this PaymentIntent's payment
method.
State, county, province, or region.
A payment link is a shareable URL that will take your customers to a hosted payment page.
The URL the customer will be redirected to after the purchase is complete.
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 1000 characters in length.
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
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.
Add all map key/value pairs to `extraParams` map.
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 1000 characters in length.
Required. Text may be up to 1000 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.
The ID of the Shipping Rate to use for this shipping option.
Integer representing the number of trial period days before the customer is charged for the
first time.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The URL the customer will be redirected to after the purchase
is complete.
Add all map key/value pairs to `extraParams` map.
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 1000 characters in length.
Required. Text may be up to 1000 characters in length.
Add all map key/value pairs to `extraParams` map.
The minimum quantity the customer can purchase.
PaymentMethod objects represent your customer's payment instruments.
Owner's verified shipping address.
The preferred network for the card.
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
An object detailing payment method configurations.
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.
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.
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)
Required. The card number, as a string without any separators.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
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.
A Radar Session is a snapshot of
the browser metadata and device details that help Radar make more accurate predictions on
your payments.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Required.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
State, county, province, or region.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
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 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.
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).
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).
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.
Default number of trial days when subscribing a customer to this plan using
trial_from_plan=true.Products describe the specific goods or services you offer to your customers.
The starting unit amount which can be updated by the customer.
Required. Width, in inches.
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
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.
The amount on which tax is calculated, in %s.
The amount on which tax is calculated, in %s.
The subscription schedule's state before the quote was marked as stale.
Unique identifier for the object.
Unique identifier for the object.
Unique identifier for the object.
Describes whether the quote line is affecting a new schedule or an existing schedule.
The amount on which tax is calculated, in %s.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than 0.
Required. The
id of the quote that will be cloned.Add all map key/value pairs to `extraParams` map.
Required. The type of calculation made to determine when the
discount ends.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Required. ID of a price to remove.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The position of the previous quote line in the
lines array after which this
line should begin.Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
The number of intervals between subscription billings.
Required. The number of intervals, as an whole number greater than
0.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Required. This is used to determine the number of billing cycles to
prebill.
The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.A quote line defines a set of changes that will be applied upon quote acceptance.
The discount end type.
The discount end type.
List of price IDs which, if present on the subscription following a paid trial,
constitute opting-in to the paid trial.
The discount end type.
The discount end type.
List of price IDs which, if present on the subscription following a paid trial,
constitute opting-in to the paid trial.
Configures the pause collection settings for a subscription during a phase.
The Pause Collection settings specify how to pause collection for a subscription during a
phase by modifying the behavior of the invoices that are generated during the paused period.
The payment collection behavior for this subscription while paused.
Configures how the scheduled subscription behaves during the trial period.
Defines how the scheduled subscription behaves when a trial ends.
A quote phase describes the line items, coupons, and trialing status of a subscription for a
predefined time period.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than 0.
Add all map key/value pairs to `extraParams` map.
Required. The type of calculation made to determine when the
discount ends.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Required. ID of a price to remove.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
The position of the previous quote line in the
lines array after which this
line should begin.Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
The number of intervals between subscription billings.
Required. The number of intervals, as an whole number greater than
0.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Required. This is used to determine the number of billing cycles to
prebill.
The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.The position of the previous quote line in the
lines array after which this
line should begin.A Reader represents a physical device for accepting payment details.
Represents an action performed by the reader.
Represents a reader action to collect customer inputs.
Represents an input to be collected using the reader.
Represents custom text to be displayed when collecting the input using a reader.
Information about a selection being collected using a reader.
Choice to be selected on a Reader.
Information about a signature being collected using a reader.
Represents a reader action to collect a payment method.
Represents a per-transaction override of a reader configuration.
Represents a per-transaction tipping configuration.
Represents a reader action to confirm a payment.
Represents a reader action to process a payment intent.
Represents a per-transaction override of a reader configuration.
Represents a per-transaction tipping configuration.
Represents a reader action to process a setup intent.
Represents a reader action to refund a payment.
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.
ACH Addenda record.
The bank account's routing number.
Add all map key/value pairs to `extraParams` map.
ReceivedDebits represent funds pulled from a FinancialAccount.
The routing number for the bank account.
ACH Addenda record.
The bank account's routing number.
Add all map key/value pairs to `extraParams` map.
Refund objects allow you to refund a charge that has previously been created but not yet
refunded.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.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.
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>foreachSecret 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.
Text may be up to 1000 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 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.
Settings for configuring manual entry of account details.
The amount on which tax is calculated, in %s.
Add all map 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. Text may be up to 1000 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 1000 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.
Required. The ID of the subscription to be canceled.
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.
Add all map key/value pairs to `extraParams` map.
The minimum quantity the customer must purchase for the Checkout Session.
Add all map key/value pairs to `extraParams` map.
The number of intervals between subscription billings.
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.
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.
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
was successful or unsuccessful.
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.
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.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
Required. IBAN of the bank account.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
SetupIntentConfirmParams.PaymentMethodOptions.UsBankAccount.FinancialConnections.ManualEntry.Builder
Add all map key/value pairs to `extraParams` map.
Required. The user agent of the browser from which the Mandate was
accepted by the customer.
Required. Transit number of the customer's bank.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
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.
[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.
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.
A Radar Session is a snapshot
of the browser metadata and device details that help Radar make more accurate predictions
on your payments.
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.
[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.
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.
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.
The Pause Collection settings determine how we will pause collection for this subscription and
for how long the subscription should be paused.
Data features requested to be retrieved upon account creation.
Pending Updates store the changes pending from a previous update that will be applied to the
Subscription upon successful payment.
Prebilling stores the time period and invoice for a Subscription billed in advance.
Configures how this subscription behaves during the trial period.
Defines how a subscription behaves when a free trial ends.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Add all map key/value pairs to `extraParams` map.
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.Required. The number of intervals, as an whole number greater than 0.
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)
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all elements to `prefetch` list.
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)
Required. The number of intervals, as an whole number greater than 0.
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)
Required. The number of intervals, as an whole number greater than 0.
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
A subscription schedule allows you to create and manage the lifecycle of a subscription by
predefining expected changes.
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.
The discount end type.
The discount end type.
A phase item describes the price and quantity of a phase.
The discount end type.
The Pause Collection settings specify how to pause collection for a subscription during a
phase by modifying the behavior of the invoices that are generated during the paused period.
Configures how the scheduled subscription behaves during the trial period.
Defines how the scheduled subscription behaves when a trial ends.
Prebilling stores the time period and invoice for a Subscription billed in advance.
Add all map key/value pairs to `extraParams` map.
Required. The position of the previous amendment in the
amendments array after which this amendment should begin.Add all map key/value pairs to `extraParams` map.
Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Required. The type of calculation made to determine when the
discount ends.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. ID of a price to remove.
Required. The number of intervals, as an whole number greater
than 0.
Required. Determines the type of trial for this item.
Required. The position of the amendment in the
amendments
array with which prebilling should begin.Required. The position of the amendment in the
amendments
array at which prebilling should end.Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Indicates if the
billing_cycle_anchor should be reset when a threshold is
reached.Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Indicates if the
billing_cycle_anchor should be reset when a threshold is
reached.Required. The number of intervals, as an whole number greater than
0.
Add all map key/value pairs to `extraParams` map.
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)
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Indicates if the
billing_cycle_anchor should be reset when a threshold is
reached.Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Configure how an opt-in following a paid trial is billed when using
billing_behavior: prorate_up_front.Add all map key/value pairs to `extraParams` map.
Indicates if the
billing_cycle_anchor should be reset when a threshold is
reached.Required. The number of intervals, as an whole number greater than
0.
Add all map key/value pairs to `extraParams` map.
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)
Required. The number of intervals, as an whole number greater than
0.
Required. Determines the type of trial for this item.
Add all map key/value pairs to `extraParams` map.
Required. The number of intervals, as an whole number greater than
0.
Same as
unit_amount, but accepts a decimal value in cents (or local equivalent)
with at most 12 decimal places.Required. Indicates how the subscription should change when the trial
ends if the user did not provide a payment method.
Add all map key/value pairs to `extraParams` map.
Indicates if the
billing_cycle_anchor should be reset when a threshold is reached.Required. The number of intervals, as an whole number greater than 0.
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)
Required. The number of intervals, as an whole number greater than
0.
The number of intervals between subscription billings.
Add all map key/value pairs to `extraParams` map.
Add all map key/value pairs to `extraParams` map.
Add all elements to `prefetch` list.
Add all map key/value pairs to `extraParams` map.
Tax codes classify goods and services
for tax purposes.
You can add one or multiple tax IDs to a customer.
A test clock enables deterministic control over objects in testmode.
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 user agent of the browser from which the beneficial owner attestation was made.
State, county, province, or region.
Town or cho-me.
Town or cho-me.
Required. The four-digit year of birth.
State, county, province, or region.
Required.
Add all map key/value pairs to `extraParams` map.
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).
To top up your Stripe balance, you create a top-up object.
Maximum value to filter by (inclusive).
Maximum value to filter by (inclusive).
A Transaction represents a real transaction that affects a Financial Connections Account balance.
A gift card transaction represents a single transaction on a referenced gift card.
Any use of an issued card that results in funds
entering or leaving your Stripe account, such as a completed purchase or refund, is represented
by an Issuing
Transaction object.A Tax Transaction records the tax collected from or refunded to your customer.
Transactions represent changes to a FinancialAccount's balance.
Change to a FinancialAccount's balance.
Whether a stopover is allowed on this flight.
The value of the tax ID.
The unit cost of the item in cents.
Maximum value to filter by (inclusive).
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).
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 an id_number check.
Point in Time.
A human-readable message giving the reason for the failure.
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.
Point in Time.
Capture a face image and perform a selfie check
comparing a photo ID and a picture of your user’s face.
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.
You can configure webhook endpoints via the API
to be notified about events that happen in your Stripe account or connected accounts.