Settings API Reference exoapi_stripe v0.1.4

The SDK for ExOAPI.Stripe. Endpoint modules and the schemas generated from the OpenAPI spec can be found under the ./sdk directory.

description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current e-mail address or if the account is enabled yet to make live charges.

:display_name :: :string

:icon :: ExOAPI.Stripe.Schemas.File | :string

:mcc :: :string

:acss_debit_payments :: :string

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

:tos_acceptance :: ExOAPI.Stripe.Schemas.CardIssuingAccountTermsOfService

:decline_on :: ExOAPI.Stripe.Schemas.AccountDeclineChargeOn

:display_name :: :string

:avs_failure :: :boolean

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

description: Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.

:statement_descriptor :: :string

:debit_negative_balances :: :boolean

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

::alternative_fields_due :: :string

:code :: :string

:creditor_id :: :string

:bacs_debit_payments :: ExOAPI.Stripe.Schemas.AccountBacsDebitPaymentsSettings

:date :: :integer

:is_controller :: :boolean

:city :: :string

:created :: :integer

:charge :: ExOAPI.Stripe.Schemas.Charge

:created :: :integer

:id :: :string

:account :: ExOAPI.Stripe.Schemas.Account | :string

:enabled :: :boolean

description: This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

:amount :: :integer

:bank_account :: ExOAPI.Stripe.Schemas.BankAccount

::available :: ExOAPI.Stripe.Schemas.BalanceAmount

description: Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance.

description: These bank accounts are payment methods on Customer objects.

:address :: ExOAPI.Stripe.Schemas.Address

description: A portal configuration describes the functionality and behavior of a portal session.

description: The Billing customer portal is a Stripe-hosted UI for subscription and billing management.

:active :: :boolean

:amount :: :integer

description: This is an object representing a capability for a Stripe account.

description: You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

:card_present :: ExOAPI.Stripe.Schemas.PaymentMethodDetailsCardPresent

:date :: :integer

description: To charge a credit or a debit card, you create a Charge object. You can retrieve and refund individual charges as well as list all charges. Charges are identified by a unique, random ID.

:stripe_report :: :string

:network_status :: :string

:amount :: :integer

:custom_mandate_url :: :string

:currency :: :string

:expires_after_days :: :integer

:expires_after_days :: :integer

:expires_after_days :: :integer

:acss_debit :: ExOAPI.Stripe.Schemas.CheckoutAcssDebitPaymentMethodOptions

:verification_method :: :string

description: A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

:amount :: :integer

description: Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country Specs API makes these rules available to your integration.

::additional :: :string

:company :: ExOAPI.Stripe.Schemas.CountrySpecVerificationFieldDetails

description: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to invoices or orders. Coupons do not work with conventional one-off charges.

::products :: :string

description: Issue a credit note to adjust an invoice's amount after the invoice is finalized.

:amount :: :integer

:amount :: :integer

description: This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.

:accepted_at :: :integer

description: Each customer has a balance value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. You may modify the value directly by using the update customer API, or by creating a Customer Balance Transaction, which increments or decrements the customer's balance by the specified amount.

:automatic_tax :: ExOAPI.Stripe.Schemas.AutomaticTax

:country :: :string

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:currency :: :string

:deleted :: :boolean

:currency :: :string

:deleted :: :boolean

:deleted :: :boolean

:checkout_session :: :string

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:deleted :: :boolean

:date :: :string

description: A discount represents the actual application of a coupon to a particular customer. It contains information about when the discount began and when it will end.

:amount :: :integer

description: A dispute occurs when a customer questions your charge with their card issuer. When this happens, you're given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. You can find more information about the dispute process in our Disputes and Fraud documentation.

:access_activity_log :: :string

:due_by :: :integer

:email_sent_at :: :integer

:created :: :integer

description: An error response from the Stripe API

description: Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object. For example, when a charge succeeds, we create a charge.succeeded event; and when an invoice payment attempt fails, we create an invoice.payment_failed event. Note that many API requests may cause multiple events to be created. For example, if you create a new subscription for a customer, you will receive both a customer.subscription.created event and a charge.succeeded event.

description: Exchange Rate objects allow you to determine the rates that Stripe is currently using to convert from one currency to another. Since this number is variable throughout the day, there are various reasons why you might want to know the current rate (for example, to dynamically price an item for a user with a default payment in a foreign currency).

:amount :: :integer

description: Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

