stripe 20.1.0-beta.1 → 20.1.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 +47 -1500
- package/OPENAPI_VERSION +1 -1
- package/README.md +0 -1
- package/VERSION +1 -1
- package/cjs/Error.js +1 -115
- package/cjs/apiVersion.js +3 -2
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/Mandates.js +0 -5
- package/cjs/resources/PaymentIntents.js +0 -8
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources/Subscriptions.js +0 -4
- package/cjs/resources.js +2 -88
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +0 -100
- package/esm/apiVersion.js +2 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/Mandates.js +0 -5
- package/esm/resources/PaymentIntents.js +0 -8
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources/Subscriptions.js +0 -4
- package/esm/resources.js +0 -81
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +2 -47
- package/types/AccountSessionsResource.d.ts +0 -264
- package/types/Accounts.d.ts +25 -249
- package/types/AccountsResource.d.ts +114 -620
- package/types/ApplicationFeesResource.d.ts +2 -2
- package/types/Apps/Secrets.d.ts +1 -1
- package/types/Balance.d.ts +2 -2
- package/types/BalanceSettings.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -12
- package/types/Billing/AlertTriggereds.d.ts +1 -1
- package/types/Billing/Alerts.d.ts +1 -1
- package/types/Billing/CreditBalanceSummary.d.ts +1 -1
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +3 -3
- package/types/Billing/CreditGrantsResource.d.ts +3 -3
- package/types/Billing/MeterEvents.d.ts +1 -1
- package/types/Billing/MeterEventsResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +10 -3
- package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
- package/types/BillingPortal/Sessions.d.ts +7 -7
- package/types/BillingPortal/SessionsResource.d.ts +7 -7
- package/types/Capabilities.d.ts +16 -18
- package/types/Cards.d.ts +2 -7
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -179
- package/types/ChargesResource.d.ts +88 -3868
- package/types/Checkout/Sessions.d.ts +20 -297
- package/types/Checkout/SessionsResource.d.ts +59 -417
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -109
- package/types/Coupons.d.ts +3 -38
- package/types/CouponsResource.d.ts +2 -25
- package/types/CreditNoteLineItems.d.ts +3 -17
- package/types/CreditNotes.d.ts +8 -5
- package/types/CreditNotesResource.d.ts +5 -5
- package/types/CustomerBalanceTransactions.d.ts +9 -6
- package/types/CustomerCashBalanceTransactions.d.ts +13 -10
- package/types/CustomerSessions.d.ts +1 -42
- package/types/CustomerSessionsResource.d.ts +0 -41
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -23
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -43
- package/types/DisputesResource.d.ts +1 -12
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +0 -85
- package/types/EventTypes.d.ts +0 -630
- package/types/Events.d.ts +1 -97
- package/types/ExchangeRates.d.ts +2 -2
- package/types/FeeRefunds.d.ts +2 -2
- package/types/FileLinks.d.ts +1 -1
- package/types/FileLinksResource.d.ts +2 -2
- package/types/Files.d.ts +4 -4
- package/types/FilesResource.d.ts +3 -3
- package/types/FinancialConnections/Accounts.d.ts +4 -37
- package/types/FinancialConnections/AccountsResource.d.ts +6 -38
- package/types/FinancialConnections/Sessions.d.ts +3 -51
- package/types/FinancialConnections/SessionsResource.d.ts +4 -41
- package/types/Forwarding/Requests.d.ts +1 -1
- package/types/Forwarding/RequestsResource.d.ts +1 -1
- package/types/FundingInstructions.d.ts +2 -2
- package/types/Identity/VerificationReports.d.ts +8 -8
- package/types/Identity/VerificationSessions.d.ts +11 -11
- package/types/Identity/VerificationSessionsResource.d.ts +18 -12
- package/types/InvoiceItems.d.ts +8 -13
- package/types/InvoiceItemsResource.d.ts +16 -114
- package/types/InvoiceLineItems.d.ts +10 -46
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +60 -204
- package/types/InvoicesResource.d.ts +132 -1651
- package/types/Issuing/Authorizations.d.ts +20 -20
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/Cardholders.d.ts +13 -13
- package/types/Issuing/CardholdersResource.d.ts +21 -22
- package/types/Issuing/Cards.d.ts +10 -10
- package/types/Issuing/CardsResource.d.ts +13 -13
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +12 -17
- package/types/Issuing/TransactionsResource.d.ts +1 -6
- package/types/LineItems.d.ts +4 -48
- package/types/LoginLinks.d.ts +1 -1
- package/types/Mandates.d.ts +1 -69
- package/types/MandatesResource.d.ts +0 -31
- package/types/PaymentAttemptRecords.d.ts +119 -135
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +48 -705
- package/types/PaymentIntentsResource.d.ts +6867 -19451
- package/types/PaymentLinks.d.ts +7 -12
- package/types/PaymentLinksResource.d.ts +28 -38
- package/types/PaymentMethodConfigurations.d.ts +4 -184
- package/types/PaymentMethodConfigurationsResource.d.ts +76 -326
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -116
- package/types/PaymentMethodsResource.d.ts +7 -116
- package/types/PaymentRecords.d.ts +126 -135
- package/types/PaymentRecordsResource.d.ts +7 -7
- package/types/Payouts.d.ts +7 -7
- package/types/PayoutsResource.d.ts +3 -3
- package/types/Persons.d.ts +21 -23
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -28
- package/types/PricesResource.d.ts +10 -32
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +14 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/Quotes.d.ts +14 -602
- package/types/QuotesResource.d.ts +298 -2628
- package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
- package/types/Radar/ValueListItems.d.ts +1 -1
- package/types/Radar/ValueLists.d.ts +2 -2
- package/types/Radar/ValueListsResource.d.ts +2 -2
- package/types/Refunds.d.ts +3 -17
- package/types/RefundsResource.d.ts +3 -3
- package/types/Reporting/ReportRuns.d.ts +3 -3
- package/types/Reporting/ReportRunsResource.d.ts +2 -2
- package/types/Reporting/ReportTypes.d.ts +3 -3
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +22 -60
- package/types/SetupIntents.d.ts +22 -157
- package/types/SetupIntentsResource.d.ts +50 -673
- package/types/ShippingRates.d.ts +3 -3
- package/types/ShippingRatesResource.d.ts +3 -3
- package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
- package/types/SourceMandateNotifications.d.ts +3 -3
- package/types/Sources.d.ts +5 -34
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -33
- package/types/SubscriptionItemsResource.d.ts +22 -131
- package/types/SubscriptionSchedules.d.ts +9 -209
- package/types/SubscriptionSchedulesResource.d.ts +39 -1257
- package/types/Subscriptions.d.ts +41 -251
- package/types/SubscriptionsResource.d.ts +94 -734
- package/types/Tax/Associations.d.ts +3 -3
- package/types/Tax/AssociationsResource.d.ts +1 -1
- package/types/Tax/CalculationLineItems.d.ts +7 -7
- package/types/Tax/Calculations.d.ts +12 -12
- package/types/Tax/CalculationsResource.d.ts +7 -7
- package/types/Tax/Registrations.d.ts +3 -3
- package/types/Tax/Settings.d.ts +1 -1
- package/types/Tax/SettingsResource.d.ts +1 -1
- package/types/Tax/TransactionLineItems.d.ts +5 -5
- package/types/Tax/Transactions.d.ts +9 -9
- package/types/Tax/TransactionsResource.d.ts +10 -10
- package/types/TaxIds.d.ts +6 -6
- package/types/TaxIdsResource.d.ts +4 -4
- package/types/TaxRates.d.ts +1 -1
- package/types/TaxRatesResource.d.ts +2 -2
- package/types/Terminal/Configurations.d.ts +0 -9
- package/types/Terminal/ConfigurationsResource.d.ts +0 -28
- package/types/Terminal/ConnectionTokens.d.ts +1 -1
- package/types/Terminal/Locations.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +3 -3
- package/types/Terminal/Readers.d.ts +10 -30
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -107
- package/types/TestHelpers/CustomersResource.d.ts +2 -2
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
- package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -27
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -27
- package/types/Tokens.d.ts +4 -4
- package/types/TokensResource.d.ts +17 -17
- package/types/Topups.d.ts +3 -3
- package/types/TopupsResource.d.ts +3 -3
- package/types/TransferReversals.d.ts +4 -4
- package/types/Transfers.d.ts +5 -10
- package/types/TransfersResource.d.ts +6 -11
- package/types/Treasury/CreditReversals.d.ts +3 -3
- package/types/Treasury/CreditReversalsResource.d.ts +1 -1
- package/types/Treasury/DebitReversals.d.ts +3 -3
- package/types/Treasury/DebitReversalsResource.d.ts +1 -1
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +1 -6
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -39
- package/types/Treasury/InboundTransfers.d.ts +4 -4
- package/types/Treasury/InboundTransfersResource.d.ts +2 -2
- package/types/Treasury/OutboundPayments.d.ts +5 -5
- package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
- package/types/Treasury/OutboundTransfers.d.ts +4 -30
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -29
- package/types/Treasury/ReceivedCredits.d.ts +9 -35
- package/types/Treasury/ReceivedDebits.d.ts +6 -37
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Core/AccountLinks.d.ts +13 -21
- package/types/V2/Core/AccountLinksResource.d.ts +8 -16
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +129 -24
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
- package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
- package/types/V2/Core/Accounts.d.ts +256 -1349
- package/types/V2/Core/AccountsResource.d.ts +282 -567
- package/types/V2/Core/EventTypes.d.ts +10 -1542
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +5 -79
- package/types/apiVersion.d.ts +2 -1
- package/types/index.d.ts +0 -134
- package/types/lib.d.ts +0 -10
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/Billing/Analytics/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/Privacy/RedactionJobs.js +0 -42
- package/cjs/resources/Tax/Forms.js +0 -20
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/BillSettings.js +0 -27
- package/cjs/resources/V2/Billing/Cadences.js +0 -23
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
- package/cjs/resources/V2/Billing/Profiles.js +0 -19
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -33
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -37
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -29
- 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/TestHelpers/FinancialAddresses.js +0 -16
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/Billing/Analytics/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/Privacy/RedactionJobs.js +0 -39
- package/esm/resources/Tax/Forms.js +0 -17
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
- package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/BillSettings.js +0 -24
- package/esm/resources/V2/Billing/Cadences.js +0 -20
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
- package/esm/resources/V2/Billing/Profiles.js +0 -16
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -30
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -34
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -26
- 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/TestHelpers/FinancialAddresses.js +0 -13
- package/types/AccountNotices.d.ts +0 -113
- package/types/AccountNoticesResource.d.ts +0 -98
- package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
- package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
- package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
- 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 -5505
- 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 -1771
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
- package/types/Tax/Forms.d.ts +0 -220
- package/types/Tax/FormsResource.d.ts +0 -107
- package/types/Terminal/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
- package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/BillSettings.d.ts +0 -120
- package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
- package/types/V2/Billing/Cadences.d.ts +0 -690
- package/types/V2/Billing/CadencesResource.d.ts +0 -487
- package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -318
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
- package/types/V2/Billing/CollectionSettings.d.ts +0 -341
- package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -683
- package/types/V2/Billing/Profiles.d.ts +0 -70
- package/types/V2/Billing/ProfilesResource.d.ts +0 -150
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -194
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -116
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -198
- 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 -148
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -172
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -175
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -109
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -212
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
- 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/PayoutMethodsBankAccountSpec.d.ts +0 -93
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
- 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/TestHelpers/FinancialAddressesResource.d.ts +0 -68
package/types/ShippingRates.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
/**
|
|
6
6
|
* Shipping rates describe the price of shipping presented to your customers and
|
|
7
|
-
* applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/
|
|
7
|
+
* applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).
|
|
8
8
|
*/
|
|
9
9
|
interface ShippingRate {
|
|
10
10
|
/**
|
|
@@ -45,7 +45,7 @@ declare module 'stripe' {
|
|
|
45
45
|
livemode: boolean;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
48
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
49
49
|
*/
|
|
50
50
|
metadata: Stripe.Metadata;
|
|
51
51
|
|
|
@@ -55,7 +55,7 @@ declare module 'stripe' {
|
|
|
55
55
|
tax_behavior: ShippingRate.TaxBehavior | null;
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
|
-
* A [tax code](https://stripe.com/
|
|
58
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
59
59
|
*/
|
|
60
60
|
tax_code: string | Stripe.TaxCode | null;
|
|
61
61
|
|
|
@@ -24,7 +24,7 @@ declare module 'stripe' {
|
|
|
24
24
|
fixed_amount?: ShippingRateCreateParams.FixedAmount;
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
27
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
28
28
|
*/
|
|
29
29
|
metadata?: Stripe.MetadataParam;
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ declare module 'stripe' {
|
|
|
34
34
|
tax_behavior?: ShippingRateCreateParams.TaxBehavior;
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
|
-
* A [tax code](https://stripe.com/
|
|
37
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
38
38
|
*/
|
|
39
39
|
tax_code?: string;
|
|
40
40
|
|
|
@@ -155,7 +155,7 @@ declare module 'stripe' {
|
|
|
155
155
|
fixed_amount?: ShippingRateUpdateParams.FixedAmount;
|
|
156
156
|
|
|
157
157
|
/**
|
|
158
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
158
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
159
159
|
*/
|
|
160
160
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
161
161
|
|
|
@@ -4,7 +4,7 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
namespace Sigma {
|
|
6
6
|
/**
|
|
7
|
-
* If you have [scheduled a Sigma query](https://stripe.com/
|
|
7
|
+
* If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll
|
|
8
8
|
* receive a `sigma.scheduled_query_run.created` webhook each time the query
|
|
9
9
|
* runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
|
|
10
10
|
* retrieve the query results.
|
|
@@ -50,11 +50,11 @@ declare module 'stripe' {
|
|
|
50
50
|
* just like a `Card` object: once chargeable, they can be charged, or can be
|
|
51
51
|
* attached to customers.
|
|
52
52
|
*
|
|
53
|
-
* Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/
|
|
54
|
-
* We recommend that you adopt the [PaymentMethods API](https://stripe.com/
|
|
53
|
+
* Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
|
|
54
|
+
* We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
|
|
55
55
|
* This newer API provides access to our latest features and payment method types.
|
|
56
56
|
*
|
|
57
|
-
* Related guides: [Sources API](https://stripe.com/
|
|
57
|
+
* Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
|
|
58
58
|
*/
|
|
59
59
|
source: Stripe.Source;
|
|
60
60
|
|
package/types/Sources.d.ts
CHANGED
|
@@ -8,11 +8,11 @@ declare module 'stripe' {
|
|
|
8
8
|
* just like a `Card` object: once chargeable, they can be charged, or can be
|
|
9
9
|
* attached to customers.
|
|
10
10
|
*
|
|
11
|
-
* Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/
|
|
12
|
-
* We recommend that you adopt the [PaymentMethods API](https://stripe.com/
|
|
11
|
+
* Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
|
|
12
|
+
* We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
|
|
13
13
|
* This newer API provides access to our latest features and payment method types.
|
|
14
14
|
*
|
|
15
|
-
* Related guides: [Sources API](https://stripe.com/
|
|
15
|
+
* Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
|
|
16
16
|
*/
|
|
17
17
|
interface Source {
|
|
18
18
|
/**
|
|
@@ -92,7 +92,7 @@ declare module 'stripe' {
|
|
|
92
92
|
livemode: boolean;
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
95
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
96
96
|
*/
|
|
97
97
|
metadata: Stripe.Metadata | null;
|
|
98
98
|
|
|
@@ -105,8 +105,6 @@ declare module 'stripe' {
|
|
|
105
105
|
|
|
106
106
|
p24?: Source.P24;
|
|
107
107
|
|
|
108
|
-
paypal?: Source.Paypal;
|
|
109
|
-
|
|
110
108
|
receiver?: Source.Receiver;
|
|
111
109
|
|
|
112
110
|
redirect?: Source.Redirect;
|
|
@@ -132,7 +130,7 @@ declare module 'stripe' {
|
|
|
132
130
|
three_d_secure?: Source.ThreeDSecure;
|
|
133
131
|
|
|
134
132
|
/**
|
|
135
|
-
* The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/
|
|
133
|
+
* The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used.
|
|
136
134
|
*/
|
|
137
135
|
type: Source.Type;
|
|
138
136
|
|
|
@@ -238,8 +236,6 @@ declare module 'stripe' {
|
|
|
238
236
|
|
|
239
237
|
brand?: string | null;
|
|
240
238
|
|
|
241
|
-
brand_product?: string | null;
|
|
242
|
-
|
|
243
239
|
country?: string | null;
|
|
244
240
|
|
|
245
241
|
cvc_check?: string | null;
|
|
@@ -280,8 +276,6 @@ declare module 'stripe' {
|
|
|
280
276
|
|
|
281
277
|
brand?: string | null;
|
|
282
278
|
|
|
283
|
-
brand_product?: string | null;
|
|
284
|
-
|
|
285
279
|
country?: string | null;
|
|
286
280
|
|
|
287
281
|
cvm_type?: string;
|
|
@@ -485,26 +479,6 @@ declare module 'stripe' {
|
|
|
485
479
|
reference?: string | null;
|
|
486
480
|
}
|
|
487
481
|
|
|
488
|
-
interface Paypal {
|
|
489
|
-
billing_agreement?: string | null;
|
|
490
|
-
|
|
491
|
-
fingerprint?: string | null;
|
|
492
|
-
|
|
493
|
-
payer_id?: string | null;
|
|
494
|
-
|
|
495
|
-
reference_id?: string;
|
|
496
|
-
|
|
497
|
-
reference_transaction_amount?: string;
|
|
498
|
-
|
|
499
|
-
reference_transaction_charged?: boolean;
|
|
500
|
-
|
|
501
|
-
statement_descriptor?: string | null;
|
|
502
|
-
|
|
503
|
-
transaction_id?: string;
|
|
504
|
-
|
|
505
|
-
verified_email?: string | null;
|
|
506
|
-
}
|
|
507
|
-
|
|
508
482
|
interface Receiver {
|
|
509
483
|
/**
|
|
510
484
|
* The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
|
|
@@ -706,8 +680,6 @@ declare module 'stripe' {
|
|
|
706
680
|
|
|
707
681
|
brand?: string | null;
|
|
708
682
|
|
|
709
|
-
brand_product?: string | null;
|
|
710
|
-
|
|
711
683
|
card?: string | null;
|
|
712
684
|
|
|
713
685
|
country?: string | null;
|
|
@@ -756,7 +728,6 @@ declare module 'stripe' {
|
|
|
756
728
|
| 'klarna'
|
|
757
729
|
| 'multibanco'
|
|
758
730
|
| 'p24'
|
|
759
|
-
| 'paypal'
|
|
760
731
|
| 'sepa_credit_transfer'
|
|
761
732
|
| 'sepa_debit'
|
|
762
733
|
| 'sofort'
|
|
@@ -71,7 +71,7 @@ declare module 'stripe' {
|
|
|
71
71
|
token?: string;
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/
|
|
74
|
+
* The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide)
|
|
75
75
|
*/
|
|
76
76
|
type?: string;
|
|
77
77
|
|
|
@@ -323,7 +323,7 @@ declare module 'stripe' {
|
|
|
323
323
|
mandate?: SourceUpdateParams.Mandate;
|
|
324
324
|
|
|
325
325
|
/**
|
|
326
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
326
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
327
327
|
*/
|
|
328
328
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
329
329
|
|
|
@@ -37,11 +37,6 @@ declare module 'stripe' {
|
|
|
37
37
|
*/
|
|
38
38
|
object: 'subscription_item';
|
|
39
39
|
|
|
40
|
-
/**
|
|
41
|
-
* The time period the subscription item has been billed for.
|
|
42
|
-
*/
|
|
43
|
-
billed_until?: number | null;
|
|
44
|
-
|
|
45
40
|
/**
|
|
46
41
|
* Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
|
|
47
42
|
*/
|
|
@@ -73,34 +68,34 @@ declare module 'stripe' {
|
|
|
73
68
|
discounts: Array<string | Stripe.Discount>;
|
|
74
69
|
|
|
75
70
|
/**
|
|
76
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
71
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
77
72
|
*/
|
|
78
73
|
metadata: Stripe.Metadata;
|
|
79
74
|
|
|
80
75
|
/**
|
|
81
|
-
* You can now model subscriptions more flexibly using the [Prices API](https://stripe.com
|
|
76
|
+
* You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
|
|
82
77
|
*
|
|
83
78
|
* Plans define the base price, currency, and billing cycle for recurring purchases of products.
|
|
84
|
-
* [Products](https://stripe.com
|
|
79
|
+
* [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
|
|
85
80
|
*
|
|
86
81
|
* For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
|
|
87
82
|
*
|
|
88
|
-
* Related guides: [Set up a subscription](https://stripe.com/
|
|
83
|
+
* Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).
|
|
89
84
|
*/
|
|
90
85
|
plan: Stripe.Plan;
|
|
91
86
|
|
|
92
87
|
/**
|
|
93
88
|
* Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
|
|
94
|
-
* [Products](https://stripe.com
|
|
89
|
+
* [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
|
|
95
90
|
*
|
|
96
91
|
* For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
|
|
97
92
|
*
|
|
98
|
-
* Related guides: [Set up a subscription](https://stripe.com/
|
|
93
|
+
* Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
|
|
99
94
|
*/
|
|
100
95
|
price: Stripe.Price;
|
|
101
96
|
|
|
102
97
|
/**
|
|
103
|
-
* The [quantity](https://stripe.com/
|
|
98
|
+
* The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
|
|
104
99
|
*/
|
|
105
100
|
quantity?: number;
|
|
106
101
|
|
|
@@ -113,11 +108,6 @@ declare module 'stripe' {
|
|
|
113
108
|
* The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
|
114
109
|
*/
|
|
115
110
|
tax_rates: Array<Stripe.TaxRate> | null;
|
|
116
|
-
|
|
117
|
-
/**
|
|
118
|
-
* Options that configure the trial on the subscription item.
|
|
119
|
-
*/
|
|
120
|
-
trial?: SubscriptionItem.Trial | null;
|
|
121
111
|
}
|
|
122
112
|
|
|
123
113
|
namespace SubscriptionItem {
|
|
@@ -127,22 +117,6 @@ declare module 'stripe' {
|
|
|
127
117
|
*/
|
|
128
118
|
usage_gte: number | null;
|
|
129
119
|
}
|
|
130
|
-
|
|
131
|
-
interface Trial {
|
|
132
|
-
/**
|
|
133
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
134
|
-
*/
|
|
135
|
-
converts_to?: Array<string> | null;
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Determines the type of trial for this item.
|
|
139
|
-
*/
|
|
140
|
-
type: Trial.Type;
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
namespace Trial {
|
|
144
|
-
type Type = 'free' | 'paid';
|
|
145
|
-
}
|
|
146
120
|
}
|
|
147
121
|
}
|
|
148
122
|
}
|
|
@@ -28,16 +28,16 @@ declare module 'stripe' {
|
|
|
28
28
|
expand?: Array<string>;
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
31
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
32
32
|
*/
|
|
33
33
|
metadata?: Stripe.MetadataParam;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/
|
|
36
|
+
* Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
|
37
37
|
*
|
|
38
|
-
* Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/
|
|
38
|
+
* Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
|
|
39
39
|
*
|
|
40
|
-
* Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/
|
|
40
|
+
* Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
|
|
41
41
|
*
|
|
42
42
|
* Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
|
|
43
43
|
*/
|
|
@@ -54,17 +54,17 @@ declare module 'stripe' {
|
|
|
54
54
|
price?: string;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
57
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
58
58
|
*/
|
|
59
59
|
price_data?: SubscriptionItemCreateParams.PriceData;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
62
|
+
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
63
63
|
*/
|
|
64
64
|
proration_behavior?: SubscriptionItemCreateParams.ProrationBehavior;
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com
|
|
67
|
+
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
|
|
68
68
|
*/
|
|
69
69
|
proration_date?: number;
|
|
70
70
|
|
|
@@ -74,20 +74,15 @@ declare module 'stripe' {
|
|
|
74
74
|
quantity?: number;
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
77
|
+
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
78
78
|
*/
|
|
79
79
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Options that configure the trial on the subscription item.
|
|
83
|
-
*/
|
|
84
|
-
trial?: SubscriptionItemCreateParams.Trial;
|
|
85
80
|
}
|
|
86
81
|
|
|
87
82
|
namespace SubscriptionItemCreateParams {
|
|
88
83
|
interface BillingThresholds {
|
|
89
84
|
/**
|
|
90
|
-
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
85
|
+
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
91
86
|
*/
|
|
92
87
|
usage_gte: number;
|
|
93
88
|
}
|
|
@@ -103,56 +98,12 @@ declare module 'stripe' {
|
|
|
103
98
|
*/
|
|
104
99
|
discount?: string;
|
|
105
100
|
|
|
106
|
-
/**
|
|
107
|
-
* Details to determine how long the discount should be applied for.
|
|
108
|
-
*/
|
|
109
|
-
discount_end?: Discount.DiscountEnd;
|
|
110
|
-
|
|
111
101
|
/**
|
|
112
102
|
* ID of the promotion code to create a new discount for.
|
|
113
103
|
*/
|
|
114
104
|
promotion_code?: string;
|
|
115
105
|
}
|
|
116
106
|
|
|
117
|
-
namespace Discount {
|
|
118
|
-
interface DiscountEnd {
|
|
119
|
-
/**
|
|
120
|
-
* Time span for the redeemed discount.
|
|
121
|
-
*/
|
|
122
|
-
duration?: DiscountEnd.Duration;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
126
|
-
*/
|
|
127
|
-
timestamp?: number;
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* The type of calculation made to determine when the discount ends.
|
|
131
|
-
*/
|
|
132
|
-
type: DiscountEnd.Type;
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
namespace DiscountEnd {
|
|
136
|
-
interface Duration {
|
|
137
|
-
/**
|
|
138
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
139
|
-
*/
|
|
140
|
-
interval: Duration.Interval;
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
144
|
-
*/
|
|
145
|
-
interval_count: number;
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
namespace Duration {
|
|
149
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
type Type = 'duration' | 'timestamp';
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
|
|
156
107
|
type PaymentBehavior =
|
|
157
108
|
| 'allow_incomplete'
|
|
158
109
|
| 'default_incomplete'
|
|
@@ -176,7 +127,7 @@ declare module 'stripe' {
|
|
|
176
127
|
recurring: PriceData.Recurring;
|
|
177
128
|
|
|
178
129
|
/**
|
|
179
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
130
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/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.
|
|
180
131
|
*/
|
|
181
132
|
tax_behavior?: PriceData.TaxBehavior;
|
|
182
133
|
|
|
@@ -212,22 +163,6 @@ declare module 'stripe' {
|
|
|
212
163
|
}
|
|
213
164
|
|
|
214
165
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
215
|
-
|
|
216
|
-
interface Trial {
|
|
217
|
-
/**
|
|
218
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
219
|
-
*/
|
|
220
|
-
converts_to?: Array<string>;
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Determines the type of trial for this item.
|
|
224
|
-
*/
|
|
225
|
-
type: Trial.Type;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
namespace Trial {
|
|
229
|
-
type Type = 'free' | 'paid';
|
|
230
|
-
}
|
|
231
166
|
}
|
|
232
167
|
|
|
233
168
|
interface SubscriptionItemRetrieveParams {
|
|
@@ -258,7 +193,7 @@ declare module 'stripe' {
|
|
|
258
193
|
expand?: Array<string>;
|
|
259
194
|
|
|
260
195
|
/**
|
|
261
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
196
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
262
197
|
*/
|
|
263
198
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
264
199
|
|
|
@@ -268,11 +203,11 @@ declare module 'stripe' {
|
|
|
268
203
|
off_session?: boolean;
|
|
269
204
|
|
|
270
205
|
/**
|
|
271
|
-
* Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/
|
|
206
|
+
* Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
|
272
207
|
*
|
|
273
|
-
* Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/
|
|
208
|
+
* Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
|
|
274
209
|
*
|
|
275
|
-
* Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/
|
|
210
|
+
* Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
|
|
276
211
|
*
|
|
277
212
|
* Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
|
|
278
213
|
*/
|
|
@@ -289,17 +224,17 @@ declare module 'stripe' {
|
|
|
289
224
|
price?: string;
|
|
290
225
|
|
|
291
226
|
/**
|
|
292
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
227
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
293
228
|
*/
|
|
294
229
|
price_data?: SubscriptionItemUpdateParams.PriceData;
|
|
295
230
|
|
|
296
231
|
/**
|
|
297
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
232
|
+
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
298
233
|
*/
|
|
299
234
|
proration_behavior?: SubscriptionItemUpdateParams.ProrationBehavior;
|
|
300
235
|
|
|
301
236
|
/**
|
|
302
|
-
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com
|
|
237
|
+
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
|
|
303
238
|
*/
|
|
304
239
|
proration_date?: number;
|
|
305
240
|
|
|
@@ -309,7 +244,7 @@ declare module 'stripe' {
|
|
|
309
244
|
quantity?: number;
|
|
310
245
|
|
|
311
246
|
/**
|
|
312
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
247
|
+
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
313
248
|
*/
|
|
314
249
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
315
250
|
}
|
|
@@ -317,7 +252,7 @@ declare module 'stripe' {
|
|
|
317
252
|
namespace SubscriptionItemUpdateParams {
|
|
318
253
|
interface BillingThresholds {
|
|
319
254
|
/**
|
|
320
|
-
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
255
|
+
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
321
256
|
*/
|
|
322
257
|
usage_gte: number;
|
|
323
258
|
}
|
|
@@ -333,56 +268,12 @@ declare module 'stripe' {
|
|
|
333
268
|
*/
|
|
334
269
|
discount?: string;
|
|
335
270
|
|
|
336
|
-
/**
|
|
337
|
-
* Details to determine how long the discount should be applied for.
|
|
338
|
-
*/
|
|
339
|
-
discount_end?: Discount.DiscountEnd;
|
|
340
|
-
|
|
341
271
|
/**
|
|
342
272
|
* ID of the promotion code to create a new discount for.
|
|
343
273
|
*/
|
|
344
274
|
promotion_code?: string;
|
|
345
275
|
}
|
|
346
276
|
|
|
347
|
-
namespace Discount {
|
|
348
|
-
interface DiscountEnd {
|
|
349
|
-
/**
|
|
350
|
-
* Time span for the redeemed discount.
|
|
351
|
-
*/
|
|
352
|
-
duration?: DiscountEnd.Duration;
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
356
|
-
*/
|
|
357
|
-
timestamp?: number;
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* The type of calculation made to determine when the discount ends.
|
|
361
|
-
*/
|
|
362
|
-
type: DiscountEnd.Type;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
namespace DiscountEnd {
|
|
366
|
-
interface Duration {
|
|
367
|
-
/**
|
|
368
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
369
|
-
*/
|
|
370
|
-
interval: Duration.Interval;
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
374
|
-
*/
|
|
375
|
-
interval_count: number;
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
namespace Duration {
|
|
379
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
380
|
-
}
|
|
381
|
-
|
|
382
|
-
type Type = 'duration' | 'timestamp';
|
|
383
|
-
}
|
|
384
|
-
}
|
|
385
|
-
|
|
386
277
|
type PaymentBehavior =
|
|
387
278
|
| 'allow_incomplete'
|
|
388
279
|
| 'default_incomplete'
|
|
@@ -406,7 +297,7 @@ declare module 'stripe' {
|
|
|
406
297
|
recurring: PriceData.Recurring;
|
|
407
298
|
|
|
408
299
|
/**
|
|
409
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
300
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/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.
|
|
410
301
|
*/
|
|
411
302
|
tax_behavior?: PriceData.TaxBehavior;
|
|
412
303
|
|
|
@@ -463,12 +354,12 @@ declare module 'stripe' {
|
|
|
463
354
|
clear_usage?: boolean;
|
|
464
355
|
|
|
465
356
|
/**
|
|
466
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
357
|
+
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
467
358
|
*/
|
|
468
359
|
proration_behavior?: SubscriptionItemDeleteParams.ProrationBehavior;
|
|
469
360
|
|
|
470
361
|
/**
|
|
471
|
-
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com
|
|
362
|
+
* If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint.
|
|
472
363
|
*/
|
|
473
364
|
proration_date?: number;
|
|
474
365
|
}
|