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
|
@@ -38,7 +38,7 @@ declare module 'stripe' {
|
|
|
38
38
|
expand?: Array<string>;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
41
|
+
* 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`.
|
|
42
42
|
*/
|
|
43
43
|
metadata?: Stripe.MetadataParam;
|
|
44
44
|
}
|
|
@@ -64,7 +64,7 @@ declare module 'stripe' {
|
|
|
64
64
|
expand?: Array<string>;
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
67
|
+
* 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`.
|
|
68
68
|
*/
|
|
69
69
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
70
70
|
}
|
package/types/Apps/Secrets.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ declare module 'stripe' {
|
|
|
12
12
|
*
|
|
13
13
|
* A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
|
|
14
14
|
*
|
|
15
|
-
* Related guide: [Store data between page reloads](https://stripe.com/
|
|
15
|
+
* Related guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects)
|
|
16
16
|
*/
|
|
17
17
|
interface Secret {
|
|
18
18
|
/**
|
package/types/Balance.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ declare module 'stripe' {
|
|
|
8
8
|
*
|
|
9
9
|
* The top-level `available` and `pending` comprise your "payments balance."
|
|
10
10
|
*
|
|
11
|
-
* Related guide: [Balances and settlement time](https://stripe.com/
|
|
11
|
+
* Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)
|
|
12
12
|
*/
|
|
13
13
|
interface Balance {
|
|
14
14
|
/**
|
|
@@ -17,7 +17,7 @@ declare module 'stripe' {
|
|
|
17
17
|
object: 'balance';
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com
|
|
20
|
+
* Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
|
|
21
21
|
*/
|
|
22
22
|
available: Array<Balance.Available>;
|
|
23
23
|
|
|
@@ -39,7 +39,7 @@ declare module 'stripe' {
|
|
|
39
39
|
} | null;
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/
|
|
42
|
+
* Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details.
|
|
43
43
|
*/
|
|
44
44
|
schedule: Payouts.Schedule | null;
|
|
45
45
|
|
|
@@ -6,7 +6,7 @@ declare module 'stripe' {
|
|
|
6
6
|
* Balance transactions represent funds moving through your Stripe account.
|
|
7
7
|
* Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [Balance transaction types](https://stripe.com/
|
|
9
|
+
* Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)
|
|
10
10
|
*/
|
|
11
11
|
interface BalanceTransaction {
|
|
12
12
|
/**
|
package/types/BankAccounts.d.ts
CHANGED
|
@@ -85,7 +85,7 @@ declare module 'stripe' {
|
|
|
85
85
|
fingerprint: string | null;
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
|
-
* Information about the [upcoming new requirements for the bank account](https://stripe.com/
|
|
88
|
+
* Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
|
|
89
89
|
*/
|
|
90
90
|
future_requirements?: BankAccount.FutureRequirements | null;
|
|
91
91
|
|
|
@@ -95,7 +95,7 @@ declare module 'stripe' {
|
|
|
95
95
|
last4: string;
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
98
|
+
* 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.
|
|
99
99
|
*/
|
|
100
100
|
metadata?: Stripe.Metadata | null;
|
|
101
101
|
|
|
@@ -122,22 +122,22 @@ declare module 'stripe' {
|
|
|
122
122
|
|
|
123
123
|
interface FutureRequirements {
|
|
124
124
|
/**
|
|
125
|
-
* Fields that need to be
|
|
125
|
+
* Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
|
|
126
126
|
*/
|
|
127
127
|
currently_due: Array<string> | null;
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
130
|
+
* Details about validation and verification failures for `due` requirements that must be resolved.
|
|
131
131
|
*/
|
|
132
132
|
errors: Array<FutureRequirements.Error> | null;
|
|
133
133
|
|
|
134
134
|
/**
|
|
135
|
-
* Fields that
|
|
135
|
+
* Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
|
|
136
136
|
*/
|
|
137
137
|
past_due: Array<string> | null;
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* Fields that might become required depending on the results of
|
|
140
|
+
* 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.
|
|
141
141
|
*/
|
|
142
142
|
pending_verification: Array<string> | null;
|
|
143
143
|
}
|
|
@@ -206,7 +206,6 @@ declare module 'stripe' {
|
|
|
206
206
|
| 'invalid_url_website_other'
|
|
207
207
|
| 'invalid_value_other'
|
|
208
208
|
| 'unsupported_business_type'
|
|
209
|
-
| 'verification_data_not_found'
|
|
210
209
|
| 'verification_directors_mismatch'
|
|
211
210
|
| 'verification_document_address_mismatch'
|
|
212
211
|
| 'verification_document_address_missing'
|
|
@@ -265,22 +264,22 @@ declare module 'stripe' {
|
|
|
265
264
|
|
|
266
265
|
interface Requirements {
|
|
267
266
|
/**
|
|
268
|
-
* Fields that need to be
|
|
267
|
+
* Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
|
|
269
268
|
*/
|
|
270
269
|
currently_due: Array<string> | null;
|
|
271
270
|
|
|
272
271
|
/**
|
|
273
|
-
*
|
|
272
|
+
* Details about validation and verification failures for `due` requirements that must be resolved.
|
|
274
273
|
*/
|
|
275
274
|
errors: Array<Requirements.Error> | null;
|
|
276
275
|
|
|
277
276
|
/**
|
|
278
|
-
* Fields that
|
|
277
|
+
* Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
|
|
279
278
|
*/
|
|
280
279
|
past_due: Array<string> | null;
|
|
281
280
|
|
|
282
281
|
/**
|
|
283
|
-
* Fields that might become required depending on the results of
|
|
282
|
+
* 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.
|
|
284
283
|
*/
|
|
285
284
|
pending_verification: Array<string> | null;
|
|
286
285
|
}
|
|
@@ -349,7 +348,6 @@ declare module 'stripe' {
|
|
|
349
348
|
| 'invalid_url_website_other'
|
|
350
349
|
| 'invalid_value_other'
|
|
351
350
|
| 'unsupported_business_type'
|
|
352
|
-
| 'verification_data_not_found'
|
|
353
351
|
| 'verification_directors_mismatch'
|
|
354
352
|
| 'verification_document_address_mismatch'
|
|
355
353
|
| 'verification_document_address_missing'
|
|
@@ -38,7 +38,7 @@ declare module 'stripe' {
|
|
|
38
38
|
title: string;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/
|
|
41
|
+
* Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter).
|
|
42
42
|
*/
|
|
43
43
|
usage_threshold: Alert.UsageThreshold | null;
|
|
44
44
|
}
|
|
@@ -25,7 +25,7 @@ declare module 'stripe' {
|
|
|
25
25
|
/**
|
|
26
26
|
* The account the balance is for.
|
|
27
27
|
*/
|
|
28
|
-
customer_account
|
|
28
|
+
customer_account: string | null;
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
31
|
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
@@ -10,12 +10,12 @@ declare module 'stripe' {
|
|
|
10
10
|
filter: CreditBalanceSummaryRetrieveParams.Filter;
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* The customer
|
|
13
|
+
* The customer whose credit balance summary you're retrieving.
|
|
14
14
|
*/
|
|
15
15
|
customer?: string;
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The account
|
|
18
|
+
* The account representing the customer whose credit balance summary you're retrieving.
|
|
19
19
|
*/
|
|
20
20
|
customer_account?: string;
|
|
21
21
|
|
|
@@ -17,12 +17,12 @@ declare module 'stripe' {
|
|
|
17
17
|
credit_grant?: string;
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* The customer
|
|
20
|
+
* The customer whose credit balance transactions you're retrieving.
|
|
21
21
|
*/
|
|
22
22
|
customer?: string;
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* The account
|
|
25
|
+
* The account representing the customer whose credit balance transactions you're retrieving.
|
|
26
26
|
*/
|
|
27
27
|
customer_account?: string;
|
|
28
28
|
|
|
@@ -39,9 +39,9 @@ declare module 'stripe' {
|
|
|
39
39
|
customer: string | Stripe.Customer | Stripe.DeletedCustomer;
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* ID of the account receiving the billing credits
|
|
42
|
+
* ID of the account representing the customer receiving the billing credits
|
|
43
43
|
*/
|
|
44
|
-
customer_account
|
|
44
|
+
customer_account: string | null;
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
47
|
* The time when the billing credits become effective-when they're eligible for use.
|
|
@@ -59,7 +59,7 @@ declare module 'stripe' {
|
|
|
59
59
|
livemode: boolean;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
62
|
+
* 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.
|
|
63
63
|
*/
|
|
64
64
|
metadata: Stripe.Metadata;
|
|
65
65
|
|
|
@@ -20,12 +20,12 @@ declare module 'stripe' {
|
|
|
20
20
|
category?: CreditGrantCreateParams.Category;
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* ID of the customer
|
|
23
|
+
* ID of the customer receiving the billing credits.
|
|
24
24
|
*/
|
|
25
25
|
customer?: string;
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
|
-
* ID of the account
|
|
28
|
+
* ID of the account representing the customer receiving the billing credits.
|
|
29
29
|
*/
|
|
30
30
|
customer_account?: string;
|
|
31
31
|
|
|
@@ -151,7 +151,7 @@ declare module 'stripe' {
|
|
|
151
151
|
customer?: string;
|
|
152
152
|
|
|
153
153
|
/**
|
|
154
|
-
* Only return credit grants for this account.
|
|
154
|
+
* Only return credit grants for this account representing the customer.
|
|
155
155
|
*/
|
|
156
156
|
customer_account?: string;
|
|
157
157
|
|
|
@@ -33,7 +33,7 @@ declare module 'stripe' {
|
|
|
33
33
|
livemode: boolean;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/
|
|
36
|
+
* The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
|
|
37
37
|
*/
|
|
38
38
|
payload: {
|
|
39
39
|
[key: string]: string;
|
|
@@ -10,7 +10,7 @@ declare module 'stripe' {
|
|
|
10
10
|
event_name: string;
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/
|
|
13
|
+
* The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
|
|
14
14
|
*/
|
|
15
15
|
payload: {
|
|
16
16
|
[key: string]: string;
|
|
@@ -39,7 +39,7 @@ declare module 'stripe' {
|
|
|
39
39
|
created: number;
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/
|
|
42
|
+
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
|
|
43
43
|
*/
|
|
44
44
|
default_return_url: string | null;
|
|
45
45
|
|
|
@@ -58,7 +58,7 @@ declare module 'stripe' {
|
|
|
58
58
|
login_page: Configuration.LoginPage;
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
61
|
+
* 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.
|
|
62
62
|
*/
|
|
63
63
|
metadata: Stripe.Metadata | null;
|
|
64
64
|
|
|
@@ -198,6 +198,11 @@ declare module 'stripe' {
|
|
|
198
198
|
}
|
|
199
199
|
|
|
200
200
|
interface SubscriptionUpdate {
|
|
201
|
+
/**
|
|
202
|
+
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
203
|
+
*/
|
|
204
|
+
billing_cycle_anchor: SubscriptionUpdate.BillingCycleAnchor | null;
|
|
205
|
+
|
|
201
206
|
/**
|
|
202
207
|
* The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
|
|
203
208
|
*/
|
|
@@ -229,6 +234,8 @@ declare module 'stripe' {
|
|
|
229
234
|
}
|
|
230
235
|
|
|
231
236
|
namespace SubscriptionUpdate {
|
|
237
|
+
type BillingCycleAnchor = 'now' | 'unchanged';
|
|
238
|
+
|
|
232
239
|
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
|
|
233
240
|
|
|
234
241
|
interface Product {
|
|
@@ -302,7 +309,7 @@ declare module 'stripe' {
|
|
|
302
309
|
enabled: boolean;
|
|
303
310
|
|
|
304
311
|
/**
|
|
305
|
-
* A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/
|
|
312
|
+
* A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
|
|
306
313
|
*/
|
|
307
314
|
url: string | null;
|
|
308
315
|
}
|
|
@@ -15,7 +15,7 @@ declare module 'stripe' {
|
|
|
15
15
|
business_profile?: ConfigurationCreateParams.BusinessProfile;
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/
|
|
18
|
+
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
|
|
19
19
|
*/
|
|
20
20
|
default_return_url?: Stripe.Emptyable<string>;
|
|
21
21
|
|
|
@@ -30,7 +30,7 @@ declare module 'stripe' {
|
|
|
30
30
|
login_page?: ConfigurationCreateParams.LoginPage;
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
33
|
+
* 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`.
|
|
34
34
|
*/
|
|
35
35
|
metadata?: Stripe.MetadataParam;
|
|
36
36
|
|
|
@@ -185,6 +185,11 @@ declare module 'stripe' {
|
|
|
185
185
|
}
|
|
186
186
|
|
|
187
187
|
interface SubscriptionUpdate {
|
|
188
|
+
/**
|
|
189
|
+
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
190
|
+
*/
|
|
191
|
+
billing_cycle_anchor?: SubscriptionUpdate.BillingCycleAnchor;
|
|
192
|
+
|
|
188
193
|
/**
|
|
189
194
|
* The types of subscription updates that are supported. When empty, subscriptions are not updateable.
|
|
190
195
|
*/
|
|
@@ -219,6 +224,8 @@ declare module 'stripe' {
|
|
|
219
224
|
}
|
|
220
225
|
|
|
221
226
|
namespace SubscriptionUpdate {
|
|
227
|
+
type BillingCycleAnchor = 'now' | 'unchanged';
|
|
228
|
+
|
|
222
229
|
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
|
|
223
230
|
|
|
224
231
|
interface Product {
|
|
@@ -288,7 +295,7 @@ declare module 'stripe' {
|
|
|
288
295
|
|
|
289
296
|
interface LoginPage {
|
|
290
297
|
/**
|
|
291
|
-
* Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/
|
|
298
|
+
* Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
|
|
292
299
|
*/
|
|
293
300
|
enabled: boolean;
|
|
294
301
|
}
|
|
@@ -313,7 +320,7 @@ declare module 'stripe' {
|
|
|
313
320
|
business_profile?: ConfigurationUpdateParams.BusinessProfile;
|
|
314
321
|
|
|
315
322
|
/**
|
|
316
|
-
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/
|
|
323
|
+
* The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
|
|
317
324
|
*/
|
|
318
325
|
default_return_url?: Stripe.Emptyable<string>;
|
|
319
326
|
|
|
@@ -333,7 +340,7 @@ declare module 'stripe' {
|
|
|
333
340
|
login_page?: ConfigurationUpdateParams.LoginPage;
|
|
334
341
|
|
|
335
342
|
/**
|
|
336
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
343
|
+
* 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`.
|
|
337
344
|
*/
|
|
338
345
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
339
346
|
|
|
@@ -488,6 +495,11 @@ declare module 'stripe' {
|
|
|
488
495
|
}
|
|
489
496
|
|
|
490
497
|
interface SubscriptionUpdate {
|
|
498
|
+
/**
|
|
499
|
+
* Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
500
|
+
*/
|
|
501
|
+
billing_cycle_anchor?: SubscriptionUpdate.BillingCycleAnchor;
|
|
502
|
+
|
|
491
503
|
/**
|
|
492
504
|
* The types of subscription updates that are supported. When empty, subscriptions are not updateable.
|
|
493
505
|
*/
|
|
@@ -522,6 +534,8 @@ declare module 'stripe' {
|
|
|
522
534
|
}
|
|
523
535
|
|
|
524
536
|
namespace SubscriptionUpdate {
|
|
537
|
+
type BillingCycleAnchor = 'now' | 'unchanged';
|
|
538
|
+
|
|
525
539
|
type DefaultAllowedUpdate = 'price' | 'promotion_code' | 'quantity';
|
|
526
540
|
|
|
527
541
|
interface Product {
|
|
@@ -593,7 +607,7 @@ declare module 'stripe' {
|
|
|
593
607
|
|
|
594
608
|
interface LoginPage {
|
|
595
609
|
/**
|
|
596
|
-
* Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/
|
|
610
|
+
* Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.
|
|
597
611
|
*
|
|
598
612
|
* Set to `false` to deactivate the `login_page.url`.
|
|
599
613
|
*/
|
|
@@ -48,10 +48,10 @@ declare module 'stripe' {
|
|
|
48
48
|
/**
|
|
49
49
|
* The ID of the account for this session.
|
|
50
50
|
*/
|
|
51
|
-
customer_account
|
|
51
|
+
customer_account: string | null;
|
|
52
52
|
|
|
53
53
|
/**
|
|
54
|
-
* Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/
|
|
54
|
+
* Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
|
|
55
55
|
*/
|
|
56
56
|
flow: Session.Flow | null;
|
|
57
57
|
|
|
@@ -66,7 +66,7 @@ declare module 'stripe' {
|
|
|
66
66
|
locale: Session.Locale | null;
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
* The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/
|
|
69
|
+
* The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
|
|
70
70
|
*/
|
|
71
71
|
on_behalf_of: string | null;
|
|
72
72
|
|
|
@@ -191,7 +191,7 @@ declare module 'stripe' {
|
|
|
191
191
|
discounts: Array<SubscriptionUpdateConfirm.Discount> | null;
|
|
192
192
|
|
|
193
193
|
/**
|
|
194
|
-
* The [subscription item](https://stripe.com/
|
|
194
|
+
* The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
|
|
195
195
|
*/
|
|
196
196
|
items: Array<SubscriptionUpdateConfirm.Item>;
|
|
197
197
|
|
|
@@ -216,17 +216,17 @@ declare module 'stripe' {
|
|
|
216
216
|
|
|
217
217
|
interface Item {
|
|
218
218
|
/**
|
|
219
|
-
* The ID of the [subscription item](https://stripe.com/
|
|
219
|
+
* The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
|
|
220
220
|
*/
|
|
221
221
|
id: string | null;
|
|
222
222
|
|
|
223
223
|
/**
|
|
224
|
-
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/
|
|
224
|
+
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
|
|
225
225
|
*/
|
|
226
226
|
price: string | null;
|
|
227
227
|
|
|
228
228
|
/**
|
|
229
|
-
* [Quantity](https://stripe.com/
|
|
229
|
+
* [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
|
|
230
230
|
*/
|
|
231
231
|
quantity?: number;
|
|
232
232
|
}
|
|
@@ -5,7 +5,7 @@ declare module 'stripe' {
|
|
|
5
5
|
namespace BillingPortal {
|
|
6
6
|
interface SessionCreateParams {
|
|
7
7
|
/**
|
|
8
|
-
* The ID of an existing [configuration](https://stripe.com/
|
|
8
|
+
* The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
|
|
9
9
|
*/
|
|
10
10
|
configuration?: string;
|
|
11
11
|
|
|
@@ -25,7 +25,7 @@ declare module 'stripe' {
|
|
|
25
25
|
expand?: Array<string>;
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
|
-
* Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/
|
|
28
|
+
* Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
|
|
29
29
|
*/
|
|
30
30
|
flow_data?: SessionCreateParams.FlowData;
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ declare module 'stripe' {
|
|
|
35
35
|
locale?: SessionCreateParams.Locale;
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
|
-
* The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/
|
|
38
|
+
* The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
|
|
39
39
|
*/
|
|
40
40
|
on_behalf_of?: string;
|
|
41
41
|
|
|
@@ -158,7 +158,7 @@ declare module 'stripe' {
|
|
|
158
158
|
discounts?: Array<SubscriptionUpdateConfirm.Discount>;
|
|
159
159
|
|
|
160
160
|
/**
|
|
161
|
-
* The [subscription item](https://stripe.com/
|
|
161
|
+
* The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
|
|
162
162
|
*/
|
|
163
163
|
items: Array<SubscriptionUpdateConfirm.Item>;
|
|
164
164
|
|
|
@@ -183,17 +183,17 @@ declare module 'stripe' {
|
|
|
183
183
|
|
|
184
184
|
interface Item {
|
|
185
185
|
/**
|
|
186
|
-
* The ID of the [subscription item](https://stripe.com/
|
|
186
|
+
* The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
|
|
187
187
|
*/
|
|
188
188
|
id: string;
|
|
189
189
|
|
|
190
190
|
/**
|
|
191
|
-
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/
|
|
191
|
+
* The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
|
|
192
192
|
*/
|
|
193
193
|
price?: string;
|
|
194
194
|
|
|
195
195
|
/**
|
|
196
|
-
* [Quantity](https://stripe.com/
|
|
196
|
+
* [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
|
|
197
197
|
*/
|
|
198
198
|
quantity?: number;
|
|
199
199
|
}
|