description: This is an object representing a file hosted on Stripe's servers. The file may have been uploaded by yourself using the create file request (for example, when uploading dispute evidence) or it may have been created by Stripe (for example, the results of a Sigma scheduled query).

description: To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that can be used to retrieve the contents of the file without authentication.

::columns :: :string

description: Each customer has a balance that is automatically applied to future invoices and payments using the customer_balance payment method. Customers can fund this balance by initiating a bank transfer to any account in the financial_addresses field. Related guide: Customer Balance - Funding Instructions to learn more

:country :: :string

description: FinancialAddresses contain identifying information that resolves to a FinancialAccount.

description: Zengin Records contain Japan bank account details per the Zengin format.

description: Point in Time

description: Point in Time

description: Point in Time

description: Point in Time

description: Point in Time

description: Result from a document check

:code :: :string

description: Result from an id_number check

:code :: :string

::allowed_types :: :string

description: Result from a selfie check

:code :: :string

::allowed_types :: :string

description: Shows last VerificationSession error

:document :: ExOAPI.Stripe.Schemas.GelatoReportDocumentOptions

:document :: ExOAPI.Stripe.Schemas.GelatoSessionDocumentOptions

:address :: ExOAPI.Stripe.Schemas.Address

description: A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

description: A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

description: Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

::line_item_ids :: :string

:end :: :integer

:amount :: :integer

:mandate_options :: ExOAPI.Stripe.Schemas.InvoicePaymentMethodOptionsAcssDebitMandateOptions

:transaction_type :: :string

:preferred_language :: :string

:request_three_d_secure :: :string

:bank_transfer :: ExOAPI.Stripe.Schemas.InvoicePaymentMethodOptionsCustomerBalanceBankTransfer

:type :: :string

:verification_method :: :string

:name :: :string

::custom_fields :: ExOAPI.Stripe.Schemas.InvoiceSettingCustomField

:days_until_due :: :integer

:days_until_due :: :integer

:amount :: :integer

:amount_gte :: :integer

:amount :: :integer

description: 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. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

:invoice :: ExOAPI.Stripe.Schemas.Invoice

:credited_items :: ExOAPI.Stripe.Schemas.InvoicesLineItemsCreditedItems

:acss_debit :: ExOAPI.Stripe.Schemas.InvoicePaymentMethodOptionsAcssDebit

:payment_method_options :: ExOAPI.Stripe.Schemas.InvoicesPaymentMethodOptions

:type :: :string

:finalized_at :: :integer

description: This resource has been renamed to Early Fraud Warning and will be removed in a future API version.

:atm_fee :: :integer

:category :: :string

:amount :: :integer

:amount :: :integer

:address_line1_check :: :string

:eligible :: :boolean

::allowed_categories :: :string

:eligible :: :boolean

:address :: ExOAPI.Stripe.Schemas.Address

:amount :: :integer

:apple_pay :: ExOAPI.Stripe.Schemas.IssuingCardApplePay

:address :: ExOAPI.Stripe.Schemas.Address

::allowed_categories :: :string

:tax_id_provided :: :boolean

:back :: ExOAPI.Stripe.Schemas.File | :string

:dob :: ExOAPI.Stripe.Schemas.IssuingCardholderIndividualDob

:day :: :integer

:disabled_reason :: :string

:amount :: :integer

:document :: ExOAPI.Stripe.Schemas.IssuingCardholderIdDocument

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:canceled :: ExOAPI.Stripe.Schemas.IssuingDisputeCanceledEvidence

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:additional_documentation :: ExOAPI.Stripe.Schemas.File | :string

:atm_fee :: :integer

:departure_at :: :integer

:arrival_airport_code :: :string

:type :: :string

:check_in_at :: :integer

:flight :: ExOAPI.Stripe.Schemas.IssuingTransactionFlightData

:description :: :string

description: When an issued card is used to make a purchase, an Issuing Authorization object is created. Authorizations must be approved for the purchase to be completed successfully.

description: You can create physical or virtual cards that are issued to cardholders.

description: An Issuing Cardholder object represents an individual or business entity who is issued cards.

description: As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.

description: When a non-stripe BIN is used, any use of an issued card must be settled directly with the card network. The net amount owed is represented by an Issuing Settlement object.

description: 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.

description: A line item.

:address :: ExOAPI.Stripe.Schemas.Address

:document :: ExOAPI.Stripe.Schemas.LegalEntityCompanyVerificationDocument

:back :: ExOAPI.Stripe.Schemas.File | :string

:day :: :integer

:city :: :string

:additional_document :: ExOAPI.Stripe.Schemas.LegalEntityPersonVerificationDocument

