stripe 22.3.0-beta.1 → 22.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +151 -1770
- package/OPENAPI_VERSION +1 -1
- package/README.md +73 -58
- package/VERSION +1 -1
- package/cjs/Error.d.ts +0 -50
- package/cjs/Error.js +1 -125
- package/cjs/Error.js.map +1 -1
- package/cjs/RequestSender.d.ts +2 -1
- package/cjs/RequestSender.js +10 -2
- package/cjs/RequestSender.js.map +1 -1
- package/cjs/Types.d.ts +2 -4
- package/cjs/Types.js.map +1 -1
- package/cjs/apiVersion.d.ts +2 -1
- package/cjs/apiVersion.js +3 -2
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/autoPagination.js +27 -2
- package/cjs/autoPagination.js.map +1 -1
- package/cjs/platform/NodePlatformFunctions.d.ts +3 -0
- package/cjs/platform/NodePlatformFunctions.js +36 -2
- package/cjs/platform/NodePlatformFunctions.js.map +1 -1
- package/cjs/platform/PlatformFunctions.d.ts +1 -0
- package/cjs/platform/PlatformFunctions.js +3 -0
- package/cjs/platform/PlatformFunctions.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +1 -1
- package/cjs/resources/AccountSessions.d.ts +0 -262
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/Accounts.d.ts +5 -829
- package/cjs/resources/Accounts.js +18 -32
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplePayDomains.js +2 -2
- package/cjs/resources/ApplePayDomains.js.map +1 -1
- package/cjs/resources/ApplicationFees.js +5 -5
- package/cjs/resources/ApplicationFees.js.map +1 -1
- package/cjs/resources/Apps/Secrets.d.ts +14 -16
- package/cjs/resources/Apps/index.d.ts +1 -1
- package/cjs/resources/Balance.d.ts +0 -67
- package/cjs/resources/BalanceTransactions.d.ts +5 -5
- package/cjs/resources/BalanceTransactions.js +3 -3
- package/cjs/resources/BalanceTransactions.js.map +1 -1
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertTriggereds.d.ts +1 -2
- package/cjs/resources/Billing/Alerts.d.ts +27 -29
- package/cjs/resources/Billing/Alerts.js +4 -4
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +40 -42
- package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +74 -76
- package/cjs/resources/Billing/CreditBalanceTransactions.js +1 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/cjs/resources/Billing/CreditGrants.d.ts +41 -43
- package/cjs/resources/Billing/CreditGrants.js +4 -4
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/MeterEventAdjustments.d.ts +9 -11
- package/cjs/resources/Billing/Meters.d.ts +39 -41
- package/cjs/resources/Billing/Meters.js +5 -5
- package/cjs/resources/Billing/Meters.js.map +1 -1
- package/cjs/resources/Billing/index.d.ts +7 -10
- package/cjs/resources/Billing/index.js +0 -2
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/BillingPortal/Configurations.d.ts +132 -134
- package/cjs/resources/BillingPortal/Configurations.js +2 -2
- package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
- package/cjs/resources/BillingPortal/Sessions.d.ts +100 -102
- package/cjs/resources/BillingPortal/index.d.ts +2 -2
- package/cjs/resources/Capabilities.d.ts +2 -2
- package/cjs/resources/Cards.d.ts +0 -4
- package/cjs/resources/Charges.d.ts +84 -3066
- package/cjs/resources/Charges.js +3 -3
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1598 -1900
- package/cjs/resources/Checkout/Sessions.js +4 -4
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -1
- package/cjs/resources/Climate/Orders.d.ts +47 -49
- package/cjs/resources/Climate/Orders.js +3 -3
- package/cjs/resources/Climate/Orders.js.map +1 -1
- package/cjs/resources/Climate/Products.d.ts +15 -17
- package/cjs/resources/Climate/Products.js +1 -1
- package/cjs/resources/Climate/Products.js.map +1 -1
- package/cjs/resources/Climate/Suppliers.d.ts +25 -27
- package/cjs/resources/Climate/Suppliers.js +1 -1
- package/cjs/resources/Climate/Suppliers.js.map +1 -1
- package/cjs/resources/Climate/index.d.ts +3 -3
- package/cjs/resources/ConfirmationTokens.d.ts +13 -67
- package/cjs/resources/ConfirmationTokens.js +1 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/CountrySpecs.js +1 -1
- package/cjs/resources/CountrySpecs.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +0 -53
- package/cjs/resources/Coupons.js +3 -16
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +1 -15
- package/cjs/resources/CreditNotes.d.ts +8 -5
- package/cjs/resources/CreditNotes.js +6 -4
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/CustomerSessions.d.ts +0 -68
- package/cjs/resources/Customers.d.ts +1 -7
- package/cjs/resources/Customers.js +31 -41
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/Disputes.d.ts +28 -30
- package/cjs/resources/Disputes.js +3 -3
- package/cjs/resources/Disputes.js.map +1 -1
- package/cjs/resources/Entitlements/ActiveEntitlements.js +1 -1
- package/cjs/resources/Entitlements/ActiveEntitlements.js.map +1 -1
- package/cjs/resources/Entitlements/Features.js +2 -2
- package/cjs/resources/Entitlements/Features.js.map +1 -1
- package/cjs/resources/Entitlements/index.d.ts +2 -2
- package/cjs/resources/EphemeralKeys.js +1 -1
- package/cjs/resources/EphemeralKeys.js.map +1 -1
- package/cjs/resources/Events.d.ts +3 -548
- package/cjs/resources/Events.js +1 -1
- package/cjs/resources/Events.js.map +1 -1
- package/cjs/resources/ExchangeRates.js +1 -1
- package/cjs/resources/ExchangeRates.js.map +1 -1
- package/cjs/resources/ExternalAccounts.d.ts +1 -212
- package/cjs/resources/ExternalAccounts.js +0 -44
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FileLinks.js +2 -2
- package/cjs/resources/FileLinks.js.map +1 -1
- package/cjs/resources/Files.js +1 -1
- package/cjs/resources/Files.js.map +1 -1
- package/cjs/resources/FinancialConnections/Accounts.d.ts +169 -217
- package/cjs/resources/FinancialConnections/Accounts.js +6 -14
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Sessions.d.ts +43 -193
- package/cjs/resources/FinancialConnections/Sessions.js +1 -1
- package/cjs/resources/FinancialConnections/Sessions.js.map +1 -1
- package/cjs/resources/FinancialConnections/Transactions.d.ts +13 -15
- package/cjs/resources/FinancialConnections/Transactions.js +1 -1
- package/cjs/resources/FinancialConnections/Transactions.js.map +1 -1
- package/cjs/resources/FinancialConnections/index.d.ts +9 -24
- package/cjs/resources/FinancialConnections/index.js +0 -4
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/Forwarding/Requests.d.ts +57 -59
- package/cjs/resources/Forwarding/Requests.js +1 -1
- package/cjs/resources/Forwarding/Requests.js.map +1 -1
- package/cjs/resources/Forwarding/index.d.ts +1 -1
- package/cjs/resources/Identity/VerificationReports.d.ts +255 -257
- package/cjs/resources/Identity/VerificationReports.js +1 -1
- package/cjs/resources/Identity/VerificationReports.js.map +1 -1
- package/cjs/resources/Identity/VerificationSessions.d.ts +148 -150
- package/cjs/resources/Identity/VerificationSessions.js +4 -4
- package/cjs/resources/Identity/VerificationSessions.js.map +1 -1
- package/cjs/resources/Identity/index.d.ts +2 -2
- package/cjs/resources/InvoiceItems.d.ts +0 -85
- package/cjs/resources/InvoiceItems.js +3 -3
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +2 -40
- package/cjs/resources/InvoicePayments.js +1 -1
- package/cjs/resources/InvoicePayments.js.map +1 -1
- package/cjs/resources/InvoiceRenderingTemplates.js +3 -3
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +23 -1341
- package/cjs/resources/Invoices.js +14 -55
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +354 -356
- package/cjs/resources/Issuing/Authorizations.js +4 -4
- package/cjs/resources/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +144 -147
- package/cjs/resources/Issuing/Cardholders.js +2 -2
- package/cjs/resources/Issuing/Cardholders.js.map +1 -1
- package/cjs/resources/Issuing/Cards.d.ts +183 -185
- package/cjs/resources/Issuing/Cards.js +2 -2
- package/cjs/resources/Issuing/Cards.js.map +1 -1
- package/cjs/resources/Issuing/Disputes.d.ts +215 -217
- package/cjs/resources/Issuing/Disputes.js +3 -3
- package/cjs/resources/Issuing/Disputes.js.map +1 -1
- package/cjs/resources/Issuing/PersonalizationDesigns.d.ts +47 -49
- package/cjs/resources/Issuing/PersonalizationDesigns.js +2 -2
- package/cjs/resources/Issuing/PersonalizationDesigns.js.map +1 -1
- package/cjs/resources/Issuing/PhysicalBundles.d.ts +24 -26
- package/cjs/resources/Issuing/PhysicalBundles.js +1 -1
- package/cjs/resources/Issuing/PhysicalBundles.js.map +1 -1
- package/cjs/resources/Issuing/Tokens.d.ts +130 -132
- package/cjs/resources/Issuing/Tokens.js +2 -2
- package/cjs/resources/Issuing/Tokens.js.map +1 -1
- package/cjs/resources/Issuing/Transactions.d.ts +223 -234
- package/cjs/resources/Issuing/Transactions.js +2 -2
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +30 -55
- package/cjs/resources/Issuing/index.js +0 -6
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +4 -30
- package/cjs/resources/Mandates.d.ts +1 -33
- package/cjs/resources/Mandates.js +1 -9
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/PaymentAttemptRecords.d.ts +9 -92
- package/cjs/resources/PaymentAttemptRecords.js +1 -1
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntents.d.ts +6495 -17272
- package/cjs/resources/PaymentIntents.js +9 -36
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +6 -19
- package/cjs/resources/PaymentLinks.js +3 -3
- package/cjs/resources/PaymentLinks.js.map +1 -1
- package/cjs/resources/PaymentMethodConfigurations.d.ts +0 -350
- package/cjs/resources/PaymentMethodConfigurations.js +2 -2
- package/cjs/resources/PaymentMethodConfigurations.js.map +1 -1
- package/cjs/resources/PaymentMethodDomains.js +3 -3
- package/cjs/resources/PaymentMethodDomains.js.map +1 -1
- package/cjs/resources/PaymentMethods.d.ts +16 -152
- package/cjs/resources/PaymentMethods.js +4 -4
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +19 -102
- package/cjs/resources/PaymentRecords.js +7 -7
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Payouts.js +4 -4
- package/cjs/resources/Payouts.js.map +1 -1
- package/cjs/resources/Persons.d.ts +2 -2
- package/cjs/resources/Plans.d.ts +0 -16
- package/cjs/resources/Plans.js +3 -3
- package/cjs/resources/Plans.js.map +1 -1
- package/cjs/resources/Prices.d.ts +0 -52
- package/cjs/resources/Prices.js +2 -2
- package/cjs/resources/Prices.js.map +1 -1
- package/cjs/resources/Products.d.ts +0 -42
- package/cjs/resources/Products.js +7 -7
- package/cjs/resources/Products.js.map +1 -1
- package/cjs/resources/PromotionCodes.d.ts +0 -12
- package/cjs/resources/PromotionCodes.js +2 -29
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/Quotes.d.ts +165 -2374
- package/cjs/resources/Quotes.js +20 -1180
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/EarlyFraudWarnings.js +1 -1
- package/cjs/resources/Radar/EarlyFraudWarnings.js.map +1 -1
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +294 -296
- package/cjs/resources/Radar/ValueListItems.d.ts +14 -16
- package/cjs/resources/Radar/ValueListItems.js +2 -2
- package/cjs/resources/Radar/ValueListItems.js.map +1 -1
- package/cjs/resources/Radar/ValueLists.d.ts +18 -20
- package/cjs/resources/Radar/ValueLists.js +3 -3
- package/cjs/resources/Radar/ValueLists.js.map +1 -1
- package/cjs/resources/Radar/index.d.ts +8 -6
- package/cjs/resources/Radar/index.js.map +1 -1
- package/cjs/resources/Refunds.d.ts +0 -11
- package/cjs/resources/Refunds.js +3 -3
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reporting/ReportRuns.d.ts +35 -37
- package/cjs/resources/Reporting/ReportRuns.js +1 -1
- package/cjs/resources/Reporting/ReportRuns.js.map +1 -1
- package/cjs/resources/Reporting/ReportTypes.js +1 -1
- package/cjs/resources/Reporting/ReportTypes.js.map +1 -1
- package/cjs/resources/Reporting/index.d.ts +2 -2
- package/cjs/resources/Reserve/Holds.d.ts +24 -64
- package/cjs/resources/Reserve/Holds.js +0 -19
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +25 -43
- package/cjs/resources/Reserve/Plans.js +0 -11
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +17 -59
- package/cjs/resources/Reserve/Releases.js +0 -19
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +3 -14
- package/cjs/resources/Reserve/index.js +0 -9
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/Reviews.js +2 -2
- package/cjs/resources/Reviews.js.map +1 -1
- package/cjs/resources/SetupAttempts.d.ts +8 -26
- package/cjs/resources/SetupIntents.d.ts +14 -333
- package/cjs/resources/SetupIntents.js +5 -5
- package/cjs/resources/SetupIntents.js.map +1 -1
- package/cjs/resources/ShippingRates.js +2 -2
- package/cjs/resources/ShippingRates.js.map +1 -1
- package/cjs/resources/Sigma/ScheduledQueryRuns.d.ts +7 -9
- package/cjs/resources/Sigma/ScheduledQueryRuns.js +1 -1
- package/cjs/resources/Sigma/ScheduledQueryRuns.js.map +1 -1
- package/cjs/resources/Sigma/index.d.ts +1 -1
- package/cjs/resources/Sources.d.ts +1 -16
- package/cjs/resources/Sources.js +4 -4
- package/cjs/resources/Sources.js.map +1 -1
- package/cjs/resources/SubscriptionItems.d.ts +0 -143
- package/cjs/resources/SubscriptionItems.js +3 -3
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +4 -1155
- package/cjs/resources/SubscriptionSchedules.js +4 -10
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +61 -560
- package/cjs/resources/Subscriptions.js +7 -152
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/Associations.d.ts +24 -26
- package/cjs/resources/Tax/CalculationLineItems.d.ts +56 -62
- package/cjs/resources/Tax/Calculations.d.ts +158 -164
- package/cjs/resources/Tax/Calculations.js +2 -2
- package/cjs/resources/Tax/Calculations.js.map +1 -1
- package/cjs/resources/Tax/Registrations.d.ts +1095 -1233
- package/cjs/resources/Tax/Registrations.js +2 -2
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +37 -39
- package/cjs/resources/Tax/TransactionLineItems.d.ts +11 -13
- package/cjs/resources/Tax/Transactions.d.ts +113 -115
- package/cjs/resources/Tax/Transactions.js +2 -2
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- package/cjs/resources/Tax/index.d.ts +18 -32
- package/cjs/resources/Tax/index.js +0 -4
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +0 -15
- package/cjs/resources/TaxCodes.js +1 -1
- package/cjs/resources/TaxCodes.js.map +1 -1
- package/cjs/resources/TaxIds.js +2 -2
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.js +2 -2
- package/cjs/resources/TaxRates.js.map +1 -1
- package/cjs/resources/Terminal/Configurations.d.ts +479 -508
- package/cjs/resources/Terminal/Configurations.js +3 -3
- package/cjs/resources/Terminal/Configurations.js.map +1 -1
- package/cjs/resources/Terminal/Locations.d.ts +72 -74
- package/cjs/resources/Terminal/Locations.js +3 -3
- package/cjs/resources/Terminal/Locations.js.map +1 -1
- package/cjs/resources/Terminal/OnboardingLinks.d.ts +16 -18
- package/cjs/resources/Terminal/Readers.d.ts +479 -497
- package/cjs/resources/Terminal/Readers.js +11 -11
- package/cjs/resources/Terminal/Readers.js.map +1 -1
- package/cjs/resources/Terminal/index.d.ts +11 -13
- package/cjs/resources/Terminal/index.js +0 -2
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +2 -79
- package/cjs/resources/TestHelpers/Customers.js +1 -1
- package/cjs/resources/TestHelpers/Customers.js.map +1 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.js +6 -6
- package/cjs/resources/TestHelpers/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/TestHelpers/Issuing/Cards.js +5 -5
- package/cjs/resources/TestHelpers/Issuing/Cards.js.map +1 -1
- package/cjs/resources/TestHelpers/Issuing/PersonalizationDesigns.js +3 -3
- package/cjs/resources/TestHelpers/Issuing/PersonalizationDesigns.js.map +1 -1
- package/cjs/resources/TestHelpers/Issuing/Transactions.js +1 -1
- package/cjs/resources/TestHelpers/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/TestHelpers/Refunds.js +1 -1
- package/cjs/resources/TestHelpers/Refunds.js.map +1 -1
- package/cjs/resources/TestHelpers/Terminal/Readers.js +3 -3
- package/cjs/resources/TestHelpers/Terminal/Readers.js.map +1 -1
- package/cjs/resources/TestHelpers/TestClocks.d.ts +27 -29
- package/cjs/resources/TestHelpers/TestClocks.js +3 -3
- package/cjs/resources/TestHelpers/TestClocks.js.map +1 -1
- package/cjs/resources/TestHelpers/Treasury/InboundTransfers.js +3 -3
- package/cjs/resources/TestHelpers/Treasury/InboundTransfers.js.map +1 -1
- package/cjs/resources/TestHelpers/Treasury/OutboundPayments.js +4 -4
- package/cjs/resources/TestHelpers/Treasury/OutboundPayments.js.map +1 -1
- package/cjs/resources/TestHelpers/Treasury/OutboundTransfers.js +4 -4
- package/cjs/resources/TestHelpers/Treasury/OutboundTransfers.js.map +1 -1
- package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +0 -22
- package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +0 -22
- package/cjs/resources/TestHelpers/index.d.ts +3 -5
- package/cjs/resources/TestHelpers/index.js +4 -6
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Tokens.js +1 -1
- package/cjs/resources/Tokens.js.map +1 -1
- package/cjs/resources/Topups.d.ts +18 -0
- package/cjs/resources/Topups.js +3 -3
- package/cjs/resources/Topups.js.map +1 -1
- package/cjs/resources/Transfers.d.ts +0 -8
- package/cjs/resources/Transfers.js +6 -6
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/Treasury/CreditReversals.d.ts +11 -13
- package/cjs/resources/Treasury/CreditReversals.js +1 -1
- package/cjs/resources/Treasury/CreditReversals.js.map +1 -1
- package/cjs/resources/Treasury/DebitReversals.d.ts +18 -20
- package/cjs/resources/Treasury/DebitReversals.js +1 -1
- package/cjs/resources/Treasury/DebitReversals.js.map +1 -1
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +252 -259
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +88 -123
- package/cjs/resources/Treasury/FinancialAccounts.js +5 -5
- package/cjs/resources/Treasury/FinancialAccounts.js.map +1 -1
- package/cjs/resources/Treasury/InboundTransfers.d.ts +79 -81
- package/cjs/resources/Treasury/InboundTransfers.js +2 -2
- package/cjs/resources/Treasury/InboundTransfers.js.map +1 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +125 -135
- package/cjs/resources/Treasury/OutboundPayments.js +2 -2
- package/cjs/resources/Treasury/OutboundPayments.js.map +1 -1
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +114 -160
- package/cjs/resources/Treasury/OutboundTransfers.js +2 -2
- package/cjs/resources/Treasury/OutboundTransfers.js.map +1 -1
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +118 -142
- package/cjs/resources/Treasury/ReceivedCredits.js +1 -1
- package/cjs/resources/Treasury/ReceivedCredits.js.map +1 -1
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +86 -114
- package/cjs/resources/Treasury/ReceivedDebits.js +1 -1
- package/cjs/resources/Treasury/ReceivedDebits.js.map +1 -1
- package/cjs/resources/Treasury/TransactionEntries.d.ts +75 -77
- package/cjs/resources/Treasury/TransactionEntries.js +1 -1
- package/cjs/resources/Treasury/TransactionEntries.js.map +1 -1
- package/cjs/resources/Treasury/Transactions.d.ts +86 -88
- package/cjs/resources/Treasury/Transactions.js +1 -1
- package/cjs/resources/Treasury/Transactions.js.map +1 -1
- package/cjs/resources/Treasury/index.d.ts +10 -10
- package/cjs/resources/V2/Billing/MeterEventAdjustments.d.ts +9 -13
- package/cjs/resources/V2/Billing/index.d.ts +9 -48
- package/cjs/resources/V2/Billing/index.js +0 -8
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.d.ts +2 -2
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalogImports.d.ts +132 -131
- package/cjs/resources/V2/Core/AccountLinks.d.ts +81 -85
- package/cjs/resources/V2/Core/AccountPersons.d.ts +369 -373
- package/cjs/resources/V2/Core/AccountTokens.d.ts +0 -10
- package/cjs/resources/V2/Core/AccountTokens.js +1 -1
- package/cjs/resources/V2/Core/AccountTokens.js.map +1 -1
- package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js +3 -3
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts/Persons.js +7 -7
- package/cjs/resources/V2/Core/Accounts/Persons.js.map +1 -1
- package/cjs/resources/V2/Core/Accounts.d.ts +3043 -4006
- package/cjs/resources/V2/Core/Accounts.js +3 -3
- package/cjs/resources/V2/Core/Accounts.js.map +1 -1
- package/cjs/resources/V2/Core/EventDestinations.d.ts +78 -82
- package/cjs/resources/V2/Core/EventDestinations.js +6 -6
- package/cjs/resources/V2/Core/EventDestinations.js.map +1 -1
- package/cjs/resources/V2/Core/Events.d.ts +31 -1154
- package/cjs/resources/V2/Core/Events.js +1 -1
- package/cjs/resources/V2/Core/Events.js.map +1 -1
- package/cjs/resources/V2/Core/index.d.ts +14 -24
- package/cjs/resources/V2/Core/index.js +0 -4
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/index.d.ts +0 -27
- package/cjs/resources/V2/index.js +0 -14
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +3 -3
- package/cjs/resources/WebhookEndpoints.js +3 -3
- package/cjs/resources/WebhookEndpoints.js.map +1 -1
- package/cjs/resources.d.ts +0 -10
- package/cjs/resources.js +10 -146
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +14384 -3
- package/cjs/stripe.cjs.node.js +1 -4
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +69 -62
- package/cjs/stripe.core.js +37 -55
- package/cjs/stripe.core.js.map +1 -1
- package/cjs/utils.d.ts +1 -1
- package/cjs/utils.js +13 -2
- package/cjs/utils.js.map +1 -1
- package/esm/Error.d.ts +0 -50
- package/esm/Error.js +0 -109
- package/esm/Error.js.map +1 -1
- package/esm/RequestSender.d.ts +2 -1
- package/esm/RequestSender.js +10 -2
- package/esm/RequestSender.js.map +1 -1
- package/esm/Types.d.ts +2 -4
- package/esm/Types.js.map +1 -1
- package/esm/apiVersion.d.ts +2 -1
- package/esm/apiVersion.js +2 -1
- package/esm/apiVersion.js.map +1 -1
- package/esm/autoPagination.js +27 -2
- package/esm/autoPagination.js.map +1 -1
- package/esm/platform/NodePlatformFunctions.d.ts +3 -0
- package/esm/platform/NodePlatformFunctions.js +36 -2
- package/esm/platform/NodePlatformFunctions.js.map +1 -1
- package/esm/platform/PlatformFunctions.d.ts +1 -0
- package/esm/platform/PlatformFunctions.js +3 -0
- package/esm/platform/PlatformFunctions.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +1 -1
- package/esm/resources/AccountSessions.d.ts +0 -262
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/Accounts.d.ts +5 -829
- package/esm/resources/Accounts.js +18 -32
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplePayDomains.js +2 -2
- package/esm/resources/ApplePayDomains.js.map +1 -1
- package/esm/resources/ApplicationFees.js +5 -5
- package/esm/resources/ApplicationFees.js.map +1 -1
- package/esm/resources/Apps/Secrets.d.ts +14 -16
- package/esm/resources/Apps/index.d.ts +1 -1
- package/esm/resources/Balance.d.ts +0 -67
- package/esm/resources/BalanceTransactions.d.ts +5 -5
- package/esm/resources/BalanceTransactions.js +3 -3
- package/esm/resources/BalanceTransactions.js.map +1 -1
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertTriggereds.d.ts +1 -2
- package/esm/resources/Billing/Alerts.d.ts +27 -29
- package/esm/resources/Billing/Alerts.js +4 -4
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +40 -42
- package/esm/resources/Billing/CreditBalanceTransactions.d.ts +74 -76
- package/esm/resources/Billing/CreditBalanceTransactions.js +1 -1
- package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/esm/resources/Billing/CreditGrants.d.ts +41 -43
- package/esm/resources/Billing/CreditGrants.js +4 -4
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/MeterEventAdjustments.d.ts +9 -11
- package/esm/resources/Billing/Meters.d.ts +39 -41
- package/esm/resources/Billing/Meters.js +5 -5
- package/esm/resources/Billing/Meters.js.map +1 -1
- package/esm/resources/Billing/index.d.ts +7 -10
- package/esm/resources/Billing/index.js +0 -2
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/BillingPortal/Configurations.d.ts +132 -134
- package/esm/resources/BillingPortal/Configurations.js +2 -2
- package/esm/resources/BillingPortal/Configurations.js.map +1 -1
- package/esm/resources/BillingPortal/Sessions.d.ts +100 -102
- package/esm/resources/BillingPortal/index.d.ts +2 -2
- package/esm/resources/Capabilities.d.ts +2 -2
- package/esm/resources/Cards.d.ts +0 -4
- package/esm/resources/Charges.d.ts +84 -3066
- package/esm/resources/Charges.js +3 -3
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1598 -1900
- package/esm/resources/Checkout/Sessions.js +4 -4
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -1
- package/esm/resources/Climate/Orders.d.ts +47 -49
- package/esm/resources/Climate/Orders.js +3 -3
- package/esm/resources/Climate/Orders.js.map +1 -1
- package/esm/resources/Climate/Products.d.ts +15 -17
- package/esm/resources/Climate/Products.js +1 -1
- package/esm/resources/Climate/Products.js.map +1 -1
- package/esm/resources/Climate/Suppliers.d.ts +25 -27
- package/esm/resources/Climate/Suppliers.js +1 -1
- package/esm/resources/Climate/Suppliers.js.map +1 -1
- package/esm/resources/Climate/index.d.ts +3 -3
- package/esm/resources/ConfirmationTokens.d.ts +13 -67
- package/esm/resources/ConfirmationTokens.js +1 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/CountrySpecs.js +1 -1
- package/esm/resources/CountrySpecs.js.map +1 -1
- package/esm/resources/Coupons.d.ts +0 -53
- package/esm/resources/Coupons.js +3 -16
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +1 -15
- package/esm/resources/CreditNotes.d.ts +8 -5
- package/esm/resources/CreditNotes.js +6 -4
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/CustomerSessions.d.ts +0 -68
- package/esm/resources/Customers.d.ts +1 -7
- package/esm/resources/Customers.js +31 -41
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/Disputes.d.ts +28 -30
- package/esm/resources/Disputes.js +3 -3
- package/esm/resources/Disputes.js.map +1 -1
- package/esm/resources/Entitlements/ActiveEntitlements.js +1 -1
- package/esm/resources/Entitlements/ActiveEntitlements.js.map +1 -1
- package/esm/resources/Entitlements/Features.js +2 -2
- package/esm/resources/Entitlements/Features.js.map +1 -1
- package/esm/resources/Entitlements/index.d.ts +2 -2
- package/esm/resources/EphemeralKeys.js +1 -1
- package/esm/resources/EphemeralKeys.js.map +1 -1
- package/esm/resources/Events.d.ts +3 -548
- package/esm/resources/Events.js +1 -1
- package/esm/resources/Events.js.map +1 -1
- package/esm/resources/ExchangeRates.js +1 -1
- package/esm/resources/ExchangeRates.js.map +1 -1
- package/esm/resources/ExternalAccounts.d.ts +1 -212
- package/esm/resources/ExternalAccounts.js +1 -42
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FileLinks.js +2 -2
- package/esm/resources/FileLinks.js.map +1 -1
- package/esm/resources/Files.js +1 -1
- package/esm/resources/Files.js.map +1 -1
- package/esm/resources/FinancialConnections/Accounts.d.ts +169 -217
- package/esm/resources/FinancialConnections/Accounts.js +6 -14
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Sessions.d.ts +43 -193
- package/esm/resources/FinancialConnections/Sessions.js +1 -1
- package/esm/resources/FinancialConnections/Sessions.js.map +1 -1
- package/esm/resources/FinancialConnections/Transactions.d.ts +13 -15
- package/esm/resources/FinancialConnections/Transactions.js +1 -1
- package/esm/resources/FinancialConnections/Transactions.js.map +1 -1
- package/esm/resources/FinancialConnections/index.d.ts +9 -24
- package/esm/resources/FinancialConnections/index.js +0 -4
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/Forwarding/Requests.d.ts +57 -59
- package/esm/resources/Forwarding/Requests.js +1 -1
- package/esm/resources/Forwarding/Requests.js.map +1 -1
- package/esm/resources/Forwarding/index.d.ts +1 -1
- package/esm/resources/Identity/VerificationReports.d.ts +255 -257
- package/esm/resources/Identity/VerificationReports.js +1 -1
- package/esm/resources/Identity/VerificationReports.js.map +1 -1
- package/esm/resources/Identity/VerificationSessions.d.ts +148 -150
- package/esm/resources/Identity/VerificationSessions.js +4 -4
- package/esm/resources/Identity/VerificationSessions.js.map +1 -1
- package/esm/resources/Identity/index.d.ts +2 -2
- package/esm/resources/InvoiceItems.d.ts +0 -85
- package/esm/resources/InvoiceItems.js +3 -3
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +2 -40
- package/esm/resources/InvoicePayments.js +1 -1
- package/esm/resources/InvoicePayments.js.map +1 -1
- package/esm/resources/InvoiceRenderingTemplates.js +3 -3
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +23 -1341
- package/esm/resources/Invoices.js +14 -55
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +354 -356
- package/esm/resources/Issuing/Authorizations.js +4 -4
- package/esm/resources/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +144 -147
- package/esm/resources/Issuing/Cardholders.js +2 -2
- package/esm/resources/Issuing/Cardholders.js.map +1 -1
- package/esm/resources/Issuing/Cards.d.ts +183 -185
- package/esm/resources/Issuing/Cards.js +2 -2
- package/esm/resources/Issuing/Cards.js.map +1 -1
- package/esm/resources/Issuing/Disputes.d.ts +215 -217
- package/esm/resources/Issuing/Disputes.js +3 -3
- package/esm/resources/Issuing/Disputes.js.map +1 -1
- package/esm/resources/Issuing/PersonalizationDesigns.d.ts +47 -49
- package/esm/resources/Issuing/PersonalizationDesigns.js +2 -2
- package/esm/resources/Issuing/PersonalizationDesigns.js.map +1 -1
- package/esm/resources/Issuing/PhysicalBundles.d.ts +24 -26
- package/esm/resources/Issuing/PhysicalBundles.js +1 -1
- package/esm/resources/Issuing/PhysicalBundles.js.map +1 -1
- package/esm/resources/Issuing/Tokens.d.ts +130 -132
- package/esm/resources/Issuing/Tokens.js +2 -2
- package/esm/resources/Issuing/Tokens.js.map +1 -1
- package/esm/resources/Issuing/Transactions.d.ts +223 -234
- package/esm/resources/Issuing/Transactions.js +2 -2
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +30 -55
- package/esm/resources/Issuing/index.js +0 -6
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +4 -30
- package/esm/resources/Mandates.d.ts +1 -33
- package/esm/resources/Mandates.js +1 -9
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/PaymentAttemptRecords.d.ts +9 -92
- package/esm/resources/PaymentAttemptRecords.js +1 -1
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntents.d.ts +6495 -17272
- package/esm/resources/PaymentIntents.js +9 -36
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +6 -19
- package/esm/resources/PaymentLinks.js +3 -3
- package/esm/resources/PaymentLinks.js.map +1 -1
- package/esm/resources/PaymentMethodConfigurations.d.ts +0 -350
- package/esm/resources/PaymentMethodConfigurations.js +2 -2
- package/esm/resources/PaymentMethodConfigurations.js.map +1 -1
- package/esm/resources/PaymentMethodDomains.js +3 -3
- package/esm/resources/PaymentMethodDomains.js.map +1 -1
- package/esm/resources/PaymentMethods.d.ts +16 -152
- package/esm/resources/PaymentMethods.js +4 -4
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +19 -102
- package/esm/resources/PaymentRecords.js +7 -7
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Payouts.js +4 -4
- package/esm/resources/Payouts.js.map +1 -1
- package/esm/resources/Persons.d.ts +2 -2
- package/esm/resources/Plans.d.ts +0 -16
- package/esm/resources/Plans.js +3 -3
- package/esm/resources/Plans.js.map +1 -1
- package/esm/resources/Prices.d.ts +0 -52
- package/esm/resources/Prices.js +2 -2
- package/esm/resources/Prices.js.map +1 -1
- package/esm/resources/Products.d.ts +0 -42
- package/esm/resources/Products.js +7 -7
- package/esm/resources/Products.js.map +1 -1
- package/esm/resources/PromotionCodes.d.ts +0 -12
- package/esm/resources/PromotionCodes.js +2 -29
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/Quotes.d.ts +165 -2374
- package/esm/resources/Quotes.js +20 -1180
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/EarlyFraudWarnings.js +1 -1
- package/esm/resources/Radar/EarlyFraudWarnings.js.map +1 -1
- package/esm/resources/Radar/PaymentEvaluations.d.ts +294 -296
- package/esm/resources/Radar/ValueListItems.d.ts +14 -16
- package/esm/resources/Radar/ValueListItems.js +2 -2
- package/esm/resources/Radar/ValueListItems.js.map +1 -1
- package/esm/resources/Radar/ValueLists.d.ts +18 -20
- package/esm/resources/Radar/ValueLists.js +3 -3
- package/esm/resources/Radar/ValueLists.js.map +1 -1
- package/esm/resources/Radar/index.d.ts +8 -6
- package/esm/resources/Radar/index.js.map +1 -1
- package/esm/resources/Refunds.d.ts +0 -11
- package/esm/resources/Refunds.js +3 -3
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reporting/ReportRuns.d.ts +35 -37
- package/esm/resources/Reporting/ReportRuns.js +1 -1
- package/esm/resources/Reporting/ReportRuns.js.map +1 -1
- package/esm/resources/Reporting/ReportTypes.js +1 -1
- package/esm/resources/Reporting/ReportTypes.js.map +1 -1
- package/esm/resources/Reporting/index.d.ts +2 -2
- package/esm/resources/Reserve/Holds.d.ts +24 -64
- package/esm/resources/Reserve/Holds.js +1 -17
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +25 -43
- package/esm/resources/Reserve/Plans.js +1 -9
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +17 -59
- package/esm/resources/Reserve/Releases.js +1 -17
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +3 -14
- package/esm/resources/Reserve/index.js +0 -9
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/Reviews.js +2 -2
- package/esm/resources/Reviews.js.map +1 -1
- package/esm/resources/SetupAttempts.d.ts +8 -26
- package/esm/resources/SetupIntents.d.ts +14 -333
- package/esm/resources/SetupIntents.js +5 -5
- package/esm/resources/SetupIntents.js.map +1 -1
- package/esm/resources/ShippingRates.js +2 -2
- package/esm/resources/ShippingRates.js.map +1 -1
- package/esm/resources/Sigma/ScheduledQueryRuns.d.ts +7 -9
- package/esm/resources/Sigma/ScheduledQueryRuns.js +1 -1
- package/esm/resources/Sigma/ScheduledQueryRuns.js.map +1 -1
- package/esm/resources/Sigma/index.d.ts +1 -1
- package/esm/resources/Sources.d.ts +1 -16
- package/esm/resources/Sources.js +4 -4
- package/esm/resources/Sources.js.map +1 -1
- package/esm/resources/SubscriptionItems.d.ts +0 -143
- package/esm/resources/SubscriptionItems.js +3 -3
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +4 -1155
- package/esm/resources/SubscriptionSchedules.js +4 -10
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +61 -560
- package/esm/resources/Subscriptions.js +7 -152
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/Associations.d.ts +24 -26
- package/esm/resources/Tax/CalculationLineItems.d.ts +56 -62
- package/esm/resources/Tax/Calculations.d.ts +158 -164
- package/esm/resources/Tax/Calculations.js +2 -2
- package/esm/resources/Tax/Calculations.js.map +1 -1
- package/esm/resources/Tax/Registrations.d.ts +1095 -1233
- package/esm/resources/Tax/Registrations.js +2 -2
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +37 -39
- package/esm/resources/Tax/TransactionLineItems.d.ts +11 -13
- package/esm/resources/Tax/Transactions.d.ts +113 -115
- package/esm/resources/Tax/Transactions.js +2 -2
- package/esm/resources/Tax/Transactions.js.map +1 -1
- package/esm/resources/Tax/index.d.ts +18 -32
- package/esm/resources/Tax/index.js +0 -4
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +0 -15
- package/esm/resources/TaxCodes.js +1 -1
- package/esm/resources/TaxCodes.js.map +1 -1
- package/esm/resources/TaxIds.js +2 -2
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.js +2 -2
- package/esm/resources/TaxRates.js.map +1 -1
- package/esm/resources/Terminal/Configurations.d.ts +479 -508
- package/esm/resources/Terminal/Configurations.js +3 -3
- package/esm/resources/Terminal/Configurations.js.map +1 -1
- package/esm/resources/Terminal/Locations.d.ts +72 -74
- package/esm/resources/Terminal/Locations.js +3 -3
- package/esm/resources/Terminal/Locations.js.map +1 -1
- package/esm/resources/Terminal/OnboardingLinks.d.ts +16 -18
- package/esm/resources/Terminal/Readers.d.ts +479 -497
- package/esm/resources/Terminal/Readers.js +11 -11
- package/esm/resources/Terminal/Readers.js.map +1 -1
- package/esm/resources/Terminal/index.d.ts +11 -13
- package/esm/resources/Terminal/index.js +0 -2
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +2 -79
- package/esm/resources/TestHelpers/Customers.js +1 -1
- package/esm/resources/TestHelpers/Customers.js.map +1 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.js +6 -6
- package/esm/resources/TestHelpers/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/TestHelpers/Issuing/Cards.js +5 -5
- package/esm/resources/TestHelpers/Issuing/Cards.js.map +1 -1
- package/esm/resources/TestHelpers/Issuing/PersonalizationDesigns.js +3 -3
- package/esm/resources/TestHelpers/Issuing/PersonalizationDesigns.js.map +1 -1
- package/esm/resources/TestHelpers/Issuing/Transactions.js +1 -1
- package/esm/resources/TestHelpers/Issuing/Transactions.js.map +1 -1
- package/esm/resources/TestHelpers/Refunds.js +1 -1
- package/esm/resources/TestHelpers/Refunds.js.map +1 -1
- package/esm/resources/TestHelpers/Terminal/Readers.js +3 -3
- package/esm/resources/TestHelpers/Terminal/Readers.js.map +1 -1
- package/esm/resources/TestHelpers/TestClocks.d.ts +27 -29
- package/esm/resources/TestHelpers/TestClocks.js +3 -3
- package/esm/resources/TestHelpers/TestClocks.js.map +1 -1
- package/esm/resources/TestHelpers/Treasury/InboundTransfers.js +3 -3
- package/esm/resources/TestHelpers/Treasury/InboundTransfers.js.map +1 -1
- package/esm/resources/TestHelpers/Treasury/OutboundPayments.js +4 -4
- package/esm/resources/TestHelpers/Treasury/OutboundPayments.js.map +1 -1
- package/esm/resources/TestHelpers/Treasury/OutboundTransfers.js +4 -4
- package/esm/resources/TestHelpers/Treasury/OutboundTransfers.js.map +1 -1
- package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +0 -22
- package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +0 -22
- package/esm/resources/TestHelpers/index.d.ts +3 -5
- package/esm/resources/TestHelpers/index.js +0 -2
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Tokens.js +1 -1
- package/esm/resources/Tokens.js.map +1 -1
- package/esm/resources/Topups.d.ts +18 -0
- package/esm/resources/Topups.js +3 -3
- package/esm/resources/Topups.js.map +1 -1
- package/esm/resources/Transfers.d.ts +0 -8
- package/esm/resources/Transfers.js +6 -6
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/Treasury/CreditReversals.d.ts +11 -13
- package/esm/resources/Treasury/CreditReversals.js +1 -1
- package/esm/resources/Treasury/CreditReversals.js.map +1 -1
- package/esm/resources/Treasury/DebitReversals.d.ts +18 -20
- package/esm/resources/Treasury/DebitReversals.js +1 -1
- package/esm/resources/Treasury/DebitReversals.js.map +1 -1
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +252 -259
- package/esm/resources/Treasury/FinancialAccounts.d.ts +88 -123
- package/esm/resources/Treasury/FinancialAccounts.js +5 -5
- package/esm/resources/Treasury/FinancialAccounts.js.map +1 -1
- package/esm/resources/Treasury/InboundTransfers.d.ts +79 -81
- package/esm/resources/Treasury/InboundTransfers.js +2 -2
- package/esm/resources/Treasury/InboundTransfers.js.map +1 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +125 -135
- package/esm/resources/Treasury/OutboundPayments.js +2 -2
- package/esm/resources/Treasury/OutboundPayments.js.map +1 -1
- package/esm/resources/Treasury/OutboundTransfers.d.ts +114 -160
- package/esm/resources/Treasury/OutboundTransfers.js +2 -2
- package/esm/resources/Treasury/OutboundTransfers.js.map +1 -1
- package/esm/resources/Treasury/ReceivedCredits.d.ts +118 -142
- package/esm/resources/Treasury/ReceivedCredits.js +1 -1
- package/esm/resources/Treasury/ReceivedCredits.js.map +1 -1
- package/esm/resources/Treasury/ReceivedDebits.d.ts +86 -114
- package/esm/resources/Treasury/ReceivedDebits.js +1 -1
- package/esm/resources/Treasury/ReceivedDebits.js.map +1 -1
- package/esm/resources/Treasury/TransactionEntries.d.ts +75 -77
- package/esm/resources/Treasury/TransactionEntries.js +1 -1
- package/esm/resources/Treasury/TransactionEntries.js.map +1 -1
- package/esm/resources/Treasury/Transactions.d.ts +86 -88
- package/esm/resources/Treasury/Transactions.js +1 -1
- package/esm/resources/Treasury/Transactions.js.map +1 -1
- package/esm/resources/Treasury/index.d.ts +10 -10
- package/esm/resources/V2/Billing/MeterEventAdjustments.d.ts +9 -13
- package/esm/resources/V2/Billing/index.d.ts +9 -48
- package/esm/resources/V2/Billing/index.js +0 -8
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.d.ts +2 -2
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.js +1 -1
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -1
- package/esm/resources/V2/Commerce/ProductCatalogImports.d.ts +132 -131
- package/esm/resources/V2/Core/AccountLinks.d.ts +81 -85
- package/esm/resources/V2/Core/AccountPersons.d.ts +369 -373
- package/esm/resources/V2/Core/AccountTokens.d.ts +0 -10
- package/esm/resources/V2/Core/AccountTokens.js +1 -1
- package/esm/resources/V2/Core/AccountTokens.js.map +1 -1
- package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/esm/resources/V2/Core/Accounts/PersonTokens.js +3 -3
- package/esm/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts/Persons.js +7 -7
- package/esm/resources/V2/Core/Accounts/Persons.js.map +1 -1
- package/esm/resources/V2/Core/Accounts.d.ts +3043 -4006
- package/esm/resources/V2/Core/Accounts.js +3 -3
- package/esm/resources/V2/Core/Accounts.js.map +1 -1
- package/esm/resources/V2/Core/EventDestinations.d.ts +78 -82
- package/esm/resources/V2/Core/EventDestinations.js +6 -6
- package/esm/resources/V2/Core/EventDestinations.js.map +1 -1
- package/esm/resources/V2/Core/Events.d.ts +31 -1154
- package/esm/resources/V2/Core/Events.js +1 -1
- package/esm/resources/V2/Core/Events.js.map +1 -1
- package/esm/resources/V2/Core/index.d.ts +14 -24
- package/esm/resources/V2/Core/index.js +0 -4
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/index.d.ts +0 -27
- package/esm/resources/V2/index.js +0 -14
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +3 -3
- package/esm/resources/WebhookEndpoints.js +3 -3
- package/esm/resources/WebhookEndpoints.js.map +1 -1
- package/esm/resources.d.ts +0 -10
- package/esm/resources.js +0 -131
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +69 -62
- package/esm/stripe.core.js +7 -25
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +68 -63
- package/esm/stripe.esm.node.js +2 -25
- package/esm/stripe.esm.node.js.map +1 -1
- package/esm/utils.d.ts +1 -1
- package/esm/utils.js +13 -2
- package/esm/utils.js.map +1 -1
- package/package.json +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +0 -19
- package/cjs/StripeEventNotificationHandler.js +0 -148
- package/cjs/StripeEventNotificationHandler.js.map +0 -1
- package/cjs/resources/AccountNotices.d.ts +0 -140
- package/cjs/resources/AccountNotices.js +0 -29
- package/cjs/resources/AccountNotices.js.map +0 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +0 -84
- package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -15
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +0 -1
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +0 -32
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +0 -4
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +0 -1
- package/cjs/resources/Billing/Analytics/index.d.ts +0 -15
- package/cjs/resources/Billing/Analytics/index.js +0 -13
- package/cjs/resources/Billing/Analytics/index.js.map +0 -1
- package/cjs/resources/Capital/FinancingOffers.d.ts +0 -191
- package/cjs/resources/Capital/FinancingOffers.js +0 -30
- package/cjs/resources/Capital/FinancingOffers.js.map +0 -1
- package/cjs/resources/Capital/FinancingSummary.d.ts +0 -98
- package/cjs/resources/Capital/FinancingSummary.js +0 -15
- package/cjs/resources/Capital/FinancingSummary.js.map +0 -1
- package/cjs/resources/Capital/FinancingTransactions.d.ts +0 -143
- package/cjs/resources/Capital/FinancingTransactions.js +0 -24
- package/cjs/resources/Capital/FinancingTransactions.js.map +0 -1
- package/cjs/resources/Capital/index.d.ts +0 -25
- package/cjs/resources/Capital/index.js +0 -17
- package/cjs/resources/Capital/index.js.map +0 -1
- package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +0 -24
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +0 -4
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +0 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +0 -87
- package/cjs/resources/FinancialConnections/Authorizations.js +0 -15
- package/cjs/resources/FinancialConnections/Authorizations.js.map +0 -1
- package/cjs/resources/FinancialConnections/Institutions.d.ts +0 -101
- package/cjs/resources/FinancialConnections/Institutions.js +0 -23
- package/cjs/resources/FinancialConnections/Institutions.js.map +0 -1
- package/cjs/resources/FxQuotes.d.ts +0 -212
- package/cjs/resources/FxQuotes.js +0 -29
- package/cjs/resources/FxQuotes.js.map +0 -1
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +0 -640
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -47
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +0 -95
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -23
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +0 -1
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +0 -68
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -23
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +0 -1
- package/cjs/resources/Issuing/Settlements.d.ts +0 -85
- package/cjs/resources/Issuing/Settlements.js +0 -4
- package/cjs/resources/Issuing/Settlements.js.map +0 -1
- package/cjs/resources/Margins.d.ts +0 -115
- package/cjs/resources/Margins.js +0 -35
- package/cjs/resources/Margins.js.map +0 -1
- package/cjs/resources/Orders.d.ts +0 -4693
- package/cjs/resources/Orders.js +0 -457
- package/cjs/resources/Orders.js.map +0 -1
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +0 -37
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js +0 -4
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +0 -1
- package/cjs/resources/Privacy/RedactionJobs.d.ts +0 -229
- package/cjs/resources/Privacy/RedactionJobs.js +0 -73
- package/cjs/resources/Privacy/RedactionJobs.js.map +0 -1
- package/cjs/resources/Privacy/index.d.ts +0 -22
- package/cjs/resources/Privacy/index.js +0 -13
- package/cjs/resources/Privacy/index.js.map +0 -1
- package/cjs/resources/ProductCatalog/TrialOffers.d.ts +0 -127
- package/cjs/resources/ProductCatalog/TrialOffers.js +0 -15
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +0 -1
- package/cjs/resources/ProductCatalog/index.d.ts +0 -12
- package/cjs/resources/ProductCatalog/index.js +0 -13
- package/cjs/resources/ProductCatalog/index.js.map +0 -1
- package/cjs/resources/QuoteLines.d.ts +0 -507
- package/cjs/resources/QuoteLines.js +0 -4
- package/cjs/resources/QuoteLines.js.map +0 -1
- package/cjs/resources/QuotePreviewInvoices.d.ts +0 -1120
- package/cjs/resources/QuotePreviewInvoices.js +0 -4
- package/cjs/resources/QuotePreviewInvoices.js.map +0 -1
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -737
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +0 -4
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +0 -1095
- package/cjs/resources/SharedPayment/GrantedTokens.js +0 -15
- package/cjs/resources/SharedPayment/GrantedTokens.js.map +0 -1
- package/cjs/resources/SharedPayment/IssuedTokens.d.ts +0 -308
- package/cjs/resources/SharedPayment/IssuedTokens.js +0 -27
- package/cjs/resources/SharedPayment/IssuedTokens.js.map +0 -1
- package/cjs/resources/SharedPayment/index.d.ts +0 -19
- package/cjs/resources/SharedPayment/index.js +0 -15
- package/cjs/resources/SharedPayment/index.js.map +0 -1
- package/cjs/resources/Tax/Forms.d.ts +0 -230
- package/cjs/resources/Tax/Forms.js +0 -32
- package/cjs/resources/Tax/Forms.js.map +0 -1
- package/cjs/resources/Tax/Locations.d.ts +0 -108
- package/cjs/resources/Tax/Locations.js +0 -33
- package/cjs/resources/Tax/Locations.js.map +0 -1
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +0 -52
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -15
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +0 -1
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +0 -68
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -21
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +0 -1
- package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +0 -8
- package/cjs/resources/TestHelpers/SharedPayment/index.js +0 -13
- package/cjs/resources/TestHelpers/SharedPayment/index.js.map +0 -1
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +0 -75
- package/cjs/resources/V2/Billing/BillSettingVersions.js +0 -4
- package/cjs/resources/V2/Billing/BillSettingVersions.js.map +0 -1
- package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +0 -33
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -23
- package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +0 -1
- package/cjs/resources/V2/Billing/BillSettings.d.ts +0 -284
- package/cjs/resources/V2/Billing/BillSettings.js +0 -41
- package/cjs/resources/V2/Billing/BillSettings.js.map +0 -1
- package/cjs/resources/V2/Billing/Cadences.d.ts +0 -951
- package/cjs/resources/V2/Billing/Cadences.js +0 -198
- package/cjs/resources/V2/Billing/Cadences.js.map +0 -1
- package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +0 -240
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js +0 -4
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +0 -1
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +0 -33
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -70
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +0 -1
- package/cjs/resources/V2/Billing/CollectionSettings.d.ts +0 -779
- package/cjs/resources/V2/Billing/CollectionSettings.js +0 -166
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +0 -1
- package/cjs/resources/V2/Billing/Profiles.d.ts +0 -166
- package/cjs/resources/V2/Billing/Profiles.js +0 -35
- package/cjs/resources/V2/Billing/Profiles.js.map +0 -1
- package/cjs/resources/V2/Core/BatchJobs.d.ts +0 -373
- package/cjs/resources/V2/Core/BatchJobs.js +0 -225
- package/cjs/resources/V2/Core/BatchJobs.js.map +0 -1
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -285
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -54
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +0 -1
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +0 -254
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -62
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +0 -1
- package/cjs/resources/V2/Core/Vault/index.d.ts +0 -28
- package/cjs/resources/V2/Core/Vault/index.js +0 -15
- package/cjs/resources/V2/Core/Vault/index.js.map +0 -1
- package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +0 -156
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js +0 -46
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +0 -1
- package/cjs/resources/V2/Data/Reporting/index.d.ts +0 -13
- package/cjs/resources/V2/Data/Reporting/index.js +0 -13
- package/cjs/resources/V2/Data/Reporting/index.js.map +0 -1
- package/cjs/resources/V2/Data/index.d.ts +0 -10
- package/cjs/resources/V2/Data/index.js +0 -13
- package/cjs/resources/V2/Data/index.js.map +0 -1
- package/cjs/resources/V2/EventMisc.d.ts +0 -0
- package/cjs/resources/V2/EventMisc.js +0 -2
- package/cjs/resources/V2/EventMisc.js.map +0 -1
- package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +0 -166
- package/cjs/resources/V2/Extend/WorkflowRuns.js +0 -23
- package/cjs/resources/V2/Extend/WorkflowRuns.js.map +0 -1
- package/cjs/resources/V2/Extend/Workflows.d.ts +0 -123
- package/cjs/resources/V2/Extend/Workflows.js +0 -30
- package/cjs/resources/V2/Extend/Workflows.js.map +0 -1
- package/cjs/resources/V2/Extend/index.d.ts +0 -20
- package/cjs/resources/V2/Extend/index.js +0 -15
- package/cjs/resources/V2/Extend/index.js.map +0 -1
- package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +0 -14
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js +0 -4
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +0 -1
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -19
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +0 -4
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +0 -1
- package/cjs/resources/V2/Iam/ActivityLogs.d.ts +0 -214
- package/cjs/resources/V2/Iam/ActivityLogs.js +0 -23
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +0 -1
- package/cjs/resources/V2/Iam/index.d.ts +0 -13
- package/cjs/resources/V2/Iam/index.js +0 -13
- package/cjs/resources/V2/Iam/index.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +0 -135
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -23
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -244
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -44
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -215
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -31
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +0 -254
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -30
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -212
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -22
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +0 -388
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -41
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -300
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -49
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +0 -330
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -39
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -243
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -44
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -96
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -17
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +0 -295
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -23
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +0 -161
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -23
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -165
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -23
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +0 -196
- package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -23
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/index.d.ts +0 -104
- package/cjs/resources/V2/MoneyManagement/index.js +0 -39
- package/cjs/resources/V2/MoneyManagement/index.js.map +0 -1
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +0 -96
- package/cjs/resources/V2/Network/BusinessProfiles.js +0 -21
- package/cjs/resources/V2/Network/BusinessProfiles.js.map +0 -1
- package/cjs/resources/V2/Network/index.d.ts +0 -13
- package/cjs/resources/V2/Network/index.js +0 -13
- package/cjs/resources/V2/Network/index.js.map +0 -1
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +0 -147
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +0 -41
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +0 -1
- package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +0 -16
- package/cjs/resources/V2/OrchestratedCommerce/index.js +0 -13
- package/cjs/resources/V2/OrchestratedCommerce/index.js.map +0 -1
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +0 -44
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -23
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +0 -1
- package/cjs/resources/V2/TestHelpers/index.d.ts +0 -8
- package/cjs/resources/V2/TestHelpers/index.js +0 -13
- package/cjs/resources/V2/TestHelpers/index.js.map +0 -1
- package/esm/StripeEventNotificationHandler.d.ts +0 -19
- package/esm/StripeEventNotificationHandler.js +0 -144
- package/esm/StripeEventNotificationHandler.js.map +0 -1
- package/esm/resources/AccountNotices.d.ts +0 -140
- package/esm/resources/AccountNotices.js +0 -25
- package/esm/resources/AccountNotices.js.map +0 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +0 -84
- package/esm/resources/Billing/Analytics/MeterUsage.js +0 -11
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +0 -1
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +0 -32
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +0 -3
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +0 -1
- package/esm/resources/Billing/Analytics/index.d.ts +0 -15
- package/esm/resources/Billing/Analytics/index.js +0 -9
- package/esm/resources/Billing/Analytics/index.js.map +0 -1
- package/esm/resources/Capital/FinancingOffers.d.ts +0 -191
- package/esm/resources/Capital/FinancingOffers.js +0 -26
- package/esm/resources/Capital/FinancingOffers.js.map +0 -1
- package/esm/resources/Capital/FinancingSummary.d.ts +0 -98
- package/esm/resources/Capital/FinancingSummary.js +0 -11
- package/esm/resources/Capital/FinancingSummary.js.map +0 -1
- package/esm/resources/Capital/FinancingTransactions.d.ts +0 -143
- package/esm/resources/Capital/FinancingTransactions.js +0 -20
- package/esm/resources/Capital/FinancingTransactions.js.map +0 -1
- package/esm/resources/Capital/index.d.ts +0 -25
- package/esm/resources/Capital/index.js +0 -13
- package/esm/resources/Capital/index.js.map +0 -1
- package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +0 -24
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +0 -3
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +0 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +0 -87
- package/esm/resources/FinancialConnections/Authorizations.js +0 -11
- package/esm/resources/FinancialConnections/Authorizations.js.map +0 -1
- package/esm/resources/FinancialConnections/Institutions.d.ts +0 -101
- package/esm/resources/FinancialConnections/Institutions.js +0 -19
- package/esm/resources/FinancialConnections/Institutions.js.map +0 -1
- package/esm/resources/FxQuotes.d.ts +0 -212
- package/esm/resources/FxQuotes.js +0 -25
- package/esm/resources/FxQuotes.js.map +0 -1
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +0 -640
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -43
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +0 -95
- package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -19
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +0 -1
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +0 -68
- package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -19
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +0 -1
- package/esm/resources/Issuing/Settlements.d.ts +0 -85
- package/esm/resources/Issuing/Settlements.js +0 -3
- package/esm/resources/Issuing/Settlements.js.map +0 -1
- package/esm/resources/Margins.d.ts +0 -115
- package/esm/resources/Margins.js +0 -31
- package/esm/resources/Margins.js.map +0 -1
- package/esm/resources/Orders.d.ts +0 -4693
- package/esm/resources/Orders.js +0 -453
- package/esm/resources/Orders.js.map +0 -1
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +0 -37
- package/esm/resources/Privacy/RedactionJobValidationErrors.js +0 -3
- package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +0 -1
- package/esm/resources/Privacy/RedactionJobs.d.ts +0 -229
- package/esm/resources/Privacy/RedactionJobs.js +0 -69
- package/esm/resources/Privacy/RedactionJobs.js.map +0 -1
- package/esm/resources/Privacy/index.d.ts +0 -22
- package/esm/resources/Privacy/index.js +0 -9
- package/esm/resources/Privacy/index.js.map +0 -1
- package/esm/resources/ProductCatalog/TrialOffers.d.ts +0 -127
- package/esm/resources/ProductCatalog/TrialOffers.js +0 -11
- package/esm/resources/ProductCatalog/TrialOffers.js.map +0 -1
- package/esm/resources/ProductCatalog/index.d.ts +0 -12
- package/esm/resources/ProductCatalog/index.js +0 -9
- package/esm/resources/ProductCatalog/index.js.map +0 -1
- package/esm/resources/QuoteLines.d.ts +0 -507
- package/esm/resources/QuoteLines.js +0 -3
- package/esm/resources/QuoteLines.js.map +0 -1
- package/esm/resources/QuotePreviewInvoices.d.ts +0 -1120
- package/esm/resources/QuotePreviewInvoices.js +0 -3
- package/esm/resources/QuotePreviewInvoices.js.map +0 -1
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -737
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +0 -3
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +0 -1095
- package/esm/resources/SharedPayment/GrantedTokens.js +0 -11
- package/esm/resources/SharedPayment/GrantedTokens.js.map +0 -1
- package/esm/resources/SharedPayment/IssuedTokens.d.ts +0 -308
- package/esm/resources/SharedPayment/IssuedTokens.js +0 -23
- package/esm/resources/SharedPayment/IssuedTokens.js.map +0 -1
- package/esm/resources/SharedPayment/index.d.ts +0 -19
- package/esm/resources/SharedPayment/index.js +0 -11
- package/esm/resources/SharedPayment/index.js.map +0 -1
- package/esm/resources/Tax/Forms.d.ts +0 -230
- package/esm/resources/Tax/Forms.js +0 -28
- package/esm/resources/Tax/Forms.js.map +0 -1
- package/esm/resources/Tax/Locations.d.ts +0 -108
- package/esm/resources/Tax/Locations.js +0 -29
- package/esm/resources/Tax/Locations.js.map +0 -1
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +0 -52
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -11
- package/esm/resources/Terminal/ReaderCollectedData.js.map +0 -1
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +0 -68
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -17
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +0 -1
- package/esm/resources/TestHelpers/SharedPayment/index.d.ts +0 -8
- package/esm/resources/TestHelpers/SharedPayment/index.js +0 -9
- package/esm/resources/TestHelpers/SharedPayment/index.js.map +0 -1
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +0 -75
- package/esm/resources/V2/Billing/BillSettingVersions.js +0 -3
- package/esm/resources/V2/Billing/BillSettingVersions.js.map +0 -1
- package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +0 -33
- package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -19
- package/esm/resources/V2/Billing/BillSettings/Versions.js.map +0 -1
- package/esm/resources/V2/Billing/BillSettings.d.ts +0 -284
- package/esm/resources/V2/Billing/BillSettings.js +0 -37
- package/esm/resources/V2/Billing/BillSettings.js.map +0 -1
- package/esm/resources/V2/Billing/Cadences.d.ts +0 -951
- package/esm/resources/V2/Billing/Cadences.js +0 -194
- package/esm/resources/V2/Billing/Cadences.js.map +0 -1
- package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +0 -240
- package/esm/resources/V2/Billing/CollectionSettingVersions.js +0 -3
- package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +0 -1
- package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +0 -33
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -66
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +0 -1
- package/esm/resources/V2/Billing/CollectionSettings.d.ts +0 -779
- package/esm/resources/V2/Billing/CollectionSettings.js +0 -162
- package/esm/resources/V2/Billing/CollectionSettings.js.map +0 -1
- package/esm/resources/V2/Billing/Profiles.d.ts +0 -166
- package/esm/resources/V2/Billing/Profiles.js +0 -31
- package/esm/resources/V2/Billing/Profiles.js.map +0 -1
- package/esm/resources/V2/Core/BatchJobs.d.ts +0 -373
- package/esm/resources/V2/Core/BatchJobs.js +0 -221
- package/esm/resources/V2/Core/BatchJobs.js.map +0 -1
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -285
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -50
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +0 -1
- package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +0 -254
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -58
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +0 -1
- package/esm/resources/V2/Core/Vault/index.d.ts +0 -28
- package/esm/resources/V2/Core/Vault/index.js +0 -11
- package/esm/resources/V2/Core/Vault/index.js.map +0 -1
- package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +0 -156
- package/esm/resources/V2/Data/Reporting/QueryRuns.js +0 -42
- package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +0 -1
- package/esm/resources/V2/Data/Reporting/index.d.ts +0 -13
- package/esm/resources/V2/Data/Reporting/index.js +0 -9
- package/esm/resources/V2/Data/Reporting/index.js.map +0 -1
- package/esm/resources/V2/Data/index.d.ts +0 -10
- package/esm/resources/V2/Data/index.js +0 -9
- package/esm/resources/V2/Data/index.js.map +0 -1
- package/esm/resources/V2/EventMisc.d.ts +0 -0
- package/esm/resources/V2/EventMisc.js +0 -2
- package/esm/resources/V2/EventMisc.js.map +0 -1
- package/esm/resources/V2/Extend/WorkflowRuns.d.ts +0 -166
- package/esm/resources/V2/Extend/WorkflowRuns.js +0 -19
- package/esm/resources/V2/Extend/WorkflowRuns.js.map +0 -1
- package/esm/resources/V2/Extend/Workflows.d.ts +0 -123
- package/esm/resources/V2/Extend/Workflows.js +0 -26
- package/esm/resources/V2/Extend/Workflows.js.map +0 -1
- package/esm/resources/V2/Extend/index.d.ts +0 -20
- package/esm/resources/V2/Extend/index.js +0 -11
- package/esm/resources/V2/Extend/index.js.map +0 -1
- package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +0 -14
- package/esm/resources/V2/FinancialAddressCreditSimulations.js +0 -3
- package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +0 -1
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -19
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +0 -3
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +0 -1
- package/esm/resources/V2/Iam/ActivityLogs.d.ts +0 -214
- package/esm/resources/V2/Iam/ActivityLogs.js +0 -19
- package/esm/resources/V2/Iam/ActivityLogs.js.map +0 -1
- package/esm/resources/V2/Iam/index.d.ts +0 -13
- package/esm/resources/V2/Iam/index.js +0 -9
- package/esm/resources/V2/Iam/index.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +0 -135
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -19
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -244
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -40
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -215
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -27
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +0 -254
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -26
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -212
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -18
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +0 -388
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -37
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -300
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -45
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +0 -330
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -35
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -243
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -40
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -96
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -13
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +0 -295
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -19
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +0 -161
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -19
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -165
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -19
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/Transactions.d.ts +0 -196
- package/esm/resources/V2/MoneyManagement/Transactions.js +0 -19
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/index.d.ts +0 -104
- package/esm/resources/V2/MoneyManagement/index.js +0 -35
- package/esm/resources/V2/MoneyManagement/index.js.map +0 -1
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +0 -96
- package/esm/resources/V2/Network/BusinessProfiles.js +0 -17
- package/esm/resources/V2/Network/BusinessProfiles.js.map +0 -1
- package/esm/resources/V2/Network/index.d.ts +0 -13
- package/esm/resources/V2/Network/index.js +0 -9
- package/esm/resources/V2/Network/index.js.map +0 -1
- package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +0 -147
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js +0 -37
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +0 -1
- package/esm/resources/V2/OrchestratedCommerce/index.d.ts +0 -16
- package/esm/resources/V2/OrchestratedCommerce/index.js +0 -9
- package/esm/resources/V2/OrchestratedCommerce/index.js.map +0 -1
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +0 -44
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -19
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +0 -1
- package/esm/resources/V2/TestHelpers/index.d.ts +0 -8
- package/esm/resources/V2/TestHelpers/index.js +0 -9
- package/esm/resources/V2/TestHelpers/index.js.map +0 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { StripeResource } from '../../StripeResource.js';
|
|
2
2
|
import { LineItem } from './../LineItems.js';
|
|
3
|
+
import { Discount as _Discount } from './../Discounts.js';
|
|
3
4
|
import { Subscription } from './../Subscriptions.js';
|
|
4
5
|
import { Customer, DeletedCustomer } from './../Customers.js';
|
|
5
6
|
import { Invoice } from './../Invoices.js';
|
|
@@ -56,11 +57,11 @@ export interface Session {
|
|
|
56
57
|
/**
|
|
57
58
|
* Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
|
58
59
|
*/
|
|
59
|
-
adaptive_pricing:
|
|
60
|
+
adaptive_pricing: Session.AdaptivePricing | null;
|
|
60
61
|
/**
|
|
61
62
|
* When set, provides configuration for actions to take if this Checkout Session expires.
|
|
62
63
|
*/
|
|
63
|
-
after_expiration:
|
|
64
|
+
after_expiration: Session.AfterExpiration | null;
|
|
64
65
|
/**
|
|
65
66
|
* Enables user redeemable promotion codes.
|
|
66
67
|
*/
|
|
@@ -73,12 +74,12 @@ export interface Session {
|
|
|
73
74
|
* Total of all items after discounts and taxes are applied.
|
|
74
75
|
*/
|
|
75
76
|
amount_total: number | null;
|
|
76
|
-
automatic_tax:
|
|
77
|
+
automatic_tax: Session.AutomaticTax;
|
|
77
78
|
/**
|
|
78
79
|
* Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
|
79
80
|
*/
|
|
80
|
-
billing_address_collection:
|
|
81
|
-
branding_settings?:
|
|
81
|
+
billing_address_collection: Session.BillingAddressCollection | null;
|
|
82
|
+
branding_settings?: Session.BrandingSettings;
|
|
82
83
|
/**
|
|
83
84
|
* If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
|
|
84
85
|
*/
|
|
@@ -97,15 +98,15 @@ export interface Session {
|
|
|
97
98
|
/**
|
|
98
99
|
* Information about the customer collected within the Checkout Session.
|
|
99
100
|
*/
|
|
100
|
-
collected_information:
|
|
101
|
+
collected_information: Session.CollectedInformation | null;
|
|
101
102
|
/**
|
|
102
103
|
* Results of `consent_collection` for this session.
|
|
103
104
|
*/
|
|
104
|
-
consent:
|
|
105
|
+
consent: Session.Consent | null;
|
|
105
106
|
/**
|
|
106
107
|
* When set, provides configuration for the Checkout Session to gather active consent from customers.
|
|
107
108
|
*/
|
|
108
|
-
consent_collection:
|
|
109
|
+
consent_collection: Session.ConsentCollection | null;
|
|
109
110
|
/**
|
|
110
111
|
* Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
111
112
|
*/
|
|
@@ -117,12 +118,12 @@ export interface Session {
|
|
|
117
118
|
/**
|
|
118
119
|
* Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.
|
|
119
120
|
*/
|
|
120
|
-
currency_conversion:
|
|
121
|
+
currency_conversion: Session.CurrencyConversion | null;
|
|
121
122
|
/**
|
|
122
123
|
* Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
|
|
123
124
|
*/
|
|
124
|
-
custom_fields: Array<
|
|
125
|
-
custom_text:
|
|
125
|
+
custom_fields: Array<Session.CustomField>;
|
|
126
|
+
custom_text: Session.CustomText;
|
|
126
127
|
/**
|
|
127
128
|
* The ID of the customer for this Session.
|
|
128
129
|
* For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
|
|
@@ -138,11 +139,11 @@ export interface Session {
|
|
|
138
139
|
/**
|
|
139
140
|
* Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
|
|
140
141
|
*/
|
|
141
|
-
customer_creation:
|
|
142
|
+
customer_creation: Session.CustomerCreation | null;
|
|
142
143
|
/**
|
|
143
144
|
* The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
|
|
144
145
|
*/
|
|
145
|
-
customer_details:
|
|
146
|
+
customer_details: Session.CustomerDetails | null;
|
|
146
147
|
/**
|
|
147
148
|
* If provided, this value will be used when the Customer object is created.
|
|
148
149
|
* If not provided, customers will be asked to enter their email address.
|
|
@@ -154,7 +155,7 @@ export interface Session {
|
|
|
154
155
|
/**
|
|
155
156
|
* List of coupons and promotion codes attached to the Checkout Session.
|
|
156
157
|
*/
|
|
157
|
-
discounts: Array<
|
|
158
|
+
discounts: Array<Session.Discount> | null;
|
|
158
159
|
/**
|
|
159
160
|
* A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
|
|
160
161
|
*/
|
|
@@ -174,7 +175,7 @@ export interface Session {
|
|
|
174
175
|
/**
|
|
175
176
|
* Details on the state of invoice creation for the Checkout Session.
|
|
176
177
|
*/
|
|
177
|
-
invoice_creation:
|
|
178
|
+
invoice_creation: Session.InvoiceCreation | null;
|
|
178
179
|
/**
|
|
179
180
|
* The line items purchased by the customer.
|
|
180
181
|
*/
|
|
@@ -186,11 +187,11 @@ export interface Session {
|
|
|
186
187
|
/**
|
|
187
188
|
* The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
|
188
189
|
*/
|
|
189
|
-
locale:
|
|
190
|
+
locale: Session.Locale | null;
|
|
190
191
|
/**
|
|
191
192
|
* Settings for Managed Payments for this Checkout Session and resulting [PaymentIntents](https://docs.stripe.com/api/payment_intents/object), [Invoices](https://docs.stripe.com/api/invoices/object), and [Subscriptions](https://docs.stripe.com/api/subscriptions/object).
|
|
192
193
|
*/
|
|
193
|
-
managed_payments:
|
|
194
|
+
managed_payments: Session.ManagedPayments | null;
|
|
194
195
|
/**
|
|
195
196
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
196
197
|
*/
|
|
@@ -198,16 +199,16 @@ export interface Session {
|
|
|
198
199
|
/**
|
|
199
200
|
* The mode of the Checkout Session.
|
|
200
201
|
*/
|
|
201
|
-
mode:
|
|
202
|
-
name_collection?:
|
|
202
|
+
mode: Session.Mode;
|
|
203
|
+
name_collection?: Session.NameCollection;
|
|
203
204
|
/**
|
|
204
205
|
* The optional items presented to the customer at checkout.
|
|
205
206
|
*/
|
|
206
|
-
optional_items?: Array<
|
|
207
|
+
optional_items?: Array<Session.OptionalItem> | null;
|
|
207
208
|
/**
|
|
208
209
|
* Where the user is coming from. This informs the optimizations that are applied to the session.
|
|
209
210
|
*/
|
|
210
|
-
origin_context:
|
|
211
|
+
origin_context: Session.OriginContext | null;
|
|
211
212
|
/**
|
|
212
213
|
* The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
|
|
213
214
|
*/
|
|
@@ -219,15 +220,15 @@ export interface Session {
|
|
|
219
220
|
/**
|
|
220
221
|
* Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
|
|
221
222
|
*/
|
|
222
|
-
payment_method_collection:
|
|
223
|
+
payment_method_collection: Session.PaymentMethodCollection | null;
|
|
223
224
|
/**
|
|
224
225
|
* Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
|
|
225
226
|
*/
|
|
226
|
-
payment_method_configuration_details:
|
|
227
|
+
payment_method_configuration_details: Session.PaymentMethodConfigurationDetails | null;
|
|
227
228
|
/**
|
|
228
229
|
* Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
|
|
229
230
|
*/
|
|
230
|
-
payment_method_options:
|
|
231
|
+
payment_method_options: Session.PaymentMethodOptions | null;
|
|
231
232
|
/**
|
|
232
233
|
* A list of the types of payment methods (e.g. card) this Checkout
|
|
233
234
|
* Session is allowed to accept.
|
|
@@ -237,15 +238,15 @@ export interface Session {
|
|
|
237
238
|
* The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
|
|
238
239
|
* You can use this value to decide when to fulfill your customer's order.
|
|
239
240
|
*/
|
|
240
|
-
payment_status:
|
|
241
|
+
payment_status: Session.PaymentStatus;
|
|
241
242
|
/**
|
|
242
243
|
* This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
|
243
244
|
*
|
|
244
245
|
* For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
|
|
245
246
|
*/
|
|
246
|
-
permissions:
|
|
247
|
-
phone_number_collection?:
|
|
248
|
-
presentment_details?:
|
|
247
|
+
permissions: Session.Permissions | null;
|
|
248
|
+
phone_number_collection?: Session.PhoneNumberCollection;
|
|
249
|
+
presentment_details?: Session.PresentmentDetails;
|
|
249
250
|
/**
|
|
250
251
|
* The ID of the original expired Checkout Session that triggered the recovery flow.
|
|
251
252
|
*/
|
|
@@ -253,7 +254,7 @@ export interface Session {
|
|
|
253
254
|
/**
|
|
254
255
|
* This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
|
|
255
256
|
*/
|
|
256
|
-
redirect_on_completion?:
|
|
257
|
+
redirect_on_completion?: Session.RedirectOnCompletion;
|
|
257
258
|
/**
|
|
258
259
|
* Applies to Checkout Sessions with `ui_mode: embedded_page` or `ui_mode: elements`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
|
|
259
260
|
*/
|
|
@@ -261,7 +262,7 @@ export interface Session {
|
|
|
261
262
|
/**
|
|
262
263
|
* Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
|
263
264
|
*/
|
|
264
|
-
saved_payment_method_options:
|
|
265
|
+
saved_payment_method_options: Session.SavedPaymentMethodOptions | null;
|
|
265
266
|
/**
|
|
266
267
|
* The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
|
|
267
268
|
*/
|
|
@@ -269,25 +270,25 @@ export interface Session {
|
|
|
269
270
|
/**
|
|
270
271
|
* When set, provides configuration for Checkout to collect a shipping address from a customer.
|
|
271
272
|
*/
|
|
272
|
-
shipping_address_collection:
|
|
273
|
+
shipping_address_collection: Session.ShippingAddressCollection | null;
|
|
273
274
|
/**
|
|
274
275
|
* The details of the customer cost of shipping, including the customer chosen ShippingRate.
|
|
275
276
|
*/
|
|
276
|
-
shipping_cost:
|
|
277
|
+
shipping_cost: Session.ShippingCost | null;
|
|
277
278
|
/**
|
|
278
279
|
* The shipping rate options applied to this Session.
|
|
279
280
|
*/
|
|
280
|
-
shipping_options: Array<
|
|
281
|
+
shipping_options: Array<Session.ShippingOption>;
|
|
281
282
|
/**
|
|
282
283
|
* The status of the Checkout Session, one of `open`, `complete`, or `expired`.
|
|
283
284
|
*/
|
|
284
|
-
status:
|
|
285
|
+
status: Session.Status | null;
|
|
285
286
|
/**
|
|
286
287
|
* Describes the type of transaction being performed by Checkout in order to customize
|
|
287
288
|
* relevant text on the page, such as the submit button. `submit_type` can only be
|
|
288
289
|
* specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
|
289
290
|
*/
|
|
290
|
-
submit_type:
|
|
291
|
+
submit_type: Session.SubmitType | null;
|
|
291
292
|
/**
|
|
292
293
|
* The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode.
|
|
293
294
|
*/
|
|
@@ -297,15 +298,15 @@ export interface Session {
|
|
|
297
298
|
* subscription creation is successful.
|
|
298
299
|
*/
|
|
299
300
|
success_url: string | null;
|
|
300
|
-
tax_id_collection?:
|
|
301
|
+
tax_id_collection?: Session.TaxIdCollection;
|
|
301
302
|
/**
|
|
302
303
|
* Tax and discount details for the computed total amount.
|
|
303
304
|
*/
|
|
304
|
-
total_details:
|
|
305
|
+
total_details: Session.TotalDetails | null;
|
|
305
306
|
/**
|
|
306
307
|
* The UI mode of the Session. Defaults to `hosted_page`.
|
|
307
308
|
*/
|
|
308
|
-
ui_mode:
|
|
309
|
+
ui_mode: Session.UiMode | null;
|
|
309
310
|
/**
|
|
310
311
|
* The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted_page`. Redirect customers to this URL to take them to Checkout. If you're using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it'll use `checkout.stripe.com.`
|
|
311
312
|
* This value is only present when the session is active.
|
|
@@ -314,1824 +315,1780 @@ export interface Session {
|
|
|
314
315
|
/**
|
|
315
316
|
* Wallet-specific configuration for this Checkout Session.
|
|
316
317
|
*/
|
|
317
|
-
wallet_options:
|
|
318
|
+
wallet_options: Session.WalletOptions | null;
|
|
318
319
|
}
|
|
319
|
-
export declare namespace
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
320
|
+
export declare namespace Session {
|
|
321
|
+
interface AdaptivePricing {
|
|
322
|
+
/**
|
|
323
|
+
* If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
|
|
324
|
+
*/
|
|
325
|
+
enabled: boolean;
|
|
326
|
+
}
|
|
327
|
+
interface AfterExpiration {
|
|
328
|
+
/**
|
|
329
|
+
* When set, configuration used to recover the Checkout Session on expiry.
|
|
330
|
+
*/
|
|
331
|
+
recovery: AfterExpiration.Recovery | null;
|
|
332
|
+
}
|
|
333
|
+
interface AutomaticTax {
|
|
334
|
+
/**
|
|
335
|
+
* Indicates whether automatic tax is enabled for the session
|
|
336
|
+
*/
|
|
337
|
+
enabled: boolean;
|
|
338
|
+
/**
|
|
339
|
+
* The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
|
340
|
+
*/
|
|
341
|
+
liability: AutomaticTax.Liability | null;
|
|
342
|
+
/**
|
|
343
|
+
* The tax provider powering automatic tax.
|
|
344
|
+
*/
|
|
345
|
+
provider: string | null;
|
|
346
|
+
/**
|
|
347
|
+
* The status of the most recent automated tax calculation for this session.
|
|
348
|
+
*/
|
|
349
|
+
status: AutomaticTax.Status | null;
|
|
350
|
+
}
|
|
351
|
+
type BillingAddressCollection = 'auto' | 'required';
|
|
352
|
+
interface BrandingSettings {
|
|
353
|
+
/**
|
|
354
|
+
* A hex color value starting with `#` representing the background color for the Checkout Session.
|
|
355
|
+
*/
|
|
356
|
+
background_color: string;
|
|
357
|
+
/**
|
|
358
|
+
* The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
|
|
359
|
+
*/
|
|
360
|
+
border_style: BrandingSettings.BorderStyle;
|
|
361
|
+
/**
|
|
362
|
+
* A hex color value starting with `#` representing the button color for the Checkout Session.
|
|
363
|
+
*/
|
|
364
|
+
button_color: string;
|
|
365
|
+
/**
|
|
366
|
+
* The display name shown on the Checkout Session.
|
|
367
|
+
*/
|
|
368
|
+
display_name: string;
|
|
369
|
+
/**
|
|
370
|
+
* The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
|
|
371
|
+
*/
|
|
372
|
+
font_family: string;
|
|
373
|
+
/**
|
|
374
|
+
* The icon for the Checkout Session. You cannot set both `logo` and `icon`.
|
|
375
|
+
*/
|
|
376
|
+
icon: BrandingSettings.Icon | null;
|
|
377
|
+
/**
|
|
378
|
+
* The logo for the Checkout Session. You cannot set both `logo` and `icon`.
|
|
379
|
+
*/
|
|
380
|
+
logo: BrandingSettings.Logo | null;
|
|
381
|
+
}
|
|
382
|
+
interface CollectedInformation {
|
|
383
|
+
/**
|
|
384
|
+
* Customer's business name for this Checkout Session
|
|
385
|
+
*/
|
|
386
|
+
business_name: string | null;
|
|
387
|
+
/**
|
|
388
|
+
* Customer's individual name for this Checkout Session
|
|
389
|
+
*/
|
|
390
|
+
individual_name: string | null;
|
|
391
|
+
/**
|
|
392
|
+
* Shipping information for this Checkout Session.
|
|
393
|
+
*/
|
|
394
|
+
shipping_details: CollectedInformation.ShippingDetails | null;
|
|
395
|
+
}
|
|
396
|
+
interface Consent {
|
|
397
|
+
/**
|
|
398
|
+
* If `opt_in`, the customer consents to receiving promotional communications
|
|
399
|
+
* from the merchant about this Checkout Session.
|
|
400
|
+
*/
|
|
401
|
+
promotions: Consent.Promotions | null;
|
|
402
|
+
/**
|
|
403
|
+
* If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
|
|
404
|
+
*/
|
|
405
|
+
terms_of_service: 'accepted' | null;
|
|
406
|
+
}
|
|
407
|
+
interface ConsentCollection {
|
|
408
|
+
/**
|
|
409
|
+
* If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
|
410
|
+
*/
|
|
411
|
+
payment_method_reuse_agreement: ConsentCollection.PaymentMethodReuseAgreement | null;
|
|
412
|
+
/**
|
|
413
|
+
* If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
|
414
|
+
* Session will determine whether to display an option to opt into promotional communication
|
|
415
|
+
* from the merchant depending on the customer's locale. Only available to US merchants and US customers.
|
|
416
|
+
*/
|
|
417
|
+
promotions: ConsentCollection.Promotions | null;
|
|
418
|
+
/**
|
|
419
|
+
* If set to `required`, it requires customers to accept the terms of service before being able to pay.
|
|
420
|
+
*/
|
|
421
|
+
terms_of_service: ConsentCollection.TermsOfService | null;
|
|
422
|
+
}
|
|
423
|
+
interface CurrencyConversion {
|
|
424
|
+
/**
|
|
425
|
+
* Total of all items in source currency before discounts or taxes are applied.
|
|
426
|
+
*/
|
|
427
|
+
amount_subtotal: number;
|
|
428
|
+
/**
|
|
429
|
+
* Total of all items in source currency after discounts and taxes are applied.
|
|
430
|
+
*/
|
|
431
|
+
amount_total: number;
|
|
432
|
+
/**
|
|
433
|
+
* Exchange rate used to convert source currency amounts to customer currency amounts
|
|
434
|
+
*/
|
|
435
|
+
fx_rate: Decimal;
|
|
436
|
+
/**
|
|
437
|
+
* Creation currency of the CheckoutSession before localization
|
|
438
|
+
*/
|
|
439
|
+
source_currency: string;
|
|
440
|
+
}
|
|
441
|
+
interface CustomField {
|
|
442
|
+
dropdown?: CustomField.Dropdown;
|
|
443
|
+
/**
|
|
444
|
+
* String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
|
|
445
|
+
*/
|
|
446
|
+
key: string;
|
|
447
|
+
label: CustomField.Label;
|
|
448
|
+
numeric?: CustomField.Numeric;
|
|
449
|
+
/**
|
|
450
|
+
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
451
|
+
*/
|
|
452
|
+
optional: boolean;
|
|
453
|
+
text?: CustomField.Text;
|
|
454
|
+
/**
|
|
455
|
+
* The type of the field.
|
|
456
|
+
*/
|
|
457
|
+
type: CustomField.Type;
|
|
458
|
+
}
|
|
459
|
+
interface CustomText {
|
|
460
|
+
/**
|
|
461
|
+
* Custom text that should be displayed after the payment confirmation button.
|
|
462
|
+
*/
|
|
463
|
+
after_submit: CustomText.AfterSubmit | null;
|
|
464
|
+
/**
|
|
465
|
+
* Custom text that should be displayed alongside shipping address collection.
|
|
466
|
+
*/
|
|
467
|
+
shipping_address: CustomText.ShippingAddress | null;
|
|
468
|
+
/**
|
|
469
|
+
* Custom text that should be displayed alongside the payment confirmation button.
|
|
470
|
+
*/
|
|
471
|
+
submit: CustomText.Submit | null;
|
|
472
|
+
/**
|
|
473
|
+
* Custom text that should be displayed in place of the default terms of service agreement text.
|
|
474
|
+
*/
|
|
475
|
+
terms_of_service_acceptance: CustomText.TermsOfServiceAcceptance | null;
|
|
476
|
+
}
|
|
477
|
+
type CustomerCreation = 'always' | 'if_required';
|
|
478
|
+
interface CustomerDetails {
|
|
479
|
+
/**
|
|
480
|
+
* The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
|
481
|
+
*/
|
|
482
|
+
address: Address | null;
|
|
483
|
+
/**
|
|
484
|
+
* The customer's business name after a completed Checkout Session.
|
|
485
|
+
*/
|
|
486
|
+
business_name: string | null;
|
|
487
|
+
/**
|
|
488
|
+
* The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
|
|
489
|
+
* Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
|
|
490
|
+
*/
|
|
491
|
+
email: string | null;
|
|
492
|
+
/**
|
|
493
|
+
* The customer's individual name after a completed Checkout Session.
|
|
494
|
+
*/
|
|
495
|
+
individual_name: string | null;
|
|
496
|
+
/**
|
|
497
|
+
* The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
|
498
|
+
*/
|
|
499
|
+
name: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* The customer's phone number after a completed Checkout Session.
|
|
502
|
+
*/
|
|
503
|
+
phone: string | null;
|
|
504
|
+
/**
|
|
505
|
+
* The customer's tax exempt status after a completed Checkout Session.
|
|
506
|
+
*/
|
|
507
|
+
tax_exempt: CustomerDetails.TaxExempt | null;
|
|
508
|
+
/**
|
|
509
|
+
* The customer's tax IDs after a completed Checkout Session.
|
|
510
|
+
*/
|
|
511
|
+
tax_ids: Array<CustomerDetails.TaxId> | null;
|
|
512
|
+
}
|
|
513
|
+
interface Discount {
|
|
514
|
+
/**
|
|
515
|
+
* Coupon attached to the Checkout Session.
|
|
516
|
+
*/
|
|
517
|
+
coupon: string | Coupon | null;
|
|
518
|
+
/**
|
|
519
|
+
* Promotion code attached to the Checkout Session.
|
|
520
|
+
*/
|
|
521
|
+
promotion_code: string | PromotionCode | null;
|
|
522
|
+
}
|
|
523
|
+
interface InvoiceCreation {
|
|
524
|
+
/**
|
|
525
|
+
* Indicates whether invoice creation is enabled for the Checkout Session.
|
|
526
|
+
*/
|
|
527
|
+
enabled: boolean;
|
|
528
|
+
invoice_data: InvoiceCreation.InvoiceData;
|
|
529
|
+
}
|
|
530
|
+
type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-GB' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW';
|
|
531
|
+
interface ManagedPayments {
|
|
532
|
+
/**
|
|
533
|
+
* Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session.
|
|
534
|
+
*/
|
|
535
|
+
enabled: boolean;
|
|
536
|
+
}
|
|
537
|
+
type Mode = 'payment' | 'setup' | 'subscription';
|
|
538
|
+
interface NameCollection {
|
|
539
|
+
business?: NameCollection.Business;
|
|
540
|
+
individual?: NameCollection.Individual;
|
|
541
|
+
}
|
|
542
|
+
interface OptionalItem {
|
|
543
|
+
adjustable_quantity: OptionalItem.AdjustableQuantity | null;
|
|
544
|
+
price: string;
|
|
545
|
+
quantity: number;
|
|
546
|
+
}
|
|
547
|
+
type OriginContext = 'mobile_app' | 'web';
|
|
548
|
+
type PaymentMethodCollection = 'always' | 'if_required';
|
|
549
|
+
interface PaymentMethodConfigurationDetails {
|
|
550
|
+
/**
|
|
551
|
+
* ID of the payment method configuration used.
|
|
552
|
+
*/
|
|
553
|
+
id: string;
|
|
554
|
+
/**
|
|
555
|
+
* ID of the parent payment method configuration used.
|
|
556
|
+
*/
|
|
557
|
+
parent: string | null;
|
|
558
|
+
}
|
|
559
|
+
interface PaymentMethodOptions {
|
|
560
|
+
acss_debit?: PaymentMethodOptions.AcssDebit;
|
|
561
|
+
affirm?: PaymentMethodOptions.Affirm;
|
|
562
|
+
afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
|
|
563
|
+
alipay?: PaymentMethodOptions.Alipay;
|
|
564
|
+
alma?: PaymentMethodOptions.Alma;
|
|
565
|
+
amazon_pay?: PaymentMethodOptions.AmazonPay;
|
|
566
|
+
au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
|
|
567
|
+
bacs_debit?: PaymentMethodOptions.BacsDebit;
|
|
568
|
+
bancontact?: PaymentMethodOptions.Bancontact;
|
|
569
|
+
billie?: PaymentMethodOptions.Billie;
|
|
570
|
+
boleto?: PaymentMethodOptions.Boleto;
|
|
571
|
+
card?: PaymentMethodOptions.Card;
|
|
572
|
+
cashapp?: PaymentMethodOptions.Cashapp;
|
|
573
|
+
customer_balance?: PaymentMethodOptions.CustomerBalance;
|
|
574
|
+
eps?: PaymentMethodOptions.Eps;
|
|
575
|
+
fpx?: PaymentMethodOptions.Fpx;
|
|
576
|
+
giropay?: PaymentMethodOptions.Giropay;
|
|
577
|
+
grabpay?: PaymentMethodOptions.Grabpay;
|
|
578
|
+
ideal?: PaymentMethodOptions.Ideal;
|
|
579
|
+
kakao_pay?: PaymentMethodOptions.KakaoPay;
|
|
580
|
+
klarna?: PaymentMethodOptions.Klarna;
|
|
581
|
+
konbini?: PaymentMethodOptions.Konbini;
|
|
582
|
+
kr_card?: PaymentMethodOptions.KrCard;
|
|
583
|
+
link?: PaymentMethodOptions.Link;
|
|
584
|
+
mobilepay?: PaymentMethodOptions.Mobilepay;
|
|
585
|
+
multibanco?: PaymentMethodOptions.Multibanco;
|
|
586
|
+
naver_pay?: PaymentMethodOptions.NaverPay;
|
|
587
|
+
oxxo?: PaymentMethodOptions.Oxxo;
|
|
588
|
+
p24?: PaymentMethodOptions.P24;
|
|
589
|
+
payco?: PaymentMethodOptions.Payco;
|
|
590
|
+
paynow?: PaymentMethodOptions.Paynow;
|
|
591
|
+
paypal?: PaymentMethodOptions.Paypal;
|
|
592
|
+
payto?: PaymentMethodOptions.Payto;
|
|
593
|
+
pix?: PaymentMethodOptions.Pix;
|
|
594
|
+
revolut_pay?: PaymentMethodOptions.RevolutPay;
|
|
595
|
+
samsung_pay?: PaymentMethodOptions.SamsungPay;
|
|
596
|
+
satispay?: PaymentMethodOptions.Satispay;
|
|
597
|
+
scalapay?: PaymentMethodOptions.Scalapay;
|
|
598
|
+
sepa_debit?: PaymentMethodOptions.SepaDebit;
|
|
599
|
+
sofort?: PaymentMethodOptions.Sofort;
|
|
600
|
+
sunbit?: PaymentMethodOptions.Sunbit;
|
|
601
|
+
swish?: PaymentMethodOptions.Swish;
|
|
602
|
+
twint?: PaymentMethodOptions.Twint;
|
|
603
|
+
upi?: PaymentMethodOptions.Upi;
|
|
604
|
+
us_bank_account?: PaymentMethodOptions.UsBankAccount;
|
|
605
|
+
wechat_pay?: PaymentMethodOptions.WechatPay;
|
|
606
|
+
}
|
|
607
|
+
type PaymentStatus = 'no_payment_required' | 'paid' | 'unpaid';
|
|
608
|
+
interface Permissions {
|
|
609
|
+
/**
|
|
610
|
+
* Determines which entity is allowed to update the shipping details.
|
|
611
|
+
*
|
|
612
|
+
* Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
|
|
613
|
+
*
|
|
614
|
+
* When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
|
|
615
|
+
*/
|
|
616
|
+
update_shipping_details: Permissions.UpdateShippingDetails | null;
|
|
617
|
+
}
|
|
618
|
+
interface PhoneNumberCollection {
|
|
619
|
+
/**
|
|
620
|
+
* Indicates whether phone number collection is enabled for the session
|
|
621
|
+
*/
|
|
622
|
+
enabled: boolean;
|
|
623
|
+
}
|
|
624
|
+
interface PresentmentDetails {
|
|
625
|
+
/**
|
|
626
|
+
* Amount intended to be collected by this payment, denominated in `presentment_currency`.
|
|
627
|
+
*/
|
|
628
|
+
presentment_amount: number;
|
|
629
|
+
/**
|
|
630
|
+
* Currency presented to the customer during payment.
|
|
631
|
+
*/
|
|
632
|
+
presentment_currency: string;
|
|
633
|
+
}
|
|
634
|
+
type RedirectOnCompletion = 'always' | 'if_required' | 'never';
|
|
635
|
+
interface SavedPaymentMethodOptions {
|
|
636
|
+
/**
|
|
637
|
+
* 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.
|
|
638
|
+
*/
|
|
639
|
+
allow_redisplay_filters: Array<SavedPaymentMethodOptions.AllowRedisplayFilter> | null;
|
|
640
|
+
/**
|
|
641
|
+
* Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
|
|
642
|
+
*/
|
|
643
|
+
payment_method_remove: SavedPaymentMethodOptions.PaymentMethodRemove | null;
|
|
644
|
+
/**
|
|
645
|
+
* Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
|
646
|
+
*/
|
|
647
|
+
payment_method_save: SavedPaymentMethodOptions.PaymentMethodSave | null;
|
|
648
|
+
}
|
|
649
|
+
interface ShippingAddressCollection {
|
|
650
|
+
/**
|
|
651
|
+
* An array of two-letter ISO country codes representing which countries Checkout should provide as options for
|
|
652
|
+
* shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
|
|
653
|
+
*/
|
|
654
|
+
allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
|
|
655
|
+
}
|
|
656
|
+
interface ShippingCost {
|
|
657
|
+
/**
|
|
658
|
+
* Total shipping cost before any discounts or taxes are applied.
|
|
659
|
+
*/
|
|
660
|
+
amount_subtotal: number;
|
|
661
|
+
/**
|
|
662
|
+
* Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
|
|
663
|
+
*/
|
|
664
|
+
amount_tax: number;
|
|
665
|
+
/**
|
|
666
|
+
* Total shipping cost after discounts and taxes are applied.
|
|
667
|
+
*/
|
|
668
|
+
amount_total: number;
|
|
669
|
+
/**
|
|
670
|
+
* The ID of the ShippingRate for this order.
|
|
671
|
+
*/
|
|
672
|
+
shipping_rate: string | ShippingRate | null;
|
|
673
|
+
/**
|
|
674
|
+
* The taxes applied to the shipping rate.
|
|
675
|
+
*/
|
|
676
|
+
taxes?: Array<ShippingCost.Tax>;
|
|
677
|
+
}
|
|
678
|
+
interface ShippingOption {
|
|
679
|
+
/**
|
|
680
|
+
* A non-negative integer in cents representing how much to charge.
|
|
681
|
+
*/
|
|
682
|
+
shipping_amount: number;
|
|
683
|
+
/**
|
|
684
|
+
* The shipping rate.
|
|
685
|
+
*/
|
|
686
|
+
shipping_rate: string | ShippingRate;
|
|
687
|
+
}
|
|
688
|
+
type Status = 'complete' | 'expired' | 'open';
|
|
689
|
+
type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
|
|
690
|
+
interface TaxIdCollection {
|
|
691
|
+
/**
|
|
692
|
+
* Indicates whether tax ID collection is enabled for the session
|
|
693
|
+
*/
|
|
694
|
+
enabled: boolean;
|
|
695
|
+
/**
|
|
696
|
+
* Indicates whether a tax ID is required on the payment page
|
|
697
|
+
*/
|
|
698
|
+
required: TaxIdCollection.Required;
|
|
699
|
+
}
|
|
700
|
+
interface TotalDetails {
|
|
701
|
+
/**
|
|
702
|
+
* This is the sum of all the discounts.
|
|
703
|
+
*/
|
|
704
|
+
amount_discount: number;
|
|
705
|
+
/**
|
|
706
|
+
* This is the sum of all the shipping amounts.
|
|
707
|
+
*/
|
|
708
|
+
amount_shipping: number | null;
|
|
709
|
+
/**
|
|
710
|
+
* This is the sum of all the tax amounts.
|
|
711
|
+
*/
|
|
712
|
+
amount_tax: number;
|
|
713
|
+
breakdown?: TotalDetails.Breakdown;
|
|
714
|
+
}
|
|
715
|
+
type UiMode = 'elements' | 'embedded_page' | 'form' | 'hosted_page';
|
|
716
|
+
interface WalletOptions {
|
|
717
|
+
link?: WalletOptions.Link;
|
|
718
|
+
}
|
|
719
|
+
namespace AfterExpiration {
|
|
720
|
+
interface Recovery {
|
|
328
721
|
/**
|
|
329
|
-
*
|
|
722
|
+
* Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
|
|
330
723
|
*/
|
|
331
|
-
|
|
332
|
-
}
|
|
333
|
-
interface AutomaticTax {
|
|
724
|
+
allow_promotion_codes: boolean;
|
|
334
725
|
/**
|
|
335
|
-
*
|
|
726
|
+
* If `true`, a recovery url will be generated to recover this Checkout Session if it
|
|
727
|
+
* expires before a transaction is completed. It will be attached to the
|
|
728
|
+
* Checkout Session object upon expiration.
|
|
336
729
|
*/
|
|
337
730
|
enabled: boolean;
|
|
338
731
|
/**
|
|
339
|
-
* The
|
|
340
|
-
*/
|
|
341
|
-
liability: AutomaticTax.Liability | null;
|
|
342
|
-
/**
|
|
343
|
-
* The tax provider powering automatic tax.
|
|
732
|
+
* The timestamp at which the recovery URL will expire.
|
|
344
733
|
*/
|
|
345
|
-
|
|
734
|
+
expires_at: number | null;
|
|
346
735
|
/**
|
|
347
|
-
*
|
|
736
|
+
* URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
|
|
348
737
|
*/
|
|
349
|
-
|
|
738
|
+
url: string | null;
|
|
350
739
|
}
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
* A hex color value starting with `#` representing the background color for the Checkout Session.
|
|
355
|
-
*/
|
|
356
|
-
background_color: string;
|
|
357
|
-
/**
|
|
358
|
-
* The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
|
|
359
|
-
*/
|
|
360
|
-
border_style: BrandingSettings.BorderStyle;
|
|
740
|
+
}
|
|
741
|
+
namespace AutomaticTax {
|
|
742
|
+
interface Liability {
|
|
361
743
|
/**
|
|
362
|
-
*
|
|
744
|
+
* The connected account being referenced when `type` is `account`.
|
|
363
745
|
*/
|
|
364
|
-
|
|
746
|
+
account?: string | Account;
|
|
365
747
|
/**
|
|
366
|
-
*
|
|
748
|
+
* Type of the account referenced.
|
|
367
749
|
*/
|
|
368
|
-
|
|
750
|
+
type: Liability.Type;
|
|
751
|
+
}
|
|
752
|
+
type Status = 'complete' | 'failed' | 'requires_location_inputs';
|
|
753
|
+
namespace Liability {
|
|
754
|
+
type Type = 'account' | 'self';
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
namespace BrandingSettings {
|
|
758
|
+
type BorderStyle = 'pill' | 'rectangular' | 'rounded';
|
|
759
|
+
interface Icon {
|
|
369
760
|
/**
|
|
370
|
-
* The
|
|
761
|
+
* The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
|
|
371
762
|
*/
|
|
372
|
-
|
|
763
|
+
file?: string;
|
|
373
764
|
/**
|
|
374
|
-
* The
|
|
765
|
+
* The type of image for the icon. Must be one of `file` or `url`.
|
|
375
766
|
*/
|
|
376
|
-
|
|
767
|
+
type: Icon.Type;
|
|
377
768
|
/**
|
|
378
|
-
* The
|
|
769
|
+
* The URL of the image. Present when `type` is `url`.
|
|
379
770
|
*/
|
|
380
|
-
|
|
771
|
+
url?: string;
|
|
381
772
|
}
|
|
382
|
-
interface
|
|
383
|
-
/**
|
|
384
|
-
* Customer's business name for this Checkout Session
|
|
385
|
-
*/
|
|
386
|
-
business_name: string | null;
|
|
773
|
+
interface Logo {
|
|
387
774
|
/**
|
|
388
|
-
*
|
|
775
|
+
* The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
|
|
389
776
|
*/
|
|
390
|
-
|
|
777
|
+
file?: string;
|
|
391
778
|
/**
|
|
392
|
-
*
|
|
779
|
+
* The type of image for the logo. Must be one of `file` or `url`.
|
|
393
780
|
*/
|
|
394
|
-
|
|
781
|
+
type: Logo.Type;
|
|
395
782
|
/**
|
|
396
|
-
*
|
|
783
|
+
* The URL of the image. Present when `type` is `url`.
|
|
397
784
|
*/
|
|
398
|
-
|
|
785
|
+
url?: string;
|
|
786
|
+
}
|
|
787
|
+
namespace Icon {
|
|
788
|
+
type Type = 'file' | 'url';
|
|
789
|
+
}
|
|
790
|
+
namespace Logo {
|
|
791
|
+
type Type = 'file' | 'url';
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
namespace CollectedInformation {
|
|
795
|
+
interface ShippingDetails {
|
|
796
|
+
address: Address;
|
|
399
797
|
/**
|
|
400
|
-
*
|
|
798
|
+
* Customer name.
|
|
401
799
|
*/
|
|
402
|
-
|
|
800
|
+
name: string;
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
namespace Consent {
|
|
804
|
+
type Promotions = 'opt_in' | 'opt_out';
|
|
805
|
+
}
|
|
806
|
+
namespace ConsentCollection {
|
|
807
|
+
interface PaymentMethodReuseAgreement {
|
|
403
808
|
/**
|
|
404
|
-
*
|
|
809
|
+
* Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
|
|
810
|
+
*
|
|
811
|
+
* When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
|
|
405
812
|
*/
|
|
406
|
-
|
|
813
|
+
position: PaymentMethodReuseAgreement.Position;
|
|
814
|
+
}
|
|
815
|
+
type Promotions = 'auto' | 'none';
|
|
816
|
+
type TermsOfService = 'none' | 'required';
|
|
817
|
+
namespace PaymentMethodReuseAgreement {
|
|
818
|
+
type Position = 'auto' | 'hidden';
|
|
407
819
|
}
|
|
408
|
-
|
|
820
|
+
}
|
|
821
|
+
namespace CustomerDetails {
|
|
822
|
+
type TaxExempt = 'exempt' | 'none' | 'reverse';
|
|
823
|
+
interface TaxId {
|
|
409
824
|
/**
|
|
410
|
-
*
|
|
411
|
-
* from the merchant about this Checkout Session.
|
|
825
|
+
* 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`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_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`
|
|
412
826
|
*/
|
|
413
|
-
|
|
827
|
+
type: TaxId.Type;
|
|
414
828
|
/**
|
|
415
|
-
*
|
|
829
|
+
* The value of the tax ID.
|
|
416
830
|
*/
|
|
417
|
-
|
|
831
|
+
value: string | null;
|
|
418
832
|
}
|
|
419
|
-
|
|
833
|
+
namespace TaxId {
|
|
834
|
+
type Type = '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' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_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' | 'pl_nip' | 'py_ruc' | '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' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
835
|
+
}
|
|
836
|
+
}
|
|
837
|
+
namespace CustomField {
|
|
838
|
+
interface Dropdown {
|
|
420
839
|
/**
|
|
421
|
-
*
|
|
840
|
+
* The value that pre-fills on the payment page.
|
|
422
841
|
*/
|
|
423
|
-
|
|
842
|
+
default_value: string | null;
|
|
424
843
|
/**
|
|
425
|
-
*
|
|
426
|
-
* Session will determine whether to display an option to opt into promotional communication
|
|
427
|
-
* from the merchant depending on the customer's locale. Only available to US merchants and US customers.
|
|
844
|
+
* The options available for the customer to select. Up to 200 options allowed.
|
|
428
845
|
*/
|
|
429
|
-
|
|
846
|
+
options: Array<Dropdown.Option>;
|
|
430
847
|
/**
|
|
431
|
-
*
|
|
848
|
+
* The option selected by the customer. This will be the `value` for the option.
|
|
432
849
|
*/
|
|
433
|
-
|
|
850
|
+
value: string | null;
|
|
434
851
|
}
|
|
435
|
-
interface
|
|
436
|
-
/**
|
|
437
|
-
* Total of all items in source currency before discounts or taxes are applied.
|
|
438
|
-
*/
|
|
439
|
-
amount_subtotal: number;
|
|
852
|
+
interface Label {
|
|
440
853
|
/**
|
|
441
|
-
*
|
|
854
|
+
* Custom text for the label, displayed to the customer. Up to 50 characters.
|
|
442
855
|
*/
|
|
443
|
-
|
|
856
|
+
custom: string | null;
|
|
444
857
|
/**
|
|
445
|
-
*
|
|
858
|
+
* The type of the label.
|
|
446
859
|
*/
|
|
447
|
-
|
|
860
|
+
type: 'custom';
|
|
861
|
+
}
|
|
862
|
+
interface Numeric {
|
|
448
863
|
/**
|
|
449
|
-
*
|
|
864
|
+
* The value that pre-fills the field on the payment page.
|
|
450
865
|
*/
|
|
451
|
-
|
|
452
|
-
}
|
|
453
|
-
interface CustomField {
|
|
454
|
-
dropdown?: CustomField.Dropdown;
|
|
866
|
+
default_value: string | null;
|
|
455
867
|
/**
|
|
456
|
-
*
|
|
868
|
+
* The maximum character length constraint for the customer's input.
|
|
457
869
|
*/
|
|
458
|
-
|
|
459
|
-
label: CustomField.Label;
|
|
460
|
-
numeric?: CustomField.Numeric;
|
|
870
|
+
maximum_length: number | null;
|
|
461
871
|
/**
|
|
462
|
-
*
|
|
872
|
+
* The minimum character length requirement for the customer's input.
|
|
463
873
|
*/
|
|
464
|
-
|
|
465
|
-
text?: CustomField.Text;
|
|
874
|
+
minimum_length: number | null;
|
|
466
875
|
/**
|
|
467
|
-
* The
|
|
876
|
+
* The value entered by the customer, containing only digits.
|
|
468
877
|
*/
|
|
469
|
-
|
|
878
|
+
value: string | null;
|
|
470
879
|
}
|
|
471
|
-
interface
|
|
880
|
+
interface Text {
|
|
472
881
|
/**
|
|
473
|
-
*
|
|
882
|
+
* The value that pre-fills the field on the payment page.
|
|
474
883
|
*/
|
|
475
|
-
|
|
884
|
+
default_value: string | null;
|
|
476
885
|
/**
|
|
477
|
-
*
|
|
886
|
+
* The maximum character length constraint for the customer's input.
|
|
478
887
|
*/
|
|
479
|
-
|
|
888
|
+
maximum_length: number | null;
|
|
480
889
|
/**
|
|
481
|
-
*
|
|
890
|
+
* The minimum character length requirement for the customer's input.
|
|
482
891
|
*/
|
|
483
|
-
|
|
892
|
+
minimum_length: number | null;
|
|
484
893
|
/**
|
|
485
|
-
*
|
|
894
|
+
* The value entered by the customer.
|
|
486
895
|
*/
|
|
487
|
-
|
|
896
|
+
value: string | null;
|
|
488
897
|
}
|
|
489
|
-
type
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
898
|
+
type Type = 'dropdown' | 'numeric' | 'text';
|
|
899
|
+
namespace Dropdown {
|
|
900
|
+
interface Option {
|
|
901
|
+
/**
|
|
902
|
+
* The label for the option, displayed to the customer. Up to 100 characters.
|
|
903
|
+
*/
|
|
904
|
+
label: string;
|
|
905
|
+
/**
|
|
906
|
+
* The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
|
|
907
|
+
*/
|
|
908
|
+
value: string;
|
|
909
|
+
}
|
|
910
|
+
}
|
|
911
|
+
}
|
|
912
|
+
namespace CustomText {
|
|
913
|
+
interface AfterSubmit {
|
|
495
914
|
/**
|
|
496
|
-
*
|
|
915
|
+
* Text can be up to 1200 characters in length.
|
|
497
916
|
*/
|
|
498
|
-
|
|
917
|
+
message: string;
|
|
918
|
+
}
|
|
919
|
+
interface ShippingAddress {
|
|
499
920
|
/**
|
|
500
|
-
*
|
|
501
|
-
* Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
|
|
921
|
+
* Text can be up to 1200 characters in length.
|
|
502
922
|
*/
|
|
503
|
-
|
|
923
|
+
message: string;
|
|
924
|
+
}
|
|
925
|
+
interface Submit {
|
|
504
926
|
/**
|
|
505
|
-
*
|
|
927
|
+
* Text can be up to 1200 characters in length.
|
|
506
928
|
*/
|
|
507
|
-
|
|
929
|
+
message: string;
|
|
930
|
+
}
|
|
931
|
+
interface TermsOfServiceAcceptance {
|
|
508
932
|
/**
|
|
509
|
-
*
|
|
933
|
+
* Text can be up to 1200 characters in length.
|
|
510
934
|
*/
|
|
511
|
-
|
|
935
|
+
message: string;
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
namespace InvoiceCreation {
|
|
939
|
+
interface InvoiceData {
|
|
512
940
|
/**
|
|
513
|
-
* The
|
|
941
|
+
* The account tax IDs associated with the invoice.
|
|
514
942
|
*/
|
|
515
|
-
|
|
943
|
+
account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
|
|
516
944
|
/**
|
|
517
|
-
*
|
|
945
|
+
* Custom fields displayed on the invoice.
|
|
518
946
|
*/
|
|
519
|
-
|
|
947
|
+
custom_fields: Array<InvoiceData.CustomField> | null;
|
|
520
948
|
/**
|
|
521
|
-
*
|
|
949
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
522
950
|
*/
|
|
523
|
-
|
|
524
|
-
}
|
|
525
|
-
interface Discount {
|
|
951
|
+
description: string | null;
|
|
526
952
|
/**
|
|
527
|
-
*
|
|
953
|
+
* Footer displayed on the invoice.
|
|
528
954
|
*/
|
|
529
|
-
|
|
955
|
+
footer: string | null;
|
|
530
956
|
/**
|
|
531
|
-
*
|
|
957
|
+
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
532
958
|
*/
|
|
533
|
-
|
|
534
|
-
}
|
|
535
|
-
interface InvoiceCreation {
|
|
959
|
+
issuer: InvoiceData.Issuer | null;
|
|
536
960
|
/**
|
|
537
|
-
*
|
|
961
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
538
962
|
*/
|
|
539
|
-
|
|
540
|
-
invoice_data: InvoiceCreation.InvoiceData;
|
|
541
|
-
}
|
|
542
|
-
type Locale = 'auto' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'en-GB' | 'es' | 'es-419' | 'et' | 'fi' | 'fil' | 'fr' | 'fr-CA' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lt' | 'lv' | 'ms' | 'mt' | 'nb' | 'nl' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv' | 'th' | 'tr' | 'vi' | 'zh' | 'zh-HK' | 'zh-TW';
|
|
543
|
-
interface ManagedPayments {
|
|
963
|
+
metadata: Metadata | null;
|
|
544
964
|
/**
|
|
545
|
-
*
|
|
965
|
+
* Options for invoice PDF rendering.
|
|
546
966
|
*/
|
|
547
|
-
|
|
967
|
+
rendering_options: InvoiceData.RenderingOptions | null;
|
|
548
968
|
}
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
969
|
+
namespace InvoiceData {
|
|
970
|
+
interface CustomField {
|
|
971
|
+
/**
|
|
972
|
+
* The name of the custom field.
|
|
973
|
+
*/
|
|
974
|
+
name: string;
|
|
975
|
+
/**
|
|
976
|
+
* The value of the custom field.
|
|
977
|
+
*/
|
|
978
|
+
value: string;
|
|
979
|
+
}
|
|
980
|
+
interface Issuer {
|
|
981
|
+
/**
|
|
982
|
+
* The connected account being referenced when `type` is `account`.
|
|
983
|
+
*/
|
|
984
|
+
account?: string | Account;
|
|
985
|
+
/**
|
|
986
|
+
* Type of the account referenced.
|
|
987
|
+
*/
|
|
988
|
+
type: Issuer.Type;
|
|
989
|
+
}
|
|
990
|
+
interface RenderingOptions {
|
|
991
|
+
/**
|
|
992
|
+
* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
|
|
993
|
+
*/
|
|
994
|
+
amount_tax_display: string | null;
|
|
995
|
+
/**
|
|
996
|
+
* ID of the invoice rendering template to be used for the generated invoice.
|
|
997
|
+
*/
|
|
998
|
+
template: string | null;
|
|
999
|
+
}
|
|
1000
|
+
namespace Issuer {
|
|
1001
|
+
type Type = 'account' | 'self';
|
|
1002
|
+
}
|
|
553
1003
|
}
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
1004
|
+
}
|
|
1005
|
+
namespace NameCollection {
|
|
1006
|
+
interface Business {
|
|
1007
|
+
/**
|
|
1008
|
+
* Indicates whether business name collection is enabled for the session
|
|
1009
|
+
*/
|
|
1010
|
+
enabled: boolean;
|
|
1011
|
+
/**
|
|
1012
|
+
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
1013
|
+
*/
|
|
1014
|
+
optional: boolean;
|
|
558
1015
|
}
|
|
559
|
-
|
|
560
|
-
type PaymentMethodCollection = 'always' | 'if_required';
|
|
561
|
-
interface PaymentMethodConfigurationDetails {
|
|
1016
|
+
interface Individual {
|
|
562
1017
|
/**
|
|
563
|
-
*
|
|
1018
|
+
* Indicates whether individual name collection is enabled for the session
|
|
564
1019
|
*/
|
|
565
|
-
|
|
1020
|
+
enabled: boolean;
|
|
566
1021
|
/**
|
|
567
|
-
*
|
|
1022
|
+
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
568
1023
|
*/
|
|
569
|
-
|
|
1024
|
+
optional: boolean;
|
|
570
1025
|
}
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
eps?: PaymentMethodOptions.Eps;
|
|
587
|
-
fpx?: PaymentMethodOptions.Fpx;
|
|
588
|
-
giropay?: PaymentMethodOptions.Giropay;
|
|
589
|
-
grabpay?: PaymentMethodOptions.Grabpay;
|
|
590
|
-
ideal?: PaymentMethodOptions.Ideal;
|
|
591
|
-
kakao_pay?: PaymentMethodOptions.KakaoPay;
|
|
592
|
-
klarna?: PaymentMethodOptions.Klarna;
|
|
593
|
-
konbini?: PaymentMethodOptions.Konbini;
|
|
594
|
-
kr_card?: PaymentMethodOptions.KrCard;
|
|
595
|
-
link?: PaymentMethodOptions.Link;
|
|
596
|
-
mobilepay?: PaymentMethodOptions.Mobilepay;
|
|
597
|
-
multibanco?: PaymentMethodOptions.Multibanco;
|
|
598
|
-
naver_pay?: PaymentMethodOptions.NaverPay;
|
|
599
|
-
oxxo?: PaymentMethodOptions.Oxxo;
|
|
600
|
-
p24?: PaymentMethodOptions.P24;
|
|
601
|
-
payco?: PaymentMethodOptions.Payco;
|
|
602
|
-
paynow?: PaymentMethodOptions.Paynow;
|
|
603
|
-
paypal?: PaymentMethodOptions.Paypal;
|
|
604
|
-
payto?: PaymentMethodOptions.Payto;
|
|
605
|
-
pix?: PaymentMethodOptions.Pix;
|
|
606
|
-
revolut_pay?: PaymentMethodOptions.RevolutPay;
|
|
607
|
-
samsung_pay?: PaymentMethodOptions.SamsungPay;
|
|
608
|
-
satispay?: PaymentMethodOptions.Satispay;
|
|
609
|
-
scalapay?: PaymentMethodOptions.Scalapay;
|
|
610
|
-
sepa_debit?: PaymentMethodOptions.SepaDebit;
|
|
611
|
-
sofort?: PaymentMethodOptions.Sofort;
|
|
612
|
-
swish?: PaymentMethodOptions.Swish;
|
|
613
|
-
twint?: PaymentMethodOptions.Twint;
|
|
614
|
-
upi?: PaymentMethodOptions.Upi;
|
|
615
|
-
us_bank_account?: PaymentMethodOptions.UsBankAccount;
|
|
1026
|
+
}
|
|
1027
|
+
namespace OptionalItem {
|
|
1028
|
+
interface AdjustableQuantity {
|
|
1029
|
+
/**
|
|
1030
|
+
* Set to true if the quantity can be adjusted to any non-negative integer.
|
|
1031
|
+
*/
|
|
1032
|
+
enabled: boolean;
|
|
1033
|
+
/**
|
|
1034
|
+
* The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
|
|
1035
|
+
*/
|
|
1036
|
+
maximum: number | null;
|
|
1037
|
+
/**
|
|
1038
|
+
* The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
|
|
1039
|
+
*/
|
|
1040
|
+
minimum: number | null;
|
|
616
1041
|
}
|
|
617
|
-
|
|
618
|
-
|
|
1042
|
+
}
|
|
1043
|
+
namespace PaymentMethodOptions {
|
|
1044
|
+
interface AcssDebit {
|
|
619
1045
|
/**
|
|
620
|
-
*
|
|
1046
|
+
* Currency supported by the bank account. Returned when the Session is in `setup` mode.
|
|
621
1047
|
*/
|
|
622
|
-
|
|
1048
|
+
currency?: AcssDebit.Currency;
|
|
1049
|
+
mandate_options?: AcssDebit.MandateOptions;
|
|
623
1050
|
/**
|
|
624
|
-
*
|
|
1051
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
625
1052
|
*
|
|
626
|
-
*
|
|
1053
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
627
1054
|
*
|
|
628
|
-
*
|
|
1055
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1056
|
+
*
|
|
1057
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
629
1058
|
*/
|
|
630
|
-
|
|
1059
|
+
setup_future_usage?: AcssDebit.SetupFutureUsage;
|
|
631
1060
|
/**
|
|
632
|
-
*
|
|
1061
|
+
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1062
|
+
*/
|
|
1063
|
+
target_date?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* Bank account verification method. The default value is `automatic`.
|
|
1066
|
+
*/
|
|
1067
|
+
verification_method?: AcssDebit.VerificationMethod;
|
|
1068
|
+
}
|
|
1069
|
+
interface Affirm {
|
|
1070
|
+
/**
|
|
1071
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1072
|
+
*/
|
|
1073
|
+
capture_method?: 'manual';
|
|
1074
|
+
/**
|
|
1075
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
633
1076
|
*
|
|
634
|
-
*
|
|
1077
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
635
1078
|
*
|
|
636
|
-
*
|
|
1079
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1080
|
+
*
|
|
1081
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
637
1082
|
*/
|
|
638
|
-
|
|
1083
|
+
setup_future_usage?: 'none';
|
|
639
1084
|
}
|
|
640
|
-
interface
|
|
1085
|
+
interface AfterpayClearpay {
|
|
641
1086
|
/**
|
|
642
|
-
*
|
|
1087
|
+
* Controls when the funds will be captured from the customer's account.
|
|
643
1088
|
*/
|
|
644
|
-
|
|
1089
|
+
capture_method?: 'manual';
|
|
1090
|
+
/**
|
|
1091
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1092
|
+
*
|
|
1093
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1094
|
+
*
|
|
1095
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1096
|
+
*
|
|
1097
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1098
|
+
*/
|
|
1099
|
+
setup_future_usage?: 'none';
|
|
645
1100
|
}
|
|
646
|
-
interface
|
|
1101
|
+
interface Alipay {
|
|
647
1102
|
/**
|
|
648
|
-
*
|
|
1103
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1104
|
+
*
|
|
1105
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1106
|
+
*
|
|
1107
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1108
|
+
*
|
|
1109
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
649
1110
|
*/
|
|
650
|
-
|
|
1111
|
+
setup_future_usage?: 'none';
|
|
1112
|
+
}
|
|
1113
|
+
interface Alma {
|
|
651
1114
|
/**
|
|
652
|
-
*
|
|
1115
|
+
* Controls when the funds will be captured from the customer's account.
|
|
653
1116
|
*/
|
|
654
|
-
|
|
1117
|
+
capture_method?: 'manual';
|
|
655
1118
|
}
|
|
656
|
-
|
|
657
|
-
interface SavedPaymentMethodOptions {
|
|
1119
|
+
interface AmazonPay {
|
|
658
1120
|
/**
|
|
659
|
-
*
|
|
1121
|
+
* Controls when the funds will be captured from the customer's account.
|
|
660
1122
|
*/
|
|
661
|
-
|
|
1123
|
+
capture_method?: 'manual';
|
|
662
1124
|
/**
|
|
663
|
-
*
|
|
1125
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1126
|
+
*
|
|
1127
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1128
|
+
*
|
|
1129
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1130
|
+
*
|
|
1131
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
664
1132
|
*/
|
|
665
|
-
|
|
1133
|
+
setup_future_usage?: AmazonPay.SetupFutureUsage;
|
|
1134
|
+
}
|
|
1135
|
+
interface AuBecsDebit {
|
|
666
1136
|
/**
|
|
667
|
-
*
|
|
1137
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1138
|
+
*
|
|
1139
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1140
|
+
*
|
|
1141
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1142
|
+
*
|
|
1143
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1144
|
+
*/
|
|
1145
|
+
setup_future_usage?: 'none';
|
|
1146
|
+
/**
|
|
1147
|
+
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
668
1148
|
*/
|
|
669
|
-
|
|
1149
|
+
target_date?: string;
|
|
670
1150
|
}
|
|
671
|
-
interface
|
|
1151
|
+
interface BacsDebit {
|
|
1152
|
+
mandate_options?: BacsDebit.MandateOptions;
|
|
672
1153
|
/**
|
|
673
|
-
*
|
|
674
|
-
*
|
|
1154
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1155
|
+
*
|
|
1156
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1157
|
+
*
|
|
1158
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1159
|
+
*
|
|
1160
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
675
1161
|
*/
|
|
676
|
-
|
|
1162
|
+
setup_future_usage?: BacsDebit.SetupFutureUsage;
|
|
1163
|
+
/**
|
|
1164
|
+
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1165
|
+
*/
|
|
1166
|
+
target_date?: string;
|
|
1167
|
+
}
|
|
1168
|
+
interface Bancontact {
|
|
1169
|
+
/**
|
|
1170
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1171
|
+
*
|
|
1172
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1173
|
+
*
|
|
1174
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1175
|
+
*
|
|
1176
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1177
|
+
*/
|
|
1178
|
+
setup_future_usage?: 'none';
|
|
1179
|
+
}
|
|
1180
|
+
interface Billie {
|
|
1181
|
+
/**
|
|
1182
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1183
|
+
*/
|
|
1184
|
+
capture_method?: 'manual';
|
|
1185
|
+
}
|
|
1186
|
+
interface Boleto {
|
|
1187
|
+
/**
|
|
1188
|
+
* The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
|
|
1189
|
+
*/
|
|
1190
|
+
expires_after_days: number;
|
|
1191
|
+
/**
|
|
1192
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1193
|
+
*
|
|
1194
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1195
|
+
*
|
|
1196
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1197
|
+
*
|
|
1198
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1199
|
+
*/
|
|
1200
|
+
setup_future_usage?: Boleto.SetupFutureUsage;
|
|
677
1201
|
}
|
|
678
|
-
interface
|
|
1202
|
+
interface Card {
|
|
1203
|
+
/**
|
|
1204
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1205
|
+
*/
|
|
1206
|
+
capture_method?: 'manual';
|
|
1207
|
+
installments?: Card.Installments;
|
|
1208
|
+
/**
|
|
1209
|
+
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
1210
|
+
*/
|
|
1211
|
+
request_extended_authorization?: Card.RequestExtendedAuthorization;
|
|
1212
|
+
/**
|
|
1213
|
+
* Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this CheckoutSession.
|
|
1214
|
+
*/
|
|
1215
|
+
request_incremental_authorization?: Card.RequestIncrementalAuthorization;
|
|
1216
|
+
/**
|
|
1217
|
+
* Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this CheckoutSession.
|
|
1218
|
+
*/
|
|
1219
|
+
request_multicapture?: Card.RequestMulticapture;
|
|
679
1220
|
/**
|
|
680
|
-
*
|
|
1221
|
+
* Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this CheckoutSession.
|
|
681
1222
|
*/
|
|
682
|
-
|
|
1223
|
+
request_overcapture?: Card.RequestOvercapture;
|
|
683
1224
|
/**
|
|
684
|
-
*
|
|
1225
|
+
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). 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](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
685
1226
|
*/
|
|
686
|
-
|
|
1227
|
+
request_three_d_secure: Card.RequestThreeDSecure;
|
|
1228
|
+
restrictions?: Card.Restrictions;
|
|
687
1229
|
/**
|
|
688
|
-
*
|
|
1230
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1231
|
+
*
|
|
1232
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1233
|
+
*
|
|
1234
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1235
|
+
*
|
|
1236
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
689
1237
|
*/
|
|
690
|
-
|
|
1238
|
+
setup_future_usage?: Card.SetupFutureUsage;
|
|
691
1239
|
/**
|
|
692
|
-
*
|
|
1240
|
+
* Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
|
|
693
1241
|
*/
|
|
694
|
-
|
|
1242
|
+
statement_descriptor_suffix_kana?: string;
|
|
695
1243
|
/**
|
|
696
|
-
*
|
|
1244
|
+
* Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
|
697
1245
|
*/
|
|
698
|
-
|
|
1246
|
+
statement_descriptor_suffix_kanji?: string;
|
|
699
1247
|
}
|
|
700
|
-
interface
|
|
1248
|
+
interface Cashapp {
|
|
701
1249
|
/**
|
|
702
|
-
*
|
|
1250
|
+
* Controls when the funds will be captured from the customer's account.
|
|
703
1251
|
*/
|
|
704
|
-
|
|
1252
|
+
capture_method?: 'manual';
|
|
705
1253
|
/**
|
|
706
|
-
*
|
|
1254
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1255
|
+
*
|
|
1256
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1257
|
+
*
|
|
1258
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1259
|
+
*
|
|
1260
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
707
1261
|
*/
|
|
708
|
-
|
|
1262
|
+
setup_future_usage?: 'none';
|
|
709
1263
|
}
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
interface TaxIdCollection {
|
|
1264
|
+
interface CustomerBalance {
|
|
1265
|
+
bank_transfer?: CustomerBalance.BankTransfer;
|
|
713
1266
|
/**
|
|
714
|
-
*
|
|
1267
|
+
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
|
715
1268
|
*/
|
|
716
|
-
|
|
1269
|
+
funding_type: 'bank_transfer' | null;
|
|
717
1270
|
/**
|
|
718
|
-
* Indicates
|
|
1271
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1272
|
+
*
|
|
1273
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1274
|
+
*
|
|
1275
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1276
|
+
*
|
|
1277
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
719
1278
|
*/
|
|
720
|
-
|
|
1279
|
+
setup_future_usage?: 'none';
|
|
721
1280
|
}
|
|
722
|
-
interface
|
|
1281
|
+
interface Eps {
|
|
723
1282
|
/**
|
|
724
|
-
*
|
|
1283
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1284
|
+
*
|
|
1285
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1286
|
+
*
|
|
1287
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1288
|
+
*
|
|
1289
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
725
1290
|
*/
|
|
726
|
-
|
|
1291
|
+
setup_future_usage?: 'none';
|
|
1292
|
+
}
|
|
1293
|
+
interface Fpx {
|
|
727
1294
|
/**
|
|
728
|
-
*
|
|
1295
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1296
|
+
*
|
|
1297
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1298
|
+
*
|
|
1299
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1300
|
+
*
|
|
1301
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
729
1302
|
*/
|
|
730
|
-
|
|
1303
|
+
setup_future_usage?: 'none';
|
|
1304
|
+
}
|
|
1305
|
+
interface Giropay {
|
|
731
1306
|
/**
|
|
732
|
-
*
|
|
1307
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1308
|
+
*
|
|
1309
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1310
|
+
*
|
|
1311
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1312
|
+
*
|
|
1313
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
733
1314
|
*/
|
|
734
|
-
|
|
735
|
-
breakdown?: TotalDetails.Breakdown;
|
|
1315
|
+
setup_future_usage?: 'none';
|
|
736
1316
|
}
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
1317
|
+
interface Grabpay {
|
|
1318
|
+
/**
|
|
1319
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1320
|
+
*
|
|
1321
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1322
|
+
*
|
|
1323
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1324
|
+
*
|
|
1325
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1326
|
+
*/
|
|
1327
|
+
setup_future_usage?: 'none';
|
|
740
1328
|
}
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
enabled: boolean;
|
|
753
|
-
/**
|
|
754
|
-
* The timestamp at which the recovery URL will expire.
|
|
755
|
-
*/
|
|
756
|
-
expires_at: number | null;
|
|
757
|
-
/**
|
|
758
|
-
* URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
|
|
759
|
-
*/
|
|
760
|
-
url: string | null;
|
|
761
|
-
}
|
|
1329
|
+
interface Ideal {
|
|
1330
|
+
/**
|
|
1331
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1332
|
+
*
|
|
1333
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1334
|
+
*
|
|
1335
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1336
|
+
*
|
|
1337
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1338
|
+
*/
|
|
1339
|
+
setup_future_usage?: 'none';
|
|
762
1340
|
}
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
1341
|
+
interface KakaoPay {
|
|
1342
|
+
/**
|
|
1343
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1344
|
+
*/
|
|
1345
|
+
capture_method?: 'manual';
|
|
1346
|
+
/**
|
|
1347
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1348
|
+
*
|
|
1349
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1350
|
+
*
|
|
1351
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1352
|
+
*
|
|
1353
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1354
|
+
*/
|
|
1355
|
+
setup_future_usage?: KakaoPay.SetupFutureUsage;
|
|
778
1356
|
}
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
1357
|
+
interface Klarna {
|
|
1358
|
+
/**
|
|
1359
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1360
|
+
*/
|
|
1361
|
+
capture_method?: 'manual';
|
|
1362
|
+
/**
|
|
1363
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1364
|
+
*
|
|
1365
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1366
|
+
*
|
|
1367
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1368
|
+
*
|
|
1369
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1370
|
+
*/
|
|
1371
|
+
setup_future_usage?: Klarna.SetupFutureUsage;
|
|
1372
|
+
}
|
|
1373
|
+
interface Konbini {
|
|
1374
|
+
/**
|
|
1375
|
+
* The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
|
|
1376
|
+
*/
|
|
1377
|
+
expires_after_days: number | null;
|
|
1378
|
+
/**
|
|
1379
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1380
|
+
*
|
|
1381
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1382
|
+
*
|
|
1383
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1384
|
+
*
|
|
1385
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1386
|
+
*/
|
|
1387
|
+
setup_future_usage?: 'none';
|
|
1388
|
+
}
|
|
1389
|
+
interface KrCard {
|
|
1390
|
+
/**
|
|
1391
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1392
|
+
*/
|
|
1393
|
+
capture_method?: 'manual';
|
|
1394
|
+
/**
|
|
1395
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1396
|
+
*
|
|
1397
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1398
|
+
*
|
|
1399
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1400
|
+
*
|
|
1401
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1402
|
+
*/
|
|
1403
|
+
setup_future_usage?: KrCard.SetupFutureUsage;
|
|
1404
|
+
}
|
|
1405
|
+
interface Link {
|
|
1406
|
+
/**
|
|
1407
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1408
|
+
*/
|
|
1409
|
+
capture_method?: 'manual';
|
|
1410
|
+
/**
|
|
1411
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1412
|
+
*
|
|
1413
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1414
|
+
*
|
|
1415
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1416
|
+
*
|
|
1417
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1418
|
+
*/
|
|
1419
|
+
setup_future_usage?: Link.SetupFutureUsage;
|
|
1420
|
+
}
|
|
1421
|
+
interface Mobilepay {
|
|
1422
|
+
/**
|
|
1423
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1424
|
+
*/
|
|
1425
|
+
capture_method?: 'manual';
|
|
1426
|
+
/**
|
|
1427
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1428
|
+
*
|
|
1429
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1430
|
+
*
|
|
1431
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1432
|
+
*
|
|
1433
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1434
|
+
*/
|
|
1435
|
+
setup_future_usage?: 'none';
|
|
1436
|
+
}
|
|
1437
|
+
interface Multibanco {
|
|
1438
|
+
/**
|
|
1439
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1440
|
+
*
|
|
1441
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1442
|
+
*
|
|
1443
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1444
|
+
*
|
|
1445
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1446
|
+
*/
|
|
1447
|
+
setup_future_usage?: 'none';
|
|
1448
|
+
}
|
|
1449
|
+
interface NaverPay {
|
|
1450
|
+
/**
|
|
1451
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1452
|
+
*/
|
|
1453
|
+
capture_method?: 'manual';
|
|
1454
|
+
/**
|
|
1455
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1456
|
+
*
|
|
1457
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1458
|
+
*
|
|
1459
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1460
|
+
*
|
|
1461
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1462
|
+
*/
|
|
1463
|
+
setup_future_usage?: NaverPay.SetupFutureUsage;
|
|
1464
|
+
}
|
|
1465
|
+
interface Oxxo {
|
|
1466
|
+
/**
|
|
1467
|
+
* The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
|
|
1468
|
+
*/
|
|
1469
|
+
expires_after_days: number;
|
|
1470
|
+
/**
|
|
1471
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1472
|
+
*
|
|
1473
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1474
|
+
*
|
|
1475
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1476
|
+
*
|
|
1477
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1478
|
+
*/
|
|
1479
|
+
setup_future_usage?: 'none';
|
|
1480
|
+
}
|
|
1481
|
+
interface P24 {
|
|
1482
|
+
/**
|
|
1483
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1484
|
+
*
|
|
1485
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1486
|
+
*
|
|
1487
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1488
|
+
*
|
|
1489
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1490
|
+
*/
|
|
1491
|
+
setup_future_usage?: 'none';
|
|
1492
|
+
}
|
|
1493
|
+
interface Payco {
|
|
1494
|
+
/**
|
|
1495
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1496
|
+
*/
|
|
1497
|
+
capture_method?: 'manual';
|
|
1498
|
+
}
|
|
1499
|
+
interface Paynow {
|
|
1500
|
+
/**
|
|
1501
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1502
|
+
*
|
|
1503
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1504
|
+
*
|
|
1505
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1506
|
+
*
|
|
1507
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1508
|
+
*/
|
|
1509
|
+
setup_future_usage?: 'none';
|
|
1510
|
+
}
|
|
1511
|
+
interface Paypal {
|
|
1512
|
+
/**
|
|
1513
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1514
|
+
*/
|
|
1515
|
+
capture_method?: 'manual';
|
|
1516
|
+
/**
|
|
1517
|
+
* Preferred locale of the PayPal checkout page that the customer is redirected to.
|
|
1518
|
+
*/
|
|
1519
|
+
preferred_locale: string | null;
|
|
1520
|
+
/**
|
|
1521
|
+
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
|
1522
|
+
*/
|
|
1523
|
+
reference: string | null;
|
|
1524
|
+
/**
|
|
1525
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1526
|
+
*
|
|
1527
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1528
|
+
*
|
|
1529
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1530
|
+
*
|
|
1531
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1532
|
+
*/
|
|
1533
|
+
setup_future_usage?: Paypal.SetupFutureUsage;
|
|
1534
|
+
}
|
|
1535
|
+
interface Payto {
|
|
1536
|
+
mandate_options?: Payto.MandateOptions;
|
|
1537
|
+
/**
|
|
1538
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1539
|
+
*
|
|
1540
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1541
|
+
*
|
|
1542
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1543
|
+
*
|
|
1544
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1545
|
+
*/
|
|
1546
|
+
setup_future_usage?: Payto.SetupFutureUsage;
|
|
1547
|
+
}
|
|
1548
|
+
interface Pix {
|
|
1549
|
+
/**
|
|
1550
|
+
* Determines if the amount includes the IOF tax.
|
|
1551
|
+
*/
|
|
1552
|
+
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
1553
|
+
/**
|
|
1554
|
+
* The number of seconds after which Pix payment will expire.
|
|
1555
|
+
*/
|
|
1556
|
+
expires_after_seconds: number | null;
|
|
1557
|
+
mandate_options?: Pix.MandateOptions;
|
|
1558
|
+
/**
|
|
1559
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1560
|
+
*
|
|
1561
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1562
|
+
*
|
|
1563
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1564
|
+
*
|
|
1565
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1566
|
+
*/
|
|
1567
|
+
setup_future_usage?: Pix.SetupFutureUsage;
|
|
1568
|
+
}
|
|
1569
|
+
interface RevolutPay {
|
|
1570
|
+
/**
|
|
1571
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1572
|
+
*/
|
|
1573
|
+
capture_method?: 'manual';
|
|
1574
|
+
/**
|
|
1575
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1576
|
+
*
|
|
1577
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1578
|
+
*
|
|
1579
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1580
|
+
*
|
|
1581
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1582
|
+
*/
|
|
1583
|
+
setup_future_usage?: RevolutPay.SetupFutureUsage;
|
|
1584
|
+
}
|
|
1585
|
+
interface SamsungPay {
|
|
1586
|
+
/**
|
|
1587
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1588
|
+
*/
|
|
1589
|
+
capture_method?: 'manual';
|
|
1590
|
+
}
|
|
1591
|
+
interface Satispay {
|
|
1592
|
+
/**
|
|
1593
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1594
|
+
*/
|
|
1595
|
+
capture_method?: 'manual';
|
|
1596
|
+
}
|
|
1597
|
+
interface Scalapay {
|
|
1598
|
+
/**
|
|
1599
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1600
|
+
*/
|
|
1601
|
+
capture_method?: 'manual';
|
|
1602
|
+
}
|
|
1603
|
+
interface SepaDebit {
|
|
1604
|
+
mandate_options?: SepaDebit.MandateOptions;
|
|
1605
|
+
/**
|
|
1606
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1607
|
+
*
|
|
1608
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1609
|
+
*
|
|
1610
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1611
|
+
*
|
|
1612
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1613
|
+
*/
|
|
1614
|
+
setup_future_usage?: SepaDebit.SetupFutureUsage;
|
|
1615
|
+
/**
|
|
1616
|
+
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1617
|
+
*/
|
|
1618
|
+
target_date?: string;
|
|
1619
|
+
}
|
|
1620
|
+
interface Sofort {
|
|
1621
|
+
/**
|
|
1622
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1623
|
+
*
|
|
1624
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1625
|
+
*
|
|
1626
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1627
|
+
*
|
|
1628
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1629
|
+
*/
|
|
1630
|
+
setup_future_usage?: 'none';
|
|
1631
|
+
}
|
|
1632
|
+
interface Sunbit {
|
|
1633
|
+
/**
|
|
1634
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1635
|
+
*/
|
|
1636
|
+
capture_method?: 'manual';
|
|
1637
|
+
/**
|
|
1638
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1639
|
+
*
|
|
1640
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1641
|
+
*
|
|
1642
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1643
|
+
*
|
|
1644
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1645
|
+
*/
|
|
1646
|
+
setup_future_usage?: 'none';
|
|
1647
|
+
}
|
|
1648
|
+
interface Swish {
|
|
1649
|
+
/**
|
|
1650
|
+
* The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
|
|
1651
|
+
*/
|
|
1652
|
+
reference: string | null;
|
|
1653
|
+
}
|
|
1654
|
+
interface Twint {
|
|
1655
|
+
/**
|
|
1656
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1657
|
+
*
|
|
1658
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1659
|
+
*
|
|
1660
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1661
|
+
*
|
|
1662
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1663
|
+
*/
|
|
1664
|
+
setup_future_usage?: Twint.SetupFutureUsage;
|
|
1665
|
+
}
|
|
1666
|
+
interface Upi {
|
|
1667
|
+
mandate_options?: Upi.MandateOptions;
|
|
1668
|
+
/**
|
|
1669
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1670
|
+
*
|
|
1671
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1672
|
+
*
|
|
1673
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1674
|
+
*
|
|
1675
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1676
|
+
*/
|
|
1677
|
+
setup_future_usage?: Upi.SetupFutureUsage;
|
|
1678
|
+
}
|
|
1679
|
+
interface UsBankAccount {
|
|
1680
|
+
financial_connections?: UsBankAccount.FinancialConnections;
|
|
1681
|
+
/**
|
|
1682
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1683
|
+
*
|
|
1684
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1685
|
+
*
|
|
1686
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1687
|
+
*
|
|
1688
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1689
|
+
*/
|
|
1690
|
+
setup_future_usage?: UsBankAccount.SetupFutureUsage;
|
|
1691
|
+
/**
|
|
1692
|
+
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1693
|
+
*/
|
|
1694
|
+
target_date?: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* Bank account verification method. The default value is `automatic`.
|
|
1697
|
+
*/
|
|
1698
|
+
verification_method?: UsBankAccount.VerificationMethod;
|
|
1699
|
+
}
|
|
1700
|
+
interface WechatPay {
|
|
1701
|
+
/**
|
|
1702
|
+
* The app ID registered with WeChat Pay. Only required when client is iOS or Android.
|
|
1703
|
+
*/
|
|
1704
|
+
app_id: string | null;
|
|
1705
|
+
/**
|
|
1706
|
+
* The client type that the end customer will pay from
|
|
1707
|
+
*/
|
|
1708
|
+
client: WechatPay.Client | null;
|
|
1709
|
+
/**
|
|
1710
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1711
|
+
*
|
|
1712
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1713
|
+
*
|
|
1714
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1715
|
+
*
|
|
1716
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1717
|
+
*/
|
|
1718
|
+
setup_future_usage?: 'none';
|
|
1719
|
+
}
|
|
1720
|
+
namespace AcssDebit {
|
|
1721
|
+
type Currency = 'cad' | 'usd';
|
|
1722
|
+
interface MandateOptions {
|
|
796
1723
|
/**
|
|
797
|
-
*
|
|
1724
|
+
* A URL for custom mandate text
|
|
798
1725
|
*/
|
|
799
|
-
|
|
1726
|
+
custom_mandate_url?: string;
|
|
800
1727
|
/**
|
|
801
|
-
*
|
|
1728
|
+
* List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
|
|
802
1729
|
*/
|
|
803
|
-
|
|
1730
|
+
default_for?: Array<MandateOptions.DefaultFor>;
|
|
804
1731
|
/**
|
|
805
|
-
*
|
|
1732
|
+
* Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
|
|
806
1733
|
*/
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
1734
|
+
interval_description: string | null;
|
|
1735
|
+
/**
|
|
1736
|
+
* Payment schedule for the mandate.
|
|
1737
|
+
*/
|
|
1738
|
+
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
1739
|
+
/**
|
|
1740
|
+
* Transaction type of the mandate.
|
|
1741
|
+
*/
|
|
1742
|
+
transaction_type: MandateOptions.TransactionType | null;
|
|
811
1743
|
}
|
|
812
|
-
|
|
813
|
-
|
|
1744
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1745
|
+
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
1746
|
+
namespace MandateOptions {
|
|
1747
|
+
type DefaultFor = 'invoice' | 'subscription';
|
|
1748
|
+
type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
|
|
1749
|
+
type TransactionType = 'business' | 'personal';
|
|
814
1750
|
}
|
|
815
1751
|
}
|
|
816
|
-
namespace
|
|
817
|
-
|
|
818
|
-
|
|
1752
|
+
namespace AmazonPay {
|
|
1753
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1754
|
+
}
|
|
1755
|
+
namespace BacsDebit {
|
|
1756
|
+
interface MandateOptions {
|
|
819
1757
|
/**
|
|
820
|
-
*
|
|
1758
|
+
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
|
|
821
1759
|
*/
|
|
822
|
-
|
|
1760
|
+
reference_prefix?: string;
|
|
823
1761
|
}
|
|
824
|
-
|
|
1762
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1763
|
+
}
|
|
1764
|
+
namespace Boleto {
|
|
1765
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1766
|
+
}
|
|
1767
|
+
namespace Card {
|
|
1768
|
+
interface Installments {
|
|
825
1769
|
/**
|
|
826
|
-
*
|
|
1770
|
+
* Indicates if installments are enabled
|
|
827
1771
|
*/
|
|
828
|
-
|
|
1772
|
+
enabled?: boolean;
|
|
1773
|
+
}
|
|
1774
|
+
type RequestExtendedAuthorization = 'if_available' | 'never';
|
|
1775
|
+
type RequestIncrementalAuthorization = 'if_available' | 'never';
|
|
1776
|
+
type RequestMulticapture = 'if_available' | 'never';
|
|
1777
|
+
type RequestOvercapture = 'if_available' | 'never';
|
|
1778
|
+
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
|
|
1779
|
+
interface Restrictions {
|
|
829
1780
|
/**
|
|
830
|
-
* The
|
|
1781
|
+
* The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
|
|
831
1782
|
*/
|
|
832
|
-
|
|
1783
|
+
brands_blocked?: Array<Restrictions.BrandsBlocked>;
|
|
833
1784
|
}
|
|
834
|
-
|
|
835
|
-
|
|
1785
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1786
|
+
namespace Restrictions {
|
|
1787
|
+
type BrandsBlocked = 'american_express' | 'discover_global_network' | 'mastercard' | 'visa';
|
|
836
1788
|
}
|
|
837
1789
|
}
|
|
838
|
-
namespace
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
namespace ConsentCollection {
|
|
842
|
-
interface PaymentMethodReuseAgreement {
|
|
1790
|
+
namespace CustomerBalance {
|
|
1791
|
+
interface BankTransfer {
|
|
1792
|
+
eu_bank_transfer?: BankTransfer.EuBankTransfer;
|
|
843
1793
|
/**
|
|
844
|
-
*
|
|
1794
|
+
* List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
|
845
1795
|
*
|
|
846
|
-
*
|
|
1796
|
+
* Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
|
847
1797
|
*/
|
|
848
|
-
|
|
1798
|
+
requested_address_types?: Array<BankTransfer.RequestedAddressType>;
|
|
1799
|
+
/**
|
|
1800
|
+
* 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`.
|
|
1801
|
+
*/
|
|
1802
|
+
type: BankTransfer.Type | null;
|
|
849
1803
|
}
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
1804
|
+
namespace BankTransfer {
|
|
1805
|
+
interface EuBankTransfer {
|
|
1806
|
+
/**
|
|
1807
|
+
* The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
|
|
1808
|
+
*/
|
|
1809
|
+
country: EuBankTransfer.Country;
|
|
1810
|
+
}
|
|
1811
|
+
type RequestedAddressType = 'aba' | 'iban' | 'sepa' | 'sort_code' | 'spei' | 'swift' | 'zengin';
|
|
1812
|
+
type Type = 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer';
|
|
1813
|
+
namespace EuBankTransfer {
|
|
1814
|
+
type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
|
|
1815
|
+
}
|
|
854
1816
|
}
|
|
855
1817
|
}
|
|
856
|
-
namespace
|
|
857
|
-
type
|
|
858
|
-
|
|
1818
|
+
namespace KakaoPay {
|
|
1819
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1820
|
+
}
|
|
1821
|
+
namespace Klarna {
|
|
1822
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1823
|
+
}
|
|
1824
|
+
namespace KrCard {
|
|
1825
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1826
|
+
}
|
|
1827
|
+
namespace Link {
|
|
1828
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1829
|
+
}
|
|
1830
|
+
namespace NaverPay {
|
|
1831
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1832
|
+
}
|
|
1833
|
+
namespace Paypal {
|
|
1834
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1835
|
+
}
|
|
1836
|
+
namespace Payto {
|
|
1837
|
+
interface MandateOptions {
|
|
859
1838
|
/**
|
|
860
|
-
*
|
|
1839
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
861
1840
|
*/
|
|
862
|
-
|
|
1841
|
+
amount: number | null;
|
|
863
1842
|
/**
|
|
864
|
-
* The
|
|
1843
|
+
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
|
|
865
1844
|
*/
|
|
866
|
-
|
|
867
|
-
}
|
|
868
|
-
namespace TaxId {
|
|
869
|
-
type Type = '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' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_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' | 'pl_nip' | 'py_ruc' | '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' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
870
|
-
}
|
|
871
|
-
}
|
|
872
|
-
namespace CustomField {
|
|
873
|
-
interface Dropdown {
|
|
1845
|
+
amount_type: MandateOptions.AmountType | null;
|
|
874
1846
|
/**
|
|
875
|
-
*
|
|
1847
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
876
1848
|
*/
|
|
877
|
-
|
|
1849
|
+
end_date: string | null;
|
|
878
1850
|
/**
|
|
879
|
-
* The
|
|
1851
|
+
* The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
880
1852
|
*/
|
|
881
|
-
|
|
1853
|
+
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
882
1854
|
/**
|
|
883
|
-
* The
|
|
1855
|
+
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
884
1856
|
*/
|
|
885
|
-
|
|
886
|
-
}
|
|
887
|
-
interface Label {
|
|
1857
|
+
payments_per_period: number | null;
|
|
888
1858
|
/**
|
|
889
|
-
*
|
|
1859
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
890
1860
|
*/
|
|
891
|
-
|
|
1861
|
+
purpose: MandateOptions.Purpose | null;
|
|
892
1862
|
/**
|
|
893
|
-
*
|
|
1863
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
894
1864
|
*/
|
|
895
|
-
|
|
1865
|
+
start_date: string | null;
|
|
896
1866
|
}
|
|
897
|
-
|
|
1867
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1868
|
+
namespace MandateOptions {
|
|
1869
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1870
|
+
type PaymentSchedule = 'adhoc' | 'annual' | 'daily' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'weekly';
|
|
1871
|
+
type Purpose = 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility';
|
|
1872
|
+
}
|
|
1873
|
+
}
|
|
1874
|
+
namespace Pix {
|
|
1875
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1876
|
+
interface MandateOptions {
|
|
898
1877
|
/**
|
|
899
|
-
*
|
|
1878
|
+
* Amount to be charged for future payments.
|
|
900
1879
|
*/
|
|
901
|
-
|
|
1880
|
+
amount?: number;
|
|
902
1881
|
/**
|
|
903
|
-
*
|
|
1882
|
+
* Determines if the amount includes the IOF tax.
|
|
904
1883
|
*/
|
|
905
|
-
|
|
1884
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
906
1885
|
/**
|
|
907
|
-
*
|
|
1886
|
+
* Type of amount.
|
|
908
1887
|
*/
|
|
909
|
-
|
|
1888
|
+
amount_type?: MandateOptions.AmountType;
|
|
910
1889
|
/**
|
|
911
|
-
*
|
|
1890
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
|
|
912
1891
|
*/
|
|
913
|
-
|
|
914
|
-
}
|
|
915
|
-
interface Text {
|
|
1892
|
+
currency?: string;
|
|
916
1893
|
/**
|
|
917
|
-
*
|
|
1894
|
+
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
|
|
918
1895
|
*/
|
|
919
|
-
|
|
1896
|
+
end_date?: string;
|
|
920
1897
|
/**
|
|
921
|
-
*
|
|
1898
|
+
* Schedule at which the future payments will be charged.
|
|
922
1899
|
*/
|
|
923
|
-
|
|
1900
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
924
1901
|
/**
|
|
925
|
-
*
|
|
1902
|
+
* Subscription name displayed to buyers in their bank app.
|
|
926
1903
|
*/
|
|
927
|
-
|
|
1904
|
+
reference?: string;
|
|
928
1905
|
/**
|
|
929
|
-
*
|
|
1906
|
+
* Start date of the mandate, in `YYYY-MM-DD`.
|
|
930
1907
|
*/
|
|
931
|
-
|
|
1908
|
+
start_date?: string;
|
|
932
1909
|
}
|
|
933
|
-
type
|
|
934
|
-
namespace
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
*/
|
|
939
|
-
label: string;
|
|
940
|
-
/**
|
|
941
|
-
* The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
|
|
942
|
-
*/
|
|
943
|
-
value: string;
|
|
944
|
-
}
|
|
1910
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1911
|
+
namespace MandateOptions {
|
|
1912
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1913
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1914
|
+
type PaymentSchedule = 'halfyearly' | 'monthly' | 'quarterly' | 'weekly' | 'yearly';
|
|
945
1915
|
}
|
|
946
1916
|
}
|
|
947
|
-
namespace
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
message: string;
|
|
953
|
-
}
|
|
954
|
-
interface ShippingAddress {
|
|
955
|
-
/**
|
|
956
|
-
* Text can be up to 1200 characters in length.
|
|
957
|
-
*/
|
|
958
|
-
message: string;
|
|
959
|
-
}
|
|
960
|
-
interface Submit {
|
|
961
|
-
/**
|
|
962
|
-
* Text can be up to 1200 characters in length.
|
|
963
|
-
*/
|
|
964
|
-
message: string;
|
|
965
|
-
}
|
|
966
|
-
interface TermsOfServiceAcceptance {
|
|
1917
|
+
namespace RevolutPay {
|
|
1918
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1919
|
+
}
|
|
1920
|
+
namespace SepaDebit {
|
|
1921
|
+
interface MandateOptions {
|
|
967
1922
|
/**
|
|
968
|
-
*
|
|
1923
|
+
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
|
|
969
1924
|
*/
|
|
970
|
-
|
|
1925
|
+
reference_prefix?: string;
|
|
971
1926
|
}
|
|
1927
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
972
1928
|
}
|
|
973
|
-
namespace
|
|
974
|
-
|
|
1929
|
+
namespace Twint {
|
|
1930
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
1931
|
+
}
|
|
1932
|
+
namespace Upi {
|
|
1933
|
+
interface MandateOptions {
|
|
975
1934
|
/**
|
|
976
|
-
*
|
|
1935
|
+
* Amount to be charged for future payments.
|
|
977
1936
|
*/
|
|
978
|
-
|
|
1937
|
+
amount: number | null;
|
|
979
1938
|
/**
|
|
980
|
-
*
|
|
1939
|
+
* 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.
|
|
981
1940
|
*/
|
|
982
|
-
|
|
1941
|
+
amount_type: MandateOptions.AmountType | null;
|
|
983
1942
|
/**
|
|
984
|
-
*
|
|
1943
|
+
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
985
1944
|
*/
|
|
986
1945
|
description: string | null;
|
|
987
1946
|
/**
|
|
988
|
-
*
|
|
1947
|
+
* End date of the mandate or subscription.
|
|
989
1948
|
*/
|
|
990
|
-
|
|
1949
|
+
end_date: number | null;
|
|
1950
|
+
}
|
|
1951
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1952
|
+
namespace MandateOptions {
|
|
1953
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1954
|
+
}
|
|
1955
|
+
}
|
|
1956
|
+
namespace UsBankAccount {
|
|
1957
|
+
interface FinancialConnections {
|
|
1958
|
+
filters?: FinancialConnections.Filters;
|
|
991
1959
|
/**
|
|
992
|
-
* The
|
|
1960
|
+
* The list of permissions to request. The `payment_method` permission must be included.
|
|
993
1961
|
*/
|
|
994
|
-
|
|
1962
|
+
permissions?: Array<FinancialConnections.Permission>;
|
|
995
1963
|
/**
|
|
996
|
-
*
|
|
1964
|
+
* Data features requested to be retrieved upon account creation.
|
|
997
1965
|
*/
|
|
998
|
-
|
|
1966
|
+
prefetch: Array<FinancialConnections.Prefetch> | null;
|
|
999
1967
|
/**
|
|
1000
|
-
*
|
|
1968
|
+
* For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
|
|
1001
1969
|
*/
|
|
1002
|
-
|
|
1970
|
+
return_url?: string;
|
|
1003
1971
|
}
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
*/
|
|
1009
|
-
name: string;
|
|
1010
|
-
/**
|
|
1011
|
-
* The value of the custom field.
|
|
1012
|
-
*/
|
|
1013
|
-
value: string;
|
|
1014
|
-
}
|
|
1015
|
-
interface Issuer {
|
|
1016
|
-
/**
|
|
1017
|
-
* The connected account being referenced when `type` is `account`.
|
|
1018
|
-
*/
|
|
1019
|
-
account?: string | Account;
|
|
1972
|
+
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1973
|
+
type VerificationMethod = 'automatic' | 'instant';
|
|
1974
|
+
namespace FinancialConnections {
|
|
1975
|
+
interface Filters {
|
|
1020
1976
|
/**
|
|
1021
|
-
*
|
|
1977
|
+
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
1022
1978
|
*/
|
|
1023
|
-
|
|
1024
|
-
}
|
|
1025
|
-
interface RenderingOptions {
|
|
1026
|
-
/**
|
|
1027
|
-
* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
|
|
1028
|
-
*/
|
|
1029
|
-
amount_tax_display: string | null;
|
|
1030
|
-
/**
|
|
1031
|
-
* ID of the invoice rendering template to be used for the generated invoice.
|
|
1032
|
-
*/
|
|
1033
|
-
template: string | null;
|
|
1979
|
+
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1034
1980
|
}
|
|
1035
|
-
|
|
1036
|
-
|
|
1981
|
+
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1982
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1983
|
+
namespace Filters {
|
|
1984
|
+
type AccountSubcategory = 'checking' | 'savings';
|
|
1037
1985
|
}
|
|
1038
1986
|
}
|
|
1039
1987
|
}
|
|
1040
|
-
namespace
|
|
1041
|
-
|
|
1042
|
-
/**
|
|
1043
|
-
* Indicates whether business name collection is enabled for the session
|
|
1044
|
-
*/
|
|
1045
|
-
enabled: boolean;
|
|
1046
|
-
/**
|
|
1047
|
-
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
1048
|
-
*/
|
|
1049
|
-
optional: boolean;
|
|
1050
|
-
}
|
|
1051
|
-
interface Individual {
|
|
1052
|
-
/**
|
|
1053
|
-
* Indicates whether individual name collection is enabled for the session
|
|
1054
|
-
*/
|
|
1055
|
-
enabled: boolean;
|
|
1056
|
-
/**
|
|
1057
|
-
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
1058
|
-
*/
|
|
1059
|
-
optional: boolean;
|
|
1060
|
-
}
|
|
1988
|
+
namespace WechatPay {
|
|
1989
|
+
type Client = 'android' | 'ios' | 'web';
|
|
1061
1990
|
}
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1991
|
+
}
|
|
1992
|
+
namespace Permissions {
|
|
1993
|
+
type UpdateShippingDetails = 'client_only' | 'server_only';
|
|
1994
|
+
}
|
|
1995
|
+
namespace SavedPaymentMethodOptions {
|
|
1996
|
+
type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
|
|
1997
|
+
type PaymentMethodRemove = 'disabled' | 'enabled';
|
|
1998
|
+
type PaymentMethodSave = 'disabled' | 'enabled';
|
|
1999
|
+
}
|
|
2000
|
+
namespace ShippingAddressCollection {
|
|
2001
|
+
type AllowedCountry = 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ';
|
|
2002
|
+
}
|
|
2003
|
+
namespace ShippingCost {
|
|
2004
|
+
interface Tax {
|
|
2005
|
+
/**
|
|
2006
|
+
* Amount of tax applied for this rate.
|
|
2007
|
+
*/
|
|
2008
|
+
amount: number;
|
|
2009
|
+
/**
|
|
2010
|
+
* Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
2011
|
+
*
|
|
2012
|
+
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
2013
|
+
*/
|
|
2014
|
+
rate: TaxRate;
|
|
2015
|
+
/**
|
|
2016
|
+
* 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.
|
|
2017
|
+
*/
|
|
2018
|
+
taxability_reason: Tax.TaxabilityReason | null;
|
|
2019
|
+
/**
|
|
2020
|
+
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
2021
|
+
*/
|
|
2022
|
+
taxable_amount: number | null;
|
|
1077
2023
|
}
|
|
1078
|
-
namespace
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
target_date?: string;
|
|
1099
|
-
/**
|
|
1100
|
-
* Bank account verification method. The default value is `automatic`.
|
|
1101
|
-
*/
|
|
1102
|
-
verification_method?: AcssDebit.VerificationMethod;
|
|
1103
|
-
}
|
|
1104
|
-
interface Affirm {
|
|
1105
|
-
/**
|
|
1106
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1107
|
-
*/
|
|
1108
|
-
capture_method?: 'manual';
|
|
1109
|
-
/**
|
|
1110
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1111
|
-
*
|
|
1112
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1113
|
-
*
|
|
1114
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1115
|
-
*
|
|
1116
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1117
|
-
*/
|
|
1118
|
-
setup_future_usage?: 'none';
|
|
1119
|
-
}
|
|
1120
|
-
interface AfterpayClearpay {
|
|
1121
|
-
/**
|
|
1122
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1123
|
-
*/
|
|
1124
|
-
capture_method?: 'manual';
|
|
1125
|
-
/**
|
|
1126
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1127
|
-
*
|
|
1128
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1129
|
-
*
|
|
1130
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1131
|
-
*
|
|
1132
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1133
|
-
*/
|
|
1134
|
-
setup_future_usage?: 'none';
|
|
1135
|
-
}
|
|
1136
|
-
interface Alipay {
|
|
1137
|
-
/**
|
|
1138
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1139
|
-
*
|
|
1140
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1141
|
-
*
|
|
1142
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1143
|
-
*
|
|
1144
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1145
|
-
*/
|
|
1146
|
-
setup_future_usage?: 'none';
|
|
1147
|
-
}
|
|
1148
|
-
interface Alma {
|
|
1149
|
-
/**
|
|
1150
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1151
|
-
*/
|
|
1152
|
-
capture_method?: 'manual';
|
|
1153
|
-
}
|
|
1154
|
-
interface AmazonPay {
|
|
1155
|
-
/**
|
|
1156
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1157
|
-
*/
|
|
1158
|
-
capture_method?: 'manual';
|
|
2024
|
+
namespace Tax {
|
|
2025
|
+
type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
|
|
2026
|
+
}
|
|
2027
|
+
}
|
|
2028
|
+
namespace TaxIdCollection {
|
|
2029
|
+
type Required = 'if_supported' | 'never';
|
|
2030
|
+
}
|
|
2031
|
+
namespace TotalDetails {
|
|
2032
|
+
interface Breakdown {
|
|
2033
|
+
/**
|
|
2034
|
+
* The aggregated discounts.
|
|
2035
|
+
*/
|
|
2036
|
+
discounts: Array<Breakdown.Discount>;
|
|
2037
|
+
/**
|
|
2038
|
+
* The aggregated tax amounts by rate.
|
|
2039
|
+
*/
|
|
2040
|
+
taxes: Array<Breakdown.Tax>;
|
|
2041
|
+
}
|
|
2042
|
+
namespace Breakdown {
|
|
2043
|
+
interface Discount {
|
|
1159
2044
|
/**
|
|
1160
|
-
*
|
|
1161
|
-
*
|
|
1162
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1163
|
-
*
|
|
1164
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1165
|
-
*
|
|
1166
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
2045
|
+
* The amount discounted.
|
|
1167
2046
|
*/
|
|
1168
|
-
|
|
1169
|
-
}
|
|
1170
|
-
interface AuBecsDebit {
|
|
2047
|
+
amount: number;
|
|
1171
2048
|
/**
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1175
|
-
*
|
|
1176
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
2049
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
2050
|
+
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
1177
2051
|
*
|
|
1178
|
-
*
|
|
1179
|
-
*/
|
|
1180
|
-
setup_future_usage?: 'none';
|
|
1181
|
-
/**
|
|
1182
|
-
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
2052
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
1183
2053
|
*/
|
|
1184
|
-
|
|
2054
|
+
discount: _Discount;
|
|
1185
2055
|
}
|
|
1186
|
-
interface
|
|
1187
|
-
mandate_options?: BacsDebit.MandateOptions;
|
|
1188
|
-
/**
|
|
1189
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1190
|
-
*
|
|
1191
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1192
|
-
*
|
|
1193
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1194
|
-
*
|
|
1195
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1196
|
-
*/
|
|
1197
|
-
setup_future_usage?: BacsDebit.SetupFutureUsage;
|
|
2056
|
+
interface Tax {
|
|
1198
2057
|
/**
|
|
1199
|
-
*
|
|
2058
|
+
* Amount of tax applied for this rate.
|
|
1200
2059
|
*/
|
|
1201
|
-
|
|
1202
|
-
}
|
|
1203
|
-
interface Bancontact {
|
|
2060
|
+
amount: number;
|
|
1204
2061
|
/**
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
1207
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1208
|
-
*
|
|
1209
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
2062
|
+
* Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
1210
2063
|
*
|
|
1211
|
-
*
|
|
2064
|
+
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
1212
2065
|
*/
|
|
1213
|
-
|
|
1214
|
-
}
|
|
1215
|
-
interface Billie {
|
|
2066
|
+
rate: TaxRate;
|
|
1216
2067
|
/**
|
|
1217
|
-
*
|
|
2068
|
+
* 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.
|
|
1218
2069
|
*/
|
|
1219
|
-
|
|
1220
|
-
}
|
|
1221
|
-
interface Boleto {
|
|
1222
|
-
/**
|
|
1223
|
-
* The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
|
|
1224
|
-
*/
|
|
1225
|
-
expires_after_days: number;
|
|
1226
|
-
/**
|
|
1227
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1228
|
-
*
|
|
1229
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1230
|
-
*
|
|
1231
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1232
|
-
*
|
|
1233
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1234
|
-
*/
|
|
1235
|
-
setup_future_usage?: Boleto.SetupFutureUsage;
|
|
1236
|
-
}
|
|
1237
|
-
interface Card {
|
|
1238
|
-
/**
|
|
1239
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1240
|
-
*/
|
|
1241
|
-
capture_method?: 'manual';
|
|
1242
|
-
installments?: Card.Installments;
|
|
1243
|
-
/**
|
|
1244
|
-
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
1245
|
-
*/
|
|
1246
|
-
request_decremental_authorization?: Card.RequestDecrementalAuthorization;
|
|
1247
|
-
/**
|
|
1248
|
-
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
1249
|
-
*/
|
|
1250
|
-
request_extended_authorization?: Card.RequestExtendedAuthorization;
|
|
1251
|
-
/**
|
|
1252
|
-
* Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this CheckoutSession.
|
|
1253
|
-
*/
|
|
1254
|
-
request_incremental_authorization?: Card.RequestIncrementalAuthorization;
|
|
1255
|
-
/**
|
|
1256
|
-
* Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this CheckoutSession.
|
|
1257
|
-
*/
|
|
1258
|
-
request_multicapture?: Card.RequestMulticapture;
|
|
1259
|
-
/**
|
|
1260
|
-
* Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this CheckoutSession.
|
|
1261
|
-
*/
|
|
1262
|
-
request_overcapture?: Card.RequestOvercapture;
|
|
1263
|
-
/**
|
|
1264
|
-
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). 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](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
1265
|
-
*/
|
|
1266
|
-
request_three_d_secure: Card.RequestThreeDSecure;
|
|
1267
|
-
restrictions?: Card.Restrictions;
|
|
1268
|
-
/**
|
|
1269
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1270
|
-
*
|
|
1271
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1272
|
-
*
|
|
1273
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1274
|
-
*
|
|
1275
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1276
|
-
*/
|
|
1277
|
-
setup_future_usage?: Card.SetupFutureUsage;
|
|
1278
|
-
/**
|
|
1279
|
-
* Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
|
|
1280
|
-
*/
|
|
1281
|
-
statement_descriptor_suffix_kana?: string;
|
|
1282
|
-
/**
|
|
1283
|
-
* Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
|
1284
|
-
*/
|
|
1285
|
-
statement_descriptor_suffix_kanji?: string;
|
|
1286
|
-
}
|
|
1287
|
-
interface Cashapp {
|
|
1288
|
-
/**
|
|
1289
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1290
|
-
*/
|
|
1291
|
-
capture_method?: 'manual';
|
|
1292
|
-
/**
|
|
1293
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1294
|
-
*
|
|
1295
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1296
|
-
*
|
|
1297
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1298
|
-
*
|
|
1299
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1300
|
-
*/
|
|
1301
|
-
setup_future_usage?: 'none';
|
|
1302
|
-
}
|
|
1303
|
-
interface CustomerBalance {
|
|
1304
|
-
bank_transfer?: CustomerBalance.BankTransfer;
|
|
1305
|
-
/**
|
|
1306
|
-
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
|
1307
|
-
*/
|
|
1308
|
-
funding_type: 'bank_transfer' | null;
|
|
1309
|
-
/**
|
|
1310
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1311
|
-
*
|
|
1312
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1313
|
-
*
|
|
1314
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1315
|
-
*
|
|
1316
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1317
|
-
*/
|
|
1318
|
-
setup_future_usage?: 'none';
|
|
1319
|
-
}
|
|
1320
|
-
interface Eps {
|
|
1321
|
-
/**
|
|
1322
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1323
|
-
*
|
|
1324
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1325
|
-
*
|
|
1326
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1327
|
-
*
|
|
1328
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1329
|
-
*/
|
|
1330
|
-
setup_future_usage?: 'none';
|
|
1331
|
-
}
|
|
1332
|
-
interface Fpx {
|
|
1333
|
-
/**
|
|
1334
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1335
|
-
*
|
|
1336
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1337
|
-
*
|
|
1338
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1339
|
-
*
|
|
1340
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1341
|
-
*/
|
|
1342
|
-
setup_future_usage?: 'none';
|
|
1343
|
-
}
|
|
1344
|
-
interface Giropay {
|
|
1345
|
-
/**
|
|
1346
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1347
|
-
*
|
|
1348
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1349
|
-
*
|
|
1350
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1351
|
-
*
|
|
1352
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1353
|
-
*/
|
|
1354
|
-
setup_future_usage?: 'none';
|
|
1355
|
-
}
|
|
1356
|
-
interface Grabpay {
|
|
1357
|
-
/**
|
|
1358
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1359
|
-
*
|
|
1360
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1361
|
-
*
|
|
1362
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1363
|
-
*
|
|
1364
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1365
|
-
*/
|
|
1366
|
-
setup_future_usage?: 'none';
|
|
1367
|
-
}
|
|
1368
|
-
interface Ideal {
|
|
1369
|
-
/**
|
|
1370
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1371
|
-
*
|
|
1372
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1373
|
-
*
|
|
1374
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1375
|
-
*
|
|
1376
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1377
|
-
*/
|
|
1378
|
-
setup_future_usage?: 'none';
|
|
1379
|
-
}
|
|
1380
|
-
interface KakaoPay {
|
|
1381
|
-
/**
|
|
1382
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1383
|
-
*/
|
|
1384
|
-
capture_method?: 'manual';
|
|
1385
|
-
/**
|
|
1386
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1387
|
-
*
|
|
1388
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1389
|
-
*
|
|
1390
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1391
|
-
*
|
|
1392
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1393
|
-
*/
|
|
1394
|
-
setup_future_usage?: KakaoPay.SetupFutureUsage;
|
|
1395
|
-
}
|
|
1396
|
-
interface Klarna {
|
|
1397
|
-
/**
|
|
1398
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1399
|
-
*/
|
|
1400
|
-
capture_method?: 'manual';
|
|
1401
|
-
/**
|
|
1402
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1403
|
-
*
|
|
1404
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1405
|
-
*
|
|
1406
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1407
|
-
*
|
|
1408
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1409
|
-
*/
|
|
1410
|
-
setup_future_usage?: Klarna.SetupFutureUsage;
|
|
1411
|
-
}
|
|
1412
|
-
interface Konbini {
|
|
1413
|
-
/**
|
|
1414
|
-
* The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
|
|
1415
|
-
*/
|
|
1416
|
-
expires_after_days: number | null;
|
|
1417
|
-
/**
|
|
1418
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1419
|
-
*
|
|
1420
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1421
|
-
*
|
|
1422
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1423
|
-
*
|
|
1424
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1425
|
-
*/
|
|
1426
|
-
setup_future_usage?: 'none';
|
|
1427
|
-
}
|
|
1428
|
-
interface KrCard {
|
|
1429
|
-
/**
|
|
1430
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1431
|
-
*/
|
|
1432
|
-
capture_method?: 'manual';
|
|
1433
|
-
/**
|
|
1434
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1435
|
-
*
|
|
1436
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1437
|
-
*
|
|
1438
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1439
|
-
*
|
|
1440
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1441
|
-
*/
|
|
1442
|
-
setup_future_usage?: KrCard.SetupFutureUsage;
|
|
1443
|
-
}
|
|
1444
|
-
interface Link {
|
|
1445
|
-
/**
|
|
1446
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1447
|
-
*/
|
|
1448
|
-
capture_method?: 'manual';
|
|
1449
|
-
/**
|
|
1450
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1451
|
-
*
|
|
1452
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1453
|
-
*
|
|
1454
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1455
|
-
*
|
|
1456
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1457
|
-
*/
|
|
1458
|
-
setup_future_usage?: Link.SetupFutureUsage;
|
|
1459
|
-
}
|
|
1460
|
-
interface Mobilepay {
|
|
1461
|
-
/**
|
|
1462
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1463
|
-
*/
|
|
1464
|
-
capture_method?: 'manual';
|
|
1465
|
-
/**
|
|
1466
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1467
|
-
*
|
|
1468
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1469
|
-
*
|
|
1470
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1471
|
-
*
|
|
1472
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1473
|
-
*/
|
|
1474
|
-
setup_future_usage?: 'none';
|
|
1475
|
-
}
|
|
1476
|
-
interface Multibanco {
|
|
1477
|
-
/**
|
|
1478
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1479
|
-
*
|
|
1480
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1481
|
-
*
|
|
1482
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1483
|
-
*
|
|
1484
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1485
|
-
*/
|
|
1486
|
-
setup_future_usage?: 'none';
|
|
1487
|
-
}
|
|
1488
|
-
interface NaverPay {
|
|
1489
|
-
/**
|
|
1490
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1491
|
-
*/
|
|
1492
|
-
capture_method?: 'manual';
|
|
1493
|
-
/**
|
|
1494
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1495
|
-
*
|
|
1496
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1497
|
-
*
|
|
1498
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1499
|
-
*
|
|
1500
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1501
|
-
*/
|
|
1502
|
-
setup_future_usage?: NaverPay.SetupFutureUsage;
|
|
1503
|
-
}
|
|
1504
|
-
interface Oxxo {
|
|
1505
|
-
/**
|
|
1506
|
-
* The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
|
|
1507
|
-
*/
|
|
1508
|
-
expires_after_days: number;
|
|
1509
|
-
/**
|
|
1510
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1511
|
-
*
|
|
1512
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1513
|
-
*
|
|
1514
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1515
|
-
*
|
|
1516
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1517
|
-
*/
|
|
1518
|
-
setup_future_usage?: 'none';
|
|
1519
|
-
}
|
|
1520
|
-
interface P24 {
|
|
1521
|
-
/**
|
|
1522
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1523
|
-
*
|
|
1524
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1525
|
-
*
|
|
1526
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1527
|
-
*
|
|
1528
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1529
|
-
*/
|
|
1530
|
-
setup_future_usage?: 'none';
|
|
1531
|
-
}
|
|
1532
|
-
interface Payco {
|
|
1533
|
-
/**
|
|
1534
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1535
|
-
*/
|
|
1536
|
-
capture_method?: 'manual';
|
|
1537
|
-
}
|
|
1538
|
-
interface Paynow {
|
|
1539
|
-
/**
|
|
1540
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1541
|
-
*
|
|
1542
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1543
|
-
*
|
|
1544
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1545
|
-
*
|
|
1546
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1547
|
-
*/
|
|
1548
|
-
setup_future_usage?: 'none';
|
|
1549
|
-
}
|
|
1550
|
-
interface Paypal {
|
|
1551
|
-
/**
|
|
1552
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1553
|
-
*/
|
|
1554
|
-
capture_method?: 'manual';
|
|
1555
|
-
/**
|
|
1556
|
-
* Preferred locale of the PayPal checkout page that the customer is redirected to.
|
|
1557
|
-
*/
|
|
1558
|
-
preferred_locale: string | null;
|
|
1559
|
-
/**
|
|
1560
|
-
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
|
1561
|
-
*/
|
|
1562
|
-
reference: string | null;
|
|
1563
|
-
/**
|
|
1564
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1565
|
-
*
|
|
1566
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1567
|
-
*
|
|
1568
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1569
|
-
*
|
|
1570
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1571
|
-
*/
|
|
1572
|
-
setup_future_usage?: Paypal.SetupFutureUsage;
|
|
1573
|
-
/**
|
|
1574
|
-
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
1575
|
-
*/
|
|
1576
|
-
subsellers?: Array<string>;
|
|
1577
|
-
}
|
|
1578
|
-
interface Payto {
|
|
1579
|
-
mandate_options?: Payto.MandateOptions;
|
|
1580
|
-
/**
|
|
1581
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1582
|
-
*
|
|
1583
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1584
|
-
*
|
|
1585
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1586
|
-
*
|
|
1587
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1588
|
-
*/
|
|
1589
|
-
setup_future_usage?: Payto.SetupFutureUsage;
|
|
1590
|
-
}
|
|
1591
|
-
interface Pix {
|
|
1592
|
-
/**
|
|
1593
|
-
* Determines if the amount includes the IOF tax.
|
|
1594
|
-
*/
|
|
1595
|
-
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
1596
|
-
/**
|
|
1597
|
-
* The number of seconds after which Pix payment will expire.
|
|
1598
|
-
*/
|
|
1599
|
-
expires_after_seconds: number | null;
|
|
1600
|
-
mandate_options?: Pix.MandateOptions;
|
|
1601
|
-
/**
|
|
1602
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1603
|
-
*
|
|
1604
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1605
|
-
*
|
|
1606
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1607
|
-
*
|
|
1608
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1609
|
-
*/
|
|
1610
|
-
setup_future_usage?: Pix.SetupFutureUsage;
|
|
1611
|
-
}
|
|
1612
|
-
interface RevolutPay {
|
|
1613
|
-
/**
|
|
1614
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1615
|
-
*/
|
|
1616
|
-
capture_method?: 'manual';
|
|
1617
|
-
/**
|
|
1618
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1619
|
-
*
|
|
1620
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1621
|
-
*
|
|
1622
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1623
|
-
*
|
|
1624
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1625
|
-
*/
|
|
1626
|
-
setup_future_usage?: RevolutPay.SetupFutureUsage;
|
|
1627
|
-
}
|
|
1628
|
-
interface SamsungPay {
|
|
1629
|
-
/**
|
|
1630
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1631
|
-
*/
|
|
1632
|
-
capture_method?: 'manual';
|
|
1633
|
-
}
|
|
1634
|
-
interface Satispay {
|
|
1635
|
-
/**
|
|
1636
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1637
|
-
*/
|
|
1638
|
-
capture_method?: 'manual';
|
|
1639
|
-
}
|
|
1640
|
-
interface Scalapay {
|
|
1641
|
-
/**
|
|
1642
|
-
* Controls when the funds will be captured from the customer's account.
|
|
1643
|
-
*/
|
|
1644
|
-
capture_method?: 'manual';
|
|
1645
|
-
}
|
|
1646
|
-
interface SepaDebit {
|
|
1647
|
-
mandate_options?: SepaDebit.MandateOptions;
|
|
1648
|
-
/**
|
|
1649
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1650
|
-
*
|
|
1651
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1652
|
-
*
|
|
1653
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1654
|
-
*
|
|
1655
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1656
|
-
*/
|
|
1657
|
-
setup_future_usage?: SepaDebit.SetupFutureUsage;
|
|
1658
|
-
/**
|
|
1659
|
-
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1660
|
-
*/
|
|
1661
|
-
target_date?: string;
|
|
1662
|
-
}
|
|
1663
|
-
interface Sofort {
|
|
1664
|
-
/**
|
|
1665
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1666
|
-
*
|
|
1667
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1668
|
-
*
|
|
1669
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1670
|
-
*
|
|
1671
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1672
|
-
*/
|
|
1673
|
-
setup_future_usage?: 'none';
|
|
1674
|
-
}
|
|
1675
|
-
interface Swish {
|
|
1676
|
-
/**
|
|
1677
|
-
* The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
|
|
1678
|
-
*/
|
|
1679
|
-
reference: string | null;
|
|
1680
|
-
}
|
|
1681
|
-
interface Twint {
|
|
1682
|
-
/**
|
|
1683
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1684
|
-
*
|
|
1685
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1686
|
-
*
|
|
1687
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1688
|
-
*
|
|
1689
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1690
|
-
*/
|
|
1691
|
-
setup_future_usage?: Twint.SetupFutureUsage;
|
|
1692
|
-
}
|
|
1693
|
-
interface Upi {
|
|
1694
|
-
mandate_options?: Upi.MandateOptions;
|
|
1695
|
-
/**
|
|
1696
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1697
|
-
*
|
|
1698
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1699
|
-
*
|
|
1700
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1701
|
-
*
|
|
1702
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1703
|
-
*/
|
|
1704
|
-
setup_future_usage?: Upi.SetupFutureUsage;
|
|
1705
|
-
}
|
|
1706
|
-
interface UsBankAccount {
|
|
1707
|
-
financial_connections?: UsBankAccount.FinancialConnections;
|
|
1708
|
-
/**
|
|
1709
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1710
|
-
*
|
|
1711
|
-
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
1712
|
-
*
|
|
1713
|
-
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
1714
|
-
*
|
|
1715
|
-
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
1716
|
-
*/
|
|
1717
|
-
setup_future_usage?: UsBankAccount.SetupFutureUsage;
|
|
1718
|
-
/**
|
|
1719
|
-
* Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
|
|
1720
|
-
*/
|
|
1721
|
-
target_date?: string;
|
|
1722
|
-
/**
|
|
1723
|
-
* Bank account verification method. The default value is `automatic`.
|
|
1724
|
-
*/
|
|
1725
|
-
verification_method?: UsBankAccount.VerificationMethod;
|
|
1726
|
-
}
|
|
1727
|
-
namespace AcssDebit {
|
|
1728
|
-
type Currency = 'cad' | 'usd';
|
|
1729
|
-
interface MandateOptions {
|
|
1730
|
-
/**
|
|
1731
|
-
* A URL for custom mandate text
|
|
1732
|
-
*/
|
|
1733
|
-
custom_mandate_url?: string;
|
|
1734
|
-
/**
|
|
1735
|
-
* List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
|
|
1736
|
-
*/
|
|
1737
|
-
default_for?: Array<MandateOptions.DefaultFor>;
|
|
1738
|
-
/**
|
|
1739
|
-
* Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
|
|
1740
|
-
*/
|
|
1741
|
-
interval_description: string | null;
|
|
1742
|
-
/**
|
|
1743
|
-
* Payment schedule for the mandate.
|
|
1744
|
-
*/
|
|
1745
|
-
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
1746
|
-
/**
|
|
1747
|
-
* Transaction type of the mandate.
|
|
1748
|
-
*/
|
|
1749
|
-
transaction_type: MandateOptions.TransactionType | null;
|
|
1750
|
-
}
|
|
1751
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1752
|
-
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
1753
|
-
namespace MandateOptions {
|
|
1754
|
-
type DefaultFor = 'invoice' | 'subscription';
|
|
1755
|
-
type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
|
|
1756
|
-
type TransactionType = 'business' | 'personal';
|
|
1757
|
-
}
|
|
1758
|
-
}
|
|
1759
|
-
namespace AmazonPay {
|
|
1760
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1761
|
-
}
|
|
1762
|
-
namespace BacsDebit {
|
|
1763
|
-
interface MandateOptions {
|
|
1764
|
-
/**
|
|
1765
|
-
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
|
|
1766
|
-
*/
|
|
1767
|
-
reference_prefix?: string;
|
|
1768
|
-
}
|
|
1769
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1770
|
-
}
|
|
1771
|
-
namespace Boleto {
|
|
1772
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1773
|
-
}
|
|
1774
|
-
namespace Card {
|
|
1775
|
-
interface Installments {
|
|
1776
|
-
/**
|
|
1777
|
-
* Indicates if installments are enabled
|
|
1778
|
-
*/
|
|
1779
|
-
enabled?: boolean;
|
|
1780
|
-
}
|
|
1781
|
-
type RequestDecrementalAuthorization = 'if_available' | 'never';
|
|
1782
|
-
type RequestExtendedAuthorization = 'if_available' | 'never';
|
|
1783
|
-
type RequestIncrementalAuthorization = 'if_available' | 'never';
|
|
1784
|
-
type RequestMulticapture = 'if_available' | 'never';
|
|
1785
|
-
type RequestOvercapture = 'if_available' | 'never';
|
|
1786
|
-
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
|
|
1787
|
-
interface Restrictions {
|
|
1788
|
-
/**
|
|
1789
|
-
* The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
|
|
1790
|
-
*/
|
|
1791
|
-
brands_blocked?: Array<Restrictions.BrandsBlocked>;
|
|
1792
|
-
}
|
|
1793
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1794
|
-
namespace Restrictions {
|
|
1795
|
-
type BrandsBlocked = 'american_express' | 'discover_global_network' | 'mastercard' | 'visa';
|
|
1796
|
-
}
|
|
1797
|
-
}
|
|
1798
|
-
namespace CustomerBalance {
|
|
1799
|
-
interface BankTransfer {
|
|
1800
|
-
eu_bank_transfer?: BankTransfer.EuBankTransfer;
|
|
1801
|
-
/**
|
|
1802
|
-
* List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
|
1803
|
-
*
|
|
1804
|
-
* Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
|
1805
|
-
*/
|
|
1806
|
-
requested_address_types?: Array<BankTransfer.RequestedAddressType>;
|
|
1807
|
-
/**
|
|
1808
|
-
* 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`.
|
|
1809
|
-
*/
|
|
1810
|
-
type: BankTransfer.Type | null;
|
|
1811
|
-
}
|
|
1812
|
-
namespace BankTransfer {
|
|
1813
|
-
interface EuBankTransfer {
|
|
1814
|
-
/**
|
|
1815
|
-
* The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
|
|
1816
|
-
*/
|
|
1817
|
-
country: EuBankTransfer.Country;
|
|
1818
|
-
}
|
|
1819
|
-
type RequestedAddressType = 'aba' | 'iban' | 'sepa' | 'sort_code' | 'spei' | 'swift' | 'zengin';
|
|
1820
|
-
type Type = 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer';
|
|
1821
|
-
namespace EuBankTransfer {
|
|
1822
|
-
type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
|
|
1823
|
-
}
|
|
1824
|
-
}
|
|
1825
|
-
}
|
|
1826
|
-
namespace KakaoPay {
|
|
1827
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1828
|
-
}
|
|
1829
|
-
namespace Klarna {
|
|
1830
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1831
|
-
}
|
|
1832
|
-
namespace KrCard {
|
|
1833
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1834
|
-
}
|
|
1835
|
-
namespace Link {
|
|
1836
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1837
|
-
}
|
|
1838
|
-
namespace NaverPay {
|
|
1839
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1840
|
-
}
|
|
1841
|
-
namespace Paypal {
|
|
1842
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1843
|
-
}
|
|
1844
|
-
namespace Payto {
|
|
1845
|
-
interface MandateOptions {
|
|
1846
|
-
/**
|
|
1847
|
-
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1848
|
-
*/
|
|
1849
|
-
amount: number | null;
|
|
1850
|
-
/**
|
|
1851
|
-
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
|
|
1852
|
-
*/
|
|
1853
|
-
amount_type: MandateOptions.AmountType | null;
|
|
1854
|
-
/**
|
|
1855
|
-
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1856
|
-
*/
|
|
1857
|
-
end_date: string | null;
|
|
1858
|
-
/**
|
|
1859
|
-
* The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
1860
|
-
*/
|
|
1861
|
-
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
1862
|
-
/**
|
|
1863
|
-
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
1864
|
-
*/
|
|
1865
|
-
payments_per_period: number | null;
|
|
1866
|
-
/**
|
|
1867
|
-
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
1868
|
-
*/
|
|
1869
|
-
purpose: MandateOptions.Purpose | null;
|
|
1870
|
-
/**
|
|
1871
|
-
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1872
|
-
*/
|
|
1873
|
-
start_date: string | null;
|
|
1874
|
-
}
|
|
1875
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1876
|
-
namespace MandateOptions {
|
|
1877
|
-
type AmountType = 'fixed' | 'maximum';
|
|
1878
|
-
type PaymentSchedule = 'adhoc' | 'annual' | 'daily' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'weekly';
|
|
1879
|
-
type Purpose = 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility';
|
|
1880
|
-
}
|
|
1881
|
-
}
|
|
1882
|
-
namespace Pix {
|
|
1883
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
1884
|
-
interface MandateOptions {
|
|
1885
|
-
/**
|
|
1886
|
-
* Amount to be charged for future payments.
|
|
1887
|
-
*/
|
|
1888
|
-
amount?: number;
|
|
1889
|
-
/**
|
|
1890
|
-
* Determines if the amount includes the IOF tax.
|
|
1891
|
-
*/
|
|
1892
|
-
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1893
|
-
/**
|
|
1894
|
-
* Type of amount.
|
|
1895
|
-
*/
|
|
1896
|
-
amount_type?: MandateOptions.AmountType;
|
|
1897
|
-
/**
|
|
1898
|
-
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
|
|
1899
|
-
*/
|
|
1900
|
-
currency?: string;
|
|
1901
|
-
/**
|
|
1902
|
-
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
|
|
1903
|
-
*/
|
|
1904
|
-
end_date?: string;
|
|
1905
|
-
/**
|
|
1906
|
-
* Schedule at which the future payments will be charged.
|
|
1907
|
-
*/
|
|
1908
|
-
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1909
|
-
/**
|
|
1910
|
-
* Subscription name displayed to buyers in their bank app.
|
|
1911
|
-
*/
|
|
1912
|
-
reference?: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* Start date of the mandate, in `YYYY-MM-DD`.
|
|
1915
|
-
*/
|
|
1916
|
-
start_date?: string;
|
|
1917
|
-
}
|
|
1918
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1919
|
-
namespace MandateOptions {
|
|
1920
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
1921
|
-
type AmountType = 'fixed' | 'maximum';
|
|
1922
|
-
type PaymentSchedule = 'halfyearly' | 'monthly' | 'quarterly' | 'weekly' | 'yearly';
|
|
1923
|
-
}
|
|
1924
|
-
}
|
|
1925
|
-
namespace RevolutPay {
|
|
1926
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1927
|
-
}
|
|
1928
|
-
namespace SepaDebit {
|
|
1929
|
-
interface MandateOptions {
|
|
1930
|
-
/**
|
|
1931
|
-
* Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
|
|
1932
|
-
*/
|
|
1933
|
-
reference_prefix?: string;
|
|
1934
|
-
}
|
|
1935
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1936
|
-
}
|
|
1937
|
-
namespace Twint {
|
|
1938
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
1939
|
-
}
|
|
1940
|
-
namespace Upi {
|
|
1941
|
-
interface MandateOptions {
|
|
1942
|
-
/**
|
|
1943
|
-
* Amount to be charged for future payments.
|
|
1944
|
-
*/
|
|
1945
|
-
amount: number | null;
|
|
1946
|
-
/**
|
|
1947
|
-
* 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.
|
|
1948
|
-
*/
|
|
1949
|
-
amount_type: MandateOptions.AmountType | null;
|
|
1950
|
-
/**
|
|
1951
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
1952
|
-
*/
|
|
1953
|
-
description: string | null;
|
|
1954
|
-
/**
|
|
1955
|
-
* End date of the mandate or subscription.
|
|
1956
|
-
*/
|
|
1957
|
-
end_date: number | null;
|
|
1958
|
-
}
|
|
1959
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1960
|
-
namespace MandateOptions {
|
|
1961
|
-
type AmountType = 'fixed' | 'maximum';
|
|
1962
|
-
}
|
|
1963
|
-
}
|
|
1964
|
-
namespace UsBankAccount {
|
|
1965
|
-
interface FinancialConnections {
|
|
1966
|
-
filters?: FinancialConnections.Filters;
|
|
1967
|
-
manual_entry?: FinancialConnections.ManualEntry;
|
|
1968
|
-
/**
|
|
1969
|
-
* The list of permissions to request. The `payment_method` permission must be included.
|
|
1970
|
-
*/
|
|
1971
|
-
permissions?: Array<FinancialConnections.Permission>;
|
|
1972
|
-
/**
|
|
1973
|
-
* Data features requested to be retrieved upon account creation.
|
|
1974
|
-
*/
|
|
1975
|
-
prefetch: Array<FinancialConnections.Prefetch> | null;
|
|
1976
|
-
/**
|
|
1977
|
-
* For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
|
|
1978
|
-
*/
|
|
1979
|
-
return_url?: string;
|
|
1980
|
-
}
|
|
1981
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
1982
|
-
type VerificationMethod = 'automatic' | 'instant';
|
|
1983
|
-
namespace FinancialConnections {
|
|
1984
|
-
interface Filters {
|
|
1985
|
-
/**
|
|
1986
|
-
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
1987
|
-
*/
|
|
1988
|
-
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1989
|
-
/**
|
|
1990
|
-
* The institution to use to filter for possible accounts to link.
|
|
1991
|
-
*/
|
|
1992
|
-
institution?: string;
|
|
1993
|
-
}
|
|
1994
|
-
interface ManualEntry {
|
|
1995
|
-
/**
|
|
1996
|
-
* Settings for configuring manual entry of account details.
|
|
1997
|
-
*/
|
|
1998
|
-
mode?: ManualEntry.Mode;
|
|
1999
|
-
}
|
|
2000
|
-
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
2001
|
-
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
|
|
2002
|
-
namespace Filters {
|
|
2003
|
-
type AccountSubcategory = 'checking' | 'savings';
|
|
2004
|
-
}
|
|
2005
|
-
namespace ManualEntry {
|
|
2006
|
-
type Mode = 'automatic' | 'custom';
|
|
2007
|
-
}
|
|
2008
|
-
}
|
|
2009
|
-
}
|
|
2010
|
-
}
|
|
2011
|
-
namespace Permissions {
|
|
2012
|
-
interface Update {
|
|
2013
|
-
/**
|
|
2014
|
-
* Determines which entity is allowed to update the line items.
|
|
2015
|
-
*
|
|
2016
|
-
* Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
|
|
2017
|
-
*
|
|
2018
|
-
* When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
|
|
2019
|
-
*/
|
|
2020
|
-
line_items?: Update.LineItems | null;
|
|
2021
|
-
/**
|
|
2022
|
-
* Determines which entity is allowed to update the shipping details.
|
|
2023
|
-
*
|
|
2024
|
-
* Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
|
|
2025
|
-
*
|
|
2026
|
-
* When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
|
|
2027
|
-
*/
|
|
2028
|
-
shipping_details: Update.ShippingDetails | null;
|
|
2029
|
-
}
|
|
2030
|
-
type UpdateLineItems = 'client_only' | 'server_only';
|
|
2031
|
-
type UpdateShippingDetails = 'client_only' | 'server_only';
|
|
2032
|
-
namespace Update {
|
|
2033
|
-
type LineItems = 'client_only' | 'server_only';
|
|
2034
|
-
type ShippingDetails = 'client_only' | 'server_only';
|
|
2035
|
-
}
|
|
2036
|
-
}
|
|
2037
|
-
namespace SavedPaymentMethodOptions {
|
|
2038
|
-
type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
|
|
2039
|
-
type PaymentMethodRemove = 'disabled' | 'enabled';
|
|
2040
|
-
type PaymentMethodSave = 'disabled' | 'enabled';
|
|
2041
|
-
}
|
|
2042
|
-
namespace ShippingAddressCollection {
|
|
2043
|
-
type AllowedCountry = 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ';
|
|
2044
|
-
}
|
|
2045
|
-
namespace ShippingCost {
|
|
2046
|
-
interface Tax {
|
|
2047
|
-
/**
|
|
2048
|
-
* Amount of tax applied for this rate.
|
|
2049
|
-
*/
|
|
2050
|
-
amount: number;
|
|
2051
|
-
/**
|
|
2052
|
-
* Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
2053
|
-
*
|
|
2054
|
-
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
2055
|
-
*/
|
|
2056
|
-
rate: TaxRate;
|
|
2057
|
-
/**
|
|
2058
|
-
* 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.
|
|
2059
|
-
*/
|
|
2060
|
-
taxability_reason: Tax.TaxabilityReason | null;
|
|
2061
|
-
/**
|
|
2062
|
-
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
2063
|
-
*/
|
|
2064
|
-
taxable_amount: number | null;
|
|
2065
|
-
}
|
|
2066
|
-
namespace Tax {
|
|
2067
|
-
type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
|
|
2068
|
-
}
|
|
2069
|
-
}
|
|
2070
|
-
namespace TaxIdCollection {
|
|
2071
|
-
type Required = 'if_supported' | 'never';
|
|
2072
|
-
}
|
|
2073
|
-
namespace TotalDetails {
|
|
2074
|
-
interface Breakdown {
|
|
2075
|
-
/**
|
|
2076
|
-
* The aggregated discounts.
|
|
2077
|
-
*/
|
|
2078
|
-
discounts: Array<Breakdown.Discount>;
|
|
2079
|
-
/**
|
|
2080
|
-
* The aggregated tax amounts by rate.
|
|
2081
|
-
*/
|
|
2082
|
-
taxes: Array<Breakdown.Tax>;
|
|
2083
|
-
}
|
|
2084
|
-
namespace Breakdown {
|
|
2085
|
-
interface Discount {
|
|
2086
|
-
/**
|
|
2087
|
-
* The amount discounted.
|
|
2088
|
-
*/
|
|
2089
|
-
amount: number;
|
|
2090
|
-
/**
|
|
2091
|
-
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
2092
|
-
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
2093
|
-
*
|
|
2094
|
-
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
2095
|
-
*/
|
|
2096
|
-
discount: Discount;
|
|
2097
|
-
}
|
|
2098
|
-
interface Tax {
|
|
2099
|
-
/**
|
|
2100
|
-
* Amount of tax applied for this rate.
|
|
2101
|
-
*/
|
|
2102
|
-
amount: number;
|
|
2103
|
-
/**
|
|
2104
|
-
* Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
2105
|
-
*
|
|
2106
|
-
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
2107
|
-
*/
|
|
2108
|
-
rate: TaxRate;
|
|
2109
|
-
/**
|
|
2110
|
-
* 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.
|
|
2111
|
-
*/
|
|
2112
|
-
taxability_reason: Tax.TaxabilityReason | null;
|
|
2113
|
-
/**
|
|
2114
|
-
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
2115
|
-
*/
|
|
2116
|
-
taxable_amount: number | null;
|
|
2117
|
-
}
|
|
2118
|
-
namespace Tax {
|
|
2119
|
-
type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
|
|
2120
|
-
}
|
|
2121
|
-
}
|
|
2122
|
-
}
|
|
2123
|
-
namespace WalletOptions {
|
|
2124
|
-
interface Link {
|
|
2070
|
+
taxability_reason: Tax.TaxabilityReason | null;
|
|
2125
2071
|
/**
|
|
2126
|
-
*
|
|
2072
|
+
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
2127
2073
|
*/
|
|
2128
|
-
|
|
2074
|
+
taxable_amount: number | null;
|
|
2129
2075
|
}
|
|
2130
|
-
namespace
|
|
2131
|
-
type
|
|
2076
|
+
namespace Tax {
|
|
2077
|
+
type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
|
|
2132
2078
|
}
|
|
2133
2079
|
}
|
|
2134
2080
|
}
|
|
2081
|
+
namespace WalletOptions {
|
|
2082
|
+
interface Link {
|
|
2083
|
+
/**
|
|
2084
|
+
* Describes whether Checkout should display Link. Defaults to `auto`.
|
|
2085
|
+
*/
|
|
2086
|
+
display?: Link.Display;
|
|
2087
|
+
}
|
|
2088
|
+
namespace Link {
|
|
2089
|
+
type Display = 'auto' | 'never';
|
|
2090
|
+
}
|
|
2091
|
+
}
|
|
2135
2092
|
}
|
|
2136
2093
|
export declare namespace Checkout {
|
|
2137
2094
|
interface SessionCreateParams {
|
|
@@ -2281,8 +2238,6 @@ export declare namespace Checkout {
|
|
|
2281
2238
|
* You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
|
|
2282
2239
|
*
|
|
2283
2240
|
* If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.
|
|
2284
|
-
*
|
|
2285
|
-
* You can't set this parameter if `ui_mode` is `custom`.
|
|
2286
2241
|
*/
|
|
2287
2242
|
name_collection?: SessionCreateParams.NameCollection;
|
|
2288
2243
|
/**
|
|
@@ -2555,16 +2510,12 @@ export declare namespace Checkout {
|
|
|
2555
2510
|
* The ID of the coupon to apply to this Session.
|
|
2556
2511
|
*/
|
|
2557
2512
|
coupon?: string;
|
|
2558
|
-
/**
|
|
2559
|
-
* Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
2560
|
-
*/
|
|
2561
|
-
coupon_data?: Discount.CouponData;
|
|
2562
2513
|
/**
|
|
2563
2514
|
* The ID of a promotion code to apply to this Session.
|
|
2564
2515
|
*/
|
|
2565
2516
|
promotion_code?: string;
|
|
2566
2517
|
}
|
|
2567
|
-
type ExcludedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | '
|
|
2518
|
+
type ExcludedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
|
|
2568
2519
|
interface InvoiceCreation {
|
|
2569
2520
|
/**
|
|
2570
2521
|
* Set to `true` to enable invoice creation.
|
|
@@ -2760,10 +2711,6 @@ export declare namespace Checkout {
|
|
|
2760
2711
|
* contains details about the Billie payment method options.
|
|
2761
2712
|
*/
|
|
2762
2713
|
billie?: PaymentMethodOptions.Billie;
|
|
2763
|
-
/**
|
|
2764
|
-
* contains details about the BLIK payment method options.
|
|
2765
|
-
*/
|
|
2766
|
-
blik?: PaymentMethodOptions.Blik;
|
|
2767
2714
|
/**
|
|
2768
2715
|
* contains details about the Boleto payment method options.
|
|
2769
2716
|
*/
|
|
@@ -2896,6 +2843,10 @@ export declare namespace Checkout {
|
|
|
2896
2843
|
* contains details about the Sofort payment method options.
|
|
2897
2844
|
*/
|
|
2898
2845
|
sofort?: PaymentMethodOptions.Sofort;
|
|
2846
|
+
/**
|
|
2847
|
+
* contains details about the Sunbit payment method options.
|
|
2848
|
+
*/
|
|
2849
|
+
sunbit?: PaymentMethodOptions.Sunbit;
|
|
2899
2850
|
/**
|
|
2900
2851
|
* contains details about the Swish payment method options.
|
|
2901
2852
|
*/
|
|
@@ -2917,26 +2868,8 @@ export declare namespace Checkout {
|
|
|
2917
2868
|
*/
|
|
2918
2869
|
wechat_pay?: PaymentMethodOptions.WechatPay;
|
|
2919
2870
|
}
|
|
2920
|
-
type PaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | '
|
|
2871
|
+
type PaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
|
|
2921
2872
|
interface Permissions {
|
|
2922
|
-
/**
|
|
2923
|
-
* Permissions for updating the Checkout Session.
|
|
2924
|
-
*/
|
|
2925
|
-
update?: Permissions.Update;
|
|
2926
|
-
/**
|
|
2927
|
-
* Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
|
|
2928
|
-
*
|
|
2929
|
-
* Default is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.
|
|
2930
|
-
*/
|
|
2931
|
-
update_discounts?: Permissions.UpdateDiscounts;
|
|
2932
|
-
/**
|
|
2933
|
-
* Determines which entity is allowed to update the line items.
|
|
2934
|
-
*
|
|
2935
|
-
* Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
|
|
2936
|
-
*
|
|
2937
|
-
* When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
|
|
2938
|
-
*/
|
|
2939
|
-
update_line_items?: Permissions.UpdateLineItems;
|
|
2940
2873
|
/**
|
|
2941
2874
|
* Determines which entity is allowed to update the shipping details.
|
|
2942
2875
|
*
|
|
@@ -3010,6 +2943,10 @@ export declare namespace Checkout {
|
|
|
3010
2943
|
* A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `elements`.
|
|
3011
2944
|
*/
|
|
3012
2945
|
billing_cycle_anchor?: number;
|
|
2946
|
+
/**
|
|
2947
|
+
* Configures when the subscription schedule's billing cycle anchors to a specific day of the week or month.
|
|
2948
|
+
*/
|
|
2949
|
+
billing_cycle_anchor_config?: SubscriptionData.BillingCycleAnchorConfig;
|
|
3013
2950
|
/**
|
|
3014
2951
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
3015
2952
|
*/
|
|
@@ -3255,37 +3192,6 @@ export declare namespace Checkout {
|
|
|
3255
3192
|
message: string;
|
|
3256
3193
|
}
|
|
3257
3194
|
}
|
|
3258
|
-
namespace Discount {
|
|
3259
|
-
interface CouponData {
|
|
3260
|
-
/**
|
|
3261
|
-
* A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
|
|
3262
|
-
*/
|
|
3263
|
-
amount_off?: number;
|
|
3264
|
-
/**
|
|
3265
|
-
* Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
|
|
3266
|
-
*/
|
|
3267
|
-
currency?: string;
|
|
3268
|
-
/**
|
|
3269
|
-
* Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
3270
|
-
*/
|
|
3271
|
-
duration?: CouponData.Duration;
|
|
3272
|
-
/**
|
|
3273
|
-
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
3274
|
-
*/
|
|
3275
|
-
metadata?: Emptyable<MetadataParam>;
|
|
3276
|
-
/**
|
|
3277
|
-
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
3278
|
-
*/
|
|
3279
|
-
name?: string;
|
|
3280
|
-
/**
|
|
3281
|
-
* A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
|
|
3282
|
-
*/
|
|
3283
|
-
percent_off?: number;
|
|
3284
|
-
}
|
|
3285
|
-
namespace CouponData {
|
|
3286
|
-
type Duration = 'forever' | 'once' | 'repeating';
|
|
3287
|
-
}
|
|
3288
|
-
}
|
|
3289
3195
|
namespace InvoiceCreation {
|
|
3290
3196
|
interface InvoiceData {
|
|
3291
3197
|
/**
|
|
@@ -3423,10 +3329,6 @@ export declare namespace Checkout {
|
|
|
3423
3329
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3424
3330
|
*/
|
|
3425
3331
|
tax_code?: string;
|
|
3426
|
-
/**
|
|
3427
|
-
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
3428
|
-
*/
|
|
3429
|
-
tax_details?: ProductData.TaxDetails;
|
|
3430
3332
|
/**
|
|
3431
3333
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
3432
3334
|
*/
|
|
@@ -3443,18 +3345,6 @@ export declare namespace Checkout {
|
|
|
3443
3345
|
interval_count?: number;
|
|
3444
3346
|
}
|
|
3445
3347
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3446
|
-
namespace ProductData {
|
|
3447
|
-
interface TaxDetails {
|
|
3448
|
-
/**
|
|
3449
|
-
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
3450
|
-
*/
|
|
3451
|
-
performance_location?: string;
|
|
3452
|
-
/**
|
|
3453
|
-
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3454
|
-
*/
|
|
3455
|
-
tax_code?: Emptyable<string>;
|
|
3456
|
-
}
|
|
3457
|
-
}
|
|
3458
3348
|
namespace Recurring {
|
|
3459
3349
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3460
3350
|
}
|
|
@@ -3689,13 +3579,6 @@ export declare namespace Checkout {
|
|
|
3689
3579
|
*/
|
|
3690
3580
|
capture_method?: 'manual';
|
|
3691
3581
|
}
|
|
3692
|
-
interface Blik {
|
|
3693
|
-
/**
|
|
3694
|
-
* Additional fields for Mandate creation
|
|
3695
|
-
*/
|
|
3696
|
-
mandate_options?: Blik.MandateOptions;
|
|
3697
|
-
setup_future_usage?: Emptyable<Blik.SetupFutureUsage>;
|
|
3698
|
-
}
|
|
3699
3582
|
interface Boleto {
|
|
3700
3583
|
/**
|
|
3701
3584
|
* The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
|
|
@@ -3721,10 +3604,6 @@ export declare namespace Checkout {
|
|
|
3721
3604
|
* Installment options for card payments
|
|
3722
3605
|
*/
|
|
3723
3606
|
installments?: Card.Installments;
|
|
3724
|
-
/**
|
|
3725
|
-
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
3726
|
-
*/
|
|
3727
|
-
request_decremental_authorization?: Card.RequestDecrementalAuthorization;
|
|
3728
3607
|
/**
|
|
3729
3608
|
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
3730
3609
|
*/
|
|
@@ -4081,10 +3960,6 @@ export declare namespace Checkout {
|
|
|
4081
3960
|
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
|
4082
3961
|
*/
|
|
4083
3962
|
reference?: string;
|
|
4084
|
-
/**
|
|
4085
|
-
* A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
|
4086
|
-
*/
|
|
4087
|
-
reference_id?: string;
|
|
4088
3963
|
/**
|
|
4089
3964
|
* The risk correlation ID for an on-session payment using a saved PayPal payment method.
|
|
4090
3965
|
*/
|
|
@@ -4101,10 +3976,6 @@ export declare namespace Checkout {
|
|
|
4101
3976
|
* If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
|
|
4102
3977
|
*/
|
|
4103
3978
|
setup_future_usage?: Emptyable<Paypal.SetupFutureUsage>;
|
|
4104
|
-
/**
|
|
4105
|
-
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
4106
|
-
*/
|
|
4107
|
-
subsellers?: Array<string>;
|
|
4108
3979
|
}
|
|
4109
3980
|
interface Payto {
|
|
4110
3981
|
/**
|
|
@@ -4212,6 +4083,22 @@ export declare namespace Checkout {
|
|
|
4212
4083
|
*/
|
|
4213
4084
|
setup_future_usage?: 'none';
|
|
4214
4085
|
}
|
|
4086
|
+
interface Sunbit {
|
|
4087
|
+
/**
|
|
4088
|
+
* Controls when the funds will be captured from the customer's account.
|
|
4089
|
+
*/
|
|
4090
|
+
capture_method?: 'manual';
|
|
4091
|
+
/**
|
|
4092
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
4093
|
+
*
|
|
4094
|
+
* If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
4095
|
+
*
|
|
4096
|
+
* If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
4097
|
+
*
|
|
4098
|
+
* When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
|
|
4099
|
+
*/
|
|
4100
|
+
setup_future_usage?: 'none';
|
|
4101
|
+
}
|
|
4215
4102
|
interface Swish {
|
|
4216
4103
|
/**
|
|
4217
4104
|
* The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
|
|
@@ -4327,15 +4214,6 @@ export declare namespace Checkout {
|
|
|
4327
4214
|
}
|
|
4328
4215
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
4329
4216
|
}
|
|
4330
|
-
namespace Blik {
|
|
4331
|
-
interface MandateOptions {
|
|
4332
|
-
/**
|
|
4333
|
-
* Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
|
|
4334
|
-
*/
|
|
4335
|
-
expires_after?: number;
|
|
4336
|
-
}
|
|
4337
|
-
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
4338
|
-
}
|
|
4339
4217
|
namespace Boleto {
|
|
4340
4218
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
4341
4219
|
}
|
|
@@ -4347,7 +4225,6 @@ export declare namespace Checkout {
|
|
|
4347
4225
|
*/
|
|
4348
4226
|
enabled?: boolean;
|
|
4349
4227
|
}
|
|
4350
|
-
type RequestDecrementalAuthorization = 'if_available' | 'never';
|
|
4351
4228
|
type RequestExtendedAuthorization = 'if_available' | 'never';
|
|
4352
4229
|
type RequestIncrementalAuthorization = 'if_available' | 'never';
|
|
4353
4230
|
type RequestMulticapture = 'if_available' | 'never';
|
|
@@ -4586,7 +4463,7 @@ export declare namespace Checkout {
|
|
|
4586
4463
|
type VerificationMethod = 'automatic' | 'instant';
|
|
4587
4464
|
namespace FinancialConnections {
|
|
4588
4465
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
4589
|
-
type Prefetch = 'balances' | '
|
|
4466
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
4590
4467
|
}
|
|
4591
4468
|
}
|
|
4592
4469
|
namespace WechatPay {
|
|
@@ -4594,31 +4471,7 @@ export declare namespace Checkout {
|
|
|
4594
4471
|
}
|
|
4595
4472
|
}
|
|
4596
4473
|
namespace Permissions {
|
|
4597
|
-
interface Update {
|
|
4598
|
-
/**
|
|
4599
|
-
* Determines which entity is allowed to update the line items.
|
|
4600
|
-
*
|
|
4601
|
-
* Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
|
|
4602
|
-
*
|
|
4603
|
-
* When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
|
|
4604
|
-
*/
|
|
4605
|
-
line_items?: Update.LineItems;
|
|
4606
|
-
/**
|
|
4607
|
-
* Determines which entity is allowed to update the shipping details.
|
|
4608
|
-
*
|
|
4609
|
-
* Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
|
|
4610
|
-
*
|
|
4611
|
-
* When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
|
|
4612
|
-
*/
|
|
4613
|
-
shipping_details?: Update.ShippingDetails;
|
|
4614
|
-
}
|
|
4615
|
-
type UpdateDiscounts = 'client_only' | 'server_only';
|
|
4616
|
-
type UpdateLineItems = 'client_only' | 'server_only';
|
|
4617
4474
|
type UpdateShippingDetails = 'client_only' | 'server_only';
|
|
4618
|
-
namespace Update {
|
|
4619
|
-
type LineItems = 'client_only' | 'server_only';
|
|
4620
|
-
type ShippingDetails = 'client_only' | 'server_only';
|
|
4621
|
-
}
|
|
4622
4475
|
}
|
|
4623
4476
|
namespace SavedPaymentMethodOptions {
|
|
4624
4477
|
type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
|
|
@@ -4733,6 +4586,28 @@ export declare namespace Checkout {
|
|
|
4733
4586
|
}
|
|
4734
4587
|
}
|
|
4735
4588
|
namespace SubscriptionData {
|
|
4589
|
+
interface BillingCycleAnchorConfig {
|
|
4590
|
+
/**
|
|
4591
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4592
|
+
*/
|
|
4593
|
+
day_of_month: number;
|
|
4594
|
+
/**
|
|
4595
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4596
|
+
*/
|
|
4597
|
+
hour?: number;
|
|
4598
|
+
/**
|
|
4599
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4600
|
+
*/
|
|
4601
|
+
minute?: number;
|
|
4602
|
+
/**
|
|
4603
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4604
|
+
*/
|
|
4605
|
+
month?: number;
|
|
4606
|
+
/**
|
|
4607
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4608
|
+
*/
|
|
4609
|
+
second?: number;
|
|
4610
|
+
}
|
|
4736
4611
|
interface BillingMode {
|
|
4737
4612
|
/**
|
|
4738
4613
|
* Configure behavior for flexible billing mode.
|
|
@@ -4844,26 +4719,14 @@ export declare namespace Checkout {
|
|
|
4844
4719
|
}
|
|
4845
4720
|
export declare namespace Checkout {
|
|
4846
4721
|
interface SessionUpdateParams {
|
|
4847
|
-
/**
|
|
4848
|
-
* Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
|
|
4849
|
-
*/
|
|
4850
|
-
automatic_tax?: SessionUpdateParams.AutomaticTax;
|
|
4851
4722
|
/**
|
|
4852
4723
|
* Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
|
|
4853
4724
|
*/
|
|
4854
4725
|
collected_information?: SessionUpdateParams.CollectedInformation;
|
|
4855
|
-
/**
|
|
4856
|
-
* List of coupons and promotion codes attached to the Checkout Session.
|
|
4857
|
-
*/
|
|
4858
|
-
discounts?: Emptyable<Array<SessionUpdateParams.Discount>>;
|
|
4859
4726
|
/**
|
|
4860
4727
|
* Specifies which fields in the response should be expanded.
|
|
4861
4728
|
*/
|
|
4862
4729
|
expand?: Array<string>;
|
|
4863
|
-
/**
|
|
4864
|
-
* Generate a post-purchase Invoice for one-time payments.
|
|
4865
|
-
*/
|
|
4866
|
-
invoice_creation?: SessionUpdateParams.InvoiceCreation;
|
|
4867
4730
|
/**
|
|
4868
4731
|
* A list of items the customer is purchasing.
|
|
4869
4732
|
*
|
|
@@ -4888,40 +4751,14 @@ export declare namespace Checkout {
|
|
|
4888
4751
|
* The shipping rate options to apply to this Session. Up to a maximum of 5.
|
|
4889
4752
|
*/
|
|
4890
4753
|
shipping_options?: Emptyable<Array<SessionUpdateParams.ShippingOption>>;
|
|
4891
|
-
/**
|
|
4892
|
-
* A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
|
|
4893
|
-
*/
|
|
4894
|
-
subscription_data?: SessionUpdateParams.SubscriptionData;
|
|
4895
4754
|
}
|
|
4896
4755
|
namespace SessionUpdateParams {
|
|
4897
|
-
interface AutomaticTax {
|
|
4898
|
-
/**
|
|
4899
|
-
* The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
|
4900
|
-
*/
|
|
4901
|
-
liability?: AutomaticTax.Liability;
|
|
4902
|
-
}
|
|
4903
4756
|
interface CollectedInformation {
|
|
4904
4757
|
/**
|
|
4905
4758
|
* The shipping details to apply to this Session.
|
|
4906
4759
|
*/
|
|
4907
4760
|
shipping_details?: CollectedInformation.ShippingDetails;
|
|
4908
4761
|
}
|
|
4909
|
-
interface Discount {
|
|
4910
|
-
/**
|
|
4911
|
-
* The ID of the [Coupon](https://docs.stripe.com/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
4912
|
-
*/
|
|
4913
|
-
coupon?: string;
|
|
4914
|
-
/**
|
|
4915
|
-
* Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
4916
|
-
*/
|
|
4917
|
-
coupon_data?: Discount.CouponData;
|
|
4918
|
-
}
|
|
4919
|
-
interface InvoiceCreation {
|
|
4920
|
-
/**
|
|
4921
|
-
* Parameters passed when creating invoices for payment-mode Checkout Sessions.
|
|
4922
|
-
*/
|
|
4923
|
-
invoice_data?: InvoiceCreation.InvoiceData;
|
|
4924
|
-
}
|
|
4925
4762
|
interface LineItem {
|
|
4926
4763
|
/**
|
|
4927
4764
|
* When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
|
|
@@ -4962,39 +4799,6 @@ export declare namespace Checkout {
|
|
|
4962
4799
|
*/
|
|
4963
4800
|
shipping_rate_data?: ShippingOption.ShippingRateData;
|
|
4964
4801
|
}
|
|
4965
|
-
interface SubscriptionData {
|
|
4966
|
-
/**
|
|
4967
|
-
* All invoices will be billed using the specified settings.
|
|
4968
|
-
*/
|
|
4969
|
-
invoice_settings?: SubscriptionData.InvoiceSettings;
|
|
4970
|
-
/**
|
|
4971
|
-
* Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
|
|
4972
|
-
*/
|
|
4973
|
-
pending_invoice_item_interval?: Emptyable<SubscriptionData.PendingInvoiceItemInterval>;
|
|
4974
|
-
/**
|
|
4975
|
-
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
|
|
4976
|
-
*/
|
|
4977
|
-
trial_end?: number;
|
|
4978
|
-
/**
|
|
4979
|
-
* Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
|
4980
|
-
*/
|
|
4981
|
-
trial_period_days?: Emptyable<number>;
|
|
4982
|
-
}
|
|
4983
|
-
namespace AutomaticTax {
|
|
4984
|
-
interface Liability {
|
|
4985
|
-
/**
|
|
4986
|
-
* The connected account being referenced when `type` is `account`.
|
|
4987
|
-
*/
|
|
4988
|
-
account?: string;
|
|
4989
|
-
/**
|
|
4990
|
-
* Type of the account referenced in the request.
|
|
4991
|
-
*/
|
|
4992
|
-
type: Liability.Type;
|
|
4993
|
-
}
|
|
4994
|
-
namespace Liability {
|
|
4995
|
-
type Type = 'account' | 'self';
|
|
4996
|
-
}
|
|
4997
|
-
}
|
|
4998
4802
|
namespace CollectedInformation {
|
|
4999
4803
|
interface ShippingDetails {
|
|
5000
4804
|
/**
|
|
@@ -5035,60 +4839,6 @@ export declare namespace Checkout {
|
|
|
5035
4839
|
}
|
|
5036
4840
|
}
|
|
5037
4841
|
}
|
|
5038
|
-
namespace Discount {
|
|
5039
|
-
interface CouponData {
|
|
5040
|
-
/**
|
|
5041
|
-
* A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
|
|
5042
|
-
*/
|
|
5043
|
-
amount_off?: number;
|
|
5044
|
-
/**
|
|
5045
|
-
* Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
|
|
5046
|
-
*/
|
|
5047
|
-
currency?: string;
|
|
5048
|
-
/**
|
|
5049
|
-
* Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
5050
|
-
*/
|
|
5051
|
-
duration?: CouponData.Duration;
|
|
5052
|
-
/**
|
|
5053
|
-
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
5054
|
-
*/
|
|
5055
|
-
metadata?: Emptyable<MetadataParam>;
|
|
5056
|
-
/**
|
|
5057
|
-
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
5058
|
-
*/
|
|
5059
|
-
name?: string;
|
|
5060
|
-
/**
|
|
5061
|
-
* A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
|
|
5062
|
-
*/
|
|
5063
|
-
percent_off?: number;
|
|
5064
|
-
}
|
|
5065
|
-
namespace CouponData {
|
|
5066
|
-
type Duration = 'forever' | 'once' | 'repeating';
|
|
5067
|
-
}
|
|
5068
|
-
}
|
|
5069
|
-
namespace InvoiceCreation {
|
|
5070
|
-
interface InvoiceData {
|
|
5071
|
-
/**
|
|
5072
|
-
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
5073
|
-
*/
|
|
5074
|
-
issuer?: InvoiceData.Issuer;
|
|
5075
|
-
}
|
|
5076
|
-
namespace InvoiceData {
|
|
5077
|
-
interface Issuer {
|
|
5078
|
-
/**
|
|
5079
|
-
* The connected account being referenced when `type` is `account`.
|
|
5080
|
-
*/
|
|
5081
|
-
account?: string;
|
|
5082
|
-
/**
|
|
5083
|
-
* Type of the account referenced in the request.
|
|
5084
|
-
*/
|
|
5085
|
-
type: Issuer.Type;
|
|
5086
|
-
}
|
|
5087
|
-
namespace Issuer {
|
|
5088
|
-
type Type = 'account' | 'self';
|
|
5089
|
-
}
|
|
5090
|
-
}
|
|
5091
|
-
}
|
|
5092
4842
|
namespace LineItem {
|
|
5093
4843
|
interface AdjustableQuantity {
|
|
5094
4844
|
/**
|
|
@@ -5156,10 +4906,6 @@ export declare namespace Checkout {
|
|
|
5156
4906
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5157
4907
|
*/
|
|
5158
4908
|
tax_code?: string;
|
|
5159
|
-
/**
|
|
5160
|
-
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
5161
|
-
*/
|
|
5162
|
-
tax_details?: ProductData.TaxDetails;
|
|
5163
4909
|
/**
|
|
5164
4910
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
5165
4911
|
*/
|
|
@@ -5176,18 +4922,6 @@ export declare namespace Checkout {
|
|
|
5176
4922
|
interval_count?: number;
|
|
5177
4923
|
}
|
|
5178
4924
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
5179
|
-
namespace ProductData {
|
|
5180
|
-
interface TaxDetails {
|
|
5181
|
-
/**
|
|
5182
|
-
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
5183
|
-
*/
|
|
5184
|
-
performance_location?: string;
|
|
5185
|
-
/**
|
|
5186
|
-
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5187
|
-
*/
|
|
5188
|
-
tax_code?: Emptyable<string>;
|
|
5189
|
-
}
|
|
5190
|
-
}
|
|
5191
4925
|
namespace Recurring {
|
|
5192
4926
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5193
4927
|
}
|
|
@@ -5297,42 +5031,6 @@ export declare namespace Checkout {
|
|
|
5297
5031
|
}
|
|
5298
5032
|
}
|
|
5299
5033
|
}
|
|
5300
|
-
namespace SubscriptionData {
|
|
5301
|
-
interface InvoiceSettings {
|
|
5302
|
-
/**
|
|
5303
|
-
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
5304
|
-
*/
|
|
5305
|
-
issuer?: InvoiceSettings.Issuer;
|
|
5306
|
-
}
|
|
5307
|
-
interface PendingInvoiceItemInterval {
|
|
5308
|
-
/**
|
|
5309
|
-
* Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
|
|
5310
|
-
*/
|
|
5311
|
-
interval: PendingInvoiceItemInterval.Interval;
|
|
5312
|
-
/**
|
|
5313
|
-
* The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
|
|
5314
|
-
*/
|
|
5315
|
-
interval_count?: number;
|
|
5316
|
-
}
|
|
5317
|
-
namespace InvoiceSettings {
|
|
5318
|
-
interface Issuer {
|
|
5319
|
-
/**
|
|
5320
|
-
* The connected account being referenced when `type` is `account`.
|
|
5321
|
-
*/
|
|
5322
|
-
account?: string;
|
|
5323
|
-
/**
|
|
5324
|
-
* Type of the account referenced in the request.
|
|
5325
|
-
*/
|
|
5326
|
-
type: Issuer.Type;
|
|
5327
|
-
}
|
|
5328
|
-
namespace Issuer {
|
|
5329
|
-
type Type = 'account' | 'self';
|
|
5330
|
-
}
|
|
5331
|
-
}
|
|
5332
|
-
namespace PendingInvoiceItemInterval {
|
|
5333
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5334
|
-
}
|
|
5335
|
-
}
|
|
5336
5034
|
}
|
|
5337
5035
|
}
|
|
5338
5036
|
export declare namespace Checkout {
|