Package com.stripe.model
package com.stripe.model
-
ClassDescriptionThis is an object representing a Stripe account.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.Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.A notice to a Connected account.An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.Whether to allow sending refunds.Whether to allow sending refunds.This is an object representing your Stripe balance.Amount for FPX.Amount for FPX.Amount for FPX.Amount for FPX.Balance transactions represent funds moving through your Stripe account.Creates type adapter for interfaceBalanceTransactionSource
able to deserialize raw JSON to subtype implementation based on discriminator fieldobject
.Unknown subtype ofBalanceTransactionSource
.These bank accounts are payment methods onCustomer
objects.The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.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 customer'sCash balance
represents real funds.TheCharge
object represents a single attempt to move money into your Stripe account.The predicate to evaluate the payment against.Type of installment plan, one offixed_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.ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent.Data used for generating a Mandate.This hash contains details about the customer acceptance of the Mandate.This hash contains details about the online acceptance.Details of the PaymentMethod collected by Payment Element.Owner's verified shipping address.The preferred network for the card.The preferred network for the card.The four-digit year of birth.Get expandedsetupAttempt
.The reason why this PaymentMethod's fingerprint has been blockedStripe 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.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 credit note line item object.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.A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs) control over a customer.Configuration for the components supported by this customer session.This hash contains whether the 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.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.Events are our way of letting you know when something interesting happens in your account.Set of key-value pairs attached to the action when creating an Automation.The idempotency key transmitted during the request, if any.Deserialization helper to getStripeObject
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.ExpandableField<T extends HasId>Creates type adapter for interfaceExternalAccount
able to deserialize raw JSON to subtype implementation based on discriminator fieldobject
.Unknown subtype ofExternalAccount
.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.To share the contents of aFile
object with non-Stripe users, you can create aFileLink
.Each customer has abalance
that is automatically applied to future invoices and payments using thecustomer_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.Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.Get expandedaccount
.Data features requested to be retrieved upon account creation.Page size of invoice pdf.The amount on which tax is calculated, in cents (or local equivalent).The 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.Invoice Items represent the component lines of an invoice.Credited invoice line items.The invoice payment object.A line item.Login Links are single-use login link for an Express account to access their Stripe 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 methodA (partner) margin represents a specific discount distributed in partner reseller programs to business partners who resell products and services and earn a discount (margin) for doing so.Common interface for Stripe objects that can store metadata.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 expandeddestination
.The amount on which tax is calculated, in cents (or local equivalent).The value of the tax ID.PagingIterable<T extends HasId>Provides an
target that automatically iterates across all API pages and which is suitable for use with aIterable<T>
loop.foreach
PagingIterator<T extends HasId>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.An universal link that redirect to WeChat Pay app.The phone number of the recipient the ticket is delivered to.Full name of the driver on the reservation.The phone number of the recipient the ticket is delivered to.Specifies a type of interval unit.Transaction type of the mandate.Type of installment plan, one offixed_count
.State, county, province, or region.The desired country code of the bank account information.Settings for configuring manual entry of account details.Mandate collection methodIndicates 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.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 expandedaccount
.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 thecompleted_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.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 expandedsetupAttempt
.The reason why this PaymentMethod's fingerprint has been blockedPaymentMethodConfigurations 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.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.Creates type adapter for interfacePaymentSource
able to deserialize raw JSON to subtype implementation based on discriminator fieldobject
.Unknown subtype ofPaymentSource
.APayout
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.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.You can now model subscriptions more flexibly using the Prices API.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.Products describe the specific goods or services you offer to your customers.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 expandedaccount
.The reason the reestimation failed.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 expandedaccount
.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 cents (or local equivalent).A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.The discount end type.The discount end type.Determines the type of trial for this item.The discount end type.The discount end type.Determines the type of trial for this item.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.Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.Get expandedaccount
.QuotePreviewInvoice.PaymentSettings.PaymentMethodOptions.CustomerBalance.BankTransfer.EuBankTransferData features requested to be retrieved upon account creation.Page size of invoice pdf.The amount on which tax is calculated, in cents (or local equivalent).The 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.Get expandedaccount
.Get expandedaccount
.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.Get expandedaccount
.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.Refund objects allow you to refund a previously created charge that isn't refunded yet.Reviews can be used to supplement automated fraud detection with human expertise.Provides an
target that automatically iterates across all API pages and which is suitable for use with aIterable<T>
loop.foreach
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful.The type of the card wallet, one ofapple_pay
,google_pay
, orlink
.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.Shipping rates describe the price of shipping presented to your customers and applied to a purchase.Must be greater than 0.Source
objects allow you to accept a variety of payment methods.The type of this order item.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.Represents aStripeObject
that has properties or method that can make HTTP requests.StripeCollection<T extends HasId>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.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 expandedaccount
.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.Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.Get expandedaccount
.Get expandedaccount
.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.Get expandedaccount
.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.Tax codes classify goods and services for tax purposes.You can add one or multiple tax IDs to a customer or account.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.To top up your Stripe balance, you create a top-up object.ATransfer
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.Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices.You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.