:back :: ExOAPI.Stripe.Schemas.File | :string

:date :: :integer

:amount :: :integer

:amount :: :integer

:amount :: :integer

:created :: :integer

description: A Mandate is a record of the permission a customer has given you to debit their payment method.

::default_for :: :string

:url :: :string

:network_status :: :string

:acss_debit :: ExOAPI.Stripe.Schemas.MandateAcssDebit

:reference :: :string

:amount :: :integer

::available :: :string

:object :: :map

:id :: :string

:ip_address :: :string

description: Order objects are created to handle end customers' purchases of previously defined products. You can create, retrieve, and pay individual orders, as well as list all orders. Orders are identified by a unique, random ID.

description: A representation of the constituent items of any given order. Can be used to represent SKUs, shipping costs, or taxes owed on the order.

description: A return represents the full or partial return of a number of order items. Returns always belong to an order, and may optionally contain a refund.

:height :: :number

:enabled :: :boolean

:buyer_id :: :string

:day :: :integer

description: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

:customer_notification :: ExOAPI.Stripe.Schemas.PaymentIntentProcessingCustomerNotification

:alipay_handle_redirect :: ExOAPI.Stripe.Schemas.PaymentIntentNextActionAlipayHandleRedirect

:native_data :: :string

:expires_at :: :integer

:charge_attempt_at :: :integer

:amount_remaining :: :integer

:expires_after :: :integer

:expires_at :: :integer

:confirmation_number :: :string

:confirmation_number :: :string

:confirmation_number :: :string

:confirmation_number :: :string

:familymart :: ExOAPI.Stripe.Schemas.PaymentIntentNextActionKonbiniFamilymart

:data :: :string

:return_url :: :string

:arrival_date :: :integer

:data :: :string

:app_id :: :string

:native_url :: :string

:acss_debit :: ExOAPI.Stripe.Schemas.PaymentIntentTypeSpecificPaymentMethodOptionsClient | ExOAPI.Stripe.Schemas.PaymentIntentPaymentMethodOptionsAcssDebit

:mandate_options :: ExOAPI.Stripe.Schemas.PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit

:setup_future_usage :: :string

:capture_method :: :string

:setup_future_usage :: :string

:custom_mandate_url :: :string

:mandate_options :: list(:map)

:setup_future_usage :: :string

:card :: ExOAPI.Stripe.Schemas.PaymentIntentCardProcessing

:approval_requested :: :boolean

:capture_method :: :string

description: A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.

:hosted_confirmation :: ExOAPI.Stripe.Schemas.PaymentLinksResourceCompletionBehaviorConfirmationPage

:enabled :: :boolean

:custom_message :: :string

:url :: :string

:enabled :: :boolean

::allowed_countries :: :string

:trial_period_days :: :integer

:amount :: :integer

description: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

:bank_name :: :string

:bsb_number :: :string

:fingerprint :: :string

:tax_id :: ExOAPI.Stripe.Schemas.TaxId

:brand :: :string

:address_line1_check :: :string

:charge :: ExOAPI.Stripe.Schemas.Charge

:amex_express_checkout :: list(:map)

:billing_address :: ExOAPI.Stripe.Schemas.Address

:billing_address :: ExOAPI.Stripe.Schemas.Address

:ach_credit_transfer :: ExOAPI.Stripe.Schemas.PaymentMethodDetailsAchCreditTransfer

:account_number :: :string

:account_holder_type :: :string

:bank_name :: :string

:reference :: :string

:bsb_number :: :string

:fingerprint :: :string

:bank_code :: :string

:tax_id :: ExOAPI.Stripe.Schemas.TaxId

:brand :: :string

:address_line1_check :: :string

:plan :: ExOAPI.Stripe.Schemas.PaymentMethodDetailsCardInstallmentsPlan

:count :: :integer

:amount_authorized :: :integer

:account_type :: :string

:amex_express_checkout :: list(:map)

:billing_address :: ExOAPI.Stripe.Schemas.Address

:billing_address :: ExOAPI.Stripe.Schemas.Address

:bank :: :string

:bank :: :string

:bank_code :: :string

:transaction_id :: :string

:bank :: :string

:brand :: :string

:account_type :: :string

:payment_method_category :: :string

:store :: ExOAPI.Stripe.Schemas.PaymentMethodDetailsKonbiniStore

:chain :: :string

:entity :: :string

:number :: :string

:bank :: :string

:reference :: :string

:bank_code :: :string

:bank_code :: :string

:account_holder_type :: :string

:fingerprint :: :string

:bank :: :string

:bank :: :string

:bank :: :string

:dob :: ExOAPI.Stripe.Schemas.PaymentFlowsPrivatePaymentMethodsKlarnaDob

:capture_method :: :string

:setup_future_usage :: :string

:setup_future_usage :: :string

:preferred_language :: :string

:expires_after_days :: :integer

::available_plans :: ExOAPI.Stripe.Schemas.PaymentMethodDetailsCardInstallmentsPlan

:amount :: :integer

:request_extended_authorization :: :boolean

:bank_transfer :: ExOAPI.Stripe.Schemas.PaymentMethodOptionsCustomerBalanceBankTransfer

::requested_address_types :: :string

:setup_future_usage :: :string

:setup_future_usage :: :string

:setup_future_usage :: :string

:setup_future_usage :: :string

:capture_method :: :string

:confirmation_number :: :string

:expires_after_days :: :integer

:setup_future_usage :: :string

:setup_future_usage :: :string

:preferred_language :: :string

:app_id :: :string

:bank :: :string

:bank_code :: :string

:country :: :string

:account_holder_type :: :string

:recovery :: ExOAPI.Stripe.Schemas.PaymentPagesCheckoutSessionAfterExpirationRecovery

:allow_promotion_codes :: :boolean

:enabled :: :boolean

:promotions :: :string

:promotions :: :string

:address :: ExOAPI.Stripe.Schemas.Address

:enabled :: :boolean

::allowed_countries :: :string

:shipping_amount :: :integer

:type :: :string

:enabled :: :boolean

:amount_discount :: :integer

::discounts :: ExOAPI.Stripe.Schemas.LineItemsDiscountAmount

description: 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. You can retrieve individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your country and industry.

:end :: :integer

description: This is an object representing a person associated with a Stripe account.

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

:director :: :boolean

::alternatives :: ExOAPI.Stripe.Schemas.AccountRequirementsAlternative

description: You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

:flat_amount :: :integer

:account :: ExOAPI.Stripe.Schemas.Account

:headline :: :string

::allowed_updates :: :string

:customer_update :: ExOAPI.Stripe.Schemas.PortalCustomerUpdate

:enabled :: :boolean

:enabled :: :boolean

:cancellation_reason :: ExOAPI.Stripe.Schemas.PortalSubscriptionCancellationReason

:enabled :: :boolean

:enabled :: :boolean

::default_allowed_updates :: :string

::prices :: :string

description: Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

:flat_amount :: :integer

description: Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

description: A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

:first_time_transaction :: :boolean

description: A Quote is a way to model prices that you'd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

:enabled :: :boolean

:recurring :: ExOAPI.Stripe.Schemas.QuotesResourceRecurring

:is_revision :: :boolean

:amount_subtotal :: :integer

:accepted_at :: :integer

:effective_date :: :integer

:amount_discount :: :integer

::discounts :: ExOAPI.Stripe.Schemas.LineItemsDiscountAmount

:amount :: :integer

:amount_subtotal :: :integer

:city :: :string

:browser :: :string

description: An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.

description: Value lists allow you to group values together which can then be referenced in rules.

description: Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.

description: With Recipient objects, you can transfer money from your Stripe account to a third-party bank account or debit card. The API allows you to create, delete, and update your recipients. You can retrieve individual recipients as well as a list of all your recipients.

:aggregate_usage :: :string

description: Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

:display_details :: ExOAPI.Stripe.Schemas.RefundNextActionDisplayDetails

:email_sent :: ExOAPI.Stripe.Schemas.EmailSent

description: The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

description: The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

:amount :: :integer

description: Reviews can be used to supplement automated fraud detection with human expertise.

:action :: :string

description: If you have scheduled a Sigma query, you'll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

:enabled :: :boolean

:charge :: ExOAPI.Stripe.Schemas.Charge | :string

description: A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

:acss_debit :: list(:map)

:bank_code :: :string

:three_d_secure :: ExOAPI.Stripe.Schemas.ThreeDSecureDetails

:generated_card :: ExOAPI.Stripe.Schemas.PaymentMethod | :string

:bank :: :string

:bank_code :: :string

description: A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

:redirect_to_url :: ExOAPI.Stripe.Schemas.SetupIntentNextActionRedirectToUrl

:return_url :: :string

:arrival_date :: :integer

:acss_debit :: ExOAPI.Stripe.Schemas.SetupIntentTypeSpecificPaymentMethodOptionsClient | ExOAPI.Stripe.Schemas.SetupIntentPaymentMethodOptionsAcssDebit

:currency :: :string

:mandate_options :: ExOAPI.Stripe.Schemas.SetupIntentPaymentMethodOptionsCardMandateOptions

:amount :: :integer

:custom_mandate_url :: :string

:mandate_options :: list(:map)

:verification_method :: :string

:verification_method :: :string

:address :: ExOAPI.Stripe.Schemas.Address

:amount :: :integer

description: Shipping rates describe the price of shipping presented to your customers and can be applied to Checkout Sessions to collect shipping costs.

:maximum :: ExOAPI.Stripe.Schemas.ShippingRateDeliveryEstimateBound

:unit :: :string

:amount :: :integer

:message :: :string

description: Stores representations of stock keeping units. SKUs describe specific product variations, taking into account any combination of: attributes, currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents the size: large, color: red version of that shirt.

:quantity :: :integer

description: Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

:attempts_remaining :: :integer

description: Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer.

:statement_descriptor :: :string

:last4 :: :string

:creditor_identifier :: :string

:amount :: :integer

:amount :: :integer

:address :: ExOAPI.Stripe.Schemas.Address

:address :: ExOAPI.Stripe.Schemas.Address

:failure_reason :: :string

description: Some payment methods have no required amount that a customer must send. Customers can be instructed to send any amount, and it can be made up of multiple transactions. As such, sources can have multiple associated transactions.

:customer_data :: :string

:reference :: :string

:fingerprint :: :string

:available_at :: :string

:reference :: :string

:account_number :: :string

:bank_name :: :string

:bank_address_city :: :string

:data_string :: :string

:bsb_number :: :string

:bank_code :: :string

:address_line1_check :: :string

:application_cryptogram :: :string

:reference :: :string

:bank_code :: :string

:bank :: :string

:background_image_url :: :string

:entity :: :string

:reference :: :string

:bank_code :: :string

:bank_code :: :string

:address_line1_check :: :string

:prepay_id :: :string

:canceled :: :integer

description: Subscriptions allow you to charge a customer on a recurring basis.

:enabled :: :boolean

:amount_gte :: :integer

description: Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

:usage_gte :: :integer

:mandate_options :: ExOAPI.Stripe.Schemas.InvoiceMandateOptionsCard

:interval :: :string

description: A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

description: An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.

description: A phase item describes the price and quantity of a phase.

:end_date :: :integer

description: A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.

:application_fee_percent :: :number

:enabled :: :boolean

:amount_percent :: :number

description: The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused.

:acss_debit :: ExOAPI.Stripe.Schemas.InvoicePaymentMethodOptionsAcssDebit

:payment_method_options :: ExOAPI.Stripe.Schemas.SubscriptionsResourcePaymentMethodOptions

description: Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.

description: Tax codes classify goods and services for tax purposes.

:id :: :string

description: You can add one or multiple tax IDs to a customer. A customer's tax IDs are displayed on invoices and credit notes issued for the customer.

:status :: :string

description: Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

::fixed_amounts :: :integer

:splashscreen :: ExOAPI.Stripe.Schemas.File | :string

:aud :: ExOAPI.Stripe.Schemas.TerminalConfigurationConfigurationResourceCurrencySpecificConfig

description: Represents a cart to be displayed on the reader

description: Represents a line item to be displayed on the reader

description: Represents a reader action to process a payment intent

description: Represents a reader action to process a setup intent

description: Represents an action performed by the reader

description: Represents a reader action to set the reader display

description: A Configurations object represents how features should be configured for terminal readers.

description: A Connection Token is used by the Stripe Terminal SDK to connect to a reader.

description: A Location represents a grouping of readers.

description: A Reader represents a physical device for accepting payment details.

description: A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.

description: Cardholder authentication via 3D Secure is initiated by creating a 3D Secure object. Once the object has been created, you can use it to authenticate the cardholder and create a charge.

:authentication_flow :: :string

:supported :: :boolean

description: 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. A token representing this information is returned to your server to use. You should use our recommended payments integrations to perform this process client-side. This ensures that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.

description: To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

description: A Transfer object is created when you move funds between Stripe accounts as part of Connect.

:amount :: :integer

description: 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. Transfer reversals add to the platform's balance and subtract from the destination account's balance.

:delay_days :: :integer

:divide_by :: :integer

:divide_by :: :integer

description: Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices.

:id :: :string

:status :: :string

description: You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.