stripe 18.6.0-beta.1 → 19.0.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 +107 -1364
- package/OPENAPI_VERSION +1 -1
- package/README.md +22 -7
- package/VERSION +1 -1
- package/cjs/Error.js +1 -107
- package/cjs/RequestSender.js +15 -6
- package/cjs/StripeContext.js +56 -0
- package/cjs/apiVersion.js +3 -2
- package/cjs/net/FetchHttpClient.js +1 -1
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/Mandates.js +0 -5
- package/cjs/resources/PaymentIntents.js +0 -13
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources/V2/Core/Events.js +1 -1
- package/cjs/resources.js +8 -100
- package/cjs/stripe.core.js +24 -3
- package/esm/Error.js +0 -93
- package/esm/RequestSender.js +15 -6
- package/esm/StripeContext.js +52 -0
- package/esm/apiVersion.js +2 -1
- package/esm/net/FetchHttpClient.js +1 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/Mandates.js +0 -5
- package/esm/resources/PaymentIntents.js +0 -13
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources/V2/Core/Events.js +1 -1
- package/esm/resources.js +0 -85
- package/esm/stripe.core.js +24 -3
- package/package.json +4 -4
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +0 -75
- package/types/AccountSessionsResource.d.ts +0 -306
- package/types/Accounts.d.ts +5 -207
- package/types/AccountsResource.d.ts +4 -528
- package/types/BalanceSettings.d.ts +12 -6
- package/types/BalanceSettingsResource.d.ts +15 -10
- package/types/BankAccounts.d.ts +4 -0
- package/types/Billing/AlertTriggereds.d.ts +1 -1
- package/types/Billing/AlertsResource.d.ts +1 -1
- package/types/Billing/CreditBalanceSummary.d.ts +0 -5
- package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
- package/types/Billing/CreditGrants.d.ts +0 -5
- package/types/Billing/CreditGrantsResource.d.ts +1 -11
- package/types/BillingPortal/Configurations.d.ts +7 -0
- package/types/BillingPortal/ConfigurationsResource.d.ts +14 -0
- package/types/BillingPortal/Sessions.d.ts +0 -5
- package/types/BillingPortal/SessionsResource.d.ts +4 -12
- package/types/Capabilities.d.ts +4 -0
- package/types/Cards.d.ts +1 -6
- package/types/CashBalances.d.ts +0 -5
- package/types/Charges.d.ts +1 -169
- package/types/ChargesResource.d.ts +0 -1406
- package/types/Checkout/Sessions.d.ts +204 -360
- package/types/Checkout/SessionsResource.d.ts +346 -521
- package/types/ConfirmationTokens.d.ts +0 -120
- package/types/Coupons.d.ts +0 -33
- package/types/CouponsResource.d.ts +0 -21
- package/types/CreditNoteLineItems.d.ts +0 -17
- package/types/CreditNotes.d.ts +0 -5
- package/types/CreditNotesResource.d.ts +0 -5
- package/types/CustomerBalanceTransactions.d.ts +0 -2
- package/types/CustomerCashBalanceTransactions.d.ts +0 -2
- package/types/CustomerSessions.d.ts +0 -5
- package/types/CustomerSessionsResource.d.ts +1 -6
- package/types/Customers.d.ts +10 -2
- package/types/CustomersResource.d.ts +20 -7
- package/types/Discounts.d.ts +32 -24
- package/types/Disputes.d.ts +6 -29
- package/types/Errors.d.ts +0 -79
- package/types/EventTypes.d.ts +0 -664
- package/types/Events.d.ts +0 -97
- package/types/ExchangeRates.d.ts +2 -0
- package/types/ExchangeRatesResource.d.ts +6 -0
- package/types/FinancialConnections/Accounts.d.ts +1 -36
- package/types/FinancialConnections/AccountsResource.d.ts +3 -40
- package/types/FinancialConnections/Sessions.d.ts +1 -51
- package/types/FinancialConnections/SessionsResource.d.ts +1 -43
- package/types/Identity/VerificationSessions.d.ts +0 -5
- package/types/Identity/VerificationSessionsResource.d.ts +0 -7
- package/types/InvoiceItems.d.ts +27 -9
- package/types/InvoiceItemsResource.d.ts +6 -117
- package/types/InvoiceLineItems.d.ts +1 -45
- package/types/InvoicePayments.d.ts +0 -5
- package/types/InvoicePaymentsResource.d.ts +1 -10
- package/types/Invoices.d.ts +6 -172
- package/types/InvoicesResource.d.ts +54 -1523
- package/types/Issuing/CardholdersResource.d.ts +5 -6
- package/types/Issuing/Cards.d.ts +5 -0
- package/types/Issuing/CardsResource.d.ts +4 -4
- package/types/Issuing/Transactions.d.ts +0 -5
- package/types/Issuing/TransactionsResource.d.ts +0 -5
- package/types/LineItems.d.ts +0 -49
- package/types/Mandates.d.ts +1 -135
- package/types/MandatesResource.d.ts +0 -31
- package/types/PaymentIntents.d.ts +5 -820
- package/types/PaymentIntentsResource.d.ts +5643 -11279
- package/types/PaymentLinks.d.ts +0 -6
- package/types/PaymentLinksResource.d.ts +5 -12
- package/types/PaymentMethodConfigurations.d.ts +0 -180
- package/types/PaymentMethodConfigurationsResource.d.ts +28 -228
- package/types/PaymentMethods.d.ts +0 -125
- package/types/PaymentMethodsResource.d.ts +2 -172
- package/types/Persons.d.ts +4 -0
- package/types/Prices.d.ts +0 -22
- package/types/PricesResource.d.ts +0 -22
- package/types/PromotionCodes.d.ts +16 -14
- package/types/PromotionCodesResource.d.ts +15 -13
- package/types/Quotes.d.ts +9 -589
- package/types/QuotesResource.d.ts +290 -2619
- package/types/Refunds.d.ts +0 -14
- package/types/Reviews.d.ts +2 -0
- package/types/SetupAttempts.d.ts +3 -51
- package/types/SetupIntents.d.ts +4 -210
- package/types/SetupIntentsResource.d.ts +3 -913
- package/types/Sources.d.ts +1 -30
- package/types/SubscriptionItems.d.ts +0 -21
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +16 -205
- package/types/SubscriptionSchedulesResource.d.ts +21 -1243
- package/types/Subscriptions.d.ts +17 -135
- package/types/SubscriptionsResource.d.ts +49 -476
- package/types/Tax/CalculationsResource.d.ts +5 -5
- package/types/Tax/Settings.d.ts +7 -0
- package/types/TaxIds.d.ts +0 -10
- package/types/TaxIdsResource.d.ts +0 -10
- package/types/Terminal/Configurations.d.ts +9 -9
- package/types/Terminal/ConfigurationsResource.d.ts +26 -28
- package/types/Terminal/Locations.d.ts +95 -0
- package/types/Terminal/LocationsResource.d.ts +59 -6
- package/types/Terminal/Readers.d.ts +0 -20
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -118
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +79 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/Transfers.d.ts +0 -5
- package/types/TransfersResource.d.ts +0 -5
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +0 -5
- package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
- package/types/Treasury/OutboundTransfers.d.ts +0 -26
- package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
- package/types/Treasury/ReceivedCredits.d.ts +0 -26
- package/types/Treasury/ReceivedDebits.d.ts +0 -31
- package/types/V2/Billing/MeterEventStreamResource.d.ts +1 -1
- package/types/V2/Core/EventDestinations.d.ts +166 -0
- package/types/V2/Core/EventDestinationsResource.d.ts +14 -14
- package/types/V2/Core/EventTypes.d.ts +256 -0
- package/types/V2/Core/Events.d.ts +77 -0
- package/types/V2/Core/EventsResource.d.ts +4 -4
- package/types/V2/DeletedObject.d.ts +22 -0
- package/types/V2/EventMisc.d.ts +72 -0
- package/types/WebhookEndpointsResource.d.ts +2 -79
- package/types/apiVersion.d.ts +4 -0
- package/types/index.d.ts +8 -150
- package/types/lib.d.ts +7 -15
- package/types/test/typescriptTest.ts +48 -3
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/Billing/MeterUsage.js +0 -12
- package/cjs/resources/Capital/FinancingOffers.js +0 -21
- package/cjs/resources/Capital/FinancingSummary.js +0 -12
- package/cjs/resources/Capital/FinancingTransactions.js +0 -17
- package/cjs/resources/ExternalAccounts.js +0 -23
- package/cjs/resources/FinancialConnections/Institutions.js +0 -17
- package/cjs/resources/FxQuotes.js +0 -15
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
- package/cjs/resources/Margins.js +0 -22
- package/cjs/resources/Orders.js +0 -24
- package/cjs/resources/PaymentAttemptRecords.js +0 -17
- package/cjs/resources/PaymentRecords.js +0 -29
- package/cjs/resources/Privacy/RedactionJobs.js +0 -42
- package/cjs/resources/Tax/Associations.js +0 -9
- package/cjs/resources/Tax/Forms.js +0 -20
- package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
- package/cjs/resources/V2/Core/AccountLinks.js +0 -9
- package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
- package/cjs/resources/V2/Core/Accounts.js +0 -25
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
- package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
- package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/Billing/MeterUsage.js +0 -9
- package/esm/resources/Capital/FinancingOffers.js +0 -18
- package/esm/resources/Capital/FinancingSummary.js +0 -9
- package/esm/resources/Capital/FinancingTransactions.js +0 -14
- package/esm/resources/ExternalAccounts.js +0 -20
- package/esm/resources/FinancialConnections/Institutions.js +0 -14
- package/esm/resources/FxQuotes.js +0 -12
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
- package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
- package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
- package/esm/resources/Margins.js +0 -19
- package/esm/resources/Orders.js +0 -21
- package/esm/resources/PaymentAttemptRecords.js +0 -14
- package/esm/resources/PaymentRecords.js +0 -26
- package/esm/resources/Privacy/RedactionJobs.js +0 -39
- package/esm/resources/Tax/Associations.js +0 -6
- package/esm/resources/Tax/Forms.js +0 -17
- package/esm/resources/Terminal/OnboardingLinks.js +0 -9
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
- package/esm/resources/V2/Core/AccountLinks.js +0 -6
- package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
- package/esm/resources/V2/Core/Accounts.js +0 -22
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
- package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
- package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
- package/types/AccountNotices.d.ts +0 -113
- package/types/AccountNoticesResource.d.ts +0 -98
- package/types/Billing/MeterUsage.d.ts +0 -32
- package/types/Billing/MeterUsageResource.d.ts +0 -685
- package/types/Billing/MeterUsageRows.d.ts +0 -49
- package/types/Capital/FinancingOffers.d.ts +0 -188
- package/types/Capital/FinancingOffersResource.d.ts +0 -97
- package/types/Capital/FinancingSummary.d.ts +0 -106
- package/types/Capital/FinancingSummaryResource.d.ts +0 -27
- package/types/Capital/FinancingTransactions.d.ts +0 -135
- package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
- package/types/ExternalAccountsResource.d.ts +0 -304
- package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
- package/types/FinancialConnections/Institutions.d.ts +0 -98
- package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
- package/types/FxQuotes.d.ts +0 -155
- package/types/FxQuotesResource.d.ts +0 -130
- package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
- package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
- package/types/Issuing/Settlements.d.ts +0 -113
- package/types/Margins.d.ts +0 -56
- package/types/MarginsResource.d.ts +0 -114
- package/types/Orders.d.ts +0 -1163
- package/types/OrdersResource.d.ts +0 -3139
- package/types/PaymentAttemptRecords.d.ts +0 -2321
- package/types/PaymentAttemptRecordsResource.d.ts +0 -52
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
- package/types/PaymentRecords.d.ts +0 -2314
- package/types/PaymentRecordsResource.d.ts +0 -476
- package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
- package/types/Privacy/RedactionJobs.d.ts +0 -111
- package/types/Privacy/RedactionJobsResource.d.ts +0 -230
- package/types/QuoteLines.d.ts +0 -634
- package/types/QuotePreviewInvoices.d.ts +0 -1736
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -892
- package/types/Tax/Associations.d.ts +0 -82
- package/types/Tax/AssociationsResource.d.ts +0 -29
- package/types/Tax/Forms.d.ts +0 -220
- package/types/Tax/FormsResource.d.ts +0 -107
- package/types/Terminal/OnboardingLinks.d.ts +0 -57
- package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
- package/types/Terminal/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
- package/types/ThinEvent.d.ts +0 -36
- package/types/V2/Core/AccountLinks.d.ts +0 -168
- package/types/V2/Core/AccountLinksResource.d.ts +0 -152
- package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3812
- package/types/V2/Core/Accounts.d.ts +0 -8862
- package/types/V2/Core/AccountsResource.d.ts +0 -10704
- package/types/V2/Core/Persons.d.ts +0 -1888
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
- package/types/V2/EventDestinations.d.ts +0 -164
- package/types/V2/EventTypes.d.ts +0 -1188
- package/types/V2/Events.d.ts +0 -75
- package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
- package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -585
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -331
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -289
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -262
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
- package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
- package/types/V2/Payments/OffSessionPayments.d.ts +0 -179
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -174
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
|
@@ -62,6 +62,8 @@ declare module 'stripe' {
|
|
|
62
62
|
*/
|
|
63
63
|
billing_address_collection: Session.BillingAddressCollection | null;
|
|
64
64
|
|
|
65
|
+
branding_settings?: Session.BrandingSettings;
|
|
66
|
+
|
|
65
67
|
/**
|
|
66
68
|
* 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.
|
|
67
69
|
*/
|
|
@@ -126,11 +128,6 @@ declare module 'stripe' {
|
|
|
126
128
|
*/
|
|
127
129
|
customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
|
|
128
130
|
|
|
129
|
-
/**
|
|
130
|
-
* The ID of the account for this Session.
|
|
131
|
-
*/
|
|
132
|
-
customer_account?: string | null;
|
|
133
|
-
|
|
134
131
|
/**
|
|
135
132
|
* Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
|
|
136
133
|
*/
|
|
@@ -155,6 +152,11 @@ declare module 'stripe' {
|
|
|
155
152
|
*/
|
|
156
153
|
discounts: Array<Session.Discount> | null;
|
|
157
154
|
|
|
155
|
+
/**
|
|
156
|
+
* 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).
|
|
157
|
+
*/
|
|
158
|
+
excluded_payment_method_types?: Array<string>;
|
|
159
|
+
|
|
158
160
|
/**
|
|
159
161
|
* The timestamp at which the Checkout Session will expire.
|
|
160
162
|
*/
|
|
@@ -195,6 +197,8 @@ declare module 'stripe' {
|
|
|
195
197
|
*/
|
|
196
198
|
mode: Session.Mode;
|
|
197
199
|
|
|
200
|
+
name_collection?: Session.NameCollection;
|
|
201
|
+
|
|
198
202
|
/**
|
|
199
203
|
* The optional items presented to the customer at checkout.
|
|
200
204
|
*/
|
|
@@ -425,168 +429,114 @@ declare module 'stripe' {
|
|
|
425
429
|
|
|
426
430
|
type BillingAddressCollection = 'auto' | 'required';
|
|
427
431
|
|
|
428
|
-
interface
|
|
432
|
+
interface BrandingSettings {
|
|
429
433
|
/**
|
|
430
|
-
*
|
|
434
|
+
* A hex color value starting with `#` representing the background color for the Checkout Session.
|
|
431
435
|
*/
|
|
432
|
-
|
|
436
|
+
background_color: string;
|
|
433
437
|
|
|
434
438
|
/**
|
|
435
|
-
*
|
|
439
|
+
* The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
|
|
436
440
|
*/
|
|
437
|
-
|
|
441
|
+
border_style: BrandingSettings.BorderStyle;
|
|
438
442
|
|
|
439
443
|
/**
|
|
440
|
-
*
|
|
444
|
+
* A hex color value starting with `#` representing the button color for the Checkout Session.
|
|
441
445
|
*/
|
|
442
|
-
|
|
446
|
+
button_color: string;
|
|
443
447
|
|
|
444
448
|
/**
|
|
445
|
-
*
|
|
449
|
+
* The display name shown on the Checkout Session.
|
|
446
450
|
*/
|
|
447
|
-
|
|
451
|
+
display_name: string;
|
|
448
452
|
|
|
449
453
|
/**
|
|
450
|
-
*
|
|
454
|
+
* 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).
|
|
451
455
|
*/
|
|
452
|
-
|
|
456
|
+
font_family: string;
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* The icon for the Checkout Session. You cannot set both `logo` and `icon`.
|
|
460
|
+
*/
|
|
461
|
+
icon: BrandingSettings.Icon | null;
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* The logo for the Checkout Session. You cannot set both `logo` and `icon`.
|
|
465
|
+
*/
|
|
466
|
+
logo: BrandingSettings.Logo | null;
|
|
453
467
|
}
|
|
454
468
|
|
|
455
|
-
namespace
|
|
456
|
-
|
|
457
|
-
address: Stripe.Address;
|
|
469
|
+
namespace BrandingSettings {
|
|
470
|
+
type BorderStyle = 'pill' | 'rectangular' | 'rounded';
|
|
458
471
|
|
|
472
|
+
interface Icon {
|
|
459
473
|
/**
|
|
460
|
-
*
|
|
474
|
+
* 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.
|
|
461
475
|
*/
|
|
462
|
-
|
|
476
|
+
file?: string;
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* The type of image for the icon. Must be one of `file` or `url`.
|
|
480
|
+
*/
|
|
481
|
+
type: Icon.Type;
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* The URL of the image. Present when `type` is `url`.
|
|
485
|
+
*/
|
|
486
|
+
url?: string;
|
|
463
487
|
}
|
|
464
488
|
|
|
465
|
-
|
|
489
|
+
namespace Icon {
|
|
490
|
+
type Type = 'file' | 'url';
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
interface Logo {
|
|
466
494
|
/**
|
|
467
|
-
* The
|
|
495
|
+
* 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.
|
|
468
496
|
*/
|
|
469
|
-
|
|
497
|
+
file?: string;
|
|
470
498
|
|
|
471
499
|
/**
|
|
472
|
-
* The
|
|
500
|
+
* The type of image for the logo. Must be one of `file` or `url`.
|
|
473
501
|
*/
|
|
474
|
-
|
|
502
|
+
type: Logo.Type;
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* The URL of the image. Present when `type` is `url`.
|
|
506
|
+
*/
|
|
507
|
+
url?: string;
|
|
475
508
|
}
|
|
476
509
|
|
|
477
|
-
namespace
|
|
478
|
-
type Type =
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
| 'cd_nif'
|
|
508
|
-
| 'ch_uid'
|
|
509
|
-
| 'ch_vat'
|
|
510
|
-
| 'cl_tin'
|
|
511
|
-
| 'cm_niu'
|
|
512
|
-
| 'cn_tin'
|
|
513
|
-
| 'co_nit'
|
|
514
|
-
| 'cr_tin'
|
|
515
|
-
| 'cv_nif'
|
|
516
|
-
| 'de_stn'
|
|
517
|
-
| 'do_rcn'
|
|
518
|
-
| 'ec_ruc'
|
|
519
|
-
| 'eg_tin'
|
|
520
|
-
| 'es_cif'
|
|
521
|
-
| 'et_tin'
|
|
522
|
-
| 'eu_oss_vat'
|
|
523
|
-
| 'eu_vat'
|
|
524
|
-
| 'gb_vat'
|
|
525
|
-
| 'ge_vat'
|
|
526
|
-
| 'gn_nif'
|
|
527
|
-
| 'hk_br'
|
|
528
|
-
| 'hr_oib'
|
|
529
|
-
| 'hu_tin'
|
|
530
|
-
| 'id_npwp'
|
|
531
|
-
| 'il_vat'
|
|
532
|
-
| 'in_gst'
|
|
533
|
-
| 'is_vat'
|
|
534
|
-
| 'jp_cn'
|
|
535
|
-
| 'jp_rn'
|
|
536
|
-
| 'jp_trn'
|
|
537
|
-
| 'ke_pin'
|
|
538
|
-
| 'kg_tin'
|
|
539
|
-
| 'kh_tin'
|
|
540
|
-
| 'kr_brn'
|
|
541
|
-
| 'kz_bin'
|
|
542
|
-
| 'la_tin'
|
|
543
|
-
| 'li_uid'
|
|
544
|
-
| 'li_vat'
|
|
545
|
-
| 'ma_vat'
|
|
546
|
-
| 'md_vat'
|
|
547
|
-
| 'me_pib'
|
|
548
|
-
| 'mk_vat'
|
|
549
|
-
| 'mr_nif'
|
|
550
|
-
| 'mx_rfc'
|
|
551
|
-
| 'my_frp'
|
|
552
|
-
| 'my_itn'
|
|
553
|
-
| 'my_sst'
|
|
554
|
-
| 'ng_tin'
|
|
555
|
-
| 'no_vat'
|
|
556
|
-
| 'no_voec'
|
|
557
|
-
| 'np_pan'
|
|
558
|
-
| 'nz_gst'
|
|
559
|
-
| 'om_vat'
|
|
560
|
-
| 'pe_ruc'
|
|
561
|
-
| 'ph_tin'
|
|
562
|
-
| 'ro_tin'
|
|
563
|
-
| 'rs_pib'
|
|
564
|
-
| 'ru_inn'
|
|
565
|
-
| 'ru_kpp'
|
|
566
|
-
| 'sa_vat'
|
|
567
|
-
| 'sg_gst'
|
|
568
|
-
| 'sg_uen'
|
|
569
|
-
| 'si_tin'
|
|
570
|
-
| 'sn_ninea'
|
|
571
|
-
| 'sr_fin'
|
|
572
|
-
| 'sv_nit'
|
|
573
|
-
| 'th_vat'
|
|
574
|
-
| 'tj_tin'
|
|
575
|
-
| 'tr_tin'
|
|
576
|
-
| 'tw_vat'
|
|
577
|
-
| 'tz_vat'
|
|
578
|
-
| 'ua_vat'
|
|
579
|
-
| 'ug_tin'
|
|
580
|
-
| 'unknown'
|
|
581
|
-
| 'us_ein'
|
|
582
|
-
| 'uy_ruc'
|
|
583
|
-
| 'uz_tin'
|
|
584
|
-
| 'uz_vat'
|
|
585
|
-
| 've_rif'
|
|
586
|
-
| 'vn_tin'
|
|
587
|
-
| 'za_vat'
|
|
588
|
-
| 'zm_tin'
|
|
589
|
-
| 'zw_tin';
|
|
510
|
+
namespace Logo {
|
|
511
|
+
type Type = 'file' | 'url';
|
|
512
|
+
}
|
|
513
|
+
}
|
|
514
|
+
|
|
515
|
+
interface CollectedInformation {
|
|
516
|
+
/**
|
|
517
|
+
* Customer's business name for this Checkout Session
|
|
518
|
+
*/
|
|
519
|
+
business_name: string | null;
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* Customer's individual name for this Checkout Session
|
|
523
|
+
*/
|
|
524
|
+
individual_name: string | null;
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* Shipping information for this Checkout Session.
|
|
528
|
+
*/
|
|
529
|
+
shipping_details: CollectedInformation.ShippingDetails | null;
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
namespace CollectedInformation {
|
|
533
|
+
interface ShippingDetails {
|
|
534
|
+
address: Stripe.Address;
|
|
535
|
+
|
|
536
|
+
/**
|
|
537
|
+
* Customer name.
|
|
538
|
+
*/
|
|
539
|
+
name: string;
|
|
590
540
|
}
|
|
591
541
|
}
|
|
592
542
|
|
|
@@ -675,12 +625,22 @@ declare module 'stripe' {
|
|
|
675
625
|
*/
|
|
676
626
|
address: Stripe.Address | null;
|
|
677
627
|
|
|
628
|
+
/**
|
|
629
|
+
* The customer's business name after a completed Checkout Session.
|
|
630
|
+
*/
|
|
631
|
+
business_name: string | null;
|
|
632
|
+
|
|
678
633
|
/**
|
|
679
634
|
* The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
|
|
680
635
|
* 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.
|
|
681
636
|
*/
|
|
682
637
|
email: string | null;
|
|
683
638
|
|
|
639
|
+
/**
|
|
640
|
+
* The customer's individual name after a completed Checkout Session.
|
|
641
|
+
*/
|
|
642
|
+
individual_name: string | null;
|
|
643
|
+
|
|
684
644
|
/**
|
|
685
645
|
* The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
|
686
646
|
*/
|
|
@@ -1150,6 +1110,38 @@ declare module 'stripe' {
|
|
|
1150
1110
|
|
|
1151
1111
|
type Mode = 'payment' | 'setup' | 'subscription';
|
|
1152
1112
|
|
|
1113
|
+
interface NameCollection {
|
|
1114
|
+
business?: NameCollection.Business;
|
|
1115
|
+
|
|
1116
|
+
individual?: NameCollection.Individual;
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1119
|
+
namespace NameCollection {
|
|
1120
|
+
interface Business {
|
|
1121
|
+
/**
|
|
1122
|
+
* Indicates whether business name collection is enabled for the session
|
|
1123
|
+
*/
|
|
1124
|
+
enabled: boolean;
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
1128
|
+
*/
|
|
1129
|
+
optional: boolean;
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
interface Individual {
|
|
1133
|
+
/**
|
|
1134
|
+
* Indicates whether individual name collection is enabled for the session
|
|
1135
|
+
*/
|
|
1136
|
+
enabled: boolean;
|
|
1137
|
+
|
|
1138
|
+
/**
|
|
1139
|
+
* Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
|
1140
|
+
*/
|
|
1141
|
+
optional: boolean;
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1153
1145
|
interface OptionalItem {
|
|
1154
1146
|
adjustable_quantity: OptionalItem.AdjustableQuantity | null;
|
|
1155
1147
|
|
|
@@ -1202,6 +1194,8 @@ declare module 'stripe' {
|
|
|
1202
1194
|
|
|
1203
1195
|
alipay?: PaymentMethodOptions.Alipay;
|
|
1204
1196
|
|
|
1197
|
+
alma?: PaymentMethodOptions.Alma;
|
|
1198
|
+
|
|
1205
1199
|
amazon_pay?: PaymentMethodOptions.AmazonPay;
|
|
1206
1200
|
|
|
1207
1201
|
au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
|
|
@@ -1210,6 +1204,8 @@ declare module 'stripe' {
|
|
|
1210
1204
|
|
|
1211
1205
|
bancontact?: PaymentMethodOptions.Bancontact;
|
|
1212
1206
|
|
|
1207
|
+
billie?: PaymentMethodOptions.Billie;
|
|
1208
|
+
|
|
1213
1209
|
boleto?: PaymentMethodOptions.Boleto;
|
|
1214
1210
|
|
|
1215
1211
|
card?: PaymentMethodOptions.Card;
|
|
@@ -1254,14 +1250,14 @@ declare module 'stripe' {
|
|
|
1254
1250
|
|
|
1255
1251
|
paypal?: PaymentMethodOptions.Paypal;
|
|
1256
1252
|
|
|
1257
|
-
payto?: PaymentMethodOptions.Payto;
|
|
1258
|
-
|
|
1259
1253
|
pix?: PaymentMethodOptions.Pix;
|
|
1260
1254
|
|
|
1261
1255
|
revolut_pay?: PaymentMethodOptions.RevolutPay;
|
|
1262
1256
|
|
|
1263
1257
|
samsung_pay?: PaymentMethodOptions.SamsungPay;
|
|
1264
1258
|
|
|
1259
|
+
satispay?: PaymentMethodOptions.Satispay;
|
|
1260
|
+
|
|
1265
1261
|
sepa_debit?: PaymentMethodOptions.SepaDebit;
|
|
1266
1262
|
|
|
1267
1263
|
sofort?: PaymentMethodOptions.Sofort;
|
|
@@ -1346,6 +1342,11 @@ declare module 'stripe' {
|
|
|
1346
1342
|
}
|
|
1347
1343
|
|
|
1348
1344
|
interface Affirm {
|
|
1345
|
+
/**
|
|
1346
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1347
|
+
*/
|
|
1348
|
+
capture_method?: 'manual';
|
|
1349
|
+
|
|
1349
1350
|
/**
|
|
1350
1351
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1351
1352
|
*
|
|
@@ -1359,6 +1360,11 @@ declare module 'stripe' {
|
|
|
1359
1360
|
}
|
|
1360
1361
|
|
|
1361
1362
|
interface AfterpayClearpay {
|
|
1363
|
+
/**
|
|
1364
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1365
|
+
*/
|
|
1366
|
+
capture_method?: 'manual';
|
|
1367
|
+
|
|
1362
1368
|
/**
|
|
1363
1369
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1364
1370
|
*
|
|
@@ -1384,7 +1390,19 @@ declare module 'stripe' {
|
|
|
1384
1390
|
setup_future_usage?: 'none';
|
|
1385
1391
|
}
|
|
1386
1392
|
|
|
1393
|
+
interface Alma {
|
|
1394
|
+
/**
|
|
1395
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1396
|
+
*/
|
|
1397
|
+
capture_method?: 'manual';
|
|
1398
|
+
}
|
|
1399
|
+
|
|
1387
1400
|
interface AmazonPay {
|
|
1401
|
+
/**
|
|
1402
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1403
|
+
*/
|
|
1404
|
+
capture_method?: 'manual';
|
|
1405
|
+
|
|
1388
1406
|
/**
|
|
1389
1407
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1390
1408
|
*
|
|
@@ -1463,6 +1481,13 @@ declare module 'stripe' {
|
|
|
1463
1481
|
setup_future_usage?: 'none';
|
|
1464
1482
|
}
|
|
1465
1483
|
|
|
1484
|
+
interface Billie {
|
|
1485
|
+
/**
|
|
1486
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1487
|
+
*/
|
|
1488
|
+
capture_method?: 'manual';
|
|
1489
|
+
}
|
|
1490
|
+
|
|
1466
1491
|
interface Boleto {
|
|
1467
1492
|
/**
|
|
1468
1493
|
* 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.
|
|
@@ -1486,12 +1511,12 @@ declare module 'stripe' {
|
|
|
1486
1511
|
}
|
|
1487
1512
|
|
|
1488
1513
|
interface Card {
|
|
1489
|
-
installments?: Card.Installments;
|
|
1490
|
-
|
|
1491
1514
|
/**
|
|
1492
|
-
*
|
|
1515
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1493
1516
|
*/
|
|
1494
|
-
|
|
1517
|
+
capture_method?: 'manual';
|
|
1518
|
+
|
|
1519
|
+
installments?: Card.Installments;
|
|
1495
1520
|
|
|
1496
1521
|
/**
|
|
1497
1522
|
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
@@ -1550,8 +1575,6 @@ declare module 'stripe' {
|
|
|
1550
1575
|
enabled?: boolean;
|
|
1551
1576
|
}
|
|
1552
1577
|
|
|
1553
|
-
type RequestDecrementalAuthorization = 'if_available' | 'never';
|
|
1554
|
-
|
|
1555
1578
|
type RequestExtendedAuthorization = 'if_available' | 'never';
|
|
1556
1579
|
|
|
1557
1580
|
type RequestIncrementalAuthorization = 'if_available' | 'never';
|
|
@@ -1581,6 +1604,11 @@ declare module 'stripe' {
|
|
|
1581
1604
|
}
|
|
1582
1605
|
|
|
1583
1606
|
interface Cashapp {
|
|
1607
|
+
/**
|
|
1608
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1609
|
+
*/
|
|
1610
|
+
capture_method?: 'manual';
|
|
1611
|
+
|
|
1584
1612
|
/**
|
|
1585
1613
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1586
1614
|
*
|
|
@@ -1750,6 +1778,11 @@ declare module 'stripe' {
|
|
|
1750
1778
|
}
|
|
1751
1779
|
|
|
1752
1780
|
interface Klarna {
|
|
1781
|
+
/**
|
|
1782
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1783
|
+
*/
|
|
1784
|
+
capture_method?: 'manual';
|
|
1785
|
+
|
|
1753
1786
|
/**
|
|
1754
1787
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1755
1788
|
*
|
|
@@ -1807,6 +1840,11 @@ declare module 'stripe' {
|
|
|
1807
1840
|
}
|
|
1808
1841
|
|
|
1809
1842
|
interface Link {
|
|
1843
|
+
/**
|
|
1844
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1845
|
+
*/
|
|
1846
|
+
capture_method?: 'manual';
|
|
1847
|
+
|
|
1810
1848
|
/**
|
|
1811
1849
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1812
1850
|
*
|
|
@@ -1824,6 +1862,11 @@ declare module 'stripe' {
|
|
|
1824
1862
|
}
|
|
1825
1863
|
|
|
1826
1864
|
interface Mobilepay {
|
|
1865
|
+
/**
|
|
1866
|
+
* Controls when the funds will be captured from the customer's account.
|
|
1867
|
+
*/
|
|
1868
|
+
capture_method?: 'manual';
|
|
1869
|
+
|
|
1827
1870
|
/**
|
|
1828
1871
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1829
1872
|
*
|
|
@@ -1948,100 +1991,12 @@ declare module 'stripe' {
|
|
|
1948
1991
|
* 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).
|
|
1949
1992
|
*/
|
|
1950
1993
|
setup_future_usage?: Paypal.SetupFutureUsage;
|
|
1951
|
-
|
|
1952
|
-
/**
|
|
1953
|
-
* 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.
|
|
1954
|
-
*/
|
|
1955
|
-
subsellers?: Array<string>;
|
|
1956
1994
|
}
|
|
1957
1995
|
|
|
1958
1996
|
namespace Paypal {
|
|
1959
1997
|
type SetupFutureUsage = 'none' | 'off_session';
|
|
1960
1998
|
}
|
|
1961
1999
|
|
|
1962
|
-
interface Payto {
|
|
1963
|
-
mandate_options?: Payto.MandateOptions;
|
|
1964
|
-
|
|
1965
|
-
/**
|
|
1966
|
-
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
1967
|
-
*
|
|
1968
|
-
* 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.
|
|
1969
|
-
*
|
|
1970
|
-
* 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.
|
|
1971
|
-
*
|
|
1972
|
-
* 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).
|
|
1973
|
-
*/
|
|
1974
|
-
setup_future_usage?: Payto.SetupFutureUsage;
|
|
1975
|
-
}
|
|
1976
|
-
|
|
1977
|
-
namespace Payto {
|
|
1978
|
-
interface MandateOptions {
|
|
1979
|
-
/**
|
|
1980
|
-
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1981
|
-
*/
|
|
1982
|
-
amount: number | null;
|
|
1983
|
-
|
|
1984
|
-
/**
|
|
1985
|
-
* 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.
|
|
1986
|
-
*/
|
|
1987
|
-
amount_type: MandateOptions.AmountType | null;
|
|
1988
|
-
|
|
1989
|
-
/**
|
|
1990
|
-
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1991
|
-
*/
|
|
1992
|
-
end_date: string | null;
|
|
1993
|
-
|
|
1994
|
-
/**
|
|
1995
|
-
* The periodicity at which payments will be collected.
|
|
1996
|
-
*/
|
|
1997
|
-
payment_schedule: MandateOptions.PaymentSchedule | null;
|
|
1998
|
-
|
|
1999
|
-
/**
|
|
2000
|
-
* 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.
|
|
2001
|
-
*/
|
|
2002
|
-
payments_per_period: number | null;
|
|
2003
|
-
|
|
2004
|
-
/**
|
|
2005
|
-
* The purpose for which payments are made. Defaults to retail.
|
|
2006
|
-
*/
|
|
2007
|
-
purpose: MandateOptions.Purpose | null;
|
|
2008
|
-
|
|
2009
|
-
/**
|
|
2010
|
-
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
2011
|
-
*/
|
|
2012
|
-
start_date: string | null;
|
|
2013
|
-
}
|
|
2014
|
-
|
|
2015
|
-
namespace MandateOptions {
|
|
2016
|
-
type AmountType = 'fixed' | 'maximum';
|
|
2017
|
-
|
|
2018
|
-
type PaymentSchedule =
|
|
2019
|
-
| 'adhoc'
|
|
2020
|
-
| 'annual'
|
|
2021
|
-
| 'daily'
|
|
2022
|
-
| 'fortnightly'
|
|
2023
|
-
| 'monthly'
|
|
2024
|
-
| 'quarterly'
|
|
2025
|
-
| 'semi_annual'
|
|
2026
|
-
| 'weekly';
|
|
2027
|
-
|
|
2028
|
-
type Purpose =
|
|
2029
|
-
| 'dependant_support'
|
|
2030
|
-
| 'government'
|
|
2031
|
-
| 'loan'
|
|
2032
|
-
| 'mortgage'
|
|
2033
|
-
| 'other'
|
|
2034
|
-
| 'pension'
|
|
2035
|
-
| 'personal'
|
|
2036
|
-
| 'retail'
|
|
2037
|
-
| 'salary'
|
|
2038
|
-
| 'tax'
|
|
2039
|
-
| 'utility';
|
|
2040
|
-
}
|
|
2041
|
-
|
|
2042
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
2043
|
-
}
|
|
2044
|
-
|
|
2045
2000
|
interface Pix {
|
|
2046
2001
|
/**
|
|
2047
2002
|
* Determines if the amount includes the IOF tax.
|
|
@@ -2053,8 +2008,6 @@ declare module 'stripe' {
|
|
|
2053
2008
|
*/
|
|
2054
2009
|
expires_after_seconds: number | null;
|
|
2055
2010
|
|
|
2056
|
-
mandate_options?: Pix.MandateOptions;
|
|
2057
|
-
|
|
2058
2011
|
/**
|
|
2059
2012
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2060
2013
|
*
|
|
@@ -2064,71 +2017,19 @@ declare module 'stripe' {
|
|
|
2064
2017
|
*
|
|
2065
2018
|
* 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).
|
|
2066
2019
|
*/
|
|
2067
|
-
setup_future_usage?:
|
|
2020
|
+
setup_future_usage?: 'none';
|
|
2068
2021
|
}
|
|
2069
2022
|
|
|
2070
2023
|
namespace Pix {
|
|
2071
2024
|
type AmountIncludesIof = 'always' | 'never';
|
|
2072
|
-
|
|
2073
|
-
interface MandateOptions {
|
|
2074
|
-
/**
|
|
2075
|
-
* Amount to be charged for future payments.
|
|
2076
|
-
*/
|
|
2077
|
-
amount?: number;
|
|
2078
|
-
|
|
2079
|
-
/**
|
|
2080
|
-
* Determines if the amount includes the IOF tax.
|
|
2081
|
-
*/
|
|
2082
|
-
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
2083
|
-
|
|
2084
|
-
/**
|
|
2085
|
-
* Type of amount.
|
|
2086
|
-
*/
|
|
2087
|
-
amount_type?: MandateOptions.AmountType;
|
|
2088
|
-
|
|
2089
|
-
/**
|
|
2090
|
-
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
|
|
2091
|
-
*/
|
|
2092
|
-
currency?: string;
|
|
2093
|
-
|
|
2094
|
-
/**
|
|
2095
|
-
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
|
|
2096
|
-
*/
|
|
2097
|
-
end_date?: string;
|
|
2098
|
-
|
|
2099
|
-
/**
|
|
2100
|
-
* Schedule at which the future payments will be charged.
|
|
2101
|
-
*/
|
|
2102
|
-
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
2103
|
-
|
|
2104
|
-
/**
|
|
2105
|
-
* Subscription name displayed to buyers in their bank app.
|
|
2106
|
-
*/
|
|
2107
|
-
reference?: string;
|
|
2108
|
-
|
|
2109
|
-
/**
|
|
2110
|
-
* Start date of the mandate, in `YYYY-MM-DD`.
|
|
2111
|
-
*/
|
|
2112
|
-
start_date?: string;
|
|
2113
|
-
}
|
|
2114
|
-
|
|
2115
|
-
namespace MandateOptions {
|
|
2116
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
2117
|
-
|
|
2118
|
-
type AmountType = 'fixed' | 'maximum';
|
|
2119
|
-
|
|
2120
|
-
type PaymentSchedule =
|
|
2121
|
-
| 'halfyearly'
|
|
2122
|
-
| 'monthly'
|
|
2123
|
-
| 'quarterly'
|
|
2124
|
-
| 'weekly'
|
|
2125
|
-
| 'yearly';
|
|
2126
|
-
}
|
|
2127
|
-
|
|
2128
|
-
type SetupFutureUsage = 'none' | 'off_session';
|
|
2129
2025
|
}
|
|
2130
2026
|
|
|
2131
2027
|
interface RevolutPay {
|
|
2028
|
+
/**
|
|
2029
|
+
* Controls when the funds will be captured from the customer's account.
|
|
2030
|
+
*/
|
|
2031
|
+
capture_method?: 'manual';
|
|
2032
|
+
|
|
2132
2033
|
/**
|
|
2133
2034
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2134
2035
|
*
|
|
@@ -2152,6 +2053,13 @@ declare module 'stripe' {
|
|
|
2152
2053
|
capture_method?: 'manual';
|
|
2153
2054
|
}
|
|
2154
2055
|
|
|
2056
|
+
interface Satispay {
|
|
2057
|
+
/**
|
|
2058
|
+
* Controls when the funds will be captured from the customer's account.
|
|
2059
|
+
*/
|
|
2060
|
+
capture_method?: 'manual';
|
|
2061
|
+
}
|
|
2062
|
+
|
|
2155
2063
|
interface SepaDebit {
|
|
2156
2064
|
mandate_options?: SepaDebit.MandateOptions;
|
|
2157
2065
|
|
|
@@ -2232,8 +2140,6 @@ declare module 'stripe' {
|
|
|
2232
2140
|
interface FinancialConnections {
|
|
2233
2141
|
filters?: FinancialConnections.Filters;
|
|
2234
2142
|
|
|
2235
|
-
manual_entry?: FinancialConnections.ManualEntry;
|
|
2236
|
-
|
|
2237
2143
|
/**
|
|
2238
2144
|
* The list of permissions to request. The `payment_method` permission must be included.
|
|
2239
2145
|
*/
|
|
@@ -2256,39 +2162,19 @@ declare module 'stripe' {
|
|
|
2256
2162
|
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
2257
2163
|
*/
|
|
2258
2164
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2259
|
-
|
|
2260
|
-
/**
|
|
2261
|
-
* The institution to use to filter for possible accounts to link.
|
|
2262
|
-
*/
|
|
2263
|
-
institution?: string;
|
|
2264
2165
|
}
|
|
2265
2166
|
|
|
2266
2167
|
namespace Filters {
|
|
2267
2168
|
type AccountSubcategory = 'checking' | 'savings';
|
|
2268
2169
|
}
|
|
2269
2170
|
|
|
2270
|
-
interface ManualEntry {
|
|
2271
|
-
/**
|
|
2272
|
-
* Settings for configuring manual entry of account details.
|
|
2273
|
-
*/
|
|
2274
|
-
mode?: ManualEntry.Mode;
|
|
2275
|
-
}
|
|
2276
|
-
|
|
2277
|
-
namespace ManualEntry {
|
|
2278
|
-
type Mode = 'automatic' | 'custom';
|
|
2279
|
-
}
|
|
2280
|
-
|
|
2281
2171
|
type Permission =
|
|
2282
2172
|
| 'balances'
|
|
2283
2173
|
| 'ownership'
|
|
2284
2174
|
| 'payment_method'
|
|
2285
2175
|
| 'transactions';
|
|
2286
2176
|
|
|
2287
|
-
type Prefetch =
|
|
2288
|
-
| 'balances'
|
|
2289
|
-
| 'inferred_balances'
|
|
2290
|
-
| 'ownership'
|
|
2291
|
-
| 'transactions';
|
|
2177
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
2292
2178
|
}
|
|
2293
2179
|
|
|
2294
2180
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
@@ -2300,20 +2186,6 @@ declare module 'stripe' {
|
|
|
2300
2186
|
type PaymentStatus = 'no_payment_required' | 'paid' | 'unpaid';
|
|
2301
2187
|
|
|
2302
2188
|
interface Permissions {
|
|
2303
|
-
/**
|
|
2304
|
-
* Permissions for updating the Checkout Session.
|
|
2305
|
-
*/
|
|
2306
|
-
update?: Permissions.Update | null;
|
|
2307
|
-
|
|
2308
|
-
/**
|
|
2309
|
-
* Determines which entity is allowed to update the line items.
|
|
2310
|
-
*
|
|
2311
|
-
* 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.
|
|
2312
|
-
*
|
|
2313
|
-
* 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.
|
|
2314
|
-
*/
|
|
2315
|
-
update_line_items?: Permissions.UpdateLineItems | null;
|
|
2316
|
-
|
|
2317
2189
|
/**
|
|
2318
2190
|
* Determines which entity is allowed to update the shipping details.
|
|
2319
2191
|
*
|
|
@@ -2325,34 +2197,6 @@ declare module 'stripe' {
|
|
|
2325
2197
|
}
|
|
2326
2198
|
|
|
2327
2199
|
namespace Permissions {
|
|
2328
|
-
interface Update {
|
|
2329
|
-
/**
|
|
2330
|
-
* Determines which entity is allowed to update the line items.
|
|
2331
|
-
*
|
|
2332
|
-
* 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.
|
|
2333
|
-
*
|
|
2334
|
-
* 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.
|
|
2335
|
-
*/
|
|
2336
|
-
line_items?: Update.LineItems | null;
|
|
2337
|
-
|
|
2338
|
-
/**
|
|
2339
|
-
* Determines which entity is allowed to update the shipping details.
|
|
2340
|
-
*
|
|
2341
|
-
* 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.
|
|
2342
|
-
*
|
|
2343
|
-
* 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.
|
|
2344
|
-
*/
|
|
2345
|
-
shipping_details: Update.ShippingDetails | null;
|
|
2346
|
-
}
|
|
2347
|
-
|
|
2348
|
-
namespace Update {
|
|
2349
|
-
type LineItems = 'client_only' | 'server_only';
|
|
2350
|
-
|
|
2351
|
-
type ShippingDetails = 'client_only' | 'server_only';
|
|
2352
|
-
}
|
|
2353
|
-
|
|
2354
|
-
type UpdateLineItems = 'client_only' | 'server_only';
|
|
2355
|
-
|
|
2356
2200
|
type UpdateShippingDetails = 'client_only' | 'server_only';
|
|
2357
2201
|
}
|
|
2358
2202
|
|