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/Payouts.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ declare module 'stripe' {
|
|
|
10
10
|
* schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
|
|
11
11
|
* industry.
|
|
12
12
|
*
|
|
13
|
-
* Related guide: [Receiving payouts](https://stripe.com/
|
|
13
|
+
* Related guide: [Receiving payouts](https://docs.stripe.com/payouts)
|
|
14
14
|
*/
|
|
15
15
|
interface Payout {
|
|
16
16
|
/**
|
|
@@ -29,12 +29,12 @@ declare module 'stripe' {
|
|
|
29
29
|
amount: number;
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
|
-
* The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/
|
|
32
|
+
* The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.
|
|
33
33
|
*/
|
|
34
34
|
application_fee: string | Stripe.ApplicationFee | null;
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
|
-
* The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/
|
|
37
|
+
* The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.
|
|
38
38
|
*/
|
|
39
39
|
application_fee_amount: number | null;
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ declare module 'stripe' {
|
|
|
44
44
|
arrival_date: number;
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
|
-
* Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/
|
|
47
|
+
* Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).
|
|
48
48
|
*/
|
|
49
49
|
automatic: boolean;
|
|
50
50
|
|
|
@@ -83,7 +83,7 @@ declare module 'stripe' {
|
|
|
83
83
|
failure_balance_transaction: string | Stripe.BalanceTransaction | null;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
|
-
* Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/
|
|
86
|
+
* Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures).
|
|
87
87
|
*/
|
|
88
88
|
failure_code: string | null;
|
|
89
89
|
|
|
@@ -98,7 +98,7 @@ declare module 'stripe' {
|
|
|
98
98
|
livemode: boolean;
|
|
99
99
|
|
|
100
100
|
/**
|
|
101
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
101
|
+
* 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.
|
|
102
102
|
*/
|
|
103
103
|
metadata: Stripe.Metadata | null;
|
|
104
104
|
|
|
@@ -118,7 +118,7 @@ declare module 'stripe' {
|
|
|
118
118
|
payout_method: string | null;
|
|
119
119
|
|
|
120
120
|
/**
|
|
121
|
-
* If `completed`, you can use the [Balance Transactions API](https://stripe.com/
|
|
121
|
+
* If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
|
|
122
122
|
*/
|
|
123
123
|
reconciliation_status: Payout.ReconciliationStatus;
|
|
124
124
|
|
|
@@ -29,7 +29,7 @@ declare module 'stripe' {
|
|
|
29
29
|
expand?: Array<string>;
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
32
|
+
* 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`.
|
|
33
33
|
*/
|
|
34
34
|
metadata?: Stripe.MetadataParam;
|
|
35
35
|
|
|
@@ -74,7 +74,7 @@ declare module 'stripe' {
|
|
|
74
74
|
expand?: Array<string>;
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
77
|
+
* 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`.
|
|
78
78
|
*/
|
|
79
79
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
80
80
|
}
|
|
@@ -120,7 +120,7 @@ declare module 'stripe' {
|
|
|
120
120
|
expand?: Array<string>;
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
123
|
+
* 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`.
|
|
124
124
|
*/
|
|
125
125
|
metadata?: Stripe.MetadataParam;
|
|
126
126
|
}
|
package/types/Persons.d.ts
CHANGED
|
@@ -97,7 +97,7 @@ declare module 'stripe' {
|
|
|
97
97
|
full_name_aliases?: Array<string>;
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
|
-
* Information about the [upcoming new requirements for this person](https://stripe.com/
|
|
100
|
+
* Information about the [upcoming new requirements for this person](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
|
|
101
101
|
*/
|
|
102
102
|
future_requirements?: Person.FutureRequirements | null;
|
|
103
103
|
|
|
@@ -137,7 +137,7 @@ declare module 'stripe' {
|
|
|
137
137
|
maiden_name?: string | null;
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
140
|
+
* 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.
|
|
141
141
|
*/
|
|
142
142
|
metadata?: Stripe.Metadata;
|
|
143
143
|
|
|
@@ -298,17 +298,17 @@ declare module 'stripe' {
|
|
|
298
298
|
|
|
299
299
|
interface FutureRequirements {
|
|
300
300
|
/**
|
|
301
|
-
* Fields that are due and can be
|
|
301
|
+
* Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again.
|
|
302
302
|
*/
|
|
303
303
|
alternatives: Array<FutureRequirements.Alternative> | null;
|
|
304
304
|
|
|
305
305
|
/**
|
|
306
|
-
* Fields that need to be
|
|
306
|
+
* Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
|
|
307
307
|
*/
|
|
308
308
|
currently_due: Array<string>;
|
|
309
309
|
|
|
310
310
|
/**
|
|
311
|
-
*
|
|
311
|
+
* Details about validation and verification failures for `due` requirements that must be resolved.
|
|
312
312
|
*/
|
|
313
313
|
errors: Array<FutureRequirements.Error>;
|
|
314
314
|
|
|
@@ -318,12 +318,12 @@ declare module 'stripe' {
|
|
|
318
318
|
eventually_due: Array<string>;
|
|
319
319
|
|
|
320
320
|
/**
|
|
321
|
-
* Fields that
|
|
321
|
+
* Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`.
|
|
322
322
|
*/
|
|
323
323
|
past_due: Array<string>;
|
|
324
324
|
|
|
325
325
|
/**
|
|
326
|
-
* Fields that might become required depending on the results of
|
|
326
|
+
* Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
|
|
327
327
|
*/
|
|
328
328
|
pending_verification: Array<string>;
|
|
329
329
|
}
|
|
@@ -331,12 +331,12 @@ declare module 'stripe' {
|
|
|
331
331
|
namespace FutureRequirements {
|
|
332
332
|
interface Alternative {
|
|
333
333
|
/**
|
|
334
|
-
* Fields that can be provided to
|
|
334
|
+
* Fields that can be provided to resolve all fields in `original_fields_due`.
|
|
335
335
|
*/
|
|
336
336
|
alternative_fields_due: Array<string>;
|
|
337
337
|
|
|
338
338
|
/**
|
|
339
|
-
* Fields that are due and can be
|
|
339
|
+
* Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
|
|
340
340
|
*/
|
|
341
341
|
original_fields_due: Array<string>;
|
|
342
342
|
}
|
|
@@ -404,7 +404,6 @@ declare module 'stripe' {
|
|
|
404
404
|
| 'invalid_url_website_other'
|
|
405
405
|
| 'invalid_value_other'
|
|
406
406
|
| 'unsupported_business_type'
|
|
407
|
-
| 'verification_data_not_found'
|
|
408
407
|
| 'verification_directors_mismatch'
|
|
409
408
|
| 'verification_document_address_mismatch'
|
|
410
409
|
| 'verification_document_address_missing'
|
|
@@ -507,17 +506,17 @@ declare module 'stripe' {
|
|
|
507
506
|
|
|
508
507
|
interface Requirements {
|
|
509
508
|
/**
|
|
510
|
-
* Fields that are due and can be
|
|
509
|
+
* Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again.
|
|
511
510
|
*/
|
|
512
511
|
alternatives: Array<Requirements.Alternative> | null;
|
|
513
512
|
|
|
514
513
|
/**
|
|
515
|
-
* Fields that need to be
|
|
514
|
+
* Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
|
|
516
515
|
*/
|
|
517
516
|
currently_due: Array<string>;
|
|
518
517
|
|
|
519
518
|
/**
|
|
520
|
-
*
|
|
519
|
+
* Details about validation and verification failures for `due` requirements that must be resolved.
|
|
521
520
|
*/
|
|
522
521
|
errors: Array<Requirements.Error>;
|
|
523
522
|
|
|
@@ -527,12 +526,12 @@ declare module 'stripe' {
|
|
|
527
526
|
eventually_due: Array<string>;
|
|
528
527
|
|
|
529
528
|
/**
|
|
530
|
-
* Fields that
|
|
529
|
+
* Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account.
|
|
531
530
|
*/
|
|
532
531
|
past_due: Array<string>;
|
|
533
532
|
|
|
534
533
|
/**
|
|
535
|
-
* Fields that might become required depending on the results of
|
|
534
|
+
* Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
|
|
536
535
|
*/
|
|
537
536
|
pending_verification: Array<string>;
|
|
538
537
|
}
|
|
@@ -540,12 +539,12 @@ declare module 'stripe' {
|
|
|
540
539
|
namespace Requirements {
|
|
541
540
|
interface Alternative {
|
|
542
541
|
/**
|
|
543
|
-
* Fields that can be provided to
|
|
542
|
+
* Fields that can be provided to resolve all fields in `original_fields_due`.
|
|
544
543
|
*/
|
|
545
544
|
alternative_fields_due: Array<string>;
|
|
546
545
|
|
|
547
546
|
/**
|
|
548
|
-
* Fields that are due and can be
|
|
547
|
+
* Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
|
|
549
548
|
*/
|
|
550
549
|
original_fields_due: Array<string>;
|
|
551
550
|
}
|
|
@@ -613,7 +612,6 @@ declare module 'stripe' {
|
|
|
613
612
|
| 'invalid_url_website_other'
|
|
614
613
|
| 'invalid_value_other'
|
|
615
614
|
| 'unsupported_business_type'
|
|
616
|
-
| 'verification_data_not_found'
|
|
617
615
|
| 'verification_directors_mismatch'
|
|
618
616
|
| 'verification_document_address_mismatch'
|
|
619
617
|
| 'verification_document_address_missing'
|
|
@@ -771,7 +769,7 @@ declare module 'stripe' {
|
|
|
771
769
|
document?: Verification.Document;
|
|
772
770
|
|
|
773
771
|
/**
|
|
774
|
-
* The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://stripe.com/
|
|
772
|
+
* The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates.
|
|
775
773
|
*/
|
|
776
774
|
status: string;
|
|
777
775
|
}
|
|
@@ -779,7 +777,7 @@ declare module 'stripe' {
|
|
|
779
777
|
namespace Verification {
|
|
780
778
|
interface AdditionalDocument {
|
|
781
779
|
/**
|
|
782
|
-
* The back of an ID returned by a [file upload](https://stripe.com
|
|
780
|
+
* The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
783
781
|
*/
|
|
784
782
|
back: string | Stripe.File | null;
|
|
785
783
|
|
|
@@ -794,14 +792,14 @@ declare module 'stripe' {
|
|
|
794
792
|
details_code: string | null;
|
|
795
793
|
|
|
796
794
|
/**
|
|
797
|
-
* The front of an ID returned by a [file upload](https://stripe.com
|
|
795
|
+
* The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
798
796
|
*/
|
|
799
797
|
front: string | Stripe.File | null;
|
|
800
798
|
}
|
|
801
799
|
|
|
802
800
|
interface Document {
|
|
803
801
|
/**
|
|
804
|
-
* The back of an ID returned by a [file upload](https://stripe.com
|
|
802
|
+
* The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
805
803
|
*/
|
|
806
804
|
back: string | Stripe.File | null;
|
|
807
805
|
|
|
@@ -816,7 +814,7 @@ declare module 'stripe' {
|
|
|
816
814
|
details_code: string | null;
|
|
817
815
|
|
|
818
816
|
/**
|
|
819
|
-
* The front of an ID returned by a [file upload](https://stripe.com
|
|
817
|
+
* The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
820
818
|
*/
|
|
821
819
|
front: string | Stripe.File | null;
|
|
822
820
|
}
|
package/types/Plans.d.ts
CHANGED
|
@@ -23,14 +23,14 @@ declare module 'stripe' {
|
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* You can now model subscriptions more flexibly using the [Prices API](https://stripe.com
|
|
26
|
+
* 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.
|
|
27
27
|
*
|
|
28
28
|
* Plans define the base price, currency, and billing cycle for recurring purchases of products.
|
|
29
|
-
* [Products](https://stripe.com
|
|
29
|
+
* [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.
|
|
30
30
|
*
|
|
31
31
|
* For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
|
|
32
32
|
*
|
|
33
|
-
* Related guides: [Set up a subscription](https://stripe.com/
|
|
33
|
+
* 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).
|
|
34
34
|
*/
|
|
35
35
|
interface Plan {
|
|
36
36
|
/**
|
|
@@ -94,7 +94,7 @@ declare module 'stripe' {
|
|
|
94
94
|
livemode: boolean;
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
97
|
+
* 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.
|
|
98
98
|
*/
|
|
99
99
|
metadata: Stripe.Metadata | null;
|
|
100
100
|
|
|
@@ -129,7 +129,7 @@ declare module 'stripe' {
|
|
|
129
129
|
transform_usage: Plan.TransformUsage | null;
|
|
130
130
|
|
|
131
131
|
/**
|
|
132
|
-
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/
|
|
132
|
+
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
133
133
|
*/
|
|
134
134
|
trial_period_days: number | null;
|
|
135
135
|
|
package/types/PlansResource.d.ts
CHANGED
|
@@ -49,7 +49,7 @@ declare module 'stripe' {
|
|
|
49
49
|
interval_count?: number;
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
52
|
+
* 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`.
|
|
53
53
|
*/
|
|
54
54
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
55
55
|
|
|
@@ -81,7 +81,7 @@ declare module 'stripe' {
|
|
|
81
81
|
transform_usage?: PlanCreateParams.TransformUsage;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/
|
|
84
|
+
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
85
85
|
*/
|
|
86
86
|
trial_period_days?: number;
|
|
87
87
|
|
|
@@ -108,7 +108,7 @@ declare module 'stripe' {
|
|
|
108
108
|
id?: string;
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
111
|
+
* 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`.
|
|
112
112
|
*/
|
|
113
113
|
metadata?: Stripe.MetadataParam;
|
|
114
114
|
|
|
@@ -125,7 +125,7 @@ declare module 'stripe' {
|
|
|
125
125
|
statement_descriptor?: string;
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
|
-
* A [tax code](https://stripe.com/
|
|
128
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
129
129
|
*/
|
|
130
130
|
tax_code?: string;
|
|
131
131
|
|
|
@@ -202,7 +202,7 @@ declare module 'stripe' {
|
|
|
202
202
|
expand?: Array<string>;
|
|
203
203
|
|
|
204
204
|
/**
|
|
205
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
205
|
+
* 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`.
|
|
206
206
|
*/
|
|
207
207
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
208
208
|
|
|
@@ -217,7 +217,7 @@ declare module 'stripe' {
|
|
|
217
217
|
product?: string;
|
|
218
218
|
|
|
219
219
|
/**
|
|
220
|
-
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/
|
|
220
|
+
* Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
221
221
|
*/
|
|
222
222
|
trial_period_days?: number;
|
|
223
223
|
}
|
package/types/Prices.d.ts
CHANGED
|
@@ -24,11 +24,11 @@ declare module 'stripe' {
|
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
|
|
27
|
-
* [Products](https://stripe.com
|
|
27
|
+
* [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.
|
|
28
28
|
*
|
|
29
29
|
* For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
|
|
30
30
|
*
|
|
31
|
-
* Related guides: [Set up a subscription](https://stripe.com/
|
|
31
|
+
* 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).
|
|
32
32
|
*/
|
|
33
33
|
interface Price {
|
|
34
34
|
/**
|
|
@@ -89,15 +89,10 @@ declare module 'stripe' {
|
|
|
89
89
|
lookup_key: string | null;
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
92
|
+
* 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.
|
|
93
93
|
*/
|
|
94
94
|
metadata: Stripe.Metadata;
|
|
95
95
|
|
|
96
|
-
/**
|
|
97
|
-
* Subscriptions using this price will be migrated to use the new referenced price.
|
|
98
|
-
*/
|
|
99
|
-
migrate_to?: Price.MigrateTo | null;
|
|
100
|
-
|
|
101
96
|
/**
|
|
102
97
|
* A brief description of the price, hidden from customers.
|
|
103
98
|
*/
|
|
@@ -114,7 +109,7 @@ declare module 'stripe' {
|
|
|
114
109
|
recurring: Price.Recurring | null;
|
|
115
110
|
|
|
116
111
|
/**
|
|
117
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
112
|
+
* 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.
|
|
118
113
|
*/
|
|
119
114
|
tax_behavior: Price.TaxBehavior | null;
|
|
120
115
|
|
|
@@ -159,7 +154,7 @@ declare module 'stripe' {
|
|
|
159
154
|
custom_unit_amount: CurrencyOptions.CustomUnitAmount | null;
|
|
160
155
|
|
|
161
156
|
/**
|
|
162
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
157
|
+
* 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.
|
|
163
158
|
*/
|
|
164
159
|
tax_behavior: CurrencyOptions.TaxBehavior | null;
|
|
165
160
|
|
|
@@ -244,23 +239,6 @@ declare module 'stripe' {
|
|
|
244
239
|
preset: number | null;
|
|
245
240
|
}
|
|
246
241
|
|
|
247
|
-
interface MigrateTo {
|
|
248
|
-
/**
|
|
249
|
-
* The behavior controlling at what point in the subscription lifecycle to migrate the price
|
|
250
|
-
*/
|
|
251
|
-
behavior: 'at_cycle_end';
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* The unix timestamp after at which subscriptions will start to migrate to the new price.
|
|
255
|
-
*/
|
|
256
|
-
effective_after: number;
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
* The id of the price being migrated to
|
|
260
|
-
*/
|
|
261
|
-
price: string;
|
|
262
|
-
}
|
|
263
|
-
|
|
264
242
|
interface Recurring {
|
|
265
243
|
/**
|
|
266
244
|
* The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
|
|
@@ -278,7 +256,7 @@ declare module 'stripe' {
|
|
|
278
256
|
meter: string | null;
|
|
279
257
|
|
|
280
258
|
/**
|
|
281
|
-
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/
|
|
259
|
+
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
282
260
|
*/
|
|
283
261
|
trial_period_days: number | null;
|
|
284
262
|
|
|
@@ -41,7 +41,7 @@ declare module 'stripe' {
|
|
|
41
41
|
lookup_key?: string;
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
44
|
+
* 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`.
|
|
45
45
|
*/
|
|
46
46
|
metadata?: Stripe.MetadataParam;
|
|
47
47
|
|
|
@@ -66,7 +66,7 @@ declare module 'stripe' {
|
|
|
66
66
|
recurring?: PriceCreateParams.Recurring;
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
69
|
+
* 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.
|
|
70
70
|
*/
|
|
71
71
|
tax_behavior?: PriceCreateParams.TaxBehavior;
|
|
72
72
|
|
|
@@ -111,7 +111,7 @@ declare module 'stripe' {
|
|
|
111
111
|
custom_unit_amount?: CurrencyOptions.CustomUnitAmount;
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
114
|
+
* 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.
|
|
115
115
|
*/
|
|
116
116
|
tax_behavior?: CurrencyOptions.TaxBehavior;
|
|
117
117
|
|
|
@@ -218,7 +218,7 @@ declare module 'stripe' {
|
|
|
218
218
|
id?: string;
|
|
219
219
|
|
|
220
220
|
/**
|
|
221
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
221
|
+
* 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`.
|
|
222
222
|
*/
|
|
223
223
|
metadata?: Stripe.MetadataParam;
|
|
224
224
|
|
|
@@ -235,7 +235,7 @@ declare module 'stripe' {
|
|
|
235
235
|
statement_descriptor?: string;
|
|
236
236
|
|
|
237
237
|
/**
|
|
238
|
-
* A [tax code](https://stripe.com/
|
|
238
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
239
239
|
*/
|
|
240
240
|
tax_code?: string;
|
|
241
241
|
|
|
@@ -262,7 +262,7 @@ declare module 'stripe' {
|
|
|
262
262
|
meter?: string;
|
|
263
263
|
|
|
264
264
|
/**
|
|
265
|
-
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/
|
|
265
|
+
* Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
266
266
|
*/
|
|
267
267
|
trial_period_days?: number;
|
|
268
268
|
|
|
@@ -357,22 +357,17 @@ declare module 'stripe' {
|
|
|
357
357
|
lookup_key?: string;
|
|
358
358
|
|
|
359
359
|
/**
|
|
360
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
360
|
+
* 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`.
|
|
361
361
|
*/
|
|
362
362
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
363
363
|
|
|
364
|
-
/**
|
|
365
|
-
* If specified, subscriptions using this price will be updated to use the new referenced price.
|
|
366
|
-
*/
|
|
367
|
-
migrate_to?: Stripe.Emptyable<PriceUpdateParams.MigrateTo>;
|
|
368
|
-
|
|
369
364
|
/**
|
|
370
365
|
* A brief description of the price, hidden from customers.
|
|
371
366
|
*/
|
|
372
367
|
nickname?: string;
|
|
373
368
|
|
|
374
369
|
/**
|
|
375
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
370
|
+
* 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.
|
|
376
371
|
*/
|
|
377
372
|
tax_behavior?: PriceUpdateParams.TaxBehavior;
|
|
378
373
|
|
|
@@ -390,7 +385,7 @@ declare module 'stripe' {
|
|
|
390
385
|
custom_unit_amount?: CurrencyOptions.CustomUnitAmount;
|
|
391
386
|
|
|
392
387
|
/**
|
|
393
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
388
|
+
* 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.
|
|
394
389
|
*/
|
|
395
390
|
tax_behavior?: CurrencyOptions.TaxBehavior;
|
|
396
391
|
|
|
@@ -463,23 +458,6 @@ declare module 'stripe' {
|
|
|
463
458
|
}
|
|
464
459
|
}
|
|
465
460
|
|
|
466
|
-
interface MigrateTo {
|
|
467
|
-
/**
|
|
468
|
-
* The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
|
|
469
|
-
*/
|
|
470
|
-
behavior: 'at_cycle_end';
|
|
471
|
-
|
|
472
|
-
/**
|
|
473
|
-
* The time after which subscriptions should start using the new price.
|
|
474
|
-
*/
|
|
475
|
-
effective_after?: number;
|
|
476
|
-
|
|
477
|
-
/**
|
|
478
|
-
* The ID of the price object.
|
|
479
|
-
*/
|
|
480
|
-
price: string;
|
|
481
|
-
}
|
|
482
|
-
|
|
483
461
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
484
462
|
}
|
|
485
463
|
|
|
@@ -554,7 +532,7 @@ declare module 'stripe' {
|
|
|
554
532
|
|
|
555
533
|
interface PriceSearchParams {
|
|
556
534
|
/**
|
|
557
|
-
* The search query string. See [search query language](https://stripe.com/
|
|
535
|
+
* The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for prices](https://docs.stripe.com/search#query-fields-for-prices).
|
|
558
536
|
*/
|
|
559
537
|
query: string;
|
|
560
538
|
|
package/types/Products.d.ts
CHANGED
|
@@ -25,12 +25,12 @@ declare module 'stripe' {
|
|
|
25
25
|
/**
|
|
26
26
|
* Products describe the specific goods or services you offer to your customers.
|
|
27
27
|
* For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
|
|
28
|
-
* They can be used in conjunction with [Prices](https://stripe.com
|
|
28
|
+
* They can be used in conjunction with [Prices](https://api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
|
|
29
29
|
*
|
|
30
|
-
* Related guides: [Set up a subscription](https://stripe.com/
|
|
31
|
-
* [share a Payment Link](https://stripe.com/
|
|
32
|
-
* [accept payments with Checkout](https://stripe.com/
|
|
33
|
-
* and more about [Products and Prices](https://stripe.com/
|
|
30
|
+
* Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription),
|
|
31
|
+
* [share a Payment Link](https://docs.stripe.com/payment-links),
|
|
32
|
+
* [accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront),
|
|
33
|
+
* and more about [Products and Prices](https://docs.stripe.com/products-prices/overview)
|
|
34
34
|
*/
|
|
35
35
|
interface Product {
|
|
36
36
|
/**
|
|
@@ -54,7 +54,7 @@ declare module 'stripe' {
|
|
|
54
54
|
created: number;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* The ID of the [Price](https://stripe.com/
|
|
57
|
+
* The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
|
|
58
58
|
*/
|
|
59
59
|
default_price?: string | Stripe.Price | null;
|
|
60
60
|
|
|
@@ -79,12 +79,12 @@ declare module 'stripe' {
|
|
|
79
79
|
livemode: boolean;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
|
-
* A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/
|
|
82
|
+
* A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
|
|
83
83
|
*/
|
|
84
84
|
marketing_features: Array<Product.MarketingFeature>;
|
|
85
85
|
|
|
86
86
|
/**
|
|
87
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
87
|
+
* 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.
|
|
88
88
|
*/
|
|
89
89
|
metadata: Stripe.Metadata;
|
|
90
90
|
|
|
@@ -109,9 +109,9 @@ declare module 'stripe' {
|
|
|
109
109
|
statement_descriptor?: string | null;
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
* A [tax code](https://stripe.com/
|
|
112
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
113
113
|
*/
|
|
114
|
-
tax_code
|
|
114
|
+
tax_code?: string | Stripe.TaxCode | null;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
117
|
* The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
|