Package com.stripe.model
package com.stripe.model
-
ClassDescriptionThis is an object representing a Stripe account.Get expanded
front
.The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.The user agent of the browser from which the account representative accepted the service agreement.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.An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded UIs.This is an object representing your Stripe balance.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.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.To charge a credit or a debit card, you create aCharge
object.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.Options to configure Radar.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.Issue a credit note to adjust an invoice's amount after the invoice is finalized.This object represents a customer of your business.Each customer has abalance
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 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.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.Exchange Rate
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.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.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.Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.Transaction type of the mandate.Whether Installments are enabled for this Invoice.The desired country code of the bank account information.The list of permissions to request.Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle.A line item.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.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 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.An universal link that redirect to WeChat Pay app.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.Transaction type of the mandate.The desired country code of the bank account information.Type of installment plan, one offixed_count
.Specifies the type of mandates supported.For webview integrations only.Indicates that you intend to make future payments with this PaymentIntent's payment method.If customer approval is required, they need to provide approval before this time.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.PaymentMethod objects represent your customer's payment instruments.Owner's verified shipping address.The four-digit year of birth.Options to configure Radar.Get expandedsetupAttempt
.All supported networks.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 specific user onboarding requirement field (in the requirements hash) that needs to be resolved.Fields that are due and can be satisfied by providing all fields inalternative_fields_due
.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.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.The aggregated tax amounts by rate.A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.Refund
objects allow you to refund a charge that has previously been created but not yet refunded.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 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.Shipping rates describe the price of shipping presented to your customers and can be applied to Checkout Sessions and Orders to collect shipping costs.Must be greater than 0.Stores representations of stock keeping units.Source
objects allow you to accept a variety of payment methods.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.StripeCollection<T extends HasId>Provides a representation of a single page worth of data from the Stripe API.An error response 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.The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.Transaction type of the mandate.A description of the mandate or subscription that is meant to be displayed to the customer.The desired country code of the bank account information.The list of permissions to request.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.Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.Prebilling stores the time period and invoice for a Subscription billed in advance.A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.Get expandeddiscount
.Whether Stripe automatically computes tax on invoices created during this phase.A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.Configures how the scheduled subscription behaves during the trial period.Defines how the scheduled subscription behaves when a trial ends.A phase item describes the price and quantity of a phase.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.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.