Crate stripe_shared

Source
Expand description

Autogenerated types shared between async-stripe-* crates. If you find yourself needing to depend on this crate, please open an issue, as all useful types should be reexported.

Re-exports§

pub use api_version::ApiVersion;

Modules§

api_version
version

Structs§

Account
This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
AccountAnnualRevenue
AccountAnnualRevenueBuilder
AccountBacsDebitPaymentsSettings
AccountBacsDebitPaymentsSettingsBuilder
AccountBrandingSettings
AccountBrandingSettingsBuilder
AccountBuilder
AccountBusinessProfile
AccountBusinessProfileBuilder
AccountCapabilities
AccountCapabilitiesBuilder
AccountCapabilityFutureRequirements
AccountCapabilityFutureRequirementsBuilder
AccountCapabilityRequirements
AccountCapabilityRequirementsBuilder
AccountCardIssuingSettings
AccountCardIssuingSettingsBuilder
AccountCardPaymentsSettings
AccountCardPaymentsSettingsBuilder
AccountDashboardSettings
AccountDashboardSettingsBuilder
AccountDeclineChargeOn
AccountDeclineChargeOnBuilder
AccountFutureRequirements
AccountFutureRequirementsBuilder
AccountGroupMembership
AccountGroupMembershipBuilder
AccountId
AccountInvoicesSettings
AccountInvoicesSettingsBuilder
AccountMonthlyEstimatedRevenue
AccountMonthlyEstimatedRevenueBuilder
AccountPaymentsSettings
AccountPaymentsSettingsBuilder
AccountPayoutSettings
AccountPayoutSettingsBuilder
AccountRequirements
AccountRequirementsAlternative
AccountRequirementsAlternativeBuilder
AccountRequirementsBuilder
AccountRequirementsError
AccountRequirementsErrorBuilder
AccountSepaDebitPaymentsSettings
AccountSepaDebitPaymentsSettingsBuilder
AccountSettings
AccountSettingsBuilder
AccountTermsOfService
AccountTermsOfServiceBuilder
AccountTosAcceptance
AccountTosAcceptanceBuilder
AccountTreasurySettings
AccountTreasurySettingsBuilder
AccountUnificationAccountController
AccountUnificationAccountControllerBuilder
AccountUnificationAccountControllerFees
AccountUnificationAccountControllerFeesBuilder
AccountUnificationAccountControllerLosses
AccountUnificationAccountControllerLossesBuilder
AccountUnificationAccountControllerStripeDashboard
AccountUnificationAccountControllerStripeDashboardBuilder
Address
AddressBuilder
AmazonPayUnderlyingPaymentMethodFundingDetails
AmazonPayUnderlyingPaymentMethodFundingDetailsBuilder
ApiErrors
ApiErrorsBuilder
Application
ApplicationBuilder
ApplicationFee
For more details see <https://stripe.com/docs/api/application_fees/object>.
ApplicationFeeBuilder
ApplicationFeeId
ApplicationFeeRefund
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.
ApplicationFeeRefundBuilder
ApplicationFeeRefundId
ApplicationId
AutomaticTax
AutomaticTaxBuilder
BalanceTransaction
Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
BalanceTransactionBuilder
BalanceTransactionId
BalanceTransactionSourceBuilder
BankAccount
These bank accounts are payment methods on Customer objects.
BankAccountBuilder
BankAccountId
BillingBillResourceInvoicingLinesCommonCreditedItems
BillingBillResourceInvoicingLinesCommonCreditedItemsBuilder
BillingBillResourceInvoicingLinesCommonProrationDetails
BillingBillResourceInvoicingLinesCommonProrationDetailsBuilder
BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent
BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParentBuilder
BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent
BillingBillResourceInvoicingLinesParentsInvoiceLineItemParentBuilder
BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent
BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParentBuilder
BillingBillResourceInvoicingParentsInvoiceParent
BillingBillResourceInvoicingParentsInvoiceParentBuilder
BillingBillResourceInvoicingParentsInvoiceQuoteParent
BillingBillResourceInvoicingParentsInvoiceQuoteParentBuilder
BillingBillResourceInvoicingParentsInvoiceSubscriptionParent
BillingBillResourceInvoicingParentsInvoiceSubscriptionParentBuilder
BillingBillResourceInvoicingPricingPricing
BillingBillResourceInvoicingPricingPricingBuilder
BillingBillResourceInvoicingPricingPricingPriceDetails
BillingBillResourceInvoicingPricingPricingPriceDetailsBuilder
BillingBillResourceInvoicingTaxesTax
BillingBillResourceInvoicingTaxesTaxBuilder
BillingBillResourceInvoicingTaxesTaxRateDetails
BillingBillResourceInvoicingTaxesTaxRateDetailsBuilder
BillingClocksResourceStatusDetailsAdvancingStatusDetails
BillingClocksResourceStatusDetailsAdvancingStatusDetailsBuilder
BillingClocksResourceStatusDetailsStatusDetails
BillingClocksResourceStatusDetailsStatusDetailsBuilder
BillingCreditBalanceTransaction
A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
BillingCreditBalanceTransactionBuilder
BillingCreditBalanceTransactionId
BillingCreditGrant
A credit grant is an API resource that documents the allocation of some billing credits to a customer.
BillingCreditGrantBuilder
BillingCreditGrantId
BillingCreditGrantsResourceAmount
BillingCreditGrantsResourceAmountBuilder
BillingCreditGrantsResourceApplicabilityConfig
BillingCreditGrantsResourceApplicabilityConfigBuilder
BillingCreditGrantsResourceApplicablePrice
BillingCreditGrantsResourceApplicablePriceBuilder
BillingCreditGrantsResourceApplicablePriceId
BillingCreditGrantsResourceBalanceCredit
BillingCreditGrantsResourceBalanceCreditBuilder
BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided
BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoidedBuilder
BillingCreditGrantsResourceBalanceCreditsApplied
BillingCreditGrantsResourceBalanceCreditsAppliedBuilder
BillingCreditGrantsResourceBalanceDebit
BillingCreditGrantsResourceBalanceDebitBuilder
BillingCreditGrantsResourceMonetaryAmount
BillingCreditGrantsResourceMonetaryAmountBuilder
BillingCreditGrantsResourceScope
BillingCreditGrantsResourceScopeBuilder
BillingDetails
BillingDetailsBuilder
CancellationDetails
CancellationDetailsBuilder
Capability
This is an object representing a capability for a Stripe account.
CapabilityBuilder
CapabilityId
Card
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.
CardBuilder
CardGeneratedFromPaymentMethodDetails
CardGeneratedFromPaymentMethodDetailsBuilder
CardId
CardIssuingAccountTermsOfService
CardIssuingAccountTermsOfServiceBuilder
CardMandatePaymentMethodDetails
CardMandatePaymentMethodDetailsBuilder
CashBalance
A customer’s Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
CashBalanceBuilder
Charge
The Charge object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.
ChargeBuilder
ChargeFraudDetails
ChargeFraudDetailsBuilder
ChargeId
ChargeOutcome
ChargeOutcomeBuilder
ChargeTransferData
ChargeTransferDataBuilder
CheckoutAcssDebitMandateOptions
CheckoutAcssDebitMandateOptionsBuilder
CheckoutAcssDebitPaymentMethodOptions
CheckoutAcssDebitPaymentMethodOptionsBuilder
CheckoutAffirmPaymentMethodOptions
CheckoutAffirmPaymentMethodOptionsBuilder
CheckoutAfterpayClearpayPaymentMethodOptions
CheckoutAfterpayClearpayPaymentMethodOptionsBuilder
CheckoutAlipayPaymentMethodOptions
CheckoutAlipayPaymentMethodOptionsBuilder
CheckoutAmazonPayPaymentMethodOptions
CheckoutAmazonPayPaymentMethodOptionsBuilder
CheckoutAuBecsDebitPaymentMethodOptions
CheckoutAuBecsDebitPaymentMethodOptionsBuilder
CheckoutBacsDebitPaymentMethodOptions
CheckoutBacsDebitPaymentMethodOptionsBuilder
CheckoutBancontactPaymentMethodOptions
CheckoutBancontactPaymentMethodOptionsBuilder
CheckoutBoletoPaymentMethodOptions
CheckoutBoletoPaymentMethodOptionsBuilder
CheckoutCardInstallmentsOptions
CheckoutCardInstallmentsOptionsBuilder
CheckoutCardPaymentMethodOptions
CheckoutCardPaymentMethodOptionsBuilder
CheckoutCashappPaymentMethodOptions
CheckoutCashappPaymentMethodOptionsBuilder
CheckoutCustomerBalanceBankTransferPaymentMethodOptions
CheckoutCustomerBalanceBankTransferPaymentMethodOptionsBuilder
CheckoutCustomerBalancePaymentMethodOptions
CheckoutCustomerBalancePaymentMethodOptionsBuilder
CheckoutEpsPaymentMethodOptions
CheckoutEpsPaymentMethodOptionsBuilder
CheckoutFpxPaymentMethodOptions
CheckoutFpxPaymentMethodOptionsBuilder
CheckoutGiropayPaymentMethodOptions
CheckoutGiropayPaymentMethodOptionsBuilder
CheckoutGrabPayPaymentMethodOptions
CheckoutGrabPayPaymentMethodOptionsBuilder
CheckoutIdealPaymentMethodOptions
CheckoutIdealPaymentMethodOptionsBuilder
CheckoutKakaoPayPaymentMethodOptions
CheckoutKakaoPayPaymentMethodOptionsBuilder
CheckoutKlarnaPaymentMethodOptions
CheckoutKlarnaPaymentMethodOptionsBuilder
CheckoutKonbiniPaymentMethodOptions
CheckoutKonbiniPaymentMethodOptionsBuilder
CheckoutKrCardPaymentMethodOptions
CheckoutKrCardPaymentMethodOptionsBuilder
CheckoutLinkPaymentMethodOptions
CheckoutLinkPaymentMethodOptionsBuilder
CheckoutLinkWalletOptions
CheckoutLinkWalletOptionsBuilder
CheckoutMobilepayPaymentMethodOptions
CheckoutMobilepayPaymentMethodOptionsBuilder
CheckoutMultibancoPaymentMethodOptions
CheckoutMultibancoPaymentMethodOptionsBuilder
CheckoutNaverPayPaymentMethodOptions
CheckoutNaverPayPaymentMethodOptionsBuilder
CheckoutOxxoPaymentMethodOptions
CheckoutOxxoPaymentMethodOptionsBuilder
CheckoutP24PaymentMethodOptions
CheckoutP24PaymentMethodOptionsBuilder
CheckoutPaycoPaymentMethodOptions
CheckoutPaycoPaymentMethodOptionsBuilder
CheckoutPaymentMethodOptionsMandateOptionsBacsDebit
CheckoutPaymentMethodOptionsMandateOptionsBacsDebitBuilder
CheckoutPaymentMethodOptionsMandateOptionsSepaDebit
CheckoutPaymentMethodOptionsMandateOptionsSepaDebitBuilder
CheckoutPaynowPaymentMethodOptions
CheckoutPaynowPaymentMethodOptionsBuilder
CheckoutPaypalPaymentMethodOptions
CheckoutPaypalPaymentMethodOptionsBuilder
CheckoutPixPaymentMethodOptions
CheckoutPixPaymentMethodOptionsBuilder
CheckoutRevolutPayPaymentMethodOptions
CheckoutRevolutPayPaymentMethodOptionsBuilder
CheckoutSamsungPayPaymentMethodOptions
CheckoutSamsungPayPaymentMethodOptionsBuilder
CheckoutSepaDebitPaymentMethodOptions
CheckoutSepaDebitPaymentMethodOptionsBuilder
CheckoutSession
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.
CheckoutSessionBuilder
CheckoutSessionId
CheckoutSessionItem
A line item.
CheckoutSessionItemBuilder
CheckoutSessionItemId
CheckoutSessionPaymentMethodOptions
CheckoutSessionPaymentMethodOptionsBuilder
CheckoutSessionWalletOptions
CheckoutSessionWalletOptionsBuilder
CheckoutSofortPaymentMethodOptions
CheckoutSofortPaymentMethodOptionsBuilder
CheckoutSwishPaymentMethodOptions
CheckoutSwishPaymentMethodOptionsBuilder
CheckoutUsBankAccountPaymentMethodOptions
CheckoutUsBankAccountPaymentMethodOptionsBuilder
ConnectAccountReference
ConnectAccountReferenceBuilder
ConnectCollectionTransfer
ConnectCollectionTransferBuilder
ConnectCollectionTransferId
Coupon
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 subscriptions, invoices,. checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
CouponAppliesTo
CouponAppliesToBuilder
CouponBuilder
CouponCurrencyOption
CouponCurrencyOptionBuilder
CouponId
CreditNote
Issue a credit note to adjust an invoice’s amount after the invoice is finalized.
CreditNoteBuilder
CreditNoteId
CreditNoteLineItem
The credit note line item object
CreditNoteLineItemBuilder
CreditNoteLineItemId
CreditNoteRefund
CreditNoteRefundBuilder
CreditNotesPretaxCreditAmount
CreditNotesPretaxCreditAmountBuilder
CurrencyOption
CurrencyOptionBuilder
CustomUnitAmount
CustomUnitAmountBuilder
Customer
This object represents a customer of your business. Use it to create recurring charges, save payment and contact information,. and track payments that belong to the same customer.
CustomerAcceptance
CustomerAcceptanceBuilder
CustomerBalanceCustomerBalanceSettings
CustomerBalanceCustomerBalanceSettingsBuilder
CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft
CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraftBuilder
CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransactionBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransferBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransferBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransferBuilder
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransferBuilder
CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransactionBuilder
CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance
CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalanceBuilder
CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction
CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransactionBuilder
CustomerBalanceTransaction
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.
CustomerBalanceTransactionBuilder
CustomerBalanceTransactionId
CustomerBuilder
CustomerCashBalanceTransaction
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. Cash Balance Transactions. represent when funds are moved into or out of this balance. This includes funding by the customer, allocation. to payments, and refunds to the customer.
CustomerCashBalanceTransactionBuilder
CustomerCashBalanceTransactionId
CustomerId
CustomerTax
CustomerTaxBuilder
CustomerTaxLocation
CustomerTaxLocationBuilder
DeletedAccount
DeletedAccountBuilder
DeletedBankAccount
DeletedBankAccountBuilder
DeletedCard
DeletedCardBuilder
DeletedCoupon
DeletedCouponBuilder
DeletedCustomer
DeletedCustomerBuilder
DeletedDiscount
DeletedDiscountBuilder
DeletedExternalAccountBuilder
DeletedInvoice
DeletedInvoiceBuilder
DeletedPaymentSourceBuilder
DeletedPerson
DeletedPersonBuilder
DeletedPlan
DeletedPlanBuilder
DeletedProduct
DeletedProductBuilder
DeletedSubscriptionItem
DeletedSubscriptionItemBuilder
DeletedTaxId
DeletedTaxIdBuilder
DeletedTestHelpersTestClock
DeletedTestHelpersTestClockBuilder
DestinationDetailsUnimplemented
DestinationDetailsUnimplementedBuilder
Discount
A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
DiscountBuilder
DiscountId
DiscountsResourceDiscountAmount
DiscountsResourceDiscountAmountBuilder
DiscountsResourceStackableDiscount
DiscountsResourceStackableDiscountBuilder
Dispute
A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
DisputeBuilder
DisputeEnhancedEligibility
DisputeEnhancedEligibilityBuilder
DisputeEnhancedEligibilityVisaCompellingEvidence3
DisputeEnhancedEligibilityVisaCompellingEvidence3Builder
DisputeEnhancedEligibilityVisaCompliance
DisputeEnhancedEligibilityVisaComplianceBuilder
DisputeEnhancedEvidence
DisputeEnhancedEvidenceBuilder
DisputeEnhancedEvidenceVisaCompellingEvidence3
DisputeEnhancedEvidenceVisaCompellingEvidence3Builder
DisputeEnhancedEvidenceVisaCompliance
DisputeEnhancedEvidenceVisaComplianceBuilder
DisputeEvidence
For more details see <https://stripe.com/docs/api/disputes/evidence_object>.
DisputeEvidenceBuilder
DisputeEvidenceDetails
DisputeEvidenceDetailsBuilder
DisputeId
DisputePaymentMethodDetails
DisputePaymentMethodDetailsAmazonPay
DisputePaymentMethodDetailsAmazonPayBuilder
DisputePaymentMethodDetailsBuilder
DisputePaymentMethodDetailsCard
DisputePaymentMethodDetailsCardBuilder
DisputePaymentMethodDetailsKlarna
DisputePaymentMethodDetailsKlarnaBuilder
DisputePaymentMethodDetailsPaypal
DisputePaymentMethodDetailsPaypalBuilder
DisputeTransactionShippingAddress
DisputeTransactionShippingAddressBuilder
DisputeVisaCompellingEvidence3DisputedTransaction
DisputeVisaCompellingEvidence3DisputedTransactionBuilder
DisputeVisaCompellingEvidence3PriorUndisputedTransaction
DisputeVisaCompellingEvidence3PriorUndisputedTransactionBuilder
EmailSent
EmailSentBuilder
EntitlementsFeature
A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
EntitlementsFeatureBuilder
EntitlementsFeatureId
Error
An error response from the Stripe API
ErrorBuilder
Event
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. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both a customer.subscription.created event and a charge.succeeded event.
EventBuilder
EventId
ExternalAccountBuilder
ExternalAccountRequirements
ExternalAccountRequirementsBuilder
Fee
FeeBuilder
File
This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).
FileBuilder
FileId
FileLink
To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.
FileLinkBuilder
FileLinkId
FundingInstructions
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.
FundingInstructionsBankTransfer
FundingInstructionsBankTransferAbaRecord
ABA Records contain U.S. bank account details per the ABA format.
FundingInstructionsBankTransferAbaRecordBuilder
FundingInstructionsBankTransferBuilder
FundingInstructionsBankTransferFinancialAddress
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
FundingInstructionsBankTransferFinancialAddressBuilder
FundingInstructionsBankTransferIbanRecord
Iban Records contain E.U. bank account details per the SEPA format.
FundingInstructionsBankTransferIbanRecordBuilder
FundingInstructionsBankTransferSortCodeRecord
Sort Code Records contain U.K. bank account details per the sort code format.
FundingInstructionsBankTransferSortCodeRecordBuilder
FundingInstructionsBankTransferSpeiRecord
SPEI Records contain Mexico bank account details per the SPEI format.
FundingInstructionsBankTransferSpeiRecordBuilder
FundingInstructionsBankTransferSwiftRecord
SWIFT Records contain U.S. bank account details per the SWIFT format.
FundingInstructionsBankTransferSwiftRecordBuilder
FundingInstructionsBankTransferZenginRecord
Zengin Records contain Japan bank account details per the Zengin format.
FundingInstructionsBankTransferZenginRecordBuilder
FundingInstructionsBuilder
InternalCard
InternalCardBuilder
Invoice
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
InvoiceBuilder
InvoiceId
InvoiceInstallmentsCard
InvoiceInstallmentsCardBuilder
InvoiceItemThresholdReason
InvoiceItemThresholdReasonBuilder
InvoiceLineItem
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
InvoiceLineItemBuilder
InvoiceLineItemId
InvoiceLineItemPeriod
InvoiceLineItemPeriodBuilder
InvoiceMandateOptionsCard
InvoiceMandateOptionsCardBuilder
InvoicePayment
The invoice payment object
InvoicePaymentBuilder
InvoicePaymentId
InvoicePaymentMethodOptionsAcssDebit
InvoicePaymentMethodOptionsAcssDebitBuilder
InvoicePaymentMethodOptionsAcssDebitMandateOptions
InvoicePaymentMethodOptionsAcssDebitMandateOptionsBuilder
InvoicePaymentMethodOptionsBancontact
InvoicePaymentMethodOptionsBancontactBuilder
InvoicePaymentMethodOptionsCard
InvoicePaymentMethodOptionsCardBuilder
InvoicePaymentMethodOptionsCustomerBalance
InvoicePaymentMethodOptionsCustomerBalanceBankTransfer
InvoicePaymentMethodOptionsCustomerBalanceBankTransferBuilder
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferBuilder
InvoicePaymentMethodOptionsCustomerBalanceBuilder
InvoicePaymentMethodOptionsKonbini
InvoicePaymentMethodOptionsKonbiniBuilder
InvoicePaymentMethodOptionsSepaDebit
InvoicePaymentMethodOptionsSepaDebitBuilder
InvoicePaymentMethodOptionsUsBankAccount
InvoicePaymentMethodOptionsUsBankAccountBuilder
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptions
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsBuilder
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFilters
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFiltersBuilder
InvoiceRenderingPdf
InvoiceRenderingPdfBuilder
InvoiceSettingCheckoutRenderingOptions
InvoiceSettingCheckoutRenderingOptionsBuilder
InvoiceSettingCustomField
InvoiceSettingCustomFieldBuilder
InvoiceSettingCustomerRenderingOptions
InvoiceSettingCustomerRenderingOptionsBuilder
InvoiceSettingCustomerSetting
InvoiceSettingCustomerSettingBuilder
InvoiceSettingSubscriptionSchedulePhaseSetting
InvoiceSettingSubscriptionSchedulePhaseSettingBuilder
InvoiceSettingSubscriptionScheduleSetting
InvoiceSettingSubscriptionScheduleSettingBuilder
InvoiceThresholdReason
InvoiceThresholdReasonBuilder
InvoicesPaymentMethodOptions
InvoicesPaymentMethodOptionsBuilder
InvoicesPaymentSettings
InvoicesPaymentSettingsBuilder
InvoicesPaymentsInvoicePaymentAssociatedPayment
InvoicesPaymentsInvoicePaymentAssociatedPaymentBuilder
InvoicesPaymentsInvoicePaymentStatusTransitions
InvoicesPaymentsInvoicePaymentStatusTransitionsBuilder
InvoicesResourceConfirmationSecret
InvoicesResourceConfirmationSecretBuilder
InvoicesResourceFromInvoice
InvoicesResourceFromInvoiceBuilder
InvoicesResourceInvoiceRendering
InvoicesResourceInvoiceRenderingBuilder
InvoicesResourceInvoiceTaxId
InvoicesResourceInvoiceTaxIdBuilder
InvoicesResourcePretaxCreditAmount
InvoicesResourcePretaxCreditAmountBuilder
InvoicesResourceShippingCost
InvoicesResourceShippingCostBuilder
InvoicesResourceStatusTransitions
InvoicesResourceStatusTransitionsBuilder
IssuingAuthorization
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.
IssuingAuthorizationAmountDetails
IssuingAuthorizationAmountDetailsBuilder
IssuingAuthorizationAuthenticationExemption
IssuingAuthorizationAuthenticationExemptionBuilder
IssuingAuthorizationBuilder
IssuingAuthorizationFleetCardholderPromptData
IssuingAuthorizationFleetCardholderPromptDataBuilder
IssuingAuthorizationFleetData
IssuingAuthorizationFleetDataBuilder
IssuingAuthorizationFleetFuelPriceData
IssuingAuthorizationFleetFuelPriceDataBuilder
IssuingAuthorizationFleetNonFuelPriceData
IssuingAuthorizationFleetNonFuelPriceDataBuilder
IssuingAuthorizationFleetReportedBreakdown
IssuingAuthorizationFleetReportedBreakdownBuilder
IssuingAuthorizationFleetTaxData
IssuingAuthorizationFleetTaxDataBuilder
IssuingAuthorizationFraudChallenge
IssuingAuthorizationFraudChallengeBuilder
IssuingAuthorizationFuelData
IssuingAuthorizationFuelDataBuilder
IssuingAuthorizationId
IssuingAuthorizationMerchantData
IssuingAuthorizationMerchantDataBuilder
IssuingAuthorizationNetworkData
IssuingAuthorizationNetworkDataBuilder
IssuingAuthorizationPendingRequest
IssuingAuthorizationPendingRequestBuilder
IssuingAuthorizationRequest
IssuingAuthorizationRequestBuilder
IssuingAuthorizationThreeDSecure
IssuingAuthorizationThreeDSecureBuilder
IssuingAuthorizationTreasury
IssuingAuthorizationTreasuryBuilder
IssuingAuthorizationVerificationData
IssuingAuthorizationVerificationDataBuilder
IssuingCard
You can create physical or virtual cards that are issued to cardholders.
IssuingCardApplePay
IssuingCardApplePayBuilder
IssuingCardAuthorizationControls
IssuingCardAuthorizationControlsBuilder
IssuingCardBuilder
IssuingCardGooglePay
IssuingCardGooglePayBuilder
IssuingCardId
IssuingCardShipping
IssuingCardShippingAddressValidation
IssuingCardShippingAddressValidationBuilder
IssuingCardShippingBuilder
IssuingCardShippingCustoms
IssuingCardShippingCustomsBuilder
IssuingCardSpendingLimit
IssuingCardSpendingLimitBuilder
IssuingCardWallets
IssuingCardWalletsBuilder
IssuingCardholder
An Issuing Cardholder object represents an individual or business entity who is issued cards.
IssuingCardholderAddress
IssuingCardholderAddressBuilder
IssuingCardholderAuthorizationControls
IssuingCardholderAuthorizationControlsBuilder
IssuingCardholderBuilder
IssuingCardholderCardIssuing
IssuingCardholderCardIssuingBuilder
IssuingCardholderCompany
IssuingCardholderCompanyBuilder
IssuingCardholderId
IssuingCardholderIdDocument
IssuingCardholderIdDocumentBuilder
IssuingCardholderIndividual
IssuingCardholderIndividualBuilder
IssuingCardholderIndividualDob
IssuingCardholderIndividualDobBuilder
IssuingCardholderRequirements
IssuingCardholderRequirementsBuilder
IssuingCardholderSpendingLimit
IssuingCardholderSpendingLimitBuilder
IssuingCardholderUserTermsAcceptance
IssuingCardholderUserTermsAcceptanceBuilder
IssuingCardholderVerification
IssuingCardholderVerificationBuilder
IssuingDispute
As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
IssuingDisputeBuilder
IssuingDisputeCanceledEvidence
IssuingDisputeCanceledEvidenceBuilder
IssuingDisputeDuplicateEvidence
IssuingDisputeDuplicateEvidenceBuilder
IssuingDisputeEvidence
IssuingDisputeEvidenceBuilder
IssuingDisputeFraudulentEvidence
IssuingDisputeFraudulentEvidenceBuilder
IssuingDisputeId
IssuingDisputeMerchandiseNotAsDescribedEvidence
IssuingDisputeMerchandiseNotAsDescribedEvidenceBuilder
IssuingDisputeNoValidAuthorizationEvidence
IssuingDisputeNoValidAuthorizationEvidenceBuilder
IssuingDisputeNotReceivedEvidence
IssuingDisputeNotReceivedEvidenceBuilder
IssuingDisputeOtherEvidence
IssuingDisputeOtherEvidenceBuilder
IssuingDisputeServiceNotAsDescribedEvidence
IssuingDisputeServiceNotAsDescribedEvidenceBuilder
IssuingDisputeTreasury
IssuingDisputeTreasuryBuilder
IssuingNetworkTokenAddress
IssuingNetworkTokenAddressBuilder
IssuingNetworkTokenDevice
IssuingNetworkTokenDeviceBuilder
IssuingNetworkTokenMastercard
IssuingNetworkTokenMastercardBuilder
IssuingNetworkTokenNetworkData
IssuingNetworkTokenNetworkDataBuilder
IssuingNetworkTokenVisa
IssuingNetworkTokenVisaBuilder
IssuingNetworkTokenWalletProvider
IssuingNetworkTokenWalletProviderBuilder
IssuingPersonalizationDesign
A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
IssuingPersonalizationDesignBuilder
IssuingPersonalizationDesignCarrierText
IssuingPersonalizationDesignCarrierTextBuilder
IssuingPersonalizationDesignId
IssuingPersonalizationDesignPreferences
IssuingPersonalizationDesignPreferencesBuilder
IssuingPersonalizationDesignRejectionReasons
IssuingPersonalizationDesignRejectionReasonsBuilder
IssuingPhysicalBundle
A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
IssuingPhysicalBundleBuilder
IssuingPhysicalBundleFeatures
IssuingPhysicalBundleFeaturesBuilder
IssuingPhysicalBundleId
IssuingToken
An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens through Stripe.
IssuingTokenBuilder
IssuingTokenId
IssuingTransaction
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.
IssuingTransactionAmountDetails
IssuingTransactionAmountDetailsBuilder
IssuingTransactionBuilder
IssuingTransactionFleetCardholderPromptData
IssuingTransactionFleetCardholderPromptDataBuilder
IssuingTransactionFleetData
IssuingTransactionFleetDataBuilder
IssuingTransactionFleetFuelPriceData
IssuingTransactionFleetFuelPriceDataBuilder
IssuingTransactionFleetNonFuelPriceData
IssuingTransactionFleetNonFuelPriceDataBuilder
IssuingTransactionFleetReportedBreakdown
IssuingTransactionFleetReportedBreakdownBuilder
IssuingTransactionFleetTaxData
IssuingTransactionFleetTaxDataBuilder
IssuingTransactionFlightData
IssuingTransactionFlightDataBuilder
IssuingTransactionFlightDataLeg
IssuingTransactionFlightDataLegBuilder
IssuingTransactionFuelData
IssuingTransactionFuelDataBuilder
IssuingTransactionId
IssuingTransactionLodgingData
IssuingTransactionLodgingDataBuilder
IssuingTransactionNetworkData
IssuingTransactionNetworkDataBuilder
IssuingTransactionPurchaseDetails
IssuingTransactionPurchaseDetailsBuilder
IssuingTransactionReceiptData
IssuingTransactionReceiptDataBuilder
IssuingTransactionTreasury
IssuingTransactionTreasuryBuilder
KlarnaAddress
KlarnaAddressBuilder
KlarnaPayerDetails
KlarnaPayerDetailsBuilder
LegalEntityCompany
LegalEntityCompanyBuilder
LegalEntityCompanyVerification
LegalEntityCompanyVerificationBuilder
LegalEntityCompanyVerificationDocument
LegalEntityCompanyVerificationDocumentBuilder
LegalEntityDirectorshipDeclaration
LegalEntityDirectorshipDeclarationBuilder
LegalEntityDob
LegalEntityDobBuilder
LegalEntityJapanAddress
LegalEntityJapanAddressBuilder
LegalEntityPersonVerification
LegalEntityPersonVerificationBuilder
LegalEntityPersonVerificationDocument
LegalEntityPersonVerificationDocumentBuilder
LegalEntityRegistrationDate
LegalEntityRegistrationDateBuilder
LegalEntityUboDeclaration
LegalEntityUboDeclarationBuilder
Level3
Level3Builder
Level3LineItems
Level3LineItemsBuilder
LineItemsDiscountAmount
LineItemsDiscountAmountBuilder
LineItemsTaxAmount
LineItemsTaxAmountBuilder
LinkedAccountOptionsCommon
LinkedAccountOptionsCommonBuilder
Mandate
A Mandate is a record of the permission that your customer gives you to debit their payment method.
MandateAcssDebit
MandateAcssDebitBuilder
MandateAmazonPay
MandateAmazonPayBuilder
MandateAuBecsDebit
MandateAuBecsDebitBuilder
MandateBacsDebit
MandateBacsDebitBuilder
MandateBuilder
MandateCashapp
MandateCashappBuilder
MandateId
MandateKakaoPay
MandateKakaoPayBuilder
MandateKrCard
MandateKrCardBuilder
MandateLink
MandateLinkBuilder
MandateMultiUse
MandateMultiUseBuilder
MandateNaverPay
MandateNaverPayBuilder
MandateNzBankAccount
MandateNzBankAccountBuilder
MandatePaymentMethodDetails
MandatePaymentMethodDetailsBuilder
MandatePaypal
MandatePaypalBuilder
MandateRevolutPay
MandateRevolutPayBuilder
MandateSepaDebit
MandateSepaDebitBuilder
MandateSingleUse
MandateSingleUseBuilder
MandateUsBankAccount
MandateUsBankAccountBuilder
Networks
NetworksBuilder
NotificationEventData
NotificationEventDataBuilder
NotificationEventRequest
NotificationEventRequestBuilder
OfflineAcceptance
OfflineAcceptanceBuilder
OnlineAcceptance
OnlineAcceptanceBuilder
PackageDimensions
PackageDimensionsBuilder
PaymentFlowsAmountDetails
PaymentFlowsAmountDetailsBuilder
PaymentFlowsAmountDetailsClientResourceTip
PaymentFlowsAmountDetailsClientResourceTipBuilder
PaymentFlowsAutomaticPaymentMethodsPaymentIntent
PaymentFlowsAutomaticPaymentMethodsPaymentIntentBuilder
PaymentFlowsAutomaticPaymentMethodsSetupIntent
PaymentFlowsAutomaticPaymentMethodsSetupIntentBuilder
PaymentFlowsPaymentIntentPresentmentDetails
PaymentFlowsPaymentIntentPresentmentDetailsBuilder
PaymentFlowsPrivatePaymentMethodsAlipay
PaymentFlowsPrivatePaymentMethodsAlipayBuilder
PaymentFlowsPrivatePaymentMethodsAlipayDetails
PaymentFlowsPrivatePaymentMethodsAlipayDetailsBuilder
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorizationBuilder
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorizationBuilder
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercapture
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercaptureBuilder
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticapture
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticaptureBuilder
PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet
PaymentFlowsPrivatePaymentMethodsCardPresentCommonWalletBuilder
PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters
PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFiltersBuilder
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsBuilder
PaymentFlowsPrivatePaymentMethodsKlarnaDob
PaymentFlowsPrivatePaymentMethodsKlarnaDobBuilder
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsBuilder
PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptionsBuilder
PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions
PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptionsBuilder
PaymentIntent
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.
PaymentIntentBuilder
PaymentIntentCardProcessing
PaymentIntentCardProcessingBuilder
PaymentIntentId
PaymentIntentNextAction
PaymentIntentNextActionAlipayHandleRedirect
PaymentIntentNextActionAlipayHandleRedirectBuilder
PaymentIntentNextActionBoleto
PaymentIntentNextActionBoletoBuilder
PaymentIntentNextActionBuilder
PaymentIntentNextActionCardAwaitNotification
PaymentIntentNextActionCardAwaitNotificationBuilder
PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode
PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCodeBuilder
PaymentIntentNextActionCashappQrCode
PaymentIntentNextActionCashappQrCodeBuilder
PaymentIntentNextActionDisplayBankTransferInstructions
PaymentIntentNextActionDisplayBankTransferInstructionsBuilder
PaymentIntentNextActionDisplayMultibancoDetails
PaymentIntentNextActionDisplayMultibancoDetailsBuilder
PaymentIntentNextActionDisplayOxxoDetails
PaymentIntentNextActionDisplayOxxoDetailsBuilder
PaymentIntentNextActionKonbini
PaymentIntentNextActionKonbiniBuilder
PaymentIntentNextActionKonbiniFamilymart
PaymentIntentNextActionKonbiniFamilymartBuilder
PaymentIntentNextActionKonbiniLawson
PaymentIntentNextActionKonbiniLawsonBuilder
PaymentIntentNextActionKonbiniMinistop
PaymentIntentNextActionKonbiniMinistopBuilder
PaymentIntentNextActionKonbiniSeicomart
PaymentIntentNextActionKonbiniSeicomartBuilder
PaymentIntentNextActionKonbiniStores
PaymentIntentNextActionKonbiniStoresBuilder
PaymentIntentNextActionPaynowDisplayQrCode
PaymentIntentNextActionPaynowDisplayQrCodeBuilder
PaymentIntentNextActionPixDisplayQrCode
PaymentIntentNextActionPixDisplayQrCodeBuilder
PaymentIntentNextActionPromptpayDisplayQrCode
PaymentIntentNextActionPromptpayDisplayQrCodeBuilder
PaymentIntentNextActionRedirectToUrl
PaymentIntentNextActionRedirectToUrlBuilder
PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode
PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCodeBuilder
PaymentIntentNextActionSwishQrCode
PaymentIntentNextActionSwishQrCodeBuilder
PaymentIntentNextActionVerifyWithMicrodeposits
PaymentIntentNextActionVerifyWithMicrodepositsBuilder
PaymentIntentNextActionWechatPayDisplayQrCode
PaymentIntentNextActionWechatPayDisplayQrCodeBuilder
PaymentIntentNextActionWechatPayRedirectToAndroidApp
PaymentIntentNextActionWechatPayRedirectToAndroidAppBuilder
PaymentIntentNextActionWechatPayRedirectToIosApp
PaymentIntentNextActionWechatPayRedirectToIosAppBuilder
PaymentIntentPaymentMethodOptions
PaymentIntentPaymentMethodOptionsAcssDebit
PaymentIntentPaymentMethodOptionsAcssDebitBuilder
PaymentIntentPaymentMethodOptionsAuBecsDebit
PaymentIntentPaymentMethodOptionsAuBecsDebitBuilder
PaymentIntentPaymentMethodOptionsBacsDebit
PaymentIntentPaymentMethodOptionsBacsDebitBuilder
PaymentIntentPaymentMethodOptionsBlik
PaymentIntentPaymentMethodOptionsBlikBuilder
PaymentIntentPaymentMethodOptionsBuilder
PaymentIntentPaymentMethodOptionsCard
PaymentIntentPaymentMethodOptionsCardBuilder
PaymentIntentPaymentMethodOptionsEps
PaymentIntentPaymentMethodOptionsEpsBuilder
PaymentIntentPaymentMethodOptionsLink
PaymentIntentPaymentMethodOptionsLinkBuilder
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitBuilder
PaymentIntentPaymentMethodOptionsMandateOptionsBacsDebit
PaymentIntentPaymentMethodOptionsMandateOptionsBacsDebitBuilder
PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit
PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebitBuilder
PaymentIntentPaymentMethodOptionsMobilepay
PaymentIntentPaymentMethodOptionsMobilepayBuilder
PaymentIntentPaymentMethodOptionsNzBankAccount
PaymentIntentPaymentMethodOptionsNzBankAccountBuilder
PaymentIntentPaymentMethodOptionsSepaDebit
PaymentIntentPaymentMethodOptionsSepaDebitBuilder
PaymentIntentPaymentMethodOptionsSwish
PaymentIntentPaymentMethodOptionsSwishBuilder
PaymentIntentPaymentMethodOptionsUsBankAccount
PaymentIntentPaymentMethodOptionsUsBankAccountBuilder
PaymentIntentProcessing
PaymentIntentProcessingBuilder
PaymentIntentProcessingCustomerNotification
PaymentIntentProcessingCustomerNotificationBuilder
PaymentLink
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.
PaymentLinkBuilder
PaymentLinkId
PaymentLinksResourceAfterCompletion
PaymentLinksResourceAfterCompletionBuilder
PaymentLinksResourceAutomaticTax
PaymentLinksResourceAutomaticTaxBuilder
PaymentLinksResourceCompletedSessions
PaymentLinksResourceCompletedSessionsBuilder
PaymentLinksResourceCompletionBehaviorConfirmationPage
PaymentLinksResourceCompletionBehaviorConfirmationPageBuilder
PaymentLinksResourceCompletionBehaviorRedirect
PaymentLinksResourceCompletionBehaviorRedirectBuilder
PaymentLinksResourceConsentCollection
PaymentLinksResourceConsentCollectionBuilder
PaymentLinksResourceCustomFields
PaymentLinksResourceCustomFieldsBuilder
PaymentLinksResourceCustomFieldsDropdown
PaymentLinksResourceCustomFieldsDropdownBuilder
PaymentLinksResourceCustomFieldsDropdownOption
PaymentLinksResourceCustomFieldsDropdownOptionBuilder
PaymentLinksResourceCustomFieldsLabel
PaymentLinksResourceCustomFieldsLabelBuilder
PaymentLinksResourceCustomFieldsNumeric
PaymentLinksResourceCustomFieldsNumericBuilder
PaymentLinksResourceCustomFieldsText
PaymentLinksResourceCustomFieldsTextBuilder
PaymentLinksResourceCustomText
PaymentLinksResourceCustomTextBuilder
PaymentLinksResourceCustomTextPosition
PaymentLinksResourceCustomTextPositionBuilder
PaymentLinksResourceInvoiceCreation
PaymentLinksResourceInvoiceCreationBuilder
PaymentLinksResourceInvoiceSettings
PaymentLinksResourceInvoiceSettingsBuilder
PaymentLinksResourceOptionalItem
PaymentLinksResourceOptionalItemAdjustableQuantity
PaymentLinksResourceOptionalItemAdjustableQuantityBuilder
PaymentLinksResourceOptionalItemBuilder
PaymentLinksResourcePaymentIntentData
PaymentLinksResourcePaymentIntentDataBuilder
PaymentLinksResourcePaymentMethodReuseAgreement
PaymentLinksResourcePaymentMethodReuseAgreementBuilder
PaymentLinksResourcePhoneNumberCollection
PaymentLinksResourcePhoneNumberCollectionBuilder
PaymentLinksResourceRestrictions
PaymentLinksResourceRestrictionsBuilder
PaymentLinksResourceShippingAddressCollection
PaymentLinksResourceShippingAddressCollectionBuilder
PaymentLinksResourceShippingOption
PaymentLinksResourceShippingOptionBuilder
PaymentLinksResourceSubscriptionData
PaymentLinksResourceSubscriptionDataBuilder
PaymentLinksResourceSubscriptionDataInvoiceSettings
PaymentLinksResourceSubscriptionDataInvoiceSettingsBuilder
PaymentLinksResourceTaxIdCollection
PaymentLinksResourceTaxIdCollectionBuilder
PaymentLinksResourceTransferData
PaymentLinksResourceTransferDataBuilder
PaymentMethod
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.
PaymentMethodAcssDebit
PaymentMethodAcssDebitBuilder
PaymentMethodAffirm
PaymentMethodAffirmBuilder
PaymentMethodAfterpayClearpay
PaymentMethodAfterpayClearpayBuilder
PaymentMethodAlma
PaymentMethodAlmaBuilder
PaymentMethodAmazonPay
PaymentMethodAmazonPayBuilder
PaymentMethodAuBecsDebit
PaymentMethodAuBecsDebitBuilder
PaymentMethodBacsDebit
PaymentMethodBacsDebitBuilder
PaymentMethodBancontact
PaymentMethodBancontactBuilder
PaymentMethodBillie
PaymentMethodBillieBuilder
PaymentMethodBlik
PaymentMethodBlikBuilder
PaymentMethodBoleto
PaymentMethodBoletoBuilder
PaymentMethodBuilder
PaymentMethodCard
PaymentMethodCardBuilder
PaymentMethodCardChecks
PaymentMethodCardChecksBuilder
PaymentMethodCardGeneratedCard
PaymentMethodCardGeneratedCardBuilder
PaymentMethodCardPresent
PaymentMethodCardPresentBuilder
PaymentMethodCardPresentNetworks
PaymentMethodCardPresentNetworksBuilder
PaymentMethodCardWallet
PaymentMethodCardWalletAmexExpressCheckout
PaymentMethodCardWalletAmexExpressCheckoutBuilder
PaymentMethodCardWalletApplePay
PaymentMethodCardWalletApplePayBuilder
PaymentMethodCardWalletBuilder
PaymentMethodCardWalletGooglePay
PaymentMethodCardWalletGooglePayBuilder
PaymentMethodCardWalletLink
PaymentMethodCardWalletLinkBuilder
PaymentMethodCardWalletMasterpass
PaymentMethodCardWalletMasterpassBuilder
PaymentMethodCardWalletSamsungPay
PaymentMethodCardWalletSamsungPayBuilder
PaymentMethodCardWalletVisaCheckout
PaymentMethodCardWalletVisaCheckoutBuilder
PaymentMethodCashapp
PaymentMethodCashappBuilder
PaymentMethodConfigBizPaymentMethodConfigurationDetails
PaymentMethodConfigBizPaymentMethodConfigurationDetailsBuilder
PaymentMethodCustomerBalance
PaymentMethodCustomerBalanceBuilder
PaymentMethodDetails
PaymentMethodDetailsAchCreditTransfer
PaymentMethodDetailsAchCreditTransferBuilder
PaymentMethodDetailsAchDebit
PaymentMethodDetailsAchDebitBuilder
PaymentMethodDetailsAcssDebit
PaymentMethodDetailsAcssDebitBuilder
PaymentMethodDetailsAffirm
PaymentMethodDetailsAffirmBuilder
PaymentMethodDetailsAfterpayClearpay
PaymentMethodDetailsAfterpayClearpayBuilder
PaymentMethodDetailsAlma
PaymentMethodDetailsAlmaBuilder
PaymentMethodDetailsAmazonPay
PaymentMethodDetailsAmazonPayBuilder
PaymentMethodDetailsAuBecsDebit
PaymentMethodDetailsAuBecsDebitBuilder
PaymentMethodDetailsBacsDebit
PaymentMethodDetailsBacsDebitBuilder
PaymentMethodDetailsBancontact
PaymentMethodDetailsBancontactBuilder
PaymentMethodDetailsBillie
PaymentMethodDetailsBillieBuilder
PaymentMethodDetailsBlik
PaymentMethodDetailsBlikBuilder
PaymentMethodDetailsBoleto
PaymentMethodDetailsBoletoBuilder
PaymentMethodDetailsBuilder
PaymentMethodDetailsCard
PaymentMethodDetailsCardBuilder
PaymentMethodDetailsCardChecks
PaymentMethodDetailsCardChecksBuilder
PaymentMethodDetailsCardInstallments
PaymentMethodDetailsCardInstallmentsBuilder
PaymentMethodDetailsCardInstallmentsPlan
PaymentMethodDetailsCardInstallmentsPlanBuilder
PaymentMethodDetailsCardNetworkToken
PaymentMethodDetailsCardNetworkTokenBuilder
PaymentMethodDetailsCardPresent
PaymentMethodDetailsCardPresentBuilder
PaymentMethodDetailsCardPresentOffline
PaymentMethodDetailsCardPresentOfflineBuilder
PaymentMethodDetailsCardPresentReceipt
PaymentMethodDetailsCardPresentReceiptBuilder
PaymentMethodDetailsCardWallet
PaymentMethodDetailsCardWalletAmexExpressCheckout
PaymentMethodDetailsCardWalletAmexExpressCheckoutBuilder
PaymentMethodDetailsCardWalletApplePay
PaymentMethodDetailsCardWalletApplePayBuilder
PaymentMethodDetailsCardWalletBuilder
PaymentMethodDetailsCardWalletGooglePay
PaymentMethodDetailsCardWalletGooglePayBuilder
PaymentMethodDetailsCardWalletLink
PaymentMethodDetailsCardWalletLinkBuilder
PaymentMethodDetailsCardWalletMasterpass
PaymentMethodDetailsCardWalletMasterpassBuilder
PaymentMethodDetailsCardWalletSamsungPay
PaymentMethodDetailsCardWalletSamsungPayBuilder
PaymentMethodDetailsCardWalletVisaCheckout
PaymentMethodDetailsCardWalletVisaCheckoutBuilder
PaymentMethodDetailsCashapp
PaymentMethodDetailsCashappBuilder
PaymentMethodDetailsCustomerBalance
PaymentMethodDetailsCustomerBalanceBuilder
PaymentMethodDetailsEps
PaymentMethodDetailsEpsBuilder
PaymentMethodDetailsFpx
PaymentMethodDetailsFpxBuilder
PaymentMethodDetailsGiropay
PaymentMethodDetailsGiropayBuilder
PaymentMethodDetailsGrabpay
PaymentMethodDetailsGrabpayBuilder
PaymentMethodDetailsIdeal
PaymentMethodDetailsIdealBuilder
PaymentMethodDetailsInteracPresent
PaymentMethodDetailsInteracPresentBuilder
PaymentMethodDetailsInteracPresentReceipt
PaymentMethodDetailsInteracPresentReceiptBuilder
PaymentMethodDetailsKakaoPay
PaymentMethodDetailsKakaoPayBuilder
PaymentMethodDetailsKlarna
PaymentMethodDetailsKlarnaBuilder
PaymentMethodDetailsKonbini
PaymentMethodDetailsKonbiniBuilder
PaymentMethodDetailsKonbiniStore
PaymentMethodDetailsKonbiniStoreBuilder
PaymentMethodDetailsKrCard
PaymentMethodDetailsKrCardBuilder
PaymentMethodDetailsLink
PaymentMethodDetailsLinkBuilder
PaymentMethodDetailsMobilepay
PaymentMethodDetailsMobilepayBuilder
PaymentMethodDetailsMultibanco
PaymentMethodDetailsMultibancoBuilder
PaymentMethodDetailsNaverPay
PaymentMethodDetailsNaverPayBuilder
PaymentMethodDetailsNzBankAccount
PaymentMethodDetailsNzBankAccountBuilder
PaymentMethodDetailsOxxo
PaymentMethodDetailsOxxoBuilder
PaymentMethodDetailsP24
PaymentMethodDetailsP24Builder
PaymentMethodDetailsPassthroughCard
PaymentMethodDetailsPassthroughCardBuilder
PaymentMethodDetailsPayByBank
PaymentMethodDetailsPayByBankBuilder
PaymentMethodDetailsPayco
PaymentMethodDetailsPaycoBuilder
PaymentMethodDetailsPaynow
PaymentMethodDetailsPaynowBuilder
PaymentMethodDetailsPaypal
PaymentMethodDetailsPaypalBuilder
PaymentMethodDetailsPix
PaymentMethodDetailsPixBuilder
PaymentMethodDetailsPromptpay
PaymentMethodDetailsPromptpayBuilder
PaymentMethodDetailsRevolutPay
PaymentMethodDetailsRevolutPayBuilder
PaymentMethodDetailsSamsungPay
PaymentMethodDetailsSamsungPayBuilder
PaymentMethodDetailsSatispay
PaymentMethodDetailsSatispayBuilder
PaymentMethodDetailsSepaCreditTransfer
PaymentMethodDetailsSepaCreditTransferBuilder
PaymentMethodDetailsSepaDebit
PaymentMethodDetailsSepaDebitBuilder
PaymentMethodDetailsSofort
PaymentMethodDetailsSofortBuilder
PaymentMethodDetailsStripeAccount
PaymentMethodDetailsStripeAccountBuilder
PaymentMethodDetailsSwish
PaymentMethodDetailsSwishBuilder
PaymentMethodDetailsTwint
PaymentMethodDetailsTwintBuilder
PaymentMethodDetailsUsBankAccount
PaymentMethodDetailsUsBankAccountBuilder
PaymentMethodDetailsWechat
PaymentMethodDetailsWechatBuilder
PaymentMethodDetailsWechatPay
PaymentMethodDetailsWechatPayBuilder
PaymentMethodDetailsZip
PaymentMethodDetailsZipBuilder
PaymentMethodEps
PaymentMethodEpsBuilder
PaymentMethodFpx
PaymentMethodFpxBuilder
PaymentMethodGiropay
PaymentMethodGiropayBuilder
PaymentMethodGrabpay
PaymentMethodGrabpayBuilder
PaymentMethodId
PaymentMethodIdeal
PaymentMethodIdealBuilder
PaymentMethodInteracPresent
PaymentMethodInteracPresentBuilder
PaymentMethodKakaoPay
PaymentMethodKakaoPayBuilder
PaymentMethodKlarna
PaymentMethodKlarnaBuilder
PaymentMethodKonbini
PaymentMethodKonbiniBuilder
PaymentMethodKrCard
PaymentMethodKrCardBuilder
PaymentMethodLink
PaymentMethodLinkBuilder
PaymentMethodMobilepay
PaymentMethodMobilepayBuilder
PaymentMethodMultibanco
PaymentMethodMultibancoBuilder
PaymentMethodNaverPay
PaymentMethodNaverPayBuilder
PaymentMethodNzBankAccount
PaymentMethodNzBankAccountBuilder
PaymentMethodOptionsAffirm
PaymentMethodOptionsAffirmBuilder
PaymentMethodOptionsAfterpayClearpay
PaymentMethodOptionsAfterpayClearpayBuilder
PaymentMethodOptionsAlipay
PaymentMethodOptionsAlipayBuilder
PaymentMethodOptionsAlma
PaymentMethodOptionsAlmaBuilder
PaymentMethodOptionsAmazonPay
PaymentMethodOptionsAmazonPayBuilder
PaymentMethodOptionsBancontact
PaymentMethodOptionsBancontactBuilder
PaymentMethodOptionsBillie
PaymentMethodOptionsBillieBuilder
PaymentMethodOptionsBoleto
PaymentMethodOptionsBoletoBuilder
PaymentMethodOptionsCardInstallments
PaymentMethodOptionsCardInstallmentsBuilder
PaymentMethodOptionsCardMandateOptions
PaymentMethodOptionsCardMandateOptionsBuilder
PaymentMethodOptionsCardPresent
PaymentMethodOptionsCardPresentBuilder
PaymentMethodOptionsCardPresentRouting
PaymentMethodOptionsCardPresentRoutingBuilder
PaymentMethodOptionsCashapp
PaymentMethodOptionsCashappBuilder
PaymentMethodOptionsCustomerBalance
PaymentMethodOptionsCustomerBalanceBankTransfer
PaymentMethodOptionsCustomerBalanceBankTransferBuilder
PaymentMethodOptionsCustomerBalanceBuilder
PaymentMethodOptionsCustomerBalanceEuBankAccount
PaymentMethodOptionsCustomerBalanceEuBankAccountBuilder
PaymentMethodOptionsFpx
PaymentMethodOptionsFpxBuilder
PaymentMethodOptionsGiropay
PaymentMethodOptionsGiropayBuilder
PaymentMethodOptionsGrabpay
PaymentMethodOptionsGrabpayBuilder
PaymentMethodOptionsIdeal
PaymentMethodOptionsIdealBuilder
PaymentMethodOptionsInteracPresent
PaymentMethodOptionsInteracPresentBuilder
PaymentMethodOptionsKlarna
PaymentMethodOptionsKlarnaBuilder
PaymentMethodOptionsKonbini
PaymentMethodOptionsKonbiniBuilder
PaymentMethodOptionsKrCard
PaymentMethodOptionsKrCardBuilder
PaymentMethodOptionsMultibanco
PaymentMethodOptionsMultibancoBuilder
PaymentMethodOptionsOxxo
PaymentMethodOptionsOxxoBuilder
PaymentMethodOptionsP24
PaymentMethodOptionsP24Builder
PaymentMethodOptionsPayByBank
PaymentMethodOptionsPayByBankBuilder
PaymentMethodOptionsPaynow
PaymentMethodOptionsPaynowBuilder
PaymentMethodOptionsPaypal
PaymentMethodOptionsPaypalBuilder
PaymentMethodOptionsPix
PaymentMethodOptionsPixBuilder
PaymentMethodOptionsPromptpay
PaymentMethodOptionsPromptpayBuilder
PaymentMethodOptionsRevolutPay
PaymentMethodOptionsRevolutPayBuilder
PaymentMethodOptionsSofort
PaymentMethodOptionsSofortBuilder
PaymentMethodOptionsTwint
PaymentMethodOptionsTwintBuilder
PaymentMethodOptionsUsBankAccountMandateOptions
PaymentMethodOptionsUsBankAccountMandateOptionsBuilder
PaymentMethodOptionsWechatPay
PaymentMethodOptionsWechatPayBuilder
PaymentMethodOptionsZip
PaymentMethodOptionsZipBuilder
PaymentMethodOxxo
PaymentMethodOxxoBuilder
PaymentMethodP24
PaymentMethodP24Builder
PaymentMethodPayByBank
PaymentMethodPayByBankBuilder
PaymentMethodPayco
PaymentMethodPaycoBuilder
PaymentMethodPaynow
PaymentMethodPaynowBuilder
PaymentMethodPaypal
PaymentMethodPaypalBuilder
PaymentMethodPix
PaymentMethodPixBuilder
PaymentMethodPromptpay
PaymentMethodPromptpayBuilder
PaymentMethodRevolutPay
PaymentMethodRevolutPayBuilder
PaymentMethodSamsungPay
PaymentMethodSamsungPayBuilder
PaymentMethodSatispay
PaymentMethodSatispayBuilder
PaymentMethodSepaDebit
PaymentMethodSepaDebitBuilder
PaymentMethodSofort
PaymentMethodSofortBuilder
PaymentMethodSwish
PaymentMethodSwishBuilder
PaymentMethodTwint
PaymentMethodTwintBuilder
PaymentMethodUsBankAccount
PaymentMethodUsBankAccountBlocked
PaymentMethodUsBankAccountBlockedBuilder
PaymentMethodUsBankAccountBuilder
PaymentMethodUsBankAccountStatusDetails
PaymentMethodUsBankAccountStatusDetailsBuilder
PaymentMethodWechatPay
PaymentMethodWechatPayBuilder
PaymentMethodZip
PaymentMethodZipBuilder
PaymentPagesCheckoutSessionAdaptivePricing
PaymentPagesCheckoutSessionAdaptivePricingBuilder
PaymentPagesCheckoutSessionAfterExpiration
PaymentPagesCheckoutSessionAfterExpirationBuilder
PaymentPagesCheckoutSessionAfterExpirationRecovery
PaymentPagesCheckoutSessionAfterExpirationRecoveryBuilder
PaymentPagesCheckoutSessionAutomaticTax
PaymentPagesCheckoutSessionAutomaticTaxBuilder
PaymentPagesCheckoutSessionCheckoutAddressDetails
PaymentPagesCheckoutSessionCheckoutAddressDetailsBuilder
PaymentPagesCheckoutSessionCollectedInformation
PaymentPagesCheckoutSessionCollectedInformationBuilder
PaymentPagesCheckoutSessionConsent
PaymentPagesCheckoutSessionConsentBuilder
PaymentPagesCheckoutSessionConsentCollection
PaymentPagesCheckoutSessionConsentCollectionBuilder
PaymentPagesCheckoutSessionCurrencyConversion
PaymentPagesCheckoutSessionCurrencyConversionBuilder
PaymentPagesCheckoutSessionCustomFields
PaymentPagesCheckoutSessionCustomFieldsBuilder
PaymentPagesCheckoutSessionCustomFieldsDropdown
PaymentPagesCheckoutSessionCustomFieldsDropdownBuilder
PaymentPagesCheckoutSessionCustomFieldsLabel
PaymentPagesCheckoutSessionCustomFieldsLabelBuilder
PaymentPagesCheckoutSessionCustomFieldsNumeric
PaymentPagesCheckoutSessionCustomFieldsNumericBuilder
PaymentPagesCheckoutSessionCustomFieldsOption
PaymentPagesCheckoutSessionCustomFieldsOptionBuilder
PaymentPagesCheckoutSessionCustomFieldsText
PaymentPagesCheckoutSessionCustomFieldsTextBuilder
PaymentPagesCheckoutSessionCustomText
PaymentPagesCheckoutSessionCustomTextBuilder
PaymentPagesCheckoutSessionCustomTextPosition
PaymentPagesCheckoutSessionCustomTextPositionBuilder
PaymentPagesCheckoutSessionCustomerDetails
PaymentPagesCheckoutSessionCustomerDetailsBuilder
PaymentPagesCheckoutSessionDiscount
PaymentPagesCheckoutSessionDiscountBuilder
PaymentPagesCheckoutSessionInvoiceCreation
PaymentPagesCheckoutSessionInvoiceCreationBuilder
PaymentPagesCheckoutSessionInvoiceSettings
PaymentPagesCheckoutSessionInvoiceSettingsBuilder
PaymentPagesCheckoutSessionOptionalItem
PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity
PaymentPagesCheckoutSessionOptionalItemAdjustableQuantityBuilder
PaymentPagesCheckoutSessionOptionalItemBuilder
PaymentPagesCheckoutSessionPaymentMethodReuseAgreement
PaymentPagesCheckoutSessionPaymentMethodReuseAgreementBuilder
PaymentPagesCheckoutSessionPermissions
PaymentPagesCheckoutSessionPermissionsBuilder
PaymentPagesCheckoutSessionPhoneNumberCollection
PaymentPagesCheckoutSessionPhoneNumberCollectionBuilder
PaymentPagesCheckoutSessionSavedPaymentMethodOptions
PaymentPagesCheckoutSessionSavedPaymentMethodOptionsBuilder
PaymentPagesCheckoutSessionShippingAddressCollection
PaymentPagesCheckoutSessionShippingAddressCollectionBuilder
PaymentPagesCheckoutSessionShippingCost
PaymentPagesCheckoutSessionShippingCostBuilder
PaymentPagesCheckoutSessionShippingOption
PaymentPagesCheckoutSessionShippingOptionBuilder
PaymentPagesCheckoutSessionTaxId
PaymentPagesCheckoutSessionTaxIdBuilder
PaymentPagesCheckoutSessionTaxIdCollection
PaymentPagesCheckoutSessionTaxIdCollectionBuilder
PaymentPagesCheckoutSessionTotalDetails
PaymentPagesCheckoutSessionTotalDetailsBuilder
PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown
PaymentPagesCheckoutSessionTotalDetailsResourceBreakdownBuilder
PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions
PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictionsBuilder
PaymentSourceBuilder
Payout
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, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.
PayoutBuilder
PayoutId
PayoutsTraceId
PayoutsTraceIdBuilder
PaypalSellerProtection
PaypalSellerProtectionBuilder
Person
This is an object representing a person associated with a Stripe account.
PersonAdditionalTosAcceptance
PersonAdditionalTosAcceptanceBuilder
PersonAdditionalTosAcceptances
PersonAdditionalTosAcceptancesBuilder
PersonBuilder
PersonEthnicityDetails
PersonEthnicityDetailsBuilder
PersonFutureRequirements
PersonFutureRequirementsBuilder
PersonId
PersonRaceDetails
PersonRaceDetailsBuilder
PersonRelationship
PersonRelationshipBuilder
PersonRequirements
PersonRequirementsBuilder
PersonUsCfpbData
PersonUsCfpbDataBuilder
Plan
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
PlanBuilder
PlanId
PlanTier
PlanTierBuilder
PlatformEarningFeeSource
PlatformEarningFeeSourceBuilder
Price
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.
PriceBuilder
PriceId
PriceTier
PriceTierBuilder
Product
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.
ProductBuilder
ProductId
ProductMarketingFeature
ProductMarketingFeatureBuilder
PromotionCode
A Promotion Code represents a customer-redeemable code for a coupon. It can be used to. create multiple codes for a single coupon.
PromotionCodeBuilder
PromotionCodeCurrencyOption
PromotionCodeCurrencyOptionBuilder
PromotionCodeId
PromotionCodesResourceRestrictions
PromotionCodesResourceRestrictionsBuilder
RadarRadarOptions
Options to configure Radar. See Radar Session for more information.
RadarRadarOptionsBuilder
RadarReviewResourceLocation
RadarReviewResourceLocationBuilder
RadarReviewResourceSession
RadarReviewResourceSessionBuilder
Recurring
RecurringBuilder
Refund
Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.
RefundBuilder
RefundDestinationDetails
RefundDestinationDetailsBlik
RefundDestinationDetailsBlikBuilder
RefundDestinationDetailsBrBankTransfer
RefundDestinationDetailsBrBankTransferBuilder
RefundDestinationDetailsBuilder
RefundDestinationDetailsCard
RefundDestinationDetailsCardBuilder
RefundDestinationDetailsEuBankTransfer
RefundDestinationDetailsEuBankTransferBuilder
RefundDestinationDetailsGbBankTransfer
RefundDestinationDetailsGbBankTransferBuilder
RefundDestinationDetailsJpBankTransfer
RefundDestinationDetailsJpBankTransferBuilder
RefundDestinationDetailsMultibanco
RefundDestinationDetailsMultibancoBuilder
RefundDestinationDetailsMxBankTransfer
RefundDestinationDetailsMxBankTransferBuilder
RefundDestinationDetailsP24
RefundDestinationDetailsP24Builder
RefundDestinationDetailsSwish
RefundDestinationDetailsSwishBuilder
RefundDestinationDetailsThBankTransfer
RefundDestinationDetailsThBankTransferBuilder
RefundDestinationDetailsUsBankTransfer
RefundDestinationDetailsUsBankTransferBuilder
RefundId
RefundNextAction
RefundNextActionBuilder
RefundNextActionDisplayDetails
RefundNextActionDisplayDetailsBuilder
ReserveTransaction
ReserveTransactionBuilder
ReserveTransactionId
Review
Reviews can be used to supplement automated fraud detection with human expertise.
ReviewBuilder
ReviewId
RevolutPayUnderlyingPaymentMethodFundingDetails
RevolutPayUnderlyingPaymentMethodFundingDetailsBuilder
Rule
RuleBuilder
RuleId
SchedulesPhaseAutomaticTax
SchedulesPhaseAutomaticTaxBuilder
SepaDebitGeneratedFrom
SepaDebitGeneratedFromBuilder
SetupAttempt
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
SetupAttemptBuilder
SetupAttemptId
SetupAttemptPaymentMethodDetails
SetupAttemptPaymentMethodDetailsAcssDebit
SetupAttemptPaymentMethodDetailsAcssDebitBuilder
SetupAttemptPaymentMethodDetailsAmazonPay
SetupAttemptPaymentMethodDetailsAmazonPayBuilder
SetupAttemptPaymentMethodDetailsAuBecsDebit
SetupAttemptPaymentMethodDetailsAuBecsDebitBuilder
SetupAttemptPaymentMethodDetailsBacsDebit
SetupAttemptPaymentMethodDetailsBacsDebitBuilder
SetupAttemptPaymentMethodDetailsBancontact
SetupAttemptPaymentMethodDetailsBancontactBuilder
SetupAttemptPaymentMethodDetailsBoleto
SetupAttemptPaymentMethodDetailsBoletoBuilder
SetupAttemptPaymentMethodDetailsBuilder
SetupAttemptPaymentMethodDetailsCard
SetupAttemptPaymentMethodDetailsCardBuilder
SetupAttemptPaymentMethodDetailsCardChecks
SetupAttemptPaymentMethodDetailsCardChecksBuilder
SetupAttemptPaymentMethodDetailsCardPresent
SetupAttemptPaymentMethodDetailsCardPresentBuilder
SetupAttemptPaymentMethodDetailsCardWallet
SetupAttemptPaymentMethodDetailsCardWalletBuilder
SetupAttemptPaymentMethodDetailsCashapp
SetupAttemptPaymentMethodDetailsCashappBuilder
SetupAttemptPaymentMethodDetailsIdeal
SetupAttemptPaymentMethodDetailsIdealBuilder
SetupAttemptPaymentMethodDetailsKakaoPay
SetupAttemptPaymentMethodDetailsKakaoPayBuilder
SetupAttemptPaymentMethodDetailsKlarna
SetupAttemptPaymentMethodDetailsKlarnaBuilder
SetupAttemptPaymentMethodDetailsKrCard
SetupAttemptPaymentMethodDetailsKrCardBuilder
SetupAttemptPaymentMethodDetailsLink
SetupAttemptPaymentMethodDetailsLinkBuilder
SetupAttemptPaymentMethodDetailsNaverPay
SetupAttemptPaymentMethodDetailsNaverPayBuilder
SetupAttemptPaymentMethodDetailsNzBankAccount
SetupAttemptPaymentMethodDetailsNzBankAccountBuilder
SetupAttemptPaymentMethodDetailsPaypal
SetupAttemptPaymentMethodDetailsPaypalBuilder
SetupAttemptPaymentMethodDetailsRevolutPay
SetupAttemptPaymentMethodDetailsRevolutPayBuilder
SetupAttemptPaymentMethodDetailsSepaDebit
SetupAttemptPaymentMethodDetailsSepaDebitBuilder
SetupAttemptPaymentMethodDetailsSofort
SetupAttemptPaymentMethodDetailsSofortBuilder
SetupAttemptPaymentMethodDetailsUsBankAccount
SetupAttemptPaymentMethodDetailsUsBankAccountBuilder
SetupIntent
A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you can 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.
SetupIntentBuilder
SetupIntentId
SetupIntentNextAction
SetupIntentNextActionBuilder
SetupIntentNextActionRedirectToUrl
SetupIntentNextActionRedirectToUrlBuilder
SetupIntentNextActionVerifyWithMicrodeposits
SetupIntentNextActionVerifyWithMicrodepositsBuilder
SetupIntentPaymentMethodOptions
SetupIntentPaymentMethodOptionsAcssDebit
SetupIntentPaymentMethodOptionsAcssDebitBuilder
SetupIntentPaymentMethodOptionsAmazonPay
SetupIntentPaymentMethodOptionsAmazonPayBuilder
SetupIntentPaymentMethodOptionsBacsDebit
SetupIntentPaymentMethodOptionsBacsDebitBuilder
SetupIntentPaymentMethodOptionsBuilder
SetupIntentPaymentMethodOptionsCard
SetupIntentPaymentMethodOptionsCardBuilder
SetupIntentPaymentMethodOptionsCardMandateOptions
SetupIntentPaymentMethodOptionsCardMandateOptionsBuilder
SetupIntentPaymentMethodOptionsCardPresent
SetupIntentPaymentMethodOptionsCardPresentBuilder
SetupIntentPaymentMethodOptionsLink
SetupIntentPaymentMethodOptionsLinkBuilder
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitBuilder
SetupIntentPaymentMethodOptionsMandateOptionsBacsDebit
SetupIntentPaymentMethodOptionsMandateOptionsBacsDebitBuilder
SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit
SetupIntentPaymentMethodOptionsMandateOptionsSepaDebitBuilder
SetupIntentPaymentMethodOptionsPaypal
SetupIntentPaymentMethodOptionsPaypalBuilder
SetupIntentPaymentMethodOptionsSepaDebit
SetupIntentPaymentMethodOptionsSepaDebitBuilder
SetupIntentPaymentMethodOptionsUsBankAccount
SetupIntentPaymentMethodOptionsUsBankAccountBuilder
Shipping
ShippingBuilder
ShippingRate
Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.
ShippingRateBuilder
ShippingRateCurrencyOption
ShippingRateCurrencyOptionBuilder
ShippingRateDeliveryEstimate
ShippingRateDeliveryEstimateBound
ShippingRateDeliveryEstimateBoundBuilder
ShippingRateDeliveryEstimateBuilder
ShippingRateFixedAmount
ShippingRateFixedAmountBuilder
ShippingRateId
Source
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.
SourceBuilder
SourceCodeVerificationFlow
SourceCodeVerificationFlowBuilder
SourceId
SourceOrder
SourceOrderBuilder
SourceOrderItem
SourceOrderItemBuilder
SourceOwner
SourceOwnerBuilder
SourceReceiverFlow
SourceReceiverFlowBuilder
SourceRedirectFlow
SourceRedirectFlowBuilder
SourceTransaction
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.
SourceTransactionAchCreditTransferData
SourceTransactionAchCreditTransferDataBuilder
SourceTransactionBuilder
SourceTransactionChfCreditTransferData
SourceTransactionChfCreditTransferDataBuilder
SourceTransactionGbpCreditTransferData
SourceTransactionGbpCreditTransferDataBuilder
SourceTransactionId
SourceTransactionPaperCheckData
SourceTransactionPaperCheckDataBuilder
SourceTransactionSepaCreditTransferData
SourceTransactionSepaCreditTransferDataBuilder
SourceTypeAchCreditTransfer
SourceTypeAchCreditTransferBuilder
SourceTypeAchDebit
SourceTypeAchDebitBuilder
SourceTypeAcssDebit
SourceTypeAcssDebitBuilder
SourceTypeAlipay
SourceTypeAlipayBuilder
SourceTypeAuBecsDebit
SourceTypeAuBecsDebitBuilder
SourceTypeBancontact
SourceTypeBancontactBuilder
SourceTypeCard
SourceTypeCardBuilder
SourceTypeCardPresent
SourceTypeCardPresentBuilder
SourceTypeEps
SourceTypeEpsBuilder
SourceTypeGiropay
SourceTypeGiropayBuilder
SourceTypeIdeal
SourceTypeIdealBuilder
SourceTypeKlarna
SourceTypeKlarnaBuilder
SourceTypeMultibanco
SourceTypeMultibancoBuilder
SourceTypeP24
SourceTypeP24Builder
SourceTypeSepaCreditTransfer
SourceTypeSepaCreditTransferBuilder
SourceTypeSepaDebit
SourceTypeSepaDebitBuilder
SourceTypeSofort
SourceTypeSofortBuilder
SourceTypeThreeDSecure
SourceTypeThreeDSecureBuilder
SourceTypeWechat
SourceTypeWechatBuilder
Subscription
Subscriptions allow you to charge a customer on a recurring basis.
SubscriptionAutomaticTax
SubscriptionAutomaticTaxBuilder
SubscriptionBuilder
SubscriptionId
SubscriptionItem
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
SubscriptionItemBuilder
SubscriptionItemId
SubscriptionPaymentMethodOptionsCard
SubscriptionPaymentMethodOptionsCardBuilder
SubscriptionPendingInvoiceItemInterval
SubscriptionPendingInvoiceItemIntervalBuilder
SubscriptionSchedule
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
SubscriptionScheduleAddInvoiceItem
An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.
SubscriptionScheduleAddInvoiceItemBuilder
SubscriptionScheduleBuilder
SubscriptionScheduleConfigurationItem
A phase item describes the price and quantity of a phase.
SubscriptionScheduleConfigurationItemBuilder
SubscriptionScheduleCurrentPhase
SubscriptionScheduleCurrentPhaseBuilder
SubscriptionScheduleId
SubscriptionSchedulePhaseConfiguration
A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.
SubscriptionSchedulePhaseConfigurationBuilder
SubscriptionSchedulesResourceDefaultSettings
SubscriptionSchedulesResourceDefaultSettingsAutomaticTax
SubscriptionSchedulesResourceDefaultSettingsAutomaticTaxBuilder
SubscriptionSchedulesResourceDefaultSettingsBuilder
SubscriptionTransferData
SubscriptionTransferDataBuilder
SubscriptionsResourceBillingCycleAnchorConfig
SubscriptionsResourceBillingCycleAnchorConfigBuilder
SubscriptionsResourcePauseCollection
The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription. should be paused.
SubscriptionsResourcePauseCollectionBuilder
SubscriptionsResourcePaymentMethodOptions
SubscriptionsResourcePaymentMethodOptionsBuilder
SubscriptionsResourcePaymentSettings
SubscriptionsResourcePaymentSettingsBuilder
SubscriptionsResourcePendingUpdate
Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.
SubscriptionsResourcePendingUpdateBuilder
SubscriptionsResourceSubscriptionInvoiceSettings
SubscriptionsResourceSubscriptionInvoiceSettingsBuilder
SubscriptionsTrialsResourceEndBehavior
Defines how a subscription behaves when a free trial ends.
SubscriptionsTrialsResourceEndBehaviorBuilder
SubscriptionsTrialsResourceTrialSettings
Configures how this subscription behaves during the trial period.
SubscriptionsTrialsResourceTrialSettingsBuilder
TaxCode
Tax codes classify goods and services for tax purposes.
TaxCodeBuilder
TaxCodeId
TaxDeductedAtSource
TaxDeductedAtSourceBuilder
TaxDeductedAtSourceId
TaxIDsOwner
TaxIDsOwnerBuilder
TaxId
You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.
TaxIdBuilder
TaxIdId
TaxIdVerification
TaxIdVerificationBuilder
TaxRate
Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
TaxRateBuilder
TaxRateFlatAmount
The amount of the tax rate when the rate_type`` is flat_amount. Tax rates with rate_type percentagecan vary based on the transaction, resulting in this field beingnull`. This field exposes the amount and currency of the flat tax rate.
TaxRateFlatAmountBuilder
TaxRateId
TestHelpersTestClock
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.
TestHelpersTestClockBuilder
TestHelpersTestClockId
ThreeDSecureDetails
ThreeDSecureDetailsBuilder
ThreeDSecureDetailsCharge
ThreeDSecureDetailsChargeBuilder
ThreeDSecureUsage
ThreeDSecureUsageBuilder
TokenCardNetworks
TokenCardNetworksBuilder
Topup
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.
TopupBuilder
TopupId
Transfer
A Transfer object is created when you move funds between Stripe accounts as part of Connect.
TransferBuilder
TransferData
TransferDataBuilder
TransferId
TransferReversal
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.
TransferReversalBuilder
TransferReversalId
TransferSchedule
TransferScheduleBuilder
TransformQuantity
TransformQuantityBuilder
TransformUsage
TransformUsageBuilder
UsBankAccountNetworks
UsBankAccountNetworksBuilder

Enums§

AccountBusinessProfileMinorityOwnedBusinessDesignation
Whether the business is a minority-owned, women-owned, and/or LGBTQI+-owned business.
AccountBusinessType
AccountCapabilitiesStatus
AccountCapabilityFutureRequirementsDisabledReason
This is typed as an enum for consistency with requirements.disabled_reason, but it safe to assume future_requirements.disabled_reason is null because fields in future_requirements will never disable the account.
AccountCapabilityRequirementsDisabledReason
Description of why the capability is disabled. Learn more about handling verification issues.
AccountFutureRequirementsDisabledReason
This is typed as an enum for consistency with requirements.disabled_reason.
AccountInvoicesSettingsHostedPaymentMethodSave
Whether payment methods should be saved when a payment is completed for a one-time invoices on a hosted invoice page.
AccountRequirementsDisabledReason
If the account is disabled, this enum describes why. Learn more about handling verification issues.
AccountRequirementsErrorCode
The code for the type of error.
AccountType
The Stripe account type. Can be standard, express, custom, or none.
AccountUnificationAccountControllerFeesPayer
A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts.
AccountUnificationAccountControllerLossesPayments
A value indicating who is liable when this account can’t pay back negative balances from payments.
AccountUnificationAccountControllerRequirementCollection
A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
AccountUnificationAccountControllerStripeDashboardType
A value indicating the Stripe dashboard this account has access to independent of the Connect application.
AccountUnificationAccountControllerType
The controller type. Can be application, if a Connect application controls the account, or account, if the account controls itself.
AmazonPayUnderlyingPaymentMethodFundingDetailsType
funding type of the underlying payment method.
ApiErrorsCode
For some errors that could be handled programmatically, a short string indicating the error code reported.
ApiErrorsType
The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error.
AutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
AutomaticTaxStatus
The status of the most recent automated tax calculation for this invoice.
BalanceTransactionSource
The resource representing a Stripe Polymorphic
BalanceTransactionType
Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, payout_minimum_balance_hold, payout_minimum_balance_release, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, stripe_balance_payment_debit, stripe_balance_payment_debit_reversal, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead.
BankAccountAvailablePayoutMethods
A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.
BillingBillResourceInvoicingLinesParentsInvoiceLineItemParentType
The type of parent that generated this line item
BillingBillResourceInvoicingParentsInvoiceParentType
The type of parent that generated this invoice
BillingBillResourceInvoicingPricingPricingType
The type of the pricing details.
BillingBillResourceInvoicingTaxesTaxTaxBehavior
Whether this tax is inclusive or exclusive.
BillingBillResourceInvoicingTaxesTaxTaxabilityReason
The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
BillingBillResourceInvoicingTaxesTaxType
The type of tax information.
BillingCreditBalanceTransactionType
The type of credit balance transaction (credit or debit).
BillingCreditGrantCategory
BillingCreditGrantsResourceAmountType
The type of this amount. We currently only support monetary billing credits.
BillingCreditGrantsResourceBalanceCreditType
The type of credit transaction.
BillingCreditGrantsResourceBalanceDebitType
The type of debit transaction.
BillingCreditGrantsResourceScopePriceType
The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
CancellationDetailsFeedback
The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
CancellationDetailsReason
Why this subscription was canceled.
CapabilityStatus
The status of the capability.
CardAllowRedisplay
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
CardAvailablePayoutMethods
A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.
CardRegulatedStatus
Status of a card based on the card issuer.
ChargeOutcomeAdviceCode
An enumerated value providing a more detailed explanation on how to proceed with an error.
ChargeStatus
The status of the payment is either succeeded, pending, or failed.
CheckoutAcssDebitMandateOptionsDefaultFor
List of Stripe products where this mandate can be selected automatically. Returned when the Session is in setup mode.
CheckoutAcssDebitMandateOptionsPaymentSchedule
Payment schedule for the mandate.
CheckoutAcssDebitMandateOptionsTransactionType
Transaction type of the mandate.
CheckoutAcssDebitPaymentMethodOptionsCurrency
Currency supported by the bank account. Returned when the Session is in setup mode.
CheckoutAcssDebitPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutAcssDebitPaymentMethodOptionsVerificationMethod
Bank account verification method.
CheckoutAffirmPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutAfterpayClearpayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutAlipayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutAmazonPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutAuBecsDebitPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutBacsDebitPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutBancontactPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutBoletoPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutCardPaymentMethodOptionsRequestExtendedAuthorization
Request ability to capture beyond the standard authorization validity window for this CheckoutSession.
CheckoutCardPaymentMethodOptionsRequestIncrementalAuthorization
Request ability to increment the authorization for this CheckoutSession.
CheckoutCardPaymentMethodOptionsRequestMulticapture
Request ability to make multiple captures for this CheckoutSession.
CheckoutCardPaymentMethodOptionsRequestOvercapture
Request ability to overcapture for this CheckoutSession.
CheckoutCardPaymentMethodOptionsRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
CheckoutCardPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutCashappPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutCustomerBalanceBankTransferPaymentMethodOptionsRequestedAddressTypes
List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
CheckoutCustomerBalanceBankTransferPaymentMethodOptionsType
The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
CheckoutCustomerBalancePaymentMethodOptionsFundingType
The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
CheckoutCustomerBalancePaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutEpsPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutFpxPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutGiropayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutGrabPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutIdealPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutKakaoPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutKakaoPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutKlarnaPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutKonbiniPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutKrCardPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutKrCardPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutLinkPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutLinkWalletOptionsDisplay
Describes whether Checkout should display Link. Defaults to auto.
CheckoutMobilepayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutMultibancoPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutNaverPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutOxxoPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutP24PaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutPaycoPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutPaynowPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutPaypalPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutPaypalPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutRevolutPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutSamsungPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
CheckoutSepaDebitPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutSessionBillingAddressCollection
CheckoutSessionCustomerCreation
Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
CheckoutSessionLocale
CheckoutSessionMode
CheckoutSessionPaymentMethodCollection
Configure whether a Checkout Session should collect a payment method. Defaults to always.
CheckoutSessionPaymentStatus
The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. You can use this value to decide when to fulfill your customer’s order.
CheckoutSessionRedirectOnCompletion
CheckoutSessionStatus
CheckoutSessionSubmitType
CheckoutSessionUiMode
CheckoutSofortPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutUsBankAccountPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
CheckoutUsBankAccountPaymentMethodOptionsVerificationMethod
Bank account verification method.
ConnectAccountReferenceType
Type of the account referenced.
CouponDuration
CreditNoteLineItemType
The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.
CreditNoteReason
CreditNoteStatus
Status of this credit note, one of issued or void. Learn more about voiding credit notes.
CreditNoteType
Type of this credit note, one of pre_payment or post_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.
CreditNotesPretaxCreditAmountType
Type of the pretax credit amount referenced.
CurrencyOptionTaxBehavior
Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
CustomerAcceptanceType
The mandate includes the type of customer acceptance information, such as: online or offline.
CustomerBalanceCustomerBalanceSettingsReconciliationMode
The configuration for how funds that land in the customer cash balance are reconciled.
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransferNetwork
The banking network used for this funding.
CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferType
The funding method type used to fund the customer balance. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
CustomerBalanceTransactionType
Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, unapplied_from_invoice, checkout_session_subscription_payment, or checkout_session_subscription_payment_canceled. See the Customer Balance page to learn more about transaction types.
CustomerCashBalanceTransactionType
The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
CustomerTaxAutomaticTax
Surfaces if automatic tax computation is possible given the current customer location information.
CustomerTaxExempt
CustomerTaxLocationSource
The data source used to infer the customer’s location.
DeletedExternalAccount
The resource representing a Stripe Polymorphic
DeletedPaymentSource
The resource representing a Stripe Polymorphic
DisputeEnhancedEligibilityTypes
List of eligibility types that are included in enhanced_evidence.
DisputeEnhancedEligibilityVisaCompellingEvidence3RequiredActions
List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
DisputeEnhancedEligibilityVisaCompellingEvidence3Status
Visa Compelling Evidence 3.0 eligibility status.
DisputeEnhancedEligibilityVisaComplianceStatus
Visa compliance eligibility status.
DisputePaymentMethodDetailsAmazonPayDisputeType
The AmazonPay dispute type, chargeback or claim
DisputePaymentMethodDetailsCardCaseType
The type of dispute opened. Different case types may have varying fees and financial impact.
DisputePaymentMethodDetailsType
Payment method type.
DisputeStatus
Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, or lost.
DisputeVisaCompellingEvidence3DisputedTransactionMerchandiseOrServices
Categorization of disputed payment.
EventType
Description of the event (for example, invoice.created or charge.refunded).
ExternalAccount
The resource representing a Stripe Polymorphic
FilePurpose
FundingInstructionsBankTransferFinancialAddressSupportedNetworks
The payment networks supported by this FinancialAddress
FundingInstructionsBankTransferFinancialAddressType
The type of financial address
FundingInstructionsBankTransferType
The bank_transfer type
FundingInstructionsFundingType
The funding_type of the returned instructions
InvoiceBillingReason
Indicates the reason why the invoice was created.
InvoiceCollectionMethod
InvoiceCustomerTaxExempt
The customer’s tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
InvoiceMandateOptionsCardAmountType
One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
InvoicePaymentMethodOptionsAcssDebitMandateOptionsTransactionType
Transaction type of the mandate.
InvoicePaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
InvoicePaymentMethodOptionsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to.
InvoicePaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferCountry
The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.
InvoicePaymentMethodOptionsCustomerBalanceFundingType
The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFiltersAccountSubcategories
The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPermissions
The list of permissions to request. The payment_method permission must be included.
InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsPrefetch
Data features requested to be retrieved upon account creation.
InvoicePaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
InvoiceRenderingPdfPageSize
Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
InvoiceStatus
InvoicesPaymentSettingsPaymentMethodTypes
The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
InvoicesPaymentsInvoicePaymentAssociatedPaymentType
Type of payment object associated with this invoice payment.
InvoicesResourceInvoiceTaxIdType
The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown.
InvoicesResourcePretaxCreditAmountType
Type of the pretax credit amount referenced.
IssuingAuthorizationAuthenticationExemptionClaimedBy
The entity that requested the exemption, either the acquiring merchant or the Issuing user.
IssuingAuthorizationAuthenticationExemptionType
The specific exemption claimed for this authorization.
IssuingAuthorizationAuthorizationMethod
IssuingAuthorizationFleetDataPurchaseType
The type of purchase.
IssuingAuthorizationFleetDataServiceType
The type of fuel service.
IssuingAuthorizationFraudChallengeChannel
The method by which the fraud challenge was delivered to the cardholder.
IssuingAuthorizationFraudChallengeStatus
The status of the fraud challenge.
IssuingAuthorizationFraudChallengeUndeliverableReason
If the challenge is not deliverable, the reason why.
IssuingAuthorizationFuelDataType
The type of fuel that was purchased.
IssuingAuthorizationFuelDataUnit
The units for quantity_decimal.
IssuingAuthorizationRequestReason
When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
IssuingAuthorizationStatus
IssuingAuthorizationThreeDSecureResult
The outcome of the 3D Secure authentication request.
IssuingAuthorizationVerificationDataAddressLine1Check
Whether the cardholder provided an address first line and if it matched the cardholder’s billing.address.line1.
IssuingAuthorizationVerificationDataAddressPostalCodeCheck
Whether the cardholder provided a postal code and if it matched the cardholder’s billing.address.postal_code.
IssuingAuthorizationVerificationDataCvcCheck
Whether the cardholder provided a CVC and if it matched Stripe’s record.
IssuingAuthorizationVerificationDataExpiryCheck
Whether the cardholder provided an expiry date and if it matched Stripe’s record.
IssuingCardApplePayIneligibleReason
Reason the card is ineligible for Apple Pay
IssuingCardAuthorizationControlsAllowedCategories
Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.
IssuingCardAuthorizationControlsBlockedCategories
Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.
IssuingCardCancellationReason
The reason why the card was canceled.
IssuingCardGooglePayIneligibleReason
Reason the card is ineligible for Google Pay
IssuingCardReplacementReason
IssuingCardShippingAddressValidationMode
The address validation capabilities to use.
IssuingCardShippingAddressValidationResult
The validation result for the shipping address.
IssuingCardShippingCarrier
The delivery company that shipped a card.
IssuingCardShippingService
Shipment service, such as standard or express.
IssuingCardShippingStatus
The delivery status of the card.
IssuingCardShippingType
Packaging options.
IssuingCardSpendingLimitCategories
Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
IssuingCardSpendingLimitInterval
Interval (or event) to which the amount applies.
IssuingCardStatus
IssuingCardType
IssuingCardholderAuthorizationControlsAllowedCategories
Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.
IssuingCardholderAuthorizationControlsBlockedCategories
Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.
IssuingCardholderPreferredLocales
IssuingCardholderRequirementsDisabledReason
If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
IssuingCardholderRequirementsPastDue
Array of fields that need to be collected in order to verify and re-enable the cardholder.
IssuingCardholderSpendingLimitCategories
Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
IssuingCardholderSpendingLimitInterval
Interval (or event) to which the amount applies.
IssuingCardholderStatus
IssuingCardholderType
IssuingDisputeCanceledEvidenceProductType
Whether the product was a merchandise or service.
IssuingDisputeCanceledEvidenceReturnStatus
Result of cardholder’s attempt to return the product.
IssuingDisputeEvidenceReason
The reason for filing the dispute. Its value will match the field containing the evidence.
IssuingDisputeLossReason
The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
IssuingDisputeMerchandiseNotAsDescribedEvidenceReturnStatus
Result of cardholder’s attempt to return the product.
IssuingDisputeNotReceivedEvidenceProductType
Whether the product was a merchandise or service.
IssuingDisputeOtherEvidenceProductType
Whether the product was a merchandise or service.
IssuingDisputeStatus
IssuingNetworkTokenDeviceType
The type of device used for tokenization.
IssuingNetworkTokenNetworkDataType
The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
IssuingNetworkTokenWalletProviderCardNumberSource
The method used for tokenizing a card.
IssuingNetworkTokenWalletProviderReasonCodes
The reasons for suggested tokenization given by the card network.
IssuingNetworkTokenWalletProviderSuggestedDecision
The recommendation on responding to the tokenization request.
IssuingPersonalizationDesignRejectionReasonsCardLogo
The reason(s) the card logo was rejected.
IssuingPersonalizationDesignRejectionReasonsCarrierText
The reason(s) the carrier text was rejected.
IssuingPersonalizationDesignStatus
IssuingPhysicalBundleFeaturesCardLogo
The policy for how to use card logo images in a card design with this physical bundle.
IssuingPhysicalBundleFeaturesCarrierText
The policy for how to use carrier letter text in a card design with this physical bundle.
IssuingPhysicalBundleFeaturesSecondLine
The policy for how to use a second line on a card with this physical bundle.
IssuingPhysicalBundleStatus
IssuingPhysicalBundleType
IssuingTokenNetwork
The token service provider / card network associated with the token.
IssuingTokenStatus
IssuingTokenWalletProvider
The digital wallet for this token, if one was used.
IssuingTransactionType
IssuingTransactionWallet
The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay.
LegalEntityCompanyOwnershipExemptionReason
This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details.
LegalEntityCompanyStructure
The category identifying the legal structure of the company or legal entity. Also available for accounts where controller.requirement_collection is stripe. See Business structure for more details.
LineItemsTaxAmountTaxabilityReason
The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
LinkedAccountOptionsCommonPermissions
The list of permissions to request. The payment_method permission must be included.
LinkedAccountOptionsCommonPrefetch
Data features requested to be retrieved upon account creation.
MandateAcssDebitDefaultFor
List of Stripe products where this mandate can be selected automatically.
MandateAcssDebitPaymentSchedule
Payment schedule for the mandate.
MandateAcssDebitTransactionType
Transaction type of the mandate.
MandateBacsDebitNetworkStatus
The status of the mandate on the Bacs network. Can be one of pending, revoked, refused, or accepted.
MandateBacsDebitRevocationReason
When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
MandateStatus
The mandate status indicates whether or not you can use it to initiate a payment.
MandateType
The type of the mandate.
MandateUsBankAccountCollectionMethod
Mandate collection method
PaymentFlowsAutomaticPaymentMethodsPaymentIntentAllowRedirects
Controls whether this PaymentIntent will accept redirect-based payment methods.
PaymentFlowsAutomaticPaymentMethodsSetupIntentAllowRedirects
Controls whether this SetupIntent will accept redirect-based payment methods.
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorizationStatus
Indicates whether or not the capture window is extended beyond the standard authorization.
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorizationStatus
Indicates whether or not the incremental authorization feature is supported.
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercaptureStatus
Indicates whether or not the authorized amount can be over-captured.
PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticaptureStatus
Indicates whether or not multiple captures are supported.
PaymentFlowsPrivatePaymentMethodsCardPresentCommonWalletType
The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.
PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFiltersAccountSubcategories
The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptionsCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentCancellationReason
Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, automatic, or expired).
PaymentIntentCaptureMethod
PaymentIntentConfirmationMethod
PaymentIntentNextActionDisplayBankTransferInstructionsType
Type of bank transfer
PaymentIntentNextActionVerifyWithMicrodepositsMicrodepositType
The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
PaymentIntentPaymentMethodOptionsAcssDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
PaymentIntentPaymentMethodOptionsAuBecsDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsBacsDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsBlikSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsCardCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsCardNetwork
Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.
PaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization
Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestIncrementalAuthorization
Request ability to increment the authorization for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestMulticapture
Request ability to make multiple captures for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestOvercapture
Request ability to overcapture for this PaymentIntent.
PaymentIntentPaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
PaymentIntentPaymentMethodOptionsCardSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsEpsSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsLinkCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsLinkSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitPaymentSchedule
Payment schedule for the mandate.
PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitTransactionType
Transaction type of the mandate.
PaymentIntentPaymentMethodOptionsMobilepayCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentIntentPaymentMethodOptionsMobilepaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsNzBankAccountSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsSepaDebitSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsSwishSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed
Preferred transaction settlement speed
PaymentIntentPaymentMethodOptionsUsBankAccountSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentIntentPaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
PaymentIntentProcessingType
Type of the payment method for which payment is in processing state, one of card.
PaymentIntentSetupFutureUsage
PaymentIntentStatus
Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
PaymentLinkBillingAddressCollection
PaymentLinkCustomerCreation
Configuration for Customer creation during checkout.
PaymentLinkPaymentMethodCollection
Configuration for collecting a payment method during checkout. Defaults to always.
PaymentLinkPaymentMethodTypes
PaymentLinkSubmitType
PaymentLinksResourceAfterCompletionType
The specified behavior after the purchase is complete.
PaymentLinksResourceConsentCollectionPromotions
If set to auto, enables the collection of customer consent for promotional communications.
PaymentLinksResourceConsentCollectionTermsOfService
If set to required, it requires cutomers to accept the terms of service before being able to pay. If set to none, customers won’t be shown a checkbox to accept the terms of service.
PaymentLinksResourceCustomFieldsLabelType
The type of the label.
PaymentLinksResourceCustomFieldsType
The type of the field.
PaymentLinksResourcePaymentIntentDataCaptureMethod
Indicates when the funds will be captured from the customer’s account.
PaymentLinksResourcePaymentIntentDataSetupFutureUsage
Indicates that you intend to make future payments with the payment method collected during checkout.
PaymentLinksResourcePaymentMethodReuseAgreementPosition
Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used.
PaymentLinksResourceShippingAddressCollectionAllowedCountries
An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
PaymentLinksResourceTaxIdCollectionRequired
PaymentMethodAllowRedisplay
PaymentMethodCardPresentReadMethod
How card details were read in this transaction.
PaymentMethodCardRegulatedStatus
Status of a card based on the card issuer.
PaymentMethodCardWalletType
The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
PaymentMethodDetailsAchDebitAccountHolderType
Type of entity that holds the account. This can be either individual or company.
PaymentMethodDetailsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of en, de, fr, or nl
PaymentMethodDetailsCardInstallmentsPlanInterval
For fixed_count installment plans, this is the interval between installment payments your customer will make to their credit card. One of month.
PaymentMethodDetailsCardInstallmentsPlanType
Type of installment plan, one of fixed_count.
PaymentMethodDetailsCardPresentOfflineType
The method used to process this payment method offline. Only deferred is allowed.
PaymentMethodDetailsCardPresentReadMethod
How card details were read in this transaction.
PaymentMethodDetailsCardPresentReceiptAccountType
The type of account being debited or credited
PaymentMethodDetailsCardRegulatedStatus
Status of a card based on the card issuer.
PaymentMethodDetailsCardWalletType
The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
PaymentMethodDetailsEpsBank
The customer’s bank. Should be one of arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau.
PaymentMethodDetailsFpxAccountHolderType
Account holder type, if provided. Can be one of individual or company.
PaymentMethodDetailsFpxBank
The customer’s bank. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china.
PaymentMethodDetailsIdealBank
The customer’s bank. Can be one of abn_amro, asn_bank, bunq, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.
PaymentMethodDetailsIdealBic
The Bank Identifier Code of the customer’s bank.
PaymentMethodDetailsInteracPresentReadMethod
How card details were read in this transaction.
PaymentMethodDetailsInteracPresentReceiptAccountType
The type of account being debited or credited
PaymentMethodDetailsKonbiniStoreChain
The name of the convenience store chain where the payment was completed.
PaymentMethodDetailsKrCardBrand
The local credit or debit card brand.
PaymentMethodDetailsP24Bank
The customer’s bank. Can be one of ing, citi_handlowy, tmobile_usbugi_bankowe, plus_bank, etransfer_pocztowy24, banki_spbdzielcze, bank_nowy_bfg_sa, getin_bank, velobank, blik, noble_pay, ideabank, envelobank, santander_przelew24, nest_przelew, mbank_mtransfer, inteligo, pbac_z_ipko, bnp_paribas, credit_agricole, toyota_bank, bank_pekao_sa, volkswagen_bank, bank_millennium, alior_bank, or boz.
PaymentMethodDetailsSofortPreferredLanguage
Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of de, en, es, fr, it, nl, or pl
PaymentMethodDetailsUsBankAccountAccountHolderType
Account holder type: individual or company.
PaymentMethodDetailsUsBankAccountAccountType
Account type: checkings or savings. Defaults to checking if omitted.
PaymentMethodEpsBank
The customer’s bank. Should be one of arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau.
PaymentMethodFpxAccountHolderType
Account holder type, if provided. Can be one of individual or company.
PaymentMethodFpxBank
The customer’s bank, if provided. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china.
PaymentMethodIdealBank
The customer’s bank, if provided. Can be one of abn_amro, asn_bank, bunq, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.
PaymentMethodIdealBic
The Bank Identifier Code of the customer’s bank, if the bank was provided.
PaymentMethodInteracPresentReadMethod
How card details were read in this transaction.
PaymentMethodKrCardBrand
The local credit or debit card brand.
PaymentMethodNaverPayFunding
Whether to fund this transaction with Naver Pay points or a card.
PaymentMethodOptionsAffirmCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsAffirmSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsAfterpayClearpayCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsAfterpayClearpaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsAlipaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsAlmaCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsAmazonPayCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsAmazonPaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to.
PaymentMethodOptionsBancontactSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsBoletoSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsCardMandateOptionsAmountType
One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
PaymentMethodOptionsCardMandateOptionsInterval
Specifies payment frequency. One of day, week, month, year, or sporadic.
PaymentMethodOptionsCardMandateOptionsSupportedTypes
Specifies the type of mandates supported. Possible values are india.
PaymentMethodOptionsCardPresentRoutingRequestedPriority
Requested routing priority
PaymentMethodOptionsCashappCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsCashappSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsCustomerBalanceBankTransferRequestedAddressTypes
List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
PaymentMethodOptionsCustomerBalanceBankTransferType
The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
PaymentMethodOptionsCustomerBalanceEuBankAccountCountry
The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.
PaymentMethodOptionsCustomerBalanceFundingType
The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
PaymentMethodOptionsCustomerBalanceSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsFpxSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsGiropaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsGrabpaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsIdealSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsKlarnaCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsKlarnaSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsKonbiniSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsKrCardCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsKrCardSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsMultibancoSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsOxxoSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsP24SetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsPaynowSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsPaypalCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsPaypalSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsPixSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsPromptpaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsRevolutPayCaptureMethod
Controls when the funds will be captured from the customer’s account.
PaymentMethodOptionsRevolutPaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsSofortPreferredLanguage
Preferred language of the SOFORT authorization page that the customer is redirected to.
PaymentMethodOptionsSofortSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsTwintSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod
Mandate collection method
PaymentMethodOptionsWechatPayClient
The client type that the end customer will pay from
PaymentMethodOptionsWechatPaySetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodOptionsZipSetupFutureUsage
Indicates that you intend to make future payments with this PaymentIntent’s payment method.
PaymentMethodP24Bank
The customer’s bank, if provided.
PaymentMethodType
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
PaymentMethodUsBankAccountAccountHolderType
Account holder type: individual or company.
PaymentMethodUsBankAccountAccountType
Account type: checkings or savings. Defaults to checking if omitted.
PaymentMethodUsBankAccountBlockedNetworkCode
The ACH network code that resulted in this block.
PaymentMethodUsBankAccountBlockedReason
The reason why this PaymentMethod’s fingerprint has been blocked
PaymentPagesCheckoutSessionAutomaticTaxStatus
The status of the most recent automated tax calculation for this session.
PaymentPagesCheckoutSessionConsentCollectionPromotions
If set to auto, enables the collection of customer consent for promotional communications. The Checkout. Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.
PaymentPagesCheckoutSessionConsentCollectionTermsOfService
If set to required, it requires customers to accept the terms of service before being able to pay.
PaymentPagesCheckoutSessionConsentPromotions
If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session.
PaymentPagesCheckoutSessionConsentTermsOfService
If accepted, the customer in this Checkout Session has agreed to the merchant’s terms of service.
PaymentPagesCheckoutSessionCustomFieldsLabelType
The type of the label.
PaymentPagesCheckoutSessionCustomFieldsType
The type of the field.
PaymentPagesCheckoutSessionCustomerDetailsTaxExempt
The customer’s tax exempt status after a completed Checkout Session.
PaymentPagesCheckoutSessionPaymentMethodReuseAgreementPosition
Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used.
PaymentPagesCheckoutSessionPermissionsUpdateShippingDetails
Determines which entity is allowed to update the shipping details.
PaymentPagesCheckoutSessionSavedPaymentMethodOptionsAllowRedisplayFilters
Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
PaymentPagesCheckoutSessionSavedPaymentMethodOptionsPaymentMethodRemove
Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
PaymentPagesCheckoutSessionSavedPaymentMethodOptionsPaymentMethodSave
Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
PaymentPagesCheckoutSessionShippingAddressCollectionAllowedCountries
An array of two-letter ISO country codes representing which countries Checkout should provide as options for. shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI.
PaymentPagesCheckoutSessionTaxIdCollectionRequired
Indicates whether a tax ID is required on the payment page
PaymentPagesCheckoutSessionTaxIdType
The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown.
PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictionsBrandsBlocked
Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session.
PaymentSource
The resource representing a Stripe Polymorphic
PayoutReconciliationStatus
If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.
PayoutType
Can be bank_account or card.
PaypalSellerProtectionDisputeCategories
An array of conditions that are covered for the transaction, if applicable.
PaypalSellerProtectionStatus
Indicates whether the transaction is eligible for PayPal’s seller protection.
PersonEthnicityDetailsEthnicity
The persons ethnicity
PersonPoliticalExposure
PersonRaceDetailsRace
The persons race.
PlanBillingScheme
PlanInterval
PlanTiersMode
PlanUsageType
PlatformEarningFeeSourceType
Type of object that created the application fee.
PriceBillingScheme
PriceTaxBehavior
PriceTiersMode
PriceType
ProductType
RecurringInterval
The frequency at which a subscription is billed. One of day, week, month or year.
RecurringUsageType
Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
RefundDestinationDetailsCardType
The type of refund. This can be refund, reversal, or pending.
RefundPendingReason
Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.
RefundReason
Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
ReviewClosedReason
The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, redacted, or canceled.
ReviewOpenedReason
The reason the review was opened. One of rule or manual.
RevolutPayUnderlyingPaymentMethodFundingDetailsType
funding type of the underlying payment method.
SchedulesPhaseAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SetupAttemptFlowDirections
Indicates the directions of money movement for which this payment method is intended to be used.
SetupAttemptPaymentMethodDetailsBancontactPreferredLanguage
Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of en, de, fr, or nl
SetupAttemptPaymentMethodDetailsCardWalletType
The type of the card wallet, one of apple_pay, google_pay, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
SetupAttemptPaymentMethodDetailsIdealBank
The customer’s bank. Can be one of abn_amro, asn_bank, bunq, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.
SetupAttemptPaymentMethodDetailsIdealBic
The Bank Identifier Code of the customer’s bank.
SetupAttemptPaymentMethodDetailsSofortPreferredLanguage
Preferred language of the Sofort authorization page that the customer is redirected to. Can be one of en, de, fr, or nl
SetupIntentCancellationReason
SetupIntentFlowDirections
SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType
The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
SetupIntentPaymentMethodOptionsAcssDebitCurrency
Currency supported by the bank account
SetupIntentPaymentMethodOptionsAcssDebitVerificationMethod
Bank account verification method.
SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType
One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
SetupIntentPaymentMethodOptionsCardMandateOptionsInterval
Specifies payment frequency. One of day, week, month, year, or sporadic.
SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes
Specifies the type of mandates supported. Possible values are india.
SetupIntentPaymentMethodOptionsCardNetwork
Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
SetupIntentPaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitDefaultFor
List of Stripe products where this mandate can be selected automatically.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitPaymentSchedule
Payment schedule for the mandate.
SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitTransactionType
Transaction type of the mandate.
SetupIntentPaymentMethodOptionsUsBankAccountVerificationMethod
Bank account verification method.
SetupIntentStatus
Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
ShippingRateCurrencyOptionTaxBehavior
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
ShippingRateDeliveryEstimateBoundUnit
A unit of time.
ShippingRateTaxBehavior
ShippingRateType
SourceAllowRedisplay
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
SourceTransactionType
The type of source this transaction is attached to.
SourceType
The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
SubscriptionAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SubscriptionCollectionMethod
SubscriptionPaymentMethodOptionsCardNetwork
Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
SubscriptionPaymentMethodOptionsCardRequestThreeDSecure
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
SubscriptionPendingInvoiceItemIntervalInterval
Specifies invoicing frequency. Either day, week, month or year.
SubscriptionScheduleEndBehavior
SubscriptionSchedulePhaseConfigurationBillingCycleAnchor
Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
SubscriptionSchedulePhaseConfigurationCollectionMethod
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
SubscriptionSchedulePhaseConfigurationProrationBehavior
If the subscription schedule will prorate when transitioning to this phase. Possible values are create_prorations and none.
SubscriptionScheduleStatus
The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.
SubscriptionSchedulesResourceDefaultSettingsAutomaticTaxDisabledReason
If Stripe disabled automatic tax, this enum describes why.
SubscriptionSchedulesResourceDefaultSettingsBillingCycleAnchor
Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.
SubscriptionSchedulesResourceDefaultSettingsCollectionMethod
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.
SubscriptionStatus
Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, or paused.
SubscriptionsResourcePauseCollectionBehavior
The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.
SubscriptionsResourcePaymentSettingsPaymentMethodTypes
The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod
Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.
SubscriptionsTrialsResourceEndBehaviorMissingPaymentMethod
Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
TaxIDsOwnerType
Type of owner referenced.
TaxIdType
Type of the tax ID, one of ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, or zw_tin. Note that some legacy tax IDs have type unknown.
TaxIdVerificationStatus
Verification status, one of pending, verified, unverified, or unavailable.
TaxRateJurisdictionLevel
The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
TaxRateRateType
Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
TaxRateTaxType
TestHelpersTestClockStatus
The status of the Test Clock.
ThreeDSecureDetailsAuthenticationFlow
For authenticated transactions: how the customer was authenticated by the issuing bank.
ThreeDSecureDetailsChargeAuthenticationFlow
For authenticated transactions: how the customer was authenticated by the issuing bank.
ThreeDSecureDetailsChargeElectronicCommerceIndicator
The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
ThreeDSecureDetailsChargeExemptionIndicator
The exemption requested via 3DS and accepted by the issuer at authentication time.
ThreeDSecureDetailsChargeResult
Indicates the outcome of 3D Secure authentication.
ThreeDSecureDetailsChargeResultReason
Additional information about why 3D Secure succeeded or failed based on the result.
ThreeDSecureDetailsChargeVersion
The version of 3D Secure that was used.
ThreeDSecureDetailsElectronicCommerceIndicator
The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed.
ThreeDSecureDetailsResult
Indicates the outcome of 3D Secure authentication.
ThreeDSecureDetailsResultReason
Additional information about why 3D Secure succeeded or failed based on the result.
ThreeDSecureDetailsVersion
The version of 3D Secure that was used.
TopupStatus
The status of the top-up is either canceled, failed, pending, reversed, or succeeded.
TransformQuantityRound
After division, either round the result up or down.
TransformUsageRound
After division, either round the result up or down.
UsBankAccountNetworksSupported
All supported networks.