stripe 19.2.0 → 19.3.0-alpha.1
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 +1680 -12
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +28 -0
- package/cjs/resources/ExternalAccounts.js +23 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/FxQuotes.js +15 -0
- package/cjs/resources/Identity/BlocklistEntries.js +25 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
- package/cjs/resources/Mandates.js +5 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentIntents.js +8 -0
- package/cjs/resources/PaymentMethods.js +4 -0
- package/cjs/resources/Privacy/RedactionJobs.js +42 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Subscriptions.js +4 -0
- package/cjs/resources/Tax/Associations.js +9 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/BillSettings.js +27 -0
- package/cjs/resources/V2/Billing/Cadences.js +23 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
- package/cjs/resources/V2/Billing/Intents.js +36 -0
- package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +12 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +26 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
- package/cjs/resources/V2/Billing/Profiles.js +19 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
- package/cjs/resources/V2/Billing/RateCards.js +29 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
- package/cjs/resources/V2/Core/AccountLinks.js +9 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +25 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +20 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
- package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
- package/cjs/resources.js +142 -8
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +100 -0
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +25 -0
- package/esm/resources/ExternalAccounts.js +20 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/FxQuotes.js +12 -0
- package/esm/resources/Identity/BlocklistEntries.js +22 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
- package/esm/resources/Mandates.js +5 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentIntents.js +8 -0
- package/esm/resources/PaymentMethods.js +4 -0
- package/esm/resources/Privacy/RedactionJobs.js +39 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Subscriptions.js +4 -0
- package/esm/resources/Tax/Associations.js +6 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/OnboardingLinks.js +9 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/BillSettings.js +24 -0
- package/esm/resources/V2/Billing/Cadences.js +20 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
- package/esm/resources/V2/Billing/Intents.js +33 -0
- package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
- package/esm/resources/V2/Billing/LicenseFees.js +24 -0
- package/esm/resources/V2/Billing/LicensedItems.js +22 -0
- package/esm/resources/V2/Billing/MeteredItems.js +19 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +9 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +23 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
- package/esm/resources/V2/Billing/PricingPlans.js +26 -0
- package/esm/resources/V2/Billing/Profiles.js +16 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
- package/esm/resources/V2/Billing/RateCards.js +26 -0
- package/esm/resources/V2/Billing/ServiceActions.js +17 -0
- package/esm/resources/V2/Core/AccountLinks.js +6 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +22 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +17 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
- package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
- package/esm/resources.js +129 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +45 -0
- package/types/AccountSessionsResource.d.ts +264 -0
- package/types/Accounts.d.ts +214 -1
- package/types/AccountsResource.d.ts +544 -0
- package/types/ApplicationFees.d.ts +6 -1
- package/types/Balance.d.ts +82 -0
- package/types/BalanceTransactions.d.ts +2 -1
- package/types/BankAccounts.d.ts +2 -0
- package/types/Billing/AlertTriggereds.d.ts +16 -1
- package/types/Billing/Alerts.d.ts +116 -1
- package/types/Billing/AlertsResource.d.ts +149 -2
- package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
- package/types/Billing/Analytics/MeterUsageResource.d.ts +694 -0
- package/types/Billing/Analytics/MeterUsageRows.d.ts +58 -0
- package/types/Billing/CreditBalanceSummary.d.ts +123 -2
- package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
- package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
- package/types/Billing/CreditGrants.d.ts +76 -1
- package/types/Billing/CreditGrantsResource.d.ts +45 -4
- package/types/Billing/MeterEventSummaries.d.ts +7 -0
- package/types/Billing/Meters.d.ts +5 -0
- package/types/Billing/MetersResource.d.ts +17 -0
- package/types/BillingPortal/Sessions.d.ts +5 -0
- package/types/BillingPortal/SessionsResource.d.ts +12 -4
- package/types/Capabilities.d.ts +2 -0
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Cards.d.ts +19 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +185 -0
- package/types/ChargesResource.d.ts +1406 -0
- package/types/Checkout/Sessions.d.ts +427 -2
- package/types/Checkout/SessionsResource.d.ts +682 -2
- package/types/ConfirmationTokens.d.ts +139 -0
- package/types/Coupons.d.ts +33 -0
- package/types/CouponsResource.d.ts +21 -0
- package/types/CreditNoteLineItems.d.ts +17 -0
- package/types/CreditNotes.d.ts +5 -0
- package/types/CreditNotesResource.d.ts +5 -0
- package/types/CustomerBalanceTransactions.d.ts +2 -0
- package/types/CustomerCashBalanceTransactions.d.ts +2 -0
- package/types/CustomerSessions.d.ts +46 -0
- package/types/CustomerSessionsResource.d.ts +47 -1
- package/types/Customers.d.ts +2 -0
- package/types/CustomersResource.d.ts +8 -0
- package/types/DelegatedCheckout/RequestedSessions.d.ts +292 -0
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +593 -0
- package/types/Discounts.d.ts +10 -0
- package/types/Disputes.d.ts +40 -0
- package/types/DisputesResource.d.ts +11 -0
- package/types/Errors.d.ts +85 -0
- package/types/EventTypes.d.ts +630 -0
- package/types/Events.d.ts +95 -0
- package/types/ExternalAccountsResource.d.ts +304 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +36 -1
- package/types/FinancialConnections/AccountsResource.d.ts +40 -3
- package/types/FinancialConnections/Institutions.d.ts +98 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +51 -1
- package/types/FinancialConnections/SessionsResource.d.ts +43 -1
- package/types/FxQuotes.d.ts +155 -0
- package/types/FxQuotesResource.d.ts +130 -0
- package/types/Identity/BlocklistEntries.d.ts +78 -0
- package/types/Identity/BlocklistEntriesResource.d.ts +146 -0
- package/types/Identity/VerificationReports.d.ts +10 -0
- package/types/Identity/VerificationReportsResource.d.ts +5 -0
- package/types/Identity/VerificationSessions.d.ts +5 -0
- package/types/Identity/VerificationSessionsResource.d.ts +7 -0
- package/types/InvoiceItems.d.ts +114 -2
- package/types/InvoiceItemsResource.d.ts +117 -6
- package/types/InvoiceLineItems.d.ts +158 -3
- package/types/Invoices.d.ts +203 -4
- package/types/InvoicesResource.d.ts +1625 -2
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Settlements.d.ts +113 -0
- package/types/Issuing/Transactions.d.ts +5 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +49 -0
- package/types/Mandates.d.ts +135 -1
- package/types/MandatesResource.d.ts +31 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1163 -0
- package/types/OrdersResource.d.ts +3139 -0
- package/types/PaymentAttemptRecords.d.ts +141 -0
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +7 -13
- package/types/PaymentIntents.d.ts +807 -20
- package/types/PaymentIntentsResource.d.ts +9765 -4959
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +12 -0
- package/types/PaymentMethodBalances.d.ts +63 -0
- package/types/PaymentMethodConfigurations.d.ts +216 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
- package/types/PaymentMethods.d.ts +144 -0
- package/types/PaymentMethodsResource.d.ts +187 -2
- package/types/PaymentRecords.d.ts +141 -0
- package/types/Persons.d.ts +2 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
- package/types/Privacy/RedactionJobs.d.ts +111 -0
- package/types/Privacy/RedactionJobsResource.d.ts +230 -0
- package/types/PromotionCodes.d.ts +5 -0
- package/types/PromotionCodesResource.d.ts +10 -0
- package/types/QuoteLines.d.ts +634 -0
- package/types/QuotePreviewInvoices.d.ts +1771 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +908 -0
- package/types/Quotes.d.ts +594 -1
- package/types/QuotesResource.d.ts +2588 -243
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +239 -2
- package/types/SetupIntentsResource.d.ts +1044 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +26 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +205 -0
- package/types/SubscriptionSchedulesResource.d.ts +1233 -5
- package/types/Subscriptions.d.ts +262 -1
- package/types/SubscriptionsResource.d.ts +745 -8
- package/types/Tax/Associations.d.ts +82 -0
- package/types/Tax/AssociationsResource.d.ts +29 -0
- package/types/Tax/Forms.d.ts +220 -0
- package/types/Tax/FormsResource.d.ts +107 -0
- package/types/TaxIds.d.ts +10 -0
- package/types/TaxIdsResource.d.ts +10 -0
- package/types/Terminal/Configurations.d.ts +9 -0
- package/types/Terminal/ConfigurationsResource.d.ts +28 -0
- package/types/Terminal/OnboardingLinks.d.ts +57 -0
- package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
- package/types/Terminal/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +20 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/Transfers.d.ts +9 -0
- package/types/TransfersResource.d.ts +7 -0
- package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/BillSettings.d.ts +120 -0
- package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
- package/types/V2/Billing/Cadences.d.ts +731 -0
- package/types/V2/Billing/CadencesResource.d.ts +516 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +337 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
- package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
- package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
- package/types/V2/Billing/IntentActions.d.ts +459 -0
- package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
- package/types/V2/Billing/Intents.d.ts +117 -0
- package/types/V2/Billing/IntentsResource.d.ts +575 -0
- package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
- package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
- package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
- package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/LicenseFees.d.ts +164 -0
- package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
- package/types/V2/Billing/LicensedItems.d.ts +73 -0
- package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
- package/types/V2/Billing/MeteredItems.d.ts +101 -0
- package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
- package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
- package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +57 -0
- package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +40 -0
- package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +120 -0
- package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
- package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
- package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/PricingPlans.d.ts +84 -0
- package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
- package/types/V2/Billing/Profiles.d.ts +70 -0
- package/types/V2/Billing/ProfilesResource.d.ts +150 -0
- package/types/V2/Billing/RateCardRates.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
- package/types/V2/Billing/RateCardVersions.d.ts +39 -0
- package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
- package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/RateCards.d.ts +98 -0
- package/types/V2/Billing/RateCardsResource.d.ts +162 -0
- package/types/V2/Billing/ServiceActions.d.ts +274 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +370 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersons.d.ts +615 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1153 -0
- package/types/V2/Core/Accounts.d.ts +7284 -0
- package/types/V2/Core/AccountsResource.d.ts +6469 -0
- package/types/V2/Core/ClaimableSandboxes.d.ts +132 -0
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +74 -0
- package/types/V2/Core/EventTypes.d.ts +8588 -10
- package/types/V2/Core/Events.d.ts +12 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
- package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +283 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +247 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +330 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +256 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +213 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +201 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +307 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +186 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
- package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
- package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +326 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +401 -0
- package/types/V2/Tax/AutomaticRules.d.ts +53 -0
- package/types/V2/Tax/AutomaticRulesResource.d.ts +102 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +73 -0
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
- package/types/WebhookEndpointsResource.d.ts +74 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +222 -0
- package/types/lib.d.ts +10 -0
|
@@ -39,6 +39,8 @@ declare module 'stripe' {
|
|
|
39
39
|
*/
|
|
40
40
|
cancel_url?: string;
|
|
41
41
|
|
|
42
|
+
checkout_items?: Array<SessionCreateParams.CheckoutItem>;
|
|
43
|
+
|
|
42
44
|
/**
|
|
43
45
|
* A unique string to reference the Checkout Session. This can be a
|
|
44
46
|
* customer ID, a cart ID, or similar, and can be used to reconcile the
|
|
@@ -81,6 +83,11 @@ declare module 'stripe' {
|
|
|
81
83
|
*/
|
|
82
84
|
customer?: string;
|
|
83
85
|
|
|
86
|
+
/**
|
|
87
|
+
* ID of an existing Account, if one exists. Has the same behavior as `customer`.
|
|
88
|
+
*/
|
|
89
|
+
customer_account?: string;
|
|
90
|
+
|
|
84
91
|
/**
|
|
85
92
|
* Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
|
|
86
93
|
*
|
|
@@ -490,6 +497,54 @@ declare module 'stripe' {
|
|
|
490
497
|
}
|
|
491
498
|
}
|
|
492
499
|
|
|
500
|
+
interface CheckoutItem {
|
|
501
|
+
type: CheckoutItem.Type;
|
|
502
|
+
|
|
503
|
+
rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
|
|
504
|
+
|
|
505
|
+
pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
namespace CheckoutItem {
|
|
509
|
+
interface PricingPlanSubscriptionItem {
|
|
510
|
+
pricing_plan: string;
|
|
511
|
+
|
|
512
|
+
pricing_plan_version?: string;
|
|
513
|
+
|
|
514
|
+
metadata?: Stripe.MetadataParam;
|
|
515
|
+
|
|
516
|
+
component_configurations?: {
|
|
517
|
+
[key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
|
|
518
|
+
};
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
namespace PricingPlanSubscriptionItem {
|
|
522
|
+
interface ComponentConfigurations {
|
|
523
|
+
type: 'license_fee_component';
|
|
524
|
+
|
|
525
|
+
license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
namespace ComponentConfigurations {
|
|
529
|
+
interface LicenseFeeComponent {
|
|
530
|
+
quantity: number;
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
interface RateCardSubscriptionItem {
|
|
536
|
+
rate_card: string;
|
|
537
|
+
|
|
538
|
+
metadata?: Stripe.MetadataParam;
|
|
539
|
+
|
|
540
|
+
rate_card_version?: string;
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
type Type =
|
|
544
|
+
| 'rate_card_subscription_item'
|
|
545
|
+
| 'pricing_plan_subscription_item';
|
|
546
|
+
}
|
|
547
|
+
|
|
493
548
|
interface ConsentCollection {
|
|
494
549
|
/**
|
|
495
550
|
* Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
|
@@ -730,12 +785,55 @@ declare module 'stripe' {
|
|
|
730
785
|
*/
|
|
731
786
|
coupon?: string;
|
|
732
787
|
|
|
788
|
+
/**
|
|
789
|
+
* Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
790
|
+
*/
|
|
791
|
+
coupon_data?: Discount.CouponData;
|
|
792
|
+
|
|
733
793
|
/**
|
|
734
794
|
* The ID of a promotion code to apply to this Session.
|
|
735
795
|
*/
|
|
736
796
|
promotion_code?: string;
|
|
737
797
|
}
|
|
738
798
|
|
|
799
|
+
namespace Discount {
|
|
800
|
+
interface CouponData {
|
|
801
|
+
/**
|
|
802
|
+
* A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
|
|
803
|
+
*/
|
|
804
|
+
amount_off?: number;
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
|
|
808
|
+
*/
|
|
809
|
+
currency?: string;
|
|
810
|
+
|
|
811
|
+
/**
|
|
812
|
+
* Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
813
|
+
*/
|
|
814
|
+
duration?: CouponData.Duration;
|
|
815
|
+
|
|
816
|
+
/**
|
|
817
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
818
|
+
*/
|
|
819
|
+
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
823
|
+
*/
|
|
824
|
+
name?: string;
|
|
825
|
+
|
|
826
|
+
/**
|
|
827
|
+
* 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).
|
|
828
|
+
*/
|
|
829
|
+
percent_off?: number;
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
namespace CouponData {
|
|
833
|
+
type Duration = 'forever' | 'once' | 'repeating';
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
|
|
739
837
|
type ExcludedPaymentMethodType =
|
|
740
838
|
| 'acss_debit'
|
|
741
839
|
| 'affirm'
|
|
@@ -756,6 +854,7 @@ declare module 'stripe' {
|
|
|
756
854
|
| 'eps'
|
|
757
855
|
| 'fpx'
|
|
758
856
|
| 'giropay'
|
|
857
|
+
| 'gopay'
|
|
759
858
|
| 'grabpay'
|
|
760
859
|
| 'ideal'
|
|
761
860
|
| 'kakao_pay'
|
|
@@ -773,12 +872,17 @@ declare module 'stripe' {
|
|
|
773
872
|
| 'payco'
|
|
774
873
|
| 'paynow'
|
|
775
874
|
| 'paypal'
|
|
875
|
+
| 'paypay'
|
|
876
|
+
| 'payto'
|
|
776
877
|
| 'pix'
|
|
777
878
|
| 'promptpay'
|
|
879
|
+
| 'qris'
|
|
880
|
+
| 'rechnung'
|
|
778
881
|
| 'revolut_pay'
|
|
779
882
|
| 'samsung_pay'
|
|
780
883
|
| 'satispay'
|
|
781
884
|
| 'sepa_debit'
|
|
885
|
+
| 'shopeepay'
|
|
782
886
|
| 'sofort'
|
|
783
887
|
| 'swish'
|
|
784
888
|
| 'twint'
|
|
@@ -896,6 +1000,11 @@ declare module 'stripe' {
|
|
|
896
1000
|
*/
|
|
897
1001
|
dynamic_tax_rates?: Array<string>;
|
|
898
1002
|
|
|
1003
|
+
/**
|
|
1004
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
1005
|
+
*/
|
|
1006
|
+
metadata?: Stripe.MetadataParam;
|
|
1007
|
+
|
|
899
1008
|
/**
|
|
900
1009
|
* The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
|
|
901
1010
|
*/
|
|
@@ -1464,6 +1573,11 @@ declare module 'stripe' {
|
|
|
1464
1573
|
*/
|
|
1465
1574
|
paypal?: PaymentMethodOptions.Paypal;
|
|
1466
1575
|
|
|
1576
|
+
/**
|
|
1577
|
+
* contains details about the PayTo payment method options.
|
|
1578
|
+
*/
|
|
1579
|
+
payto?: PaymentMethodOptions.Payto;
|
|
1580
|
+
|
|
1467
1581
|
/**
|
|
1468
1582
|
* contains details about the Pix payment method options.
|
|
1469
1583
|
*/
|
|
@@ -1777,6 +1891,11 @@ declare module 'stripe' {
|
|
|
1777
1891
|
*/
|
|
1778
1892
|
installments?: Card.Installments;
|
|
1779
1893
|
|
|
1894
|
+
/**
|
|
1895
|
+
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
1896
|
+
*/
|
|
1897
|
+
request_decremental_authorization?: Card.RequestDecrementalAuthorization;
|
|
1898
|
+
|
|
1780
1899
|
/**
|
|
1781
1900
|
* Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
|
|
1782
1901
|
*/
|
|
@@ -1838,6 +1957,8 @@ declare module 'stripe' {
|
|
|
1838
1957
|
enabled?: boolean;
|
|
1839
1958
|
}
|
|
1840
1959
|
|
|
1960
|
+
type RequestDecrementalAuthorization = 'if_available' | 'never';
|
|
1961
|
+
|
|
1841
1962
|
type RequestExtendedAuthorization = 'if_available' | 'never';
|
|
1842
1963
|
|
|
1843
1964
|
type RequestIncrementalAuthorization = 'if_available' | 'never';
|
|
@@ -2320,6 +2441,11 @@ declare module 'stripe' {
|
|
|
2320
2441
|
*/
|
|
2321
2442
|
reference?: string;
|
|
2322
2443
|
|
|
2444
|
+
/**
|
|
2445
|
+
* 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.
|
|
2446
|
+
*/
|
|
2447
|
+
reference_id?: string;
|
|
2448
|
+
|
|
2323
2449
|
/**
|
|
2324
2450
|
* The risk correlation ID for an on-session payment using a saved PayPal payment method.
|
|
2325
2451
|
*/
|
|
@@ -2337,6 +2463,11 @@ declare module 'stripe' {
|
|
|
2337
2463
|
* 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`.
|
|
2338
2464
|
*/
|
|
2339
2465
|
setup_future_usage?: Stripe.Emptyable<Paypal.SetupFutureUsage>;
|
|
2466
|
+
|
|
2467
|
+
/**
|
|
2468
|
+
* 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.
|
|
2469
|
+
*/
|
|
2470
|
+
subsellers?: Array<string>;
|
|
2340
2471
|
}
|
|
2341
2472
|
|
|
2342
2473
|
namespace Paypal {
|
|
@@ -2366,6 +2497,92 @@ declare module 'stripe' {
|
|
|
2366
2497
|
type SetupFutureUsage = 'none' | 'off_session';
|
|
2367
2498
|
}
|
|
2368
2499
|
|
|
2500
|
+
interface Payto {
|
|
2501
|
+
/**
|
|
2502
|
+
* Additional fields for Mandate creation
|
|
2503
|
+
*/
|
|
2504
|
+
mandate_options?: Payto.MandateOptions;
|
|
2505
|
+
|
|
2506
|
+
/**
|
|
2507
|
+
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2508
|
+
*
|
|
2509
|
+
* 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.
|
|
2510
|
+
*
|
|
2511
|
+
* 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.
|
|
2512
|
+
*
|
|
2513
|
+
* 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).
|
|
2514
|
+
*/
|
|
2515
|
+
setup_future_usage?: Payto.SetupFutureUsage;
|
|
2516
|
+
}
|
|
2517
|
+
|
|
2518
|
+
namespace Payto {
|
|
2519
|
+
interface MandateOptions {
|
|
2520
|
+
/**
|
|
2521
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
2522
|
+
*/
|
|
2523
|
+
amount?: number;
|
|
2524
|
+
|
|
2525
|
+
/**
|
|
2526
|
+
* 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.
|
|
2527
|
+
*/
|
|
2528
|
+
amount_type?: MandateOptions.AmountType;
|
|
2529
|
+
|
|
2530
|
+
/**
|
|
2531
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
2532
|
+
*/
|
|
2533
|
+
end_date?: string;
|
|
2534
|
+
|
|
2535
|
+
/**
|
|
2536
|
+
* The periodicity at which payments will be collected.
|
|
2537
|
+
*/
|
|
2538
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
2539
|
+
|
|
2540
|
+
/**
|
|
2541
|
+
* 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.
|
|
2542
|
+
*/
|
|
2543
|
+
payments_per_period?: number;
|
|
2544
|
+
|
|
2545
|
+
/**
|
|
2546
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
2547
|
+
*/
|
|
2548
|
+
purpose?: MandateOptions.Purpose;
|
|
2549
|
+
|
|
2550
|
+
/**
|
|
2551
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
2552
|
+
*/
|
|
2553
|
+
start_date?: string;
|
|
2554
|
+
}
|
|
2555
|
+
|
|
2556
|
+
namespace MandateOptions {
|
|
2557
|
+
type AmountType = 'fixed' | 'maximum';
|
|
2558
|
+
|
|
2559
|
+
type PaymentSchedule =
|
|
2560
|
+
| 'adhoc'
|
|
2561
|
+
| 'annual'
|
|
2562
|
+
| 'daily'
|
|
2563
|
+
| 'fortnightly'
|
|
2564
|
+
| 'monthly'
|
|
2565
|
+
| 'quarterly'
|
|
2566
|
+
| 'semi_annual'
|
|
2567
|
+
| 'weekly';
|
|
2568
|
+
|
|
2569
|
+
type Purpose =
|
|
2570
|
+
| 'dependant_support'
|
|
2571
|
+
| 'government'
|
|
2572
|
+
| 'loan'
|
|
2573
|
+
| 'mortgage'
|
|
2574
|
+
| 'other'
|
|
2575
|
+
| 'pension'
|
|
2576
|
+
| 'personal'
|
|
2577
|
+
| 'retail'
|
|
2578
|
+
| 'salary'
|
|
2579
|
+
| 'tax'
|
|
2580
|
+
| 'utility';
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
2584
|
+
}
|
|
2585
|
+
|
|
2369
2586
|
interface Pix {
|
|
2370
2587
|
/**
|
|
2371
2588
|
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
@@ -2377,6 +2594,11 @@ declare module 'stripe' {
|
|
|
2377
2594
|
*/
|
|
2378
2595
|
expires_after_seconds?: number;
|
|
2379
2596
|
|
|
2597
|
+
/**
|
|
2598
|
+
* Additional fields for mandate creation.
|
|
2599
|
+
*/
|
|
2600
|
+
mandate_options?: Pix.MandateOptions;
|
|
2601
|
+
|
|
2380
2602
|
/**
|
|
2381
2603
|
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
2382
2604
|
*
|
|
@@ -2386,11 +2608,68 @@ declare module 'stripe' {
|
|
|
2386
2608
|
*
|
|
2387
2609
|
* 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).
|
|
2388
2610
|
*/
|
|
2389
|
-
setup_future_usage?:
|
|
2611
|
+
setup_future_usage?: Pix.SetupFutureUsage;
|
|
2390
2612
|
}
|
|
2391
2613
|
|
|
2392
2614
|
namespace Pix {
|
|
2393
2615
|
type AmountIncludesIof = 'always' | 'never';
|
|
2616
|
+
|
|
2617
|
+
interface MandateOptions {
|
|
2618
|
+
/**
|
|
2619
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
2620
|
+
*/
|
|
2621
|
+
amount?: number;
|
|
2622
|
+
|
|
2623
|
+
/**
|
|
2624
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
2625
|
+
*/
|
|
2626
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
2627
|
+
|
|
2628
|
+
/**
|
|
2629
|
+
* Type of amount. Defaults to `maximum`.
|
|
2630
|
+
*/
|
|
2631
|
+
amount_type?: MandateOptions.AmountType;
|
|
2632
|
+
|
|
2633
|
+
/**
|
|
2634
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
2635
|
+
*/
|
|
2636
|
+
currency?: string;
|
|
2637
|
+
|
|
2638
|
+
/**
|
|
2639
|
+
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
2640
|
+
*/
|
|
2641
|
+
end_date?: string;
|
|
2642
|
+
|
|
2643
|
+
/**
|
|
2644
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
2645
|
+
*/
|
|
2646
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
2647
|
+
|
|
2648
|
+
/**
|
|
2649
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
2650
|
+
*/
|
|
2651
|
+
reference?: string;
|
|
2652
|
+
|
|
2653
|
+
/**
|
|
2654
|
+
* Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
|
|
2655
|
+
*/
|
|
2656
|
+
start_date?: string;
|
|
2657
|
+
}
|
|
2658
|
+
|
|
2659
|
+
namespace MandateOptions {
|
|
2660
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
2661
|
+
|
|
2662
|
+
type AmountType = 'fixed' | 'maximum';
|
|
2663
|
+
|
|
2664
|
+
type PaymentSchedule =
|
|
2665
|
+
| 'halfyearly'
|
|
2666
|
+
| 'monthly'
|
|
2667
|
+
| 'quarterly'
|
|
2668
|
+
| 'weekly'
|
|
2669
|
+
| 'yearly';
|
|
2670
|
+
}
|
|
2671
|
+
|
|
2672
|
+
type SetupFutureUsage = 'none' | 'off_session';
|
|
2394
2673
|
}
|
|
2395
2674
|
|
|
2396
2675
|
interface RevolutPay {
|
|
@@ -2544,7 +2823,11 @@ declare module 'stripe' {
|
|
|
2544
2823
|
| 'payment_method'
|
|
2545
2824
|
| 'transactions';
|
|
2546
2825
|
|
|
2547
|
-
type Prefetch =
|
|
2826
|
+
type Prefetch =
|
|
2827
|
+
| 'balances'
|
|
2828
|
+
| 'inferred_balances'
|
|
2829
|
+
| 'ownership'
|
|
2830
|
+
| 'transactions';
|
|
2548
2831
|
}
|
|
2549
2832
|
|
|
2550
2833
|
type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
|
|
@@ -2600,6 +2883,7 @@ declare module 'stripe' {
|
|
|
2600
2883
|
| 'eps'
|
|
2601
2884
|
| 'fpx'
|
|
2602
2885
|
| 'giropay'
|
|
2886
|
+
| 'gopay'
|
|
2603
2887
|
| 'grabpay'
|
|
2604
2888
|
| 'ideal'
|
|
2605
2889
|
| 'kakao_pay'
|
|
@@ -2618,12 +2902,17 @@ declare module 'stripe' {
|
|
|
2618
2902
|
| 'payco'
|
|
2619
2903
|
| 'paynow'
|
|
2620
2904
|
| 'paypal'
|
|
2905
|
+
| 'paypay'
|
|
2906
|
+
| 'payto'
|
|
2621
2907
|
| 'pix'
|
|
2622
2908
|
| 'promptpay'
|
|
2909
|
+
| 'qris'
|
|
2910
|
+
| 'rechnung'
|
|
2623
2911
|
| 'revolut_pay'
|
|
2624
2912
|
| 'samsung_pay'
|
|
2625
2913
|
| 'satispay'
|
|
2626
2914
|
| 'sepa_debit'
|
|
2915
|
+
| 'shopeepay'
|
|
2627
2916
|
| 'sofort'
|
|
2628
2917
|
| 'swish'
|
|
2629
2918
|
| 'twint'
|
|
@@ -2632,6 +2921,27 @@ declare module 'stripe' {
|
|
|
2632
2921
|
| 'zip';
|
|
2633
2922
|
|
|
2634
2923
|
interface Permissions {
|
|
2924
|
+
/**
|
|
2925
|
+
* Permissions for updating the Checkout Session.
|
|
2926
|
+
*/
|
|
2927
|
+
update?: Permissions.Update;
|
|
2928
|
+
|
|
2929
|
+
/**
|
|
2930
|
+
* Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
|
|
2931
|
+
*
|
|
2932
|
+
* 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.
|
|
2933
|
+
*/
|
|
2934
|
+
update_discounts?: Permissions.UpdateDiscounts;
|
|
2935
|
+
|
|
2936
|
+
/**
|
|
2937
|
+
* Determines which entity is allowed to update the line items.
|
|
2938
|
+
*
|
|
2939
|
+
* 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.
|
|
2940
|
+
*
|
|
2941
|
+
* 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.
|
|
2942
|
+
*/
|
|
2943
|
+
update_line_items?: Permissions.UpdateLineItems;
|
|
2944
|
+
|
|
2635
2945
|
/**
|
|
2636
2946
|
* Determines which entity is allowed to update the shipping details.
|
|
2637
2947
|
*
|
|
@@ -2643,6 +2953,36 @@ declare module 'stripe' {
|
|
|
2643
2953
|
}
|
|
2644
2954
|
|
|
2645
2955
|
namespace Permissions {
|
|
2956
|
+
interface Update {
|
|
2957
|
+
/**
|
|
2958
|
+
* Determines which entity is allowed to update the line items.
|
|
2959
|
+
*
|
|
2960
|
+
* 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.
|
|
2961
|
+
*
|
|
2962
|
+
* 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.
|
|
2963
|
+
*/
|
|
2964
|
+
line_items?: Update.LineItems;
|
|
2965
|
+
|
|
2966
|
+
/**
|
|
2967
|
+
* Determines which entity is allowed to update the shipping details.
|
|
2968
|
+
*
|
|
2969
|
+
* 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.
|
|
2970
|
+
*
|
|
2971
|
+
* 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.
|
|
2972
|
+
*/
|
|
2973
|
+
shipping_details?: Update.ShippingDetails;
|
|
2974
|
+
}
|
|
2975
|
+
|
|
2976
|
+
namespace Update {
|
|
2977
|
+
type LineItems = 'client_only' | 'server_only';
|
|
2978
|
+
|
|
2979
|
+
type ShippingDetails = 'client_only' | 'server_only';
|
|
2980
|
+
}
|
|
2981
|
+
|
|
2982
|
+
type UpdateDiscounts = 'client_only' | 'server_only';
|
|
2983
|
+
|
|
2984
|
+
type UpdateLineItems = 'client_only' | 'server_only';
|
|
2985
|
+
|
|
2646
2986
|
type UpdateShippingDetails = 'client_only' | 'server_only';
|
|
2647
2987
|
}
|
|
2648
2988
|
|
|
@@ -3297,16 +3637,48 @@ declare module 'stripe' {
|
|
|
3297
3637
|
}
|
|
3298
3638
|
|
|
3299
3639
|
interface SessionUpdateParams {
|
|
3640
|
+
/**
|
|
3641
|
+
* Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
|
|
3642
|
+
*/
|
|
3643
|
+
automatic_tax?: SessionUpdateParams.AutomaticTax;
|
|
3644
|
+
|
|
3300
3645
|
/**
|
|
3301
3646
|
* Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
|
|
3302
3647
|
*/
|
|
3303
3648
|
collected_information?: SessionUpdateParams.CollectedInformation;
|
|
3304
3649
|
|
|
3650
|
+
/**
|
|
3651
|
+
* List of coupons and promotion codes attached to the Checkout Session.
|
|
3652
|
+
*/
|
|
3653
|
+
discounts?: Stripe.Emptyable<Array<SessionUpdateParams.Discount>>;
|
|
3654
|
+
|
|
3305
3655
|
/**
|
|
3306
3656
|
* Specifies which fields in the response should be expanded.
|
|
3307
3657
|
*/
|
|
3308
3658
|
expand?: Array<string>;
|
|
3309
3659
|
|
|
3660
|
+
/**
|
|
3661
|
+
* Generate a post-purchase Invoice for one-time payments.
|
|
3662
|
+
*/
|
|
3663
|
+
invoice_creation?: SessionUpdateParams.InvoiceCreation;
|
|
3664
|
+
|
|
3665
|
+
/**
|
|
3666
|
+
* A list of items the customer is purchasing.
|
|
3667
|
+
*
|
|
3668
|
+
* When updating line items, you must retransmit the entire array of line items.
|
|
3669
|
+
*
|
|
3670
|
+
* To retain an existing line item, specify its `id`.
|
|
3671
|
+
*
|
|
3672
|
+
* To update an existing line item, specify its `id` along with the new values of the fields to update.
|
|
3673
|
+
*
|
|
3674
|
+
* To add a new line item, specify one of `price` or `price_data` and `quantity`.
|
|
3675
|
+
*
|
|
3676
|
+
* To remove an existing line item, omit the line item's ID from the retransmitted array.
|
|
3677
|
+
*
|
|
3678
|
+
* To reorder a line item, specify it at the desired position in the retransmitted array.
|
|
3679
|
+
*/
|
|
3680
|
+
line_items?: Array<SessionUpdateParams.LineItem>;
|
|
3681
|
+
|
|
3310
3682
|
/**
|
|
3311
3683
|
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
3312
3684
|
*/
|
|
@@ -3318,9 +3690,39 @@ declare module 'stripe' {
|
|
|
3318
3690
|
shipping_options?: Stripe.Emptyable<
|
|
3319
3691
|
Array<SessionUpdateParams.ShippingOption>
|
|
3320
3692
|
>;
|
|
3693
|
+
|
|
3694
|
+
/**
|
|
3695
|
+
* A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
|
|
3696
|
+
*/
|
|
3697
|
+
subscription_data?: SessionUpdateParams.SubscriptionData;
|
|
3321
3698
|
}
|
|
3322
3699
|
|
|
3323
3700
|
namespace SessionUpdateParams {
|
|
3701
|
+
interface AutomaticTax {
|
|
3702
|
+
/**
|
|
3703
|
+
* 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.
|
|
3704
|
+
*/
|
|
3705
|
+
liability?: AutomaticTax.Liability;
|
|
3706
|
+
}
|
|
3707
|
+
|
|
3708
|
+
namespace AutomaticTax {
|
|
3709
|
+
interface Liability {
|
|
3710
|
+
/**
|
|
3711
|
+
* The connected account being referenced when `type` is `account`.
|
|
3712
|
+
*/
|
|
3713
|
+
account?: string;
|
|
3714
|
+
|
|
3715
|
+
/**
|
|
3716
|
+
* Type of the account referenced in the request.
|
|
3717
|
+
*/
|
|
3718
|
+
type: Liability.Type;
|
|
3719
|
+
}
|
|
3720
|
+
|
|
3721
|
+
namespace Liability {
|
|
3722
|
+
type Type = 'account' | 'self';
|
|
3723
|
+
}
|
|
3724
|
+
}
|
|
3725
|
+
|
|
3324
3726
|
interface CollectedInformation {
|
|
3325
3727
|
/**
|
|
3326
3728
|
* The shipping details to apply to this Session.
|
|
@@ -3376,6 +3778,235 @@ declare module 'stripe' {
|
|
|
3376
3778
|
}
|
|
3377
3779
|
}
|
|
3378
3780
|
|
|
3781
|
+
interface Discount {
|
|
3782
|
+
/**
|
|
3783
|
+
* The ID of the [Coupon](https://stripe.com/docs/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
3784
|
+
*/
|
|
3785
|
+
coupon?: string;
|
|
3786
|
+
|
|
3787
|
+
/**
|
|
3788
|
+
* Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
3789
|
+
*/
|
|
3790
|
+
coupon_data?: Discount.CouponData;
|
|
3791
|
+
}
|
|
3792
|
+
|
|
3793
|
+
namespace Discount {
|
|
3794
|
+
interface CouponData {
|
|
3795
|
+
/**
|
|
3796
|
+
* A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
|
|
3797
|
+
*/
|
|
3798
|
+
amount_off?: number;
|
|
3799
|
+
|
|
3800
|
+
/**
|
|
3801
|
+
* Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
|
|
3802
|
+
*/
|
|
3803
|
+
currency?: string;
|
|
3804
|
+
|
|
3805
|
+
/**
|
|
3806
|
+
* Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
3807
|
+
*/
|
|
3808
|
+
duration?: CouponData.Duration;
|
|
3809
|
+
|
|
3810
|
+
/**
|
|
3811
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
3812
|
+
*/
|
|
3813
|
+
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
3814
|
+
|
|
3815
|
+
/**
|
|
3816
|
+
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
3817
|
+
*/
|
|
3818
|
+
name?: string;
|
|
3819
|
+
|
|
3820
|
+
/**
|
|
3821
|
+
* 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).
|
|
3822
|
+
*/
|
|
3823
|
+
percent_off?: number;
|
|
3824
|
+
}
|
|
3825
|
+
|
|
3826
|
+
namespace CouponData {
|
|
3827
|
+
type Duration = 'forever' | 'once' | 'repeating';
|
|
3828
|
+
}
|
|
3829
|
+
}
|
|
3830
|
+
|
|
3831
|
+
interface InvoiceCreation {
|
|
3832
|
+
/**
|
|
3833
|
+
* Parameters passed when creating invoices for payment-mode Checkout Sessions.
|
|
3834
|
+
*/
|
|
3835
|
+
invoice_data?: InvoiceCreation.InvoiceData;
|
|
3836
|
+
}
|
|
3837
|
+
|
|
3838
|
+
namespace InvoiceCreation {
|
|
3839
|
+
interface InvoiceData {
|
|
3840
|
+
/**
|
|
3841
|
+
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
3842
|
+
*/
|
|
3843
|
+
issuer?: InvoiceData.Issuer;
|
|
3844
|
+
}
|
|
3845
|
+
|
|
3846
|
+
namespace InvoiceData {
|
|
3847
|
+
interface Issuer {
|
|
3848
|
+
/**
|
|
3849
|
+
* The connected account being referenced when `type` is `account`.
|
|
3850
|
+
*/
|
|
3851
|
+
account?: string;
|
|
3852
|
+
|
|
3853
|
+
/**
|
|
3854
|
+
* Type of the account referenced in the request.
|
|
3855
|
+
*/
|
|
3856
|
+
type: Issuer.Type;
|
|
3857
|
+
}
|
|
3858
|
+
|
|
3859
|
+
namespace Issuer {
|
|
3860
|
+
type Type = 'account' | 'self';
|
|
3861
|
+
}
|
|
3862
|
+
}
|
|
3863
|
+
}
|
|
3864
|
+
|
|
3865
|
+
interface LineItem {
|
|
3866
|
+
/**
|
|
3867
|
+
* When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
|
|
3868
|
+
*/
|
|
3869
|
+
adjustable_quantity?: LineItem.AdjustableQuantity;
|
|
3870
|
+
|
|
3871
|
+
/**
|
|
3872
|
+
* ID of an existing line item.
|
|
3873
|
+
*/
|
|
3874
|
+
id?: string;
|
|
3875
|
+
|
|
3876
|
+
/**
|
|
3877
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
3878
|
+
*/
|
|
3879
|
+
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
3880
|
+
|
|
3881
|
+
/**
|
|
3882
|
+
* The ID of the [Price](https://stripe.com/docs/api/prices). One of `price` or `price_data` is required when creating a new line item.
|
|
3883
|
+
*/
|
|
3884
|
+
price?: string;
|
|
3885
|
+
|
|
3886
|
+
/**
|
|
3887
|
+
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
|
|
3888
|
+
*/
|
|
3889
|
+
price_data?: LineItem.PriceData;
|
|
3890
|
+
|
|
3891
|
+
/**
|
|
3892
|
+
* The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
|
|
3893
|
+
*/
|
|
3894
|
+
quantity?: number;
|
|
3895
|
+
|
|
3896
|
+
/**
|
|
3897
|
+
* The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
|
|
3898
|
+
*/
|
|
3899
|
+
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
3900
|
+
}
|
|
3901
|
+
|
|
3902
|
+
namespace LineItem {
|
|
3903
|
+
interface AdjustableQuantity {
|
|
3904
|
+
/**
|
|
3905
|
+
* Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
|
|
3906
|
+
*/
|
|
3907
|
+
enabled: boolean;
|
|
3908
|
+
|
|
3909
|
+
/**
|
|
3910
|
+
* The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
|
|
3911
|
+
*/
|
|
3912
|
+
maximum?: number;
|
|
3913
|
+
|
|
3914
|
+
/**
|
|
3915
|
+
* The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
|
|
3916
|
+
*/
|
|
3917
|
+
minimum?: number;
|
|
3918
|
+
}
|
|
3919
|
+
|
|
3920
|
+
interface PriceData {
|
|
3921
|
+
/**
|
|
3922
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
3923
|
+
*/
|
|
3924
|
+
currency: string;
|
|
3925
|
+
|
|
3926
|
+
/**
|
|
3927
|
+
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
|
|
3928
|
+
*/
|
|
3929
|
+
product?: string;
|
|
3930
|
+
|
|
3931
|
+
/**
|
|
3932
|
+
* Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
|
|
3933
|
+
*/
|
|
3934
|
+
product_data?: PriceData.ProductData;
|
|
3935
|
+
|
|
3936
|
+
/**
|
|
3937
|
+
* The recurring components of a price such as `interval` and `interval_count`.
|
|
3938
|
+
*/
|
|
3939
|
+
recurring?: PriceData.Recurring;
|
|
3940
|
+
|
|
3941
|
+
/**
|
|
3942
|
+
* Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
3943
|
+
*/
|
|
3944
|
+
tax_behavior?: PriceData.TaxBehavior;
|
|
3945
|
+
|
|
3946
|
+
/**
|
|
3947
|
+
* A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
|
3948
|
+
*/
|
|
3949
|
+
unit_amount?: number;
|
|
3950
|
+
|
|
3951
|
+
/**
|
|
3952
|
+
* Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
|
3953
|
+
*/
|
|
3954
|
+
unit_amount_decimal?: string;
|
|
3955
|
+
}
|
|
3956
|
+
|
|
3957
|
+
namespace PriceData {
|
|
3958
|
+
interface ProductData {
|
|
3959
|
+
/**
|
|
3960
|
+
* The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
|
3961
|
+
*/
|
|
3962
|
+
description?: string;
|
|
3963
|
+
|
|
3964
|
+
/**
|
|
3965
|
+
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
3966
|
+
*/
|
|
3967
|
+
images?: Array<string>;
|
|
3968
|
+
|
|
3969
|
+
/**
|
|
3970
|
+
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
3971
|
+
*/
|
|
3972
|
+
metadata?: Stripe.MetadataParam;
|
|
3973
|
+
|
|
3974
|
+
/**
|
|
3975
|
+
* The product's name, meant to be displayable to the customer.
|
|
3976
|
+
*/
|
|
3977
|
+
name: string;
|
|
3978
|
+
|
|
3979
|
+
/**
|
|
3980
|
+
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
|
3981
|
+
*/
|
|
3982
|
+
tax_code?: string;
|
|
3983
|
+
|
|
3984
|
+
/**
|
|
3985
|
+
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
3986
|
+
*/
|
|
3987
|
+
unit_label?: string;
|
|
3988
|
+
}
|
|
3989
|
+
|
|
3990
|
+
interface Recurring {
|
|
3991
|
+
/**
|
|
3992
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
3993
|
+
*/
|
|
3994
|
+
interval: Recurring.Interval;
|
|
3995
|
+
|
|
3996
|
+
/**
|
|
3997
|
+
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
3998
|
+
*/
|
|
3999
|
+
interval_count?: number;
|
|
4000
|
+
}
|
|
4001
|
+
|
|
4002
|
+
namespace Recurring {
|
|
4003
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4004
|
+
}
|
|
4005
|
+
|
|
4006
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
4007
|
+
}
|
|
4008
|
+
}
|
|
4009
|
+
|
|
3379
4010
|
interface ShippingOption {
|
|
3380
4011
|
/**
|
|
3381
4012
|
* The ID of the Shipping Rate to use for this shipping option.
|
|
@@ -3513,6 +4144,50 @@ declare module 'stripe' {
|
|
|
3513
4144
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3514
4145
|
}
|
|
3515
4146
|
}
|
|
4147
|
+
|
|
4148
|
+
interface SubscriptionData {
|
|
4149
|
+
/**
|
|
4150
|
+
* All invoices will be billed using the specified settings.
|
|
4151
|
+
*/
|
|
4152
|
+
invoice_settings?: SubscriptionData.InvoiceSettings;
|
|
4153
|
+
|
|
4154
|
+
/**
|
|
4155
|
+
* 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.
|
|
4156
|
+
*/
|
|
4157
|
+
trial_end?: number;
|
|
4158
|
+
|
|
4159
|
+
/**
|
|
4160
|
+
* Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
|
4161
|
+
*/
|
|
4162
|
+
trial_period_days?: Stripe.Emptyable<number>;
|
|
4163
|
+
}
|
|
4164
|
+
|
|
4165
|
+
namespace SubscriptionData {
|
|
4166
|
+
interface InvoiceSettings {
|
|
4167
|
+
/**
|
|
4168
|
+
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
4169
|
+
*/
|
|
4170
|
+
issuer?: InvoiceSettings.Issuer;
|
|
4171
|
+
}
|
|
4172
|
+
|
|
4173
|
+
namespace InvoiceSettings {
|
|
4174
|
+
interface Issuer {
|
|
4175
|
+
/**
|
|
4176
|
+
* The connected account being referenced when `type` is `account`.
|
|
4177
|
+
*/
|
|
4178
|
+
account?: string;
|
|
4179
|
+
|
|
4180
|
+
/**
|
|
4181
|
+
* Type of the account referenced in the request.
|
|
4182
|
+
*/
|
|
4183
|
+
type: Issuer.Type;
|
|
4184
|
+
}
|
|
4185
|
+
|
|
4186
|
+
namespace Issuer {
|
|
4187
|
+
type Type = 'account' | 'self';
|
|
4188
|
+
}
|
|
4189
|
+
}
|
|
4190
|
+
}
|
|
3516
4191
|
}
|
|
3517
4192
|
|
|
3518
4193
|
interface SessionListParams extends PaginationParams {
|
|
@@ -3526,6 +4201,11 @@ declare module 'stripe' {
|
|
|
3526
4201
|
*/
|
|
3527
4202
|
customer?: string;
|
|
3528
4203
|
|
|
4204
|
+
/**
|
|
4205
|
+
* Only return the Checkout Sessions for the Account specified.
|
|
4206
|
+
*/
|
|
4207
|
+
customer_account?: string;
|
|
4208
|
+
|
|
3529
4209
|
/**
|
|
3530
4210
|
* Only return the Checkout Sessions for the Customer details specified.
|
|
3531
4211
|
*/
|