stripe 19.4.0-alpha.2 → 20.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -1720
- 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/PaymentMethods.js +0 -4
- 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 +8 -148
- package/cjs/stripe.core.js +1 -1
- package/cjs/utils.js +2 -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/PaymentMethods.js +0 -4
- 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 -135
- package/esm/stripe.core.js +1 -1
- package/esm/utils.js +2 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +0 -45
- package/types/AccountSessionsResource.d.ts +0 -264
- package/types/Accounts.d.ts +2 -215
- package/types/AccountsResource.d.ts +2 -634
- package/types/ApplicationFees.d.ts +1 -6
- package/types/Balance.d.ts +0 -82
- package/types/BalanceTransactions.d.ts +1 -2
- package/types/BankAccounts.d.ts +2 -4
- package/types/Billing/AlertTriggereds.d.ts +1 -16
- package/types/Billing/Alerts.d.ts +1 -116
- package/types/Billing/AlertsResource.d.ts +2 -149
- package/types/Billing/CreditBalanceSummary.d.ts +2 -123
- package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -20
- package/types/Billing/CreditBalanceTransactions.d.ts +2 -118
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
- package/types/Billing/CreditGrants.d.ts +1 -76
- package/types/Billing/CreditGrantsResource.d.ts +4 -45
- package/types/Billing/MeterEventSummaries.d.ts +0 -7
- package/types/Billing/Meters.d.ts +0 -5
- package/types/Billing/MetersResource.d.ts +0 -17
- package/types/BillingPortal/Configurations.d.ts +5 -0
- package/types/BillingPortal/Sessions.d.ts +0 -5
- package/types/BillingPortal/SessionsResource.d.ts +4 -12
- package/types/Capabilities.d.ts +0 -2
- package/types/Cards.d.ts +0 -19
- package/types/CashBalances.d.ts +0 -5
- package/types/Charges.d.ts +8 -191
- package/types/ChargesResource.d.ts +0 -1406
- package/types/Checkout/Sessions.d.ts +2 -427
- package/types/Checkout/SessionsResource.d.ts +2 -682
- package/types/ConfirmationTokens.d.ts +5 -141
- package/types/Coupons.d.ts +0 -35
- package/types/CouponsResource.d.ts +0 -23
- package/types/CreditNoteLineItems.d.ts +0 -17
- package/types/CreditNotes.d.ts +0 -5
- package/types/CreditNotesResource.d.ts +0 -5
- package/types/CustomerBalanceTransactions.d.ts +0 -2
- package/types/CustomerCashBalanceTransactions.d.ts +0 -2
- package/types/CustomerSessions.d.ts +0 -46
- package/types/CustomerSessionsResource.d.ts +2 -48
- package/types/Customers.d.ts +0 -2
- package/types/CustomersResource.d.ts +5 -8
- package/types/Discounts.d.ts +0 -20
- package/types/Disputes.d.ts +0 -40
- package/types/DisputesResource.d.ts +0 -11
- package/types/Errors.d.ts +0 -85
- package/types/EventTypes.d.ts +27 -621
- package/types/Events.d.ts +2 -95
- package/types/FinancialConnections/Accounts.d.ts +34 -36
- package/types/FinancialConnections/AccountsResource.d.ts +3 -40
- package/types/FinancialConnections/Sessions.d.ts +2 -52
- package/types/FinancialConnections/SessionsResource.d.ts +1 -43
- package/types/Identity/VerificationReports.d.ts +0 -10
- package/types/Identity/VerificationReportsResource.d.ts +0 -5
- package/types/Identity/VerificationSessions.d.ts +0 -5
- package/types/Identity/VerificationSessionsResource.d.ts +0 -7
- package/types/InvoiceItems.d.ts +2 -127
- package/types/InvoiceItemsResource.d.ts +6 -117
- package/types/InvoiceLineItems.d.ts +3 -171
- package/types/InvoicePaymentsResource.d.ts +5 -0
- package/types/Invoices.d.ts +5 -217
- package/types/InvoicesResource.d.ts +4 -1712
- package/types/Issuing/CardholdersResource.d.ts +1 -2
- package/types/Issuing/Cards.d.ts +25 -0
- package/types/Issuing/Transactions.d.ts +0 -5
- package/types/Issuing/TransactionsResource.d.ts +0 -5
- package/types/LineItems.d.ts +0 -49
- package/types/Mandates.d.ts +1 -135
- package/types/MandatesResource.d.ts +0 -31
- package/types/PaymentAttemptRecords.d.ts +16 -147
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +13 -7
- package/types/PaymentIntents.d.ts +27 -786
- package/types/PaymentIntentsResource.d.ts +4722 -9378
- package/types/PaymentLinks.d.ts +0 -6
- package/types/PaymentLinksResource.d.ts +0 -12
- package/types/PaymentMethodConfigurations.d.ts +0 -216
- package/types/PaymentMethodConfigurationsResource.d.ts +0 -300
- package/types/PaymentMethods.d.ts +5 -146
- package/types/PaymentMethodsResource.d.ts +3 -187
- package/types/PaymentRecords.d.ts +16 -147
- package/types/Persons.d.ts +0 -30
- package/types/Prices.d.ts +0 -22
- package/types/PricesResource.d.ts +0 -22
- package/types/PromotionCodes.d.ts +0 -5
- package/types/PromotionCodesResource.d.ts +0 -10
- package/types/Quotes.d.ts +1 -982
- package/types/QuotesResource.d.ts +293 -3226
- package/types/Refunds.d.ts +10 -6
- package/types/SetupAttempts.d.ts +4 -52
- package/types/SetupIntents.d.ts +2 -239
- package/types/SetupIntentsResource.d.ts +7 -1044
- package/types/Sources.d.ts +0 -29
- package/types/SubscriptionItems.d.ts +0 -26
- package/types/SubscriptionItemsResource.d.ts +0 -109
- package/types/SubscriptionSchedules.d.ts +0 -403
- package/types/SubscriptionSchedulesResource.d.ts +0 -1404
- package/types/Subscriptions.d.ts +1 -370
- package/types/SubscriptionsResource.d.ts +8 -757
- package/types/Tax/Associations.d.ts +1 -1
- package/types/Tax/RegistrationsResource.d.ts +1 -1
- package/types/TaxIds.d.ts +0 -10
- package/types/TaxIdsResource.d.ts +0 -10
- package/types/Terminal/Configurations.d.ts +0 -9
- package/types/Terminal/ConfigurationsResource.d.ts +18 -46
- package/types/Terminal/Readers.d.ts +0 -20
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +1 -126
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +27 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
- package/types/TokensResource.d.ts +0 -44
- package/types/Transfers.d.ts +0 -9
- package/types/TransfersResource.d.ts +0 -7
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +0 -5
- package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
- package/types/Treasury/OutboundTransfers.d.ts +0 -26
- package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
- package/types/Treasury/ReceivedCredits.d.ts +0 -26
- package/types/Treasury/ReceivedDebits.d.ts +0 -31
- package/types/V2/Billing/MeterEvents.d.ts +2 -1
- package/types/V2/Core/EventTypes.d.ts +10 -8680
- package/types/V2/Core/Events.d.ts +0 -14
- package/types/V2/Core/EventsResource.d.ts +2 -17
- package/types/WebhookEndpointsResource.d.ts +6 -75
- package/types/Webhooks.d.ts +0 -2
- package/types/apiVersion.d.ts +2 -1
- package/types/index.d.ts +0 -227
- 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/DelegatedCheckout/RequestedSessions.js +0 -28
- 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/Identity/BlocklistEntries.js +0 -25
- 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/Issuing/Programs.js +0 -22
- 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/TestHelpers/Capital/FinancingOffers.js +0 -16
- 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/CustomPricingUnits.js +0 -25
- package/cjs/resources/V2/Billing/Intents/Actions.js +0 -17
- package/cjs/resources/V2/Billing/Intents.js +0 -36
- package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -12
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +0 -17
- package/cjs/resources/V2/Billing/LicenseFees.js +0 -27
- package/cjs/resources/V2/Billing/LicensedItems.js +0 -25
- package/cjs/resources/V2/Billing/MeteredItems.js +0 -22
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -12
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +0 -26
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +0 -29
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +0 -17
- package/cjs/resources/V2/Billing/PricingPlans.js +0 -29
- package/cjs/resources/V2/Billing/Profiles.js +0 -19
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +0 -29
- package/cjs/resources/V2/Billing/RateCards/Rates.js +0 -25
- package/cjs/resources/V2/Billing/RateCards/Versions.js +0 -17
- package/cjs/resources/V2/Billing/RateCards.js +0 -29
- package/cjs/resources/V2/Billing/ServiceActions.js +0 -20
- package/cjs/resources/V2/Core/AccountLinks.js +0 -9
- package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
- package/cjs/resources/V2/Core/Accounts.js +0 -25
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +0 -16
- 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/RecipientVerifications.js +0 -20
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
- package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
- package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
- package/cjs/resources/V2/Reporting/ReportRuns.js +0 -13
- package/cjs/resources/V2/Reporting/Reports.js +0 -12
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +0 -12
- 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/DelegatedCheckout/RequestedSessions.js +0 -25
- 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/Identity/BlocklistEntries.js +0 -22
- 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/Issuing/Programs.js +0 -19
- 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/TestHelpers/Capital/FinancingOffers.js +0 -13
- 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/CustomPricingUnits.js +0 -22
- package/esm/resources/V2/Billing/Intents/Actions.js +0 -14
- package/esm/resources/V2/Billing/Intents.js +0 -33
- package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -9
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +0 -14
- package/esm/resources/V2/Billing/LicenseFees.js +0 -24
- package/esm/resources/V2/Billing/LicensedItems.js +0 -22
- package/esm/resources/V2/Billing/MeteredItems.js +0 -19
- package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -9
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +0 -23
- package/esm/resources/V2/Billing/PricingPlans/Components.js +0 -26
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +0 -14
- package/esm/resources/V2/Billing/PricingPlans.js +0 -26
- package/esm/resources/V2/Billing/Profiles.js +0 -16
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +0 -26
- package/esm/resources/V2/Billing/RateCards/Rates.js +0 -22
- package/esm/resources/V2/Billing/RateCards/Versions.js +0 -14
- package/esm/resources/V2/Billing/RateCards.js +0 -26
- package/esm/resources/V2/Billing/ServiceActions.js +0 -17
- package/esm/resources/V2/Core/AccountLinks.js +0 -6
- package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
- package/esm/resources/V2/Core/Accounts.js +0 -22
- package/esm/resources/V2/Core/ClaimableSandboxes.js +0 -13
- 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/RecipientVerifications.js +0 -17
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
- package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
- package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
- package/esm/resources/V2/Reporting/ReportRuns.js +0 -10
- package/esm/resources/V2/Reporting/Reports.js +0 -9
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +0 -9
- 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 -694
- package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -58
- 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/DelegatedCheckout/RequestedSessions.d.ts +0 -384
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +0 -599
- 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/Identity/BlocklistEntries.d.ts +0 -78
- package/types/Identity/BlocklistEntriesResource.d.ts +0 -146
- 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/Programs.d.ts +0 -42
- package/types/Issuing/ProgramsResource.d.ts +0 -96
- package/types/Issuing/Settlements.d.ts +0 -113
- package/types/Margins.d.ts +0 -56
- package/types/MarginsResource.d.ts +0 -114
- package/types/Orders.d.ts +0 -1163
- package/types/OrdersResource.d.ts +0 -3139
- package/types/PaymentMethodBalances.d.ts +0 -63
- 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 -1784
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -1108
- 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/TestHelpers/Capital/FinancingOffersResource.d.ts +0 -130
- package/types/TransitBalances.d.ts +0 -40
- 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 -735
- package/types/V2/Billing/CadencesResource.d.ts +0 -516
- 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/CustomPricingUnits.d.ts +0 -56
- package/types/V2/Billing/CustomPricingUnitsResource.d.ts +0 -122
- package/types/V2/Billing/IntentActions.d.ts +0 -459
- package/types/V2/Billing/Intents/ActionsResource.d.ts +0 -58
- package/types/V2/Billing/Intents.d.ts +0 -117
- package/types/V2/Billing/IntentsResource.d.ts +0 -575
- package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +0 -64
- package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +0 -28
- package/types/V2/Billing/LicenseFeeVersions.d.ts +0 -106
- package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/LicenseFees.d.ts +0 -164
- package/types/V2/Billing/LicenseFeesResource.d.ts +0 -290
- package/types/V2/Billing/LicensedItems.d.ts +0 -73
- package/types/V2/Billing/LicensedItemsResource.d.ts +0 -157
- package/types/V2/Billing/MeteredItems.d.ts +0 -101
- package/types/V2/Billing/MeteredItemsResource.d.ts +0 -189
- package/types/V2/Billing/PricingPlanComponents.d.ts +0 -109
- package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +0 -57
- package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +0 -40
- package/types/V2/Billing/PricingPlanSubscriptions.d.ts +0 -144
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +0 -120
- package/types/V2/Billing/PricingPlanVersions.d.ts +0 -49
- package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +0 -197
- package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/PricingPlans.d.ts +0 -84
- package/types/V2/Billing/PricingPlansResource.d.ts +0 -151
- package/types/V2/Billing/Profiles.d.ts +0 -70
- package/types/V2/Billing/ProfilesResource.d.ts +0 -150
- package/types/V2/Billing/RateCardRates.d.ts +0 -144
- package/types/V2/Billing/RateCardSubscriptions.d.ts +0 -144
- package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +0 -157
- package/types/V2/Billing/RateCardVersions.d.ts +0 -39
- package/types/V2/Billing/RateCards/RatesResource.d.ts +0 -203
- package/types/V2/Billing/RateCards/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/RateCards.d.ts +0 -98
- package/types/V2/Billing/RateCardsResource.d.ts +0 -162
- package/types/V2/Billing/ServiceActions.d.ts +0 -274
- package/types/V2/Billing/ServiceActionsResource.d.ts +0 -370
- package/types/V2/Core/AccountLinks.d.ts +0 -168
- package/types/V2/Core/AccountLinksResource.d.ts +0 -152
- package/types/V2/Core/AccountPersons.d.ts +0 -615
- package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -1153
- package/types/V2/Core/Accounts.d.ts +0 -7478
- package/types/V2/Core/AccountsResource.d.ts +0 -6723
- package/types/V2/Core/ClaimableSandboxes.d.ts +0 -132
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +0 -74
- 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 -178
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -126
- 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 -283
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -247
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -330
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -256
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -213
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -201
- 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 -307
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -186
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
- package/types/V2/MoneyManagement/RecipientVerifications.d.ts +0 -112
- package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +0 -77
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
- package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
- package/types/V2/Payments/OffSessionPayments.d.ts +0 -326
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -401
- package/types/V2/Reporting/ReportRuns.d.ts +0 -154
- package/types/V2/Reporting/ReportRunsResource.d.ts +0 -75
- package/types/V2/Reporting/Reports.d.ts +0 -120
- package/types/V2/Reporting/ReportsResource.d.ts +0 -30
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -73
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +0 -49
|
@@ -8,11 +8,6 @@ declare module 'stripe' {
|
|
|
8
8
|
*/
|
|
9
9
|
account_tax_ids?: Stripe.Emptyable<Array<string>>;
|
|
10
10
|
|
|
11
|
-
/**
|
|
12
|
-
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
13
|
-
*/
|
|
14
|
-
amounts_due?: Stripe.Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
15
|
-
|
|
16
11
|
/**
|
|
17
12
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
|
18
13
|
*/
|
|
@@ -53,21 +48,11 @@ declare module 'stripe' {
|
|
|
53
48
|
*/
|
|
54
49
|
customer?: string;
|
|
55
50
|
|
|
56
|
-
/**
|
|
57
|
-
* The ID of the account who will be billed.
|
|
58
|
-
*/
|
|
59
|
-
customer_account?: string;
|
|
60
|
-
|
|
61
51
|
/**
|
|
62
52
|
* The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
|
63
53
|
*/
|
|
64
54
|
days_until_due?: number;
|
|
65
55
|
|
|
66
|
-
/**
|
|
67
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
68
|
-
*/
|
|
69
|
-
default_margins?: Array<string>;
|
|
70
|
-
|
|
71
56
|
/**
|
|
72
57
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
73
58
|
*/
|
|
@@ -180,28 +165,6 @@ declare module 'stripe' {
|
|
|
180
165
|
}
|
|
181
166
|
|
|
182
167
|
namespace InvoiceCreateParams {
|
|
183
|
-
interface AmountsDue {
|
|
184
|
-
/**
|
|
185
|
-
* The amount in cents (or local equivalent).
|
|
186
|
-
*/
|
|
187
|
-
amount: number;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
191
|
-
*/
|
|
192
|
-
days_until_due?: number;
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
196
|
-
*/
|
|
197
|
-
description: string;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* Date on which a payment plan's payment is due.
|
|
201
|
-
*/
|
|
202
|
-
due_date?: number;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
168
|
interface AutomaticTax {
|
|
206
169
|
/**
|
|
207
170
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -257,56 +220,12 @@ declare module 'stripe' {
|
|
|
257
220
|
*/
|
|
258
221
|
discount?: string;
|
|
259
222
|
|
|
260
|
-
/**
|
|
261
|
-
* Details to determine how long the discount should be applied for.
|
|
262
|
-
*/
|
|
263
|
-
discount_end?: Discount.DiscountEnd;
|
|
264
|
-
|
|
265
223
|
/**
|
|
266
224
|
* ID of the promotion code to create a new discount for.
|
|
267
225
|
*/
|
|
268
226
|
promotion_code?: string;
|
|
269
227
|
}
|
|
270
228
|
|
|
271
|
-
namespace Discount {
|
|
272
|
-
interface DiscountEnd {
|
|
273
|
-
/**
|
|
274
|
-
* Time span for the redeemed discount.
|
|
275
|
-
*/
|
|
276
|
-
duration?: DiscountEnd.Duration;
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
280
|
-
*/
|
|
281
|
-
timestamp?: number;
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* The type of calculation made to determine when the discount ends.
|
|
285
|
-
*/
|
|
286
|
-
type: DiscountEnd.Type;
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
namespace DiscountEnd {
|
|
290
|
-
interface Duration {
|
|
291
|
-
/**
|
|
292
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
293
|
-
*/
|
|
294
|
-
interval: Duration.Interval;
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
298
|
-
*/
|
|
299
|
-
interval_count: number;
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
namespace Duration {
|
|
303
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
type Type = 'duration' | 'timestamp';
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
|
|
310
229
|
interface FromInvoice {
|
|
311
230
|
/**
|
|
312
231
|
* The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
|
|
@@ -378,33 +297,16 @@ declare module 'stripe' {
|
|
|
378
297
|
PaymentMethodOptions.CustomerBalance
|
|
379
298
|
>;
|
|
380
299
|
|
|
381
|
-
/**
|
|
382
|
-
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
383
|
-
*/
|
|
384
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
385
|
-
PaymentMethodOptions.IdBankTransfer
|
|
386
|
-
>;
|
|
387
|
-
|
|
388
300
|
/**
|
|
389
301
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
390
302
|
*/
|
|
391
303
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
392
304
|
|
|
393
|
-
/**
|
|
394
|
-
* If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
395
|
-
*/
|
|
396
|
-
pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
|
|
397
|
-
|
|
398
305
|
/**
|
|
399
306
|
* If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
400
307
|
*/
|
|
401
308
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
402
309
|
|
|
403
|
-
/**
|
|
404
|
-
* If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
405
|
-
*/
|
|
406
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
407
|
-
|
|
408
310
|
/**
|
|
409
311
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
410
312
|
*/
|
|
@@ -542,58 +444,10 @@ declare module 'stripe' {
|
|
|
542
444
|
}
|
|
543
445
|
}
|
|
544
446
|
|
|
545
|
-
interface IdBankTransfer {}
|
|
546
|
-
|
|
547
447
|
interface Konbini {}
|
|
548
448
|
|
|
549
|
-
interface Pix {
|
|
550
|
-
/**
|
|
551
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
552
|
-
*/
|
|
553
|
-
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
554
|
-
}
|
|
555
|
-
|
|
556
|
-
namespace Pix {
|
|
557
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
558
|
-
}
|
|
559
|
-
|
|
560
449
|
interface SepaDebit {}
|
|
561
450
|
|
|
562
|
-
interface Upi {
|
|
563
|
-
/**
|
|
564
|
-
* Configuration options for setting up an eMandate
|
|
565
|
-
*/
|
|
566
|
-
mandate_options?: Upi.MandateOptions;
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
namespace Upi {
|
|
570
|
-
interface MandateOptions {
|
|
571
|
-
/**
|
|
572
|
-
* Amount to be charged for future payments.
|
|
573
|
-
*/
|
|
574
|
-
amount?: number;
|
|
575
|
-
|
|
576
|
-
/**
|
|
577
|
-
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
|
578
|
-
*/
|
|
579
|
-
amount_type?: MandateOptions.AmountType;
|
|
580
|
-
|
|
581
|
-
/**
|
|
582
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
583
|
-
*/
|
|
584
|
-
description?: string;
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
588
|
-
*/
|
|
589
|
-
end_date?: number;
|
|
590
|
-
}
|
|
591
|
-
|
|
592
|
-
namespace MandateOptions {
|
|
593
|
-
type AmountType = 'fixed' | 'maximum';
|
|
594
|
-
}
|
|
595
|
-
}
|
|
596
|
-
|
|
597
451
|
interface UsBankAccount {
|
|
598
452
|
/**
|
|
599
453
|
* Additional fields for Financial Connections Session creation
|
|
@@ -630,11 +484,6 @@ declare module 'stripe' {
|
|
|
630
484
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
631
485
|
*/
|
|
632
486
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
633
|
-
|
|
634
|
-
/**
|
|
635
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
636
|
-
*/
|
|
637
|
-
institution?: string;
|
|
638
487
|
}
|
|
639
488
|
|
|
640
489
|
namespace Filters {
|
|
@@ -647,11 +496,7 @@ declare module 'stripe' {
|
|
|
647
496
|
| 'payment_method'
|
|
648
497
|
| 'transactions';
|
|
649
498
|
|
|
650
|
-
type Prefetch =
|
|
651
|
-
| 'balances'
|
|
652
|
-
| 'inferred_balances'
|
|
653
|
-
| 'ownership'
|
|
654
|
-
| 'transactions';
|
|
499
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
655
500
|
}
|
|
656
501
|
|
|
657
502
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -677,7 +522,6 @@ declare module 'stripe' {
|
|
|
677
522
|
| 'fpx'
|
|
678
523
|
| 'giropay'
|
|
679
524
|
| 'grabpay'
|
|
680
|
-
| 'id_bank_transfer'
|
|
681
525
|
| 'ideal'
|
|
682
526
|
| 'jp_credit_transfer'
|
|
683
527
|
| 'kakao_pay'
|
|
@@ -692,15 +536,12 @@ declare module 'stripe' {
|
|
|
692
536
|
| 'payco'
|
|
693
537
|
| 'paynow'
|
|
694
538
|
| 'paypal'
|
|
695
|
-
| 'pix'
|
|
696
539
|
| 'promptpay'
|
|
697
540
|
| 'revolut_pay'
|
|
698
541
|
| 'sepa_credit_transfer'
|
|
699
542
|
| 'sepa_debit'
|
|
700
543
|
| 'sofort'
|
|
701
|
-
| 'stripe_balance'
|
|
702
544
|
| 'swish'
|
|
703
|
-
| 'upi'
|
|
704
545
|
| 'us_bank_account'
|
|
705
546
|
| 'wechat_pay';
|
|
706
547
|
}
|
|
@@ -927,11 +768,6 @@ declare module 'stripe' {
|
|
|
927
768
|
*/
|
|
928
769
|
account_tax_ids?: Stripe.Emptyable<Array<string>>;
|
|
929
770
|
|
|
930
|
-
/**
|
|
931
|
-
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
932
|
-
*/
|
|
933
|
-
amounts_due?: Stripe.Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
934
|
-
|
|
935
771
|
/**
|
|
936
772
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
|
937
773
|
*/
|
|
@@ -967,11 +803,6 @@ declare module 'stripe' {
|
|
|
967
803
|
*/
|
|
968
804
|
days_until_due?: number;
|
|
969
805
|
|
|
970
|
-
/**
|
|
971
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
972
|
-
*/
|
|
973
|
-
default_margins?: Stripe.Emptyable<Array<string>>;
|
|
974
|
-
|
|
975
806
|
/**
|
|
976
807
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
977
808
|
*/
|
|
@@ -1069,28 +900,6 @@ declare module 'stripe' {
|
|
|
1069
900
|
}
|
|
1070
901
|
|
|
1071
902
|
namespace InvoiceUpdateParams {
|
|
1072
|
-
interface AmountsDue {
|
|
1073
|
-
/**
|
|
1074
|
-
* The amount in cents (or local equivalent).
|
|
1075
|
-
*/
|
|
1076
|
-
amount: number;
|
|
1077
|
-
|
|
1078
|
-
/**
|
|
1079
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
1080
|
-
*/
|
|
1081
|
-
days_until_due?: number;
|
|
1082
|
-
|
|
1083
|
-
/**
|
|
1084
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1085
|
-
*/
|
|
1086
|
-
description: string;
|
|
1087
|
-
|
|
1088
|
-
/**
|
|
1089
|
-
* Date on which a payment plan's payment is due.
|
|
1090
|
-
*/
|
|
1091
|
-
due_date?: number;
|
|
1092
|
-
}
|
|
1093
|
-
|
|
1094
903
|
interface AutomaticTax {
|
|
1095
904
|
/**
|
|
1096
905
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -1146,56 +955,12 @@ declare module 'stripe' {
|
|
|
1146
955
|
*/
|
|
1147
956
|
discount?: string;
|
|
1148
957
|
|
|
1149
|
-
/**
|
|
1150
|
-
* Details to determine how long the discount should be applied for.
|
|
1151
|
-
*/
|
|
1152
|
-
discount_end?: Discount.DiscountEnd;
|
|
1153
|
-
|
|
1154
958
|
/**
|
|
1155
959
|
* ID of the promotion code to create a new discount for.
|
|
1156
960
|
*/
|
|
1157
961
|
promotion_code?: string;
|
|
1158
962
|
}
|
|
1159
963
|
|
|
1160
|
-
namespace Discount {
|
|
1161
|
-
interface DiscountEnd {
|
|
1162
|
-
/**
|
|
1163
|
-
* Time span for the redeemed discount.
|
|
1164
|
-
*/
|
|
1165
|
-
duration?: DiscountEnd.Duration;
|
|
1166
|
-
|
|
1167
|
-
/**
|
|
1168
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1169
|
-
*/
|
|
1170
|
-
timestamp?: number;
|
|
1171
|
-
|
|
1172
|
-
/**
|
|
1173
|
-
* The type of calculation made to determine when the discount ends.
|
|
1174
|
-
*/
|
|
1175
|
-
type: DiscountEnd.Type;
|
|
1176
|
-
}
|
|
1177
|
-
|
|
1178
|
-
namespace DiscountEnd {
|
|
1179
|
-
interface Duration {
|
|
1180
|
-
/**
|
|
1181
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1182
|
-
*/
|
|
1183
|
-
interval: Duration.Interval;
|
|
1184
|
-
|
|
1185
|
-
/**
|
|
1186
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1187
|
-
*/
|
|
1188
|
-
interval_count: number;
|
|
1189
|
-
}
|
|
1190
|
-
|
|
1191
|
-
namespace Duration {
|
|
1192
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1193
|
-
}
|
|
1194
|
-
|
|
1195
|
-
type Type = 'duration' | 'timestamp';
|
|
1196
|
-
}
|
|
1197
|
-
}
|
|
1198
|
-
|
|
1199
964
|
interface Issuer {
|
|
1200
965
|
/**
|
|
1201
966
|
* The connected account being referenced when `type` is `account`.
|
|
@@ -1255,33 +1020,16 @@ declare module 'stripe' {
|
|
|
1255
1020
|
PaymentMethodOptions.CustomerBalance
|
|
1256
1021
|
>;
|
|
1257
1022
|
|
|
1258
|
-
/**
|
|
1259
|
-
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1260
|
-
*/
|
|
1261
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
1262
|
-
PaymentMethodOptions.IdBankTransfer
|
|
1263
|
-
>;
|
|
1264
|
-
|
|
1265
1023
|
/**
|
|
1266
1024
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1267
1025
|
*/
|
|
1268
1026
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
1269
1027
|
|
|
1270
|
-
/**
|
|
1271
|
-
* If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
1272
|
-
*/
|
|
1273
|
-
pix?: Stripe.Emptyable<PaymentMethodOptions.Pix>;
|
|
1274
|
-
|
|
1275
1028
|
/**
|
|
1276
1029
|
* If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
1277
1030
|
*/
|
|
1278
1031
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
1279
1032
|
|
|
1280
|
-
/**
|
|
1281
|
-
* If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
1282
|
-
*/
|
|
1283
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
1284
|
-
|
|
1285
1033
|
/**
|
|
1286
1034
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
1287
1035
|
*/
|
|
@@ -1419,58 +1167,10 @@ declare module 'stripe' {
|
|
|
1419
1167
|
}
|
|
1420
1168
|
}
|
|
1421
1169
|
|
|
1422
|
-
interface IdBankTransfer {}
|
|
1423
|
-
|
|
1424
1170
|
interface Konbini {}
|
|
1425
1171
|
|
|
1426
|
-
interface Pix {
|
|
1427
|
-
/**
|
|
1428
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1429
|
-
*/
|
|
1430
|
-
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
1431
|
-
}
|
|
1432
|
-
|
|
1433
|
-
namespace Pix {
|
|
1434
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
1435
|
-
}
|
|
1436
|
-
|
|
1437
1172
|
interface SepaDebit {}
|
|
1438
1173
|
|
|
1439
|
-
interface Upi {
|
|
1440
|
-
/**
|
|
1441
|
-
* Configuration options for setting up an eMandate
|
|
1442
|
-
*/
|
|
1443
|
-
mandate_options?: Upi.MandateOptions;
|
|
1444
|
-
}
|
|
1445
|
-
|
|
1446
|
-
namespace Upi {
|
|
1447
|
-
interface MandateOptions {
|
|
1448
|
-
/**
|
|
1449
|
-
* Amount to be charged for future payments.
|
|
1450
|
-
*/
|
|
1451
|
-
amount?: number;
|
|
1452
|
-
|
|
1453
|
-
/**
|
|
1454
|
-
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
|
1455
|
-
*/
|
|
1456
|
-
amount_type?: MandateOptions.AmountType;
|
|
1457
|
-
|
|
1458
|
-
/**
|
|
1459
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
1460
|
-
*/
|
|
1461
|
-
description?: string;
|
|
1462
|
-
|
|
1463
|
-
/**
|
|
1464
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
1465
|
-
*/
|
|
1466
|
-
end_date?: number;
|
|
1467
|
-
}
|
|
1468
|
-
|
|
1469
|
-
namespace MandateOptions {
|
|
1470
|
-
type AmountType = 'fixed' | 'maximum';
|
|
1471
|
-
}
|
|
1472
|
-
}
|
|
1473
|
-
|
|
1474
1174
|
interface UsBankAccount {
|
|
1475
1175
|
/**
|
|
1476
1176
|
* Additional fields for Financial Connections Session creation
|
|
@@ -1507,11 +1207,6 @@ declare module 'stripe' {
|
|
|
1507
1207
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1508
1208
|
*/
|
|
1509
1209
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1510
|
-
|
|
1511
|
-
/**
|
|
1512
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
1513
|
-
*/
|
|
1514
|
-
institution?: string;
|
|
1515
1210
|
}
|
|
1516
1211
|
|
|
1517
1212
|
namespace Filters {
|
|
@@ -1524,11 +1219,7 @@ declare module 'stripe' {
|
|
|
1524
1219
|
| 'payment_method'
|
|
1525
1220
|
| 'transactions';
|
|
1526
1221
|
|
|
1527
|
-
type Prefetch =
|
|
1528
|
-
| 'balances'
|
|
1529
|
-
| 'inferred_balances'
|
|
1530
|
-
| 'ownership'
|
|
1531
|
-
| 'transactions';
|
|
1222
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1532
1223
|
}
|
|
1533
1224
|
|
|
1534
1225
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -1554,7 +1245,6 @@ declare module 'stripe' {
|
|
|
1554
1245
|
| 'fpx'
|
|
1555
1246
|
| 'giropay'
|
|
1556
1247
|
| 'grabpay'
|
|
1557
|
-
| 'id_bank_transfer'
|
|
1558
1248
|
| 'ideal'
|
|
1559
1249
|
| 'jp_credit_transfer'
|
|
1560
1250
|
| 'kakao_pay'
|
|
@@ -1569,15 +1259,12 @@ declare module 'stripe' {
|
|
|
1569
1259
|
| 'payco'
|
|
1570
1260
|
| 'paynow'
|
|
1571
1261
|
| 'paypal'
|
|
1572
|
-
| 'pix'
|
|
1573
1262
|
| 'promptpay'
|
|
1574
1263
|
| 'revolut_pay'
|
|
1575
1264
|
| 'sepa_credit_transfer'
|
|
1576
1265
|
| 'sepa_debit'
|
|
1577
1266
|
| 'sofort'
|
|
1578
|
-
| 'stripe_balance'
|
|
1579
1267
|
| 'swish'
|
|
1580
|
-
| 'upi'
|
|
1581
1268
|
| 'us_bank_account'
|
|
1582
1269
|
| 'wechat_pay';
|
|
1583
1270
|
}
|
|
@@ -1790,11 +1477,6 @@ declare module 'stripe' {
|
|
|
1790
1477
|
}
|
|
1791
1478
|
|
|
1792
1479
|
interface InvoiceListParams extends PaginationParams {
|
|
1793
|
-
/**
|
|
1794
|
-
* Only return invoices for the cadence specified by this billing cadence ID.
|
|
1795
|
-
*/
|
|
1796
|
-
billing_cadence?: string;
|
|
1797
|
-
|
|
1798
1480
|
/**
|
|
1799
1481
|
* The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
|
|
1800
1482
|
*/
|
|
@@ -1810,11 +1492,6 @@ declare module 'stripe' {
|
|
|
1810
1492
|
*/
|
|
1811
1493
|
customer?: string;
|
|
1812
1494
|
|
|
1813
|
-
/**
|
|
1814
|
-
* Only return invoices for the account specified by this account ID.
|
|
1815
|
-
*/
|
|
1816
|
-
customer_account?: string;
|
|
1817
|
-
|
|
1818
1495
|
due_date?: Stripe.RangeQueryParam | number;
|
|
1819
1496
|
|
|
1820
1497
|
/**
|
|
@@ -1887,11 +1564,6 @@ declare module 'stripe' {
|
|
|
1887
1564
|
*/
|
|
1888
1565
|
invoice_item?: string;
|
|
1889
1566
|
|
|
1890
|
-
/**
|
|
1891
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
1892
|
-
*/
|
|
1893
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
1894
|
-
|
|
1895
1567
|
/**
|
|
1896
1568
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
1897
1569
|
*/
|
|
@@ -1940,56 +1612,12 @@ declare module 'stripe' {
|
|
|
1940
1612
|
*/
|
|
1941
1613
|
discount?: string;
|
|
1942
1614
|
|
|
1943
|
-
/**
|
|
1944
|
-
* Details to determine how long the discount should be applied for.
|
|
1945
|
-
*/
|
|
1946
|
-
discount_end?: Discount.DiscountEnd;
|
|
1947
|
-
|
|
1948
1615
|
/**
|
|
1949
1616
|
* ID of the promotion code to create a new discount for.
|
|
1950
1617
|
*/
|
|
1951
1618
|
promotion_code?: string;
|
|
1952
1619
|
}
|
|
1953
1620
|
|
|
1954
|
-
namespace Discount {
|
|
1955
|
-
interface DiscountEnd {
|
|
1956
|
-
/**
|
|
1957
|
-
* Time span for the redeemed discount.
|
|
1958
|
-
*/
|
|
1959
|
-
duration?: DiscountEnd.Duration;
|
|
1960
|
-
|
|
1961
|
-
/**
|
|
1962
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1963
|
-
*/
|
|
1964
|
-
timestamp?: number;
|
|
1965
|
-
|
|
1966
|
-
/**
|
|
1967
|
-
* The type of calculation made to determine when the discount ends.
|
|
1968
|
-
*/
|
|
1969
|
-
type: DiscountEnd.Type;
|
|
1970
|
-
}
|
|
1971
|
-
|
|
1972
|
-
namespace DiscountEnd {
|
|
1973
|
-
interface Duration {
|
|
1974
|
-
/**
|
|
1975
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1976
|
-
*/
|
|
1977
|
-
interval: Duration.Interval;
|
|
1978
|
-
|
|
1979
|
-
/**
|
|
1980
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1981
|
-
*/
|
|
1982
|
-
interval_count: number;
|
|
1983
|
-
}
|
|
1984
|
-
|
|
1985
|
-
namespace Duration {
|
|
1986
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1987
|
-
}
|
|
1988
|
-
|
|
1989
|
-
type Type = 'duration' | 'timestamp';
|
|
1990
|
-
}
|
|
1991
|
-
}
|
|
1992
|
-
|
|
1993
1621
|
interface Period {
|
|
1994
1622
|
/**
|
|
1995
1623
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -2196,11 +1824,6 @@ declare module 'stripe' {
|
|
|
2196
1824
|
}
|
|
2197
1825
|
|
|
2198
1826
|
interface InvoiceAttachPaymentParams {
|
|
2199
|
-
/**
|
|
2200
|
-
* The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
|
2201
|
-
*/
|
|
2202
|
-
amount_requested?: number;
|
|
2203
|
-
|
|
2204
1827
|
/**
|
|
2205
1828
|
* Specifies which fields in the response should be expanded.
|
|
2206
1829
|
*/
|
|
@@ -2215,45 +1838,6 @@ declare module 'stripe' {
|
|
|
2215
1838
|
* The ID of the PaymentRecord to attach to the invoice.
|
|
2216
1839
|
*/
|
|
2217
1840
|
payment_record?: string;
|
|
2218
|
-
|
|
2219
|
-
/**
|
|
2220
|
-
* The PaymentRecord data for attaching an out of band payment to the invoice.
|
|
2221
|
-
*/
|
|
2222
|
-
payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
|
|
2223
|
-
}
|
|
2224
|
-
|
|
2225
|
-
namespace InvoiceAttachPaymentParams {
|
|
2226
|
-
interface PaymentRecordData {
|
|
2227
|
-
/**
|
|
2228
|
-
* The amount that was paid out of band.
|
|
2229
|
-
*/
|
|
2230
|
-
amount: number;
|
|
2231
|
-
|
|
2232
|
-
/**
|
|
2233
|
-
* The currency that was paid out of band.
|
|
2234
|
-
*/
|
|
2235
|
-
currency: string;
|
|
2236
|
-
|
|
2237
|
-
/**
|
|
2238
|
-
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2239
|
-
*/
|
|
2240
|
-
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2241
|
-
|
|
2242
|
-
/**
|
|
2243
|
-
* The type of money movement for this out of band payment record.
|
|
2244
|
-
*/
|
|
2245
|
-
money_movement_type: string;
|
|
2246
|
-
|
|
2247
|
-
/**
|
|
2248
|
-
* The timestamp when this out of band payment was paid.
|
|
2249
|
-
*/
|
|
2250
|
-
paid_at?: number;
|
|
2251
|
-
|
|
2252
|
-
/**
|
|
2253
|
-
* The reference for this out of band payment record.
|
|
2254
|
-
*/
|
|
2255
|
-
payment_reference?: string;
|
|
2256
|
-
}
|
|
2257
1841
|
}
|
|
2258
1842
|
|
|
2259
1843
|
interface InvoiceCreatePreviewParams {
|
|
@@ -2262,11 +1846,6 @@ declare module 'stripe' {
|
|
|
2262
1846
|
*/
|
|
2263
1847
|
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
|
|
2264
1848
|
|
|
2265
|
-
/**
|
|
2266
|
-
* The identifier of the billing cadence for which you'd like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
|
|
2267
|
-
*/
|
|
2268
|
-
billing_cadence?: string;
|
|
2269
|
-
|
|
2270
1849
|
/**
|
|
2271
1850
|
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
|
2272
1851
|
*/
|
|
@@ -2277,11 +1856,6 @@ declare module 'stripe' {
|
|
|
2277
1856
|
*/
|
|
2278
1857
|
customer?: string;
|
|
2279
1858
|
|
|
2280
|
-
/**
|
|
2281
|
-
* The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
2282
|
-
*/
|
|
2283
|
-
customer_account?: string;
|
|
2284
|
-
|
|
2285
1859
|
/**
|
|
2286
1860
|
* Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
2287
1861
|
*/
|
|
@@ -2561,56 +2135,12 @@ declare module 'stripe' {
|
|
|
2561
2135
|
*/
|
|
2562
2136
|
discount?: string;
|
|
2563
2137
|
|
|
2564
|
-
/**
|
|
2565
|
-
* Details to determine how long the discount should be applied for.
|
|
2566
|
-
*/
|
|
2567
|
-
discount_end?: Discount.DiscountEnd;
|
|
2568
|
-
|
|
2569
2138
|
/**
|
|
2570
2139
|
* ID of the promotion code to create a new discount for.
|
|
2571
2140
|
*/
|
|
2572
2141
|
promotion_code?: string;
|
|
2573
2142
|
}
|
|
2574
2143
|
|
|
2575
|
-
namespace Discount {
|
|
2576
|
-
interface DiscountEnd {
|
|
2577
|
-
/**
|
|
2578
|
-
* Time span for the redeemed discount.
|
|
2579
|
-
*/
|
|
2580
|
-
duration?: DiscountEnd.Duration;
|
|
2581
|
-
|
|
2582
|
-
/**
|
|
2583
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2584
|
-
*/
|
|
2585
|
-
timestamp?: number;
|
|
2586
|
-
|
|
2587
|
-
/**
|
|
2588
|
-
* The type of calculation made to determine when the discount ends.
|
|
2589
|
-
*/
|
|
2590
|
-
type: DiscountEnd.Type;
|
|
2591
|
-
}
|
|
2592
|
-
|
|
2593
|
-
namespace DiscountEnd {
|
|
2594
|
-
interface Duration {
|
|
2595
|
-
/**
|
|
2596
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2597
|
-
*/
|
|
2598
|
-
interval: Duration.Interval;
|
|
2599
|
-
|
|
2600
|
-
/**
|
|
2601
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2602
|
-
*/
|
|
2603
|
-
interval_count: number;
|
|
2604
|
-
}
|
|
2605
|
-
|
|
2606
|
-
namespace Duration {
|
|
2607
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2608
|
-
}
|
|
2609
|
-
|
|
2610
|
-
type Type = 'duration' | 'timestamp';
|
|
2611
|
-
}
|
|
2612
|
-
}
|
|
2613
|
-
|
|
2614
2144
|
interface InvoiceItem {
|
|
2615
2145
|
/**
|
|
2616
2146
|
* The integer amount in cents (or local equivalent) of previewed invoice item.
|
|
@@ -2705,56 +2235,12 @@ declare module 'stripe' {
|
|
|
2705
2235
|
*/
|
|
2706
2236
|
discount?: string;
|
|
2707
2237
|
|
|
2708
|
-
/**
|
|
2709
|
-
* Details to determine how long the discount should be applied for.
|
|
2710
|
-
*/
|
|
2711
|
-
discount_end?: Discount.DiscountEnd;
|
|
2712
|
-
|
|
2713
2238
|
/**
|
|
2714
2239
|
* ID of the promotion code to create a new discount for.
|
|
2715
2240
|
*/
|
|
2716
2241
|
promotion_code?: string;
|
|
2717
2242
|
}
|
|
2718
2243
|
|
|
2719
|
-
namespace Discount {
|
|
2720
|
-
interface DiscountEnd {
|
|
2721
|
-
/**
|
|
2722
|
-
* Time span for the redeemed discount.
|
|
2723
|
-
*/
|
|
2724
|
-
duration?: DiscountEnd.Duration;
|
|
2725
|
-
|
|
2726
|
-
/**
|
|
2727
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2728
|
-
*/
|
|
2729
|
-
timestamp?: number;
|
|
2730
|
-
|
|
2731
|
-
/**
|
|
2732
|
-
* The type of calculation made to determine when the discount ends.
|
|
2733
|
-
*/
|
|
2734
|
-
type: DiscountEnd.Type;
|
|
2735
|
-
}
|
|
2736
|
-
|
|
2737
|
-
namespace DiscountEnd {
|
|
2738
|
-
interface Duration {
|
|
2739
|
-
/**
|
|
2740
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2741
|
-
*/
|
|
2742
|
-
interval: Duration.Interval;
|
|
2743
|
-
|
|
2744
|
-
/**
|
|
2745
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2746
|
-
*/
|
|
2747
|
-
interval_count: number;
|
|
2748
|
-
}
|
|
2749
|
-
|
|
2750
|
-
namespace Duration {
|
|
2751
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2752
|
-
}
|
|
2753
|
-
|
|
2754
|
-
type Type = 'duration' | 'timestamp';
|
|
2755
|
-
}
|
|
2756
|
-
}
|
|
2757
|
-
|
|
2758
2244
|
interface Period {
|
|
2759
2245
|
/**
|
|
2760
2246
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -2820,16 +2306,6 @@ declare module 'stripe' {
|
|
|
2820
2306
|
type PreviewMode = 'next' | 'recurring';
|
|
2821
2307
|
|
|
2822
2308
|
interface ScheduleDetails {
|
|
2823
|
-
/**
|
|
2824
|
-
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2825
|
-
*/
|
|
2826
|
-
amendments?: Array<ScheduleDetails.Amendment>;
|
|
2827
|
-
|
|
2828
|
-
/**
|
|
2829
|
-
* Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
|
2830
|
-
*/
|
|
2831
|
-
billing_behavior?: ScheduleDetails.BillingBehavior;
|
|
2832
|
-
|
|
2833
2309
|
/**
|
|
2834
2310
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
2835
2311
|
*/
|
|
@@ -2845,620 +2321,13 @@ declare module 'stripe' {
|
|
|
2845
2321
|
*/
|
|
2846
2322
|
phases?: Array<ScheduleDetails.Phase>;
|
|
2847
2323
|
|
|
2848
|
-
/**
|
|
2849
|
-
* Provide any time periods to bill in advance.
|
|
2850
|
-
*/
|
|
2851
|
-
prebilling?: Stripe.Emptyable<Array<ScheduleDetails.Prebilling>>;
|
|
2852
|
-
|
|
2853
2324
|
/**
|
|
2854
2325
|
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
2855
2326
|
*/
|
|
2856
2327
|
proration_behavior?: ScheduleDetails.ProrationBehavior;
|
|
2857
|
-
|
|
2858
|
-
/**
|
|
2859
|
-
* Sets the billing schedules for the subscription schedule.
|
|
2860
|
-
*/
|
|
2861
|
-
billing_schedules?: Array<ScheduleDetails.BillingSchedule>;
|
|
2862
2328
|
}
|
|
2863
2329
|
|
|
2864
2330
|
namespace ScheduleDetails {
|
|
2865
|
-
interface Amendment {
|
|
2866
|
-
/**
|
|
2867
|
-
* Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
|
2868
|
-
*/
|
|
2869
|
-
amendment_end?: Amendment.AmendmentEnd;
|
|
2870
|
-
|
|
2871
|
-
/**
|
|
2872
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2873
|
-
*/
|
|
2874
|
-
amendment_start: Amendment.AmendmentStart;
|
|
2875
|
-
|
|
2876
|
-
/**
|
|
2877
|
-
* For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
|
2878
|
-
*/
|
|
2879
|
-
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2880
|
-
|
|
2881
|
-
/**
|
|
2882
|
-
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2883
|
-
*/
|
|
2884
|
-
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2885
|
-
|
|
2886
|
-
/**
|
|
2887
|
-
* Changes to the subscription items during the amendment time span.
|
|
2888
|
-
*/
|
|
2889
|
-
item_actions?: Array<Amendment.ItemAction>;
|
|
2890
|
-
|
|
2891
|
-
/**
|
|
2892
|
-
* Instructions for how to modify phase metadata
|
|
2893
|
-
*/
|
|
2894
|
-
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2895
|
-
|
|
2896
|
-
/**
|
|
2897
|
-
* Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
|
2898
|
-
*/
|
|
2899
|
-
proration_behavior?: Amendment.ProrationBehavior;
|
|
2900
|
-
|
|
2901
|
-
/**
|
|
2902
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2903
|
-
*/
|
|
2904
|
-
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2905
|
-
|
|
2906
|
-
/**
|
|
2907
|
-
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2908
|
-
*/
|
|
2909
|
-
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2910
|
-
|
|
2911
|
-
/**
|
|
2912
|
-
* Settings related to subscription trials.
|
|
2913
|
-
*/
|
|
2914
|
-
trial_settings?: Amendment.TrialSettings;
|
|
2915
|
-
}
|
|
2916
|
-
|
|
2917
|
-
namespace Amendment {
|
|
2918
|
-
interface AmendmentEnd {
|
|
2919
|
-
/**
|
|
2920
|
-
* Use the `end` time of a given discount.
|
|
2921
|
-
*/
|
|
2922
|
-
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2923
|
-
|
|
2924
|
-
/**
|
|
2925
|
-
* Time span for the amendment starting from the `amendment_start`.
|
|
2926
|
-
*/
|
|
2927
|
-
duration?: AmendmentEnd.Duration;
|
|
2928
|
-
|
|
2929
|
-
/**
|
|
2930
|
-
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2931
|
-
*/
|
|
2932
|
-
timestamp?: number;
|
|
2933
|
-
|
|
2934
|
-
/**
|
|
2935
|
-
* Select one of three ways to pass the `amendment_end`.
|
|
2936
|
-
*/
|
|
2937
|
-
type: AmendmentEnd.Type;
|
|
2938
|
-
}
|
|
2939
|
-
|
|
2940
|
-
namespace AmendmentEnd {
|
|
2941
|
-
interface DiscountEnd {
|
|
2942
|
-
/**
|
|
2943
|
-
* The ID of a specific discount.
|
|
2944
|
-
*/
|
|
2945
|
-
discount: string;
|
|
2946
|
-
}
|
|
2947
|
-
|
|
2948
|
-
interface Duration {
|
|
2949
|
-
/**
|
|
2950
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2951
|
-
*/
|
|
2952
|
-
interval: Duration.Interval;
|
|
2953
|
-
|
|
2954
|
-
/**
|
|
2955
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2956
|
-
*/
|
|
2957
|
-
interval_count: number;
|
|
2958
|
-
}
|
|
2959
|
-
|
|
2960
|
-
namespace Duration {
|
|
2961
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2962
|
-
}
|
|
2963
|
-
|
|
2964
|
-
type Type =
|
|
2965
|
-
| 'discount_end'
|
|
2966
|
-
| 'duration'
|
|
2967
|
-
| 'schedule_end'
|
|
2968
|
-
| 'timestamp'
|
|
2969
|
-
| 'trial_end'
|
|
2970
|
-
| 'trial_start'
|
|
2971
|
-
| 'upcoming_invoice';
|
|
2972
|
-
}
|
|
2973
|
-
|
|
2974
|
-
interface AmendmentStart {
|
|
2975
|
-
/**
|
|
2976
|
-
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2977
|
-
*/
|
|
2978
|
-
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2979
|
-
|
|
2980
|
-
/**
|
|
2981
|
-
* Use the `end` time of a given discount.
|
|
2982
|
-
*/
|
|
2983
|
-
discount_end?: AmendmentStart.DiscountEnd;
|
|
2984
|
-
|
|
2985
|
-
/**
|
|
2986
|
-
* A precise Unix timestamp for the amendment to start.
|
|
2987
|
-
*/
|
|
2988
|
-
timestamp?: number;
|
|
2989
|
-
|
|
2990
|
-
/**
|
|
2991
|
-
* Select one of three ways to pass the `amendment_start`.
|
|
2992
|
-
*/
|
|
2993
|
-
type: AmendmentStart.Type;
|
|
2994
|
-
}
|
|
2995
|
-
|
|
2996
|
-
namespace AmendmentStart {
|
|
2997
|
-
interface AmendmentEnd {
|
|
2998
|
-
/**
|
|
2999
|
-
* The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
|
|
3000
|
-
*/
|
|
3001
|
-
index: number;
|
|
3002
|
-
}
|
|
3003
|
-
|
|
3004
|
-
interface DiscountEnd {
|
|
3005
|
-
/**
|
|
3006
|
-
* The ID of a specific discount.
|
|
3007
|
-
*/
|
|
3008
|
-
discount: string;
|
|
3009
|
-
}
|
|
3010
|
-
|
|
3011
|
-
type Type =
|
|
3012
|
-
| 'amendment_end'
|
|
3013
|
-
| 'discount_end'
|
|
3014
|
-
| 'now'
|
|
3015
|
-
| 'schedule_end'
|
|
3016
|
-
| 'timestamp'
|
|
3017
|
-
| 'trial_end'
|
|
3018
|
-
| 'trial_start'
|
|
3019
|
-
| 'upcoming_invoice';
|
|
3020
|
-
}
|
|
3021
|
-
|
|
3022
|
-
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
3023
|
-
|
|
3024
|
-
interface DiscountAction {
|
|
3025
|
-
/**
|
|
3026
|
-
* Details of the discount to add.
|
|
3027
|
-
*/
|
|
3028
|
-
add?: DiscountAction.Add;
|
|
3029
|
-
|
|
3030
|
-
/**
|
|
3031
|
-
* Details of the discount to remove.
|
|
3032
|
-
*/
|
|
3033
|
-
remove?: DiscountAction.Remove;
|
|
3034
|
-
|
|
3035
|
-
/**
|
|
3036
|
-
* Details of the discount to replace the existing discounts with.
|
|
3037
|
-
*/
|
|
3038
|
-
set?: DiscountAction.Set;
|
|
3039
|
-
|
|
3040
|
-
/**
|
|
3041
|
-
* Determines the type of discount action.
|
|
3042
|
-
*/
|
|
3043
|
-
type: DiscountAction.Type;
|
|
3044
|
-
}
|
|
3045
|
-
|
|
3046
|
-
namespace DiscountAction {
|
|
3047
|
-
interface Add {
|
|
3048
|
-
/**
|
|
3049
|
-
* The coupon code to redeem.
|
|
3050
|
-
*/
|
|
3051
|
-
coupon?: string;
|
|
3052
|
-
|
|
3053
|
-
/**
|
|
3054
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3055
|
-
*/
|
|
3056
|
-
discount?: string;
|
|
3057
|
-
|
|
3058
|
-
/**
|
|
3059
|
-
* Details to determine how long the discount should be applied for.
|
|
3060
|
-
*/
|
|
3061
|
-
discount_end?: Add.DiscountEnd;
|
|
3062
|
-
|
|
3063
|
-
/**
|
|
3064
|
-
* The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
|
|
3065
|
-
*/
|
|
3066
|
-
index?: number;
|
|
3067
|
-
|
|
3068
|
-
/**
|
|
3069
|
-
* The promotion code to redeem.
|
|
3070
|
-
*/
|
|
3071
|
-
promotion_code?: string;
|
|
3072
|
-
}
|
|
3073
|
-
|
|
3074
|
-
namespace Add {
|
|
3075
|
-
interface DiscountEnd {
|
|
3076
|
-
/**
|
|
3077
|
-
* The type of calculation made to determine when the discount ends.
|
|
3078
|
-
*/
|
|
3079
|
-
type: 'amendment_end';
|
|
3080
|
-
}
|
|
3081
|
-
}
|
|
3082
|
-
|
|
3083
|
-
interface Remove {
|
|
3084
|
-
/**
|
|
3085
|
-
* The coupon code to remove from the `discounts` array.
|
|
3086
|
-
*/
|
|
3087
|
-
coupon?: string;
|
|
3088
|
-
|
|
3089
|
-
/**
|
|
3090
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
3091
|
-
*/
|
|
3092
|
-
discount?: string;
|
|
3093
|
-
|
|
3094
|
-
/**
|
|
3095
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
3096
|
-
*/
|
|
3097
|
-
promotion_code?: string;
|
|
3098
|
-
}
|
|
3099
|
-
|
|
3100
|
-
interface Set {
|
|
3101
|
-
/**
|
|
3102
|
-
* The coupon code to replace the `discounts` array with.
|
|
3103
|
-
*/
|
|
3104
|
-
coupon?: string;
|
|
3105
|
-
|
|
3106
|
-
/**
|
|
3107
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
3108
|
-
*/
|
|
3109
|
-
discount?: string;
|
|
3110
|
-
|
|
3111
|
-
/**
|
|
3112
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3113
|
-
*/
|
|
3114
|
-
promotion_code?: string;
|
|
3115
|
-
}
|
|
3116
|
-
|
|
3117
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3118
|
-
}
|
|
3119
|
-
|
|
3120
|
-
interface ItemAction {
|
|
3121
|
-
/**
|
|
3122
|
-
* Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
|
3123
|
-
*/
|
|
3124
|
-
add?: ItemAction.Add;
|
|
3125
|
-
|
|
3126
|
-
/**
|
|
3127
|
-
* Details of the subscription item to remove.
|
|
3128
|
-
*/
|
|
3129
|
-
remove?: ItemAction.Remove;
|
|
3130
|
-
|
|
3131
|
-
/**
|
|
3132
|
-
* Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
|
3133
|
-
*/
|
|
3134
|
-
set?: ItemAction.Set;
|
|
3135
|
-
|
|
3136
|
-
/**
|
|
3137
|
-
* Determines the type of item action.
|
|
3138
|
-
*/
|
|
3139
|
-
type: ItemAction.Type;
|
|
3140
|
-
}
|
|
3141
|
-
|
|
3142
|
-
namespace ItemAction {
|
|
3143
|
-
interface Add {
|
|
3144
|
-
/**
|
|
3145
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3146
|
-
*/
|
|
3147
|
-
discounts?: Array<Add.Discount>;
|
|
3148
|
-
|
|
3149
|
-
/**
|
|
3150
|
-
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
3151
|
-
*/
|
|
3152
|
-
metadata?: Stripe.MetadataParam;
|
|
3153
|
-
|
|
3154
|
-
/**
|
|
3155
|
-
* The ID of the price object.
|
|
3156
|
-
*/
|
|
3157
|
-
price: string;
|
|
3158
|
-
|
|
3159
|
-
/**
|
|
3160
|
-
* Quantity for this item.
|
|
3161
|
-
*/
|
|
3162
|
-
quantity?: number;
|
|
3163
|
-
|
|
3164
|
-
/**
|
|
3165
|
-
* The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
|
3166
|
-
*/
|
|
3167
|
-
tax_rates?: Array<string>;
|
|
3168
|
-
|
|
3169
|
-
/**
|
|
3170
|
-
* Options that configure the trial on the subscription item.
|
|
3171
|
-
*/
|
|
3172
|
-
trial?: Add.Trial;
|
|
3173
|
-
}
|
|
3174
|
-
|
|
3175
|
-
namespace Add {
|
|
3176
|
-
interface Discount {
|
|
3177
|
-
/**
|
|
3178
|
-
* ID of the coupon to create a new discount for.
|
|
3179
|
-
*/
|
|
3180
|
-
coupon?: string;
|
|
3181
|
-
|
|
3182
|
-
/**
|
|
3183
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3184
|
-
*/
|
|
3185
|
-
discount?: string;
|
|
3186
|
-
|
|
3187
|
-
/**
|
|
3188
|
-
* Details to determine how long the discount should be applied for.
|
|
3189
|
-
*/
|
|
3190
|
-
discount_end?: Discount.DiscountEnd;
|
|
3191
|
-
|
|
3192
|
-
/**
|
|
3193
|
-
* ID of the promotion code to create a new discount for.
|
|
3194
|
-
*/
|
|
3195
|
-
promotion_code?: string;
|
|
3196
|
-
}
|
|
3197
|
-
|
|
3198
|
-
namespace Discount {
|
|
3199
|
-
interface DiscountEnd {
|
|
3200
|
-
/**
|
|
3201
|
-
* Time span for the redeemed discount.
|
|
3202
|
-
*/
|
|
3203
|
-
duration?: DiscountEnd.Duration;
|
|
3204
|
-
|
|
3205
|
-
/**
|
|
3206
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3207
|
-
*/
|
|
3208
|
-
timestamp?: number;
|
|
3209
|
-
|
|
3210
|
-
/**
|
|
3211
|
-
* The type of calculation made to determine when the discount ends.
|
|
3212
|
-
*/
|
|
3213
|
-
type: DiscountEnd.Type;
|
|
3214
|
-
}
|
|
3215
|
-
|
|
3216
|
-
namespace DiscountEnd {
|
|
3217
|
-
interface Duration {
|
|
3218
|
-
/**
|
|
3219
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3220
|
-
*/
|
|
3221
|
-
interval: Duration.Interval;
|
|
3222
|
-
|
|
3223
|
-
/**
|
|
3224
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3225
|
-
*/
|
|
3226
|
-
interval_count: number;
|
|
3227
|
-
}
|
|
3228
|
-
|
|
3229
|
-
namespace Duration {
|
|
3230
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3231
|
-
}
|
|
3232
|
-
|
|
3233
|
-
type Type = 'duration' | 'timestamp';
|
|
3234
|
-
}
|
|
3235
|
-
}
|
|
3236
|
-
|
|
3237
|
-
interface Trial {
|
|
3238
|
-
/**
|
|
3239
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
3240
|
-
*/
|
|
3241
|
-
converts_to?: Array<string>;
|
|
3242
|
-
|
|
3243
|
-
/**
|
|
3244
|
-
* Determines the type of trial for this item.
|
|
3245
|
-
*/
|
|
3246
|
-
type: Trial.Type;
|
|
3247
|
-
}
|
|
3248
|
-
|
|
3249
|
-
namespace Trial {
|
|
3250
|
-
type Type = 'free' | 'paid';
|
|
3251
|
-
}
|
|
3252
|
-
}
|
|
3253
|
-
|
|
3254
|
-
interface Remove {
|
|
3255
|
-
/**
|
|
3256
|
-
* ID of a price to remove.
|
|
3257
|
-
*/
|
|
3258
|
-
price: string;
|
|
3259
|
-
}
|
|
3260
|
-
|
|
3261
|
-
interface Set {
|
|
3262
|
-
/**
|
|
3263
|
-
* If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
|
|
3264
|
-
*/
|
|
3265
|
-
discounts?: Array<Set.Discount>;
|
|
3266
|
-
|
|
3267
|
-
/**
|
|
3268
|
-
* If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
|
|
3269
|
-
*/
|
|
3270
|
-
metadata?: Stripe.MetadataParam;
|
|
3271
|
-
|
|
3272
|
-
/**
|
|
3273
|
-
* The ID of the price object.
|
|
3274
|
-
*/
|
|
3275
|
-
price: string;
|
|
3276
|
-
|
|
3277
|
-
/**
|
|
3278
|
-
* If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
|
|
3279
|
-
*/
|
|
3280
|
-
quantity?: number;
|
|
3281
|
-
|
|
3282
|
-
/**
|
|
3283
|
-
* If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
|
|
3284
|
-
*/
|
|
3285
|
-
tax_rates?: Array<string>;
|
|
3286
|
-
|
|
3287
|
-
/**
|
|
3288
|
-
* If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
|
|
3289
|
-
*/
|
|
3290
|
-
trial?: Set.Trial;
|
|
3291
|
-
}
|
|
3292
|
-
|
|
3293
|
-
namespace Set {
|
|
3294
|
-
interface Discount {
|
|
3295
|
-
/**
|
|
3296
|
-
* ID of the coupon to create a new discount for.
|
|
3297
|
-
*/
|
|
3298
|
-
coupon?: string;
|
|
3299
|
-
|
|
3300
|
-
/**
|
|
3301
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3302
|
-
*/
|
|
3303
|
-
discount?: string;
|
|
3304
|
-
|
|
3305
|
-
/**
|
|
3306
|
-
* Details to determine how long the discount should be applied for.
|
|
3307
|
-
*/
|
|
3308
|
-
discount_end?: Discount.DiscountEnd;
|
|
3309
|
-
|
|
3310
|
-
/**
|
|
3311
|
-
* ID of the promotion code to create a new discount for.
|
|
3312
|
-
*/
|
|
3313
|
-
promotion_code?: string;
|
|
3314
|
-
}
|
|
3315
|
-
|
|
3316
|
-
namespace Discount {
|
|
3317
|
-
interface DiscountEnd {
|
|
3318
|
-
/**
|
|
3319
|
-
* Time span for the redeemed discount.
|
|
3320
|
-
*/
|
|
3321
|
-
duration?: DiscountEnd.Duration;
|
|
3322
|
-
|
|
3323
|
-
/**
|
|
3324
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3325
|
-
*/
|
|
3326
|
-
timestamp?: number;
|
|
3327
|
-
|
|
3328
|
-
/**
|
|
3329
|
-
* The type of calculation made to determine when the discount ends.
|
|
3330
|
-
*/
|
|
3331
|
-
type: DiscountEnd.Type;
|
|
3332
|
-
}
|
|
3333
|
-
|
|
3334
|
-
namespace DiscountEnd {
|
|
3335
|
-
interface Duration {
|
|
3336
|
-
/**
|
|
3337
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3338
|
-
*/
|
|
3339
|
-
interval: Duration.Interval;
|
|
3340
|
-
|
|
3341
|
-
/**
|
|
3342
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3343
|
-
*/
|
|
3344
|
-
interval_count: number;
|
|
3345
|
-
}
|
|
3346
|
-
|
|
3347
|
-
namespace Duration {
|
|
3348
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3349
|
-
}
|
|
3350
|
-
|
|
3351
|
-
type Type = 'duration' | 'timestamp';
|
|
3352
|
-
}
|
|
3353
|
-
}
|
|
3354
|
-
|
|
3355
|
-
interface Trial {
|
|
3356
|
-
/**
|
|
3357
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
3358
|
-
*/
|
|
3359
|
-
converts_to?: Array<string>;
|
|
3360
|
-
|
|
3361
|
-
/**
|
|
3362
|
-
* Determines the type of trial for this item.
|
|
3363
|
-
*/
|
|
3364
|
-
type: Trial.Type;
|
|
3365
|
-
}
|
|
3366
|
-
|
|
3367
|
-
namespace Trial {
|
|
3368
|
-
type Type = 'free' | 'paid';
|
|
3369
|
-
}
|
|
3370
|
-
}
|
|
3371
|
-
|
|
3372
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3373
|
-
}
|
|
3374
|
-
|
|
3375
|
-
interface MetadataAction {
|
|
3376
|
-
/**
|
|
3377
|
-
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3378
|
-
*/
|
|
3379
|
-
add?: {
|
|
3380
|
-
[key: string]: string;
|
|
3381
|
-
};
|
|
3382
|
-
|
|
3383
|
-
/**
|
|
3384
|
-
* Keys to remove from schedule phase metadata.
|
|
3385
|
-
*/
|
|
3386
|
-
remove?: Array<string>;
|
|
3387
|
-
|
|
3388
|
-
/**
|
|
3389
|
-
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3390
|
-
*/
|
|
3391
|
-
set?: Stripe.Emptyable<{
|
|
3392
|
-
[key: string]: string;
|
|
3393
|
-
}>;
|
|
3394
|
-
|
|
3395
|
-
/**
|
|
3396
|
-
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3397
|
-
*/
|
|
3398
|
-
type: MetadataAction.Type;
|
|
3399
|
-
}
|
|
3400
|
-
|
|
3401
|
-
namespace MetadataAction {
|
|
3402
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3403
|
-
}
|
|
3404
|
-
|
|
3405
|
-
type ProrationBehavior =
|
|
3406
|
-
| 'always_invoice'
|
|
3407
|
-
| 'create_prorations'
|
|
3408
|
-
| 'none';
|
|
3409
|
-
|
|
3410
|
-
interface SetPauseCollection {
|
|
3411
|
-
/**
|
|
3412
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
3413
|
-
*/
|
|
3414
|
-
set?: SetPauseCollection.Set;
|
|
3415
|
-
|
|
3416
|
-
/**
|
|
3417
|
-
* Determines the type of the pause_collection amendment.
|
|
3418
|
-
*/
|
|
3419
|
-
type: SetPauseCollection.Type;
|
|
3420
|
-
}
|
|
3421
|
-
|
|
3422
|
-
namespace SetPauseCollection {
|
|
3423
|
-
interface Set {
|
|
3424
|
-
/**
|
|
3425
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
3426
|
-
*/
|
|
3427
|
-
behavior: Set.Behavior;
|
|
3428
|
-
}
|
|
3429
|
-
|
|
3430
|
-
namespace Set {
|
|
3431
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3432
|
-
}
|
|
3433
|
-
|
|
3434
|
-
type Type = 'remove' | 'set';
|
|
3435
|
-
}
|
|
3436
|
-
|
|
3437
|
-
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3438
|
-
|
|
3439
|
-
interface TrialSettings {
|
|
3440
|
-
/**
|
|
3441
|
-
* Defines how the subscription should behave when a trial ends.
|
|
3442
|
-
*/
|
|
3443
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
3444
|
-
}
|
|
3445
|
-
|
|
3446
|
-
namespace TrialSettings {
|
|
3447
|
-
interface EndBehavior {
|
|
3448
|
-
/**
|
|
3449
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3450
|
-
*/
|
|
3451
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3452
|
-
}
|
|
3453
|
-
|
|
3454
|
-
namespace EndBehavior {
|
|
3455
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
3456
|
-
}
|
|
3457
|
-
}
|
|
3458
|
-
}
|
|
3459
|
-
|
|
3460
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3461
|
-
|
|
3462
2331
|
interface BillingMode {
|
|
3463
2332
|
/**
|
|
3464
2333
|
* Configure behavior for flexible billing mode.
|
|
@@ -3486,80 +2355,6 @@ declare module 'stripe' {
|
|
|
3486
2355
|
type Type = 'classic' | 'flexible';
|
|
3487
2356
|
}
|
|
3488
2357
|
|
|
3489
|
-
interface BillingSchedule {
|
|
3490
|
-
/**
|
|
3491
|
-
* Configure billing schedule differently for individual subscription items.
|
|
3492
|
-
*/
|
|
3493
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
3494
|
-
|
|
3495
|
-
/**
|
|
3496
|
-
* The end date for the billing schedule.
|
|
3497
|
-
*/
|
|
3498
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
3499
|
-
|
|
3500
|
-
/**
|
|
3501
|
-
* Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
3502
|
-
*/
|
|
3503
|
-
key?: string;
|
|
3504
|
-
}
|
|
3505
|
-
|
|
3506
|
-
namespace BillingSchedule {
|
|
3507
|
-
interface AppliesTo {
|
|
3508
|
-
/**
|
|
3509
|
-
* The ID of the price object.
|
|
3510
|
-
*/
|
|
3511
|
-
price?: string;
|
|
3512
|
-
|
|
3513
|
-
/**
|
|
3514
|
-
* Controls which subscription items the billing schedule applies to.
|
|
3515
|
-
*/
|
|
3516
|
-
type: 'price';
|
|
3517
|
-
}
|
|
3518
|
-
|
|
3519
|
-
interface BillUntil {
|
|
3520
|
-
/**
|
|
3521
|
-
* Specifies the billing period.
|
|
3522
|
-
*/
|
|
3523
|
-
duration?: BillUntil.Duration;
|
|
3524
|
-
|
|
3525
|
-
/**
|
|
3526
|
-
* The end date of the billing schedule.
|
|
3527
|
-
*/
|
|
3528
|
-
timestamp?: number;
|
|
3529
|
-
|
|
3530
|
-
/**
|
|
3531
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
3532
|
-
*/
|
|
3533
|
-
type: BillUntil.Type;
|
|
3534
|
-
}
|
|
3535
|
-
|
|
3536
|
-
namespace BillUntil {
|
|
3537
|
-
interface Duration {
|
|
3538
|
-
/**
|
|
3539
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
3540
|
-
*/
|
|
3541
|
-
interval: Duration.Interval;
|
|
3542
|
-
|
|
3543
|
-
/**
|
|
3544
|
-
* The multiplier applied to the interval.
|
|
3545
|
-
*/
|
|
3546
|
-
interval_count?: number;
|
|
3547
|
-
}
|
|
3548
|
-
|
|
3549
|
-
namespace Duration {
|
|
3550
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3551
|
-
}
|
|
3552
|
-
|
|
3553
|
-
type Type =
|
|
3554
|
-
| 'amendment_end'
|
|
3555
|
-
| 'duration'
|
|
3556
|
-
| 'line_ends_at'
|
|
3557
|
-
| 'schedule_end'
|
|
3558
|
-
| 'timestamp'
|
|
3559
|
-
| 'upcoming_invoice';
|
|
3560
|
-
}
|
|
3561
|
-
}
|
|
3562
|
-
|
|
3563
2358
|
type EndBehavior = 'cancel' | 'release';
|
|
3564
2359
|
|
|
3565
2360
|
interface Phase {
|
|
@@ -3648,11 +2443,6 @@ declare module 'stripe' {
|
|
|
3648
2443
|
*/
|
|
3649
2444
|
on_behalf_of?: string;
|
|
3650
2445
|
|
|
3651
|
-
/**
|
|
3652
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
|
3653
|
-
*/
|
|
3654
|
-
pause_collection?: Phase.PauseCollection;
|
|
3655
|
-
|
|
3656
2446
|
/**
|
|
3657
2447
|
* Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
3658
2448
|
*/
|
|
@@ -3673,20 +2463,10 @@ declare module 'stripe' {
|
|
|
3673
2463
|
*/
|
|
3674
2464
|
trial?: boolean;
|
|
3675
2465
|
|
|
3676
|
-
/**
|
|
3677
|
-
* Specify trial behavior when crossing phase boundaries
|
|
3678
|
-
*/
|
|
3679
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
3680
|
-
|
|
3681
2466
|
/**
|
|
3682
2467
|
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
|
3683
2468
|
*/
|
|
3684
2469
|
trial_end?: number | 'now';
|
|
3685
|
-
|
|
3686
|
-
/**
|
|
3687
|
-
* Settings related to subscription trials.
|
|
3688
|
-
*/
|
|
3689
|
-
trial_settings?: Phase.TrialSettings;
|
|
3690
2470
|
}
|
|
3691
2471
|
|
|
3692
2472
|
namespace Phase {
|
|
@@ -3739,54 +2519,10 @@ declare module 'stripe' {
|
|
|
3739
2519
|
*/
|
|
3740
2520
|
discount?: string;
|
|
3741
2521
|
|
|
3742
|
-
/**
|
|
3743
|
-
* Details to determine how long the discount should be applied for.
|
|
3744
|
-
*/
|
|
3745
|
-
discount_end?: Discount.DiscountEnd;
|
|
3746
|
-
|
|
3747
2522
|
/**
|
|
3748
2523
|
* ID of the promotion code to create a new discount for.
|
|
3749
|
-
*/
|
|
3750
|
-
promotion_code?: string;
|
|
3751
|
-
}
|
|
3752
|
-
|
|
3753
|
-
namespace Discount {
|
|
3754
|
-
interface DiscountEnd {
|
|
3755
|
-
/**
|
|
3756
|
-
* Time span for the redeemed discount.
|
|
3757
|
-
*/
|
|
3758
|
-
duration?: DiscountEnd.Duration;
|
|
3759
|
-
|
|
3760
|
-
/**
|
|
3761
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3762
|
-
*/
|
|
3763
|
-
timestamp?: number;
|
|
3764
|
-
|
|
3765
|
-
/**
|
|
3766
|
-
* The type of calculation made to determine when the discount ends.
|
|
3767
|
-
*/
|
|
3768
|
-
type: DiscountEnd.Type;
|
|
3769
|
-
}
|
|
3770
|
-
|
|
3771
|
-
namespace DiscountEnd {
|
|
3772
|
-
interface Duration {
|
|
3773
|
-
/**
|
|
3774
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3775
|
-
*/
|
|
3776
|
-
interval: Duration.Interval;
|
|
3777
|
-
|
|
3778
|
-
/**
|
|
3779
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3780
|
-
*/
|
|
3781
|
-
interval_count: number;
|
|
3782
|
-
}
|
|
3783
|
-
|
|
3784
|
-
namespace Duration {
|
|
3785
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3786
|
-
}
|
|
3787
|
-
|
|
3788
|
-
type Type = 'duration' | 'timestamp';
|
|
3789
|
-
}
|
|
2524
|
+
*/
|
|
2525
|
+
promotion_code?: string;
|
|
3790
2526
|
}
|
|
3791
2527
|
|
|
3792
2528
|
interface Period {
|
|
@@ -3927,56 +2663,12 @@ declare module 'stripe' {
|
|
|
3927
2663
|
*/
|
|
3928
2664
|
discount?: string;
|
|
3929
2665
|
|
|
3930
|
-
/**
|
|
3931
|
-
* Details to determine how long the discount should be applied for.
|
|
3932
|
-
*/
|
|
3933
|
-
discount_end?: Discount.DiscountEnd;
|
|
3934
|
-
|
|
3935
2666
|
/**
|
|
3936
2667
|
* ID of the promotion code to create a new discount for.
|
|
3937
2668
|
*/
|
|
3938
2669
|
promotion_code?: string;
|
|
3939
2670
|
}
|
|
3940
2671
|
|
|
3941
|
-
namespace Discount {
|
|
3942
|
-
interface DiscountEnd {
|
|
3943
|
-
/**
|
|
3944
|
-
* Time span for the redeemed discount.
|
|
3945
|
-
*/
|
|
3946
|
-
duration?: DiscountEnd.Duration;
|
|
3947
|
-
|
|
3948
|
-
/**
|
|
3949
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3950
|
-
*/
|
|
3951
|
-
timestamp?: number;
|
|
3952
|
-
|
|
3953
|
-
/**
|
|
3954
|
-
* The type of calculation made to determine when the discount ends.
|
|
3955
|
-
*/
|
|
3956
|
-
type: DiscountEnd.Type;
|
|
3957
|
-
}
|
|
3958
|
-
|
|
3959
|
-
namespace DiscountEnd {
|
|
3960
|
-
interface Duration {
|
|
3961
|
-
/**
|
|
3962
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3963
|
-
*/
|
|
3964
|
-
interval: Duration.Interval;
|
|
3965
|
-
|
|
3966
|
-
/**
|
|
3967
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3968
|
-
*/
|
|
3969
|
-
interval_count: number;
|
|
3970
|
-
}
|
|
3971
|
-
|
|
3972
|
-
namespace Duration {
|
|
3973
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3974
|
-
}
|
|
3975
|
-
|
|
3976
|
-
type Type = 'duration' | 'timestamp';
|
|
3977
|
-
}
|
|
3978
|
-
}
|
|
3979
|
-
|
|
3980
2672
|
interface Duration {
|
|
3981
2673
|
/**
|
|
3982
2674
|
* Specifies phase duration. Either `day`, `week`, `month` or `year`.
|
|
@@ -4068,11 +2760,6 @@ declare module 'stripe' {
|
|
|
4068
2760
|
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
4069
2761
|
*/
|
|
4070
2762
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
4071
|
-
|
|
4072
|
-
/**
|
|
4073
|
-
* Options that configure the trial on the subscription item.
|
|
4074
|
-
*/
|
|
4075
|
-
trial?: Item.Trial;
|
|
4076
2763
|
}
|
|
4077
2764
|
|
|
4078
2765
|
namespace Item {
|
|
@@ -4094,56 +2781,12 @@ declare module 'stripe' {
|
|
|
4094
2781
|
*/
|
|
4095
2782
|
discount?: string;
|
|
4096
2783
|
|
|
4097
|
-
/**
|
|
4098
|
-
* Details to determine how long the discount should be applied for.
|
|
4099
|
-
*/
|
|
4100
|
-
discount_end?: Discount.DiscountEnd;
|
|
4101
|
-
|
|
4102
2784
|
/**
|
|
4103
2785
|
* ID of the promotion code to create a new discount for.
|
|
4104
2786
|
*/
|
|
4105
2787
|
promotion_code?: string;
|
|
4106
2788
|
}
|
|
4107
2789
|
|
|
4108
|
-
namespace Discount {
|
|
4109
|
-
interface DiscountEnd {
|
|
4110
|
-
/**
|
|
4111
|
-
* Time span for the redeemed discount.
|
|
4112
|
-
*/
|
|
4113
|
-
duration?: DiscountEnd.Duration;
|
|
4114
|
-
|
|
4115
|
-
/**
|
|
4116
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4117
|
-
*/
|
|
4118
|
-
timestamp?: number;
|
|
4119
|
-
|
|
4120
|
-
/**
|
|
4121
|
-
* The type of calculation made to determine when the discount ends.
|
|
4122
|
-
*/
|
|
4123
|
-
type: DiscountEnd.Type;
|
|
4124
|
-
}
|
|
4125
|
-
|
|
4126
|
-
namespace DiscountEnd {
|
|
4127
|
-
interface Duration {
|
|
4128
|
-
/**
|
|
4129
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4130
|
-
*/
|
|
4131
|
-
interval: Duration.Interval;
|
|
4132
|
-
|
|
4133
|
-
/**
|
|
4134
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4135
|
-
*/
|
|
4136
|
-
interval_count: number;
|
|
4137
|
-
}
|
|
4138
|
-
|
|
4139
|
-
namespace Duration {
|
|
4140
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4141
|
-
}
|
|
4142
|
-
|
|
4143
|
-
type Type = 'duration' | 'timestamp';
|
|
4144
|
-
}
|
|
4145
|
-
}
|
|
4146
|
-
|
|
4147
2790
|
interface PriceData {
|
|
4148
2791
|
/**
|
|
4149
2792
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -4195,33 +2838,6 @@ declare module 'stripe' {
|
|
|
4195
2838
|
|
|
4196
2839
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
4197
2840
|
}
|
|
4198
|
-
|
|
4199
|
-
interface Trial {
|
|
4200
|
-
/**
|
|
4201
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
|
4202
|
-
*/
|
|
4203
|
-
converts_to?: Array<string>;
|
|
4204
|
-
|
|
4205
|
-
/**
|
|
4206
|
-
* Determines the type of trial for this item.
|
|
4207
|
-
*/
|
|
4208
|
-
type: Trial.Type;
|
|
4209
|
-
}
|
|
4210
|
-
|
|
4211
|
-
namespace Trial {
|
|
4212
|
-
type Type = 'free' | 'paid';
|
|
4213
|
-
}
|
|
4214
|
-
}
|
|
4215
|
-
|
|
4216
|
-
interface PauseCollection {
|
|
4217
|
-
/**
|
|
4218
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
4219
|
-
*/
|
|
4220
|
-
behavior: PauseCollection.Behavior;
|
|
4221
|
-
}
|
|
4222
|
-
|
|
4223
|
-
namespace PauseCollection {
|
|
4224
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
4225
2841
|
}
|
|
4226
2842
|
|
|
4227
2843
|
type ProrationBehavior =
|
|
@@ -4240,95 +2856,6 @@ declare module 'stripe' {
|
|
|
4240
2856
|
*/
|
|
4241
2857
|
destination: string;
|
|
4242
2858
|
}
|
|
4243
|
-
|
|
4244
|
-
type TrialContinuation = 'continue' | 'none';
|
|
4245
|
-
|
|
4246
|
-
interface TrialSettings {
|
|
4247
|
-
/**
|
|
4248
|
-
* Defines how the subscription should behave when a trial ends.
|
|
4249
|
-
*/
|
|
4250
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
4251
|
-
}
|
|
4252
|
-
|
|
4253
|
-
namespace TrialSettings {
|
|
4254
|
-
interface EndBehavior {
|
|
4255
|
-
/**
|
|
4256
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4257
|
-
*/
|
|
4258
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4259
|
-
}
|
|
4260
|
-
|
|
4261
|
-
namespace EndBehavior {
|
|
4262
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
4263
|
-
}
|
|
4264
|
-
}
|
|
4265
|
-
}
|
|
4266
|
-
|
|
4267
|
-
interface Prebilling {
|
|
4268
|
-
/**
|
|
4269
|
-
* The end of the prebilled time period.
|
|
4270
|
-
*/
|
|
4271
|
-
bill_until?: Prebilling.BillUntil;
|
|
4272
|
-
|
|
4273
|
-
/**
|
|
4274
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4275
|
-
*/
|
|
4276
|
-
iterations?: number;
|
|
4277
|
-
}
|
|
4278
|
-
|
|
4279
|
-
namespace Prebilling {
|
|
4280
|
-
interface BillUntil {
|
|
4281
|
-
/**
|
|
4282
|
-
* End the prebilled period when a specified amendment ends.
|
|
4283
|
-
*/
|
|
4284
|
-
amendment_end?: BillUntil.AmendmentEnd;
|
|
4285
|
-
|
|
4286
|
-
/**
|
|
4287
|
-
* Time span for prebilling, starting from `bill_from`.
|
|
4288
|
-
*/
|
|
4289
|
-
duration?: BillUntil.Duration;
|
|
4290
|
-
|
|
4291
|
-
/**
|
|
4292
|
-
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
4293
|
-
*/
|
|
4294
|
-
timestamp?: number;
|
|
4295
|
-
|
|
4296
|
-
/**
|
|
4297
|
-
* Select one of several ways to pass the `bill_until` value.
|
|
4298
|
-
*/
|
|
4299
|
-
type: BillUntil.Type;
|
|
4300
|
-
}
|
|
4301
|
-
|
|
4302
|
-
namespace BillUntil {
|
|
4303
|
-
interface AmendmentEnd {
|
|
4304
|
-
/**
|
|
4305
|
-
* The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
4306
|
-
*/
|
|
4307
|
-
index: number;
|
|
4308
|
-
}
|
|
4309
|
-
|
|
4310
|
-
interface Duration {
|
|
4311
|
-
/**
|
|
4312
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4313
|
-
*/
|
|
4314
|
-
interval: Duration.Interval;
|
|
4315
|
-
|
|
4316
|
-
/**
|
|
4317
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4318
|
-
*/
|
|
4319
|
-
interval_count: number;
|
|
4320
|
-
}
|
|
4321
|
-
|
|
4322
|
-
namespace Duration {
|
|
4323
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4324
|
-
}
|
|
4325
|
-
|
|
4326
|
-
type Type =
|
|
4327
|
-
| 'amendment_end'
|
|
4328
|
-
| 'duration'
|
|
4329
|
-
| 'schedule_end'
|
|
4330
|
-
| 'timestamp';
|
|
4331
|
-
}
|
|
4332
2859
|
}
|
|
4333
2860
|
|
|
4334
2861
|
type ProrationBehavior =
|
|
@@ -4348,13 +2875,6 @@ declare module 'stripe' {
|
|
|
4348
2875
|
*/
|
|
4349
2876
|
billing_mode?: SubscriptionDetails.BillingMode;
|
|
4350
2877
|
|
|
4351
|
-
/**
|
|
4352
|
-
* Sets the billing schedules for the subscription.
|
|
4353
|
-
*/
|
|
4354
|
-
billing_schedules?: Stripe.Emptyable<
|
|
4355
|
-
Array<SubscriptionDetails.BillingSchedule>
|
|
4356
|
-
>;
|
|
4357
|
-
|
|
4358
2878
|
/**
|
|
4359
2879
|
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
|
4360
2880
|
*/
|
|
@@ -4380,11 +2900,6 @@ declare module 'stripe' {
|
|
|
4380
2900
|
*/
|
|
4381
2901
|
items?: Array<SubscriptionDetails.Item>;
|
|
4382
2902
|
|
|
4383
|
-
/**
|
|
4384
|
-
* The pre-billing to apply to the subscription as a preview.
|
|
4385
|
-
*/
|
|
4386
|
-
prebilling?: SubscriptionDetails.Prebilling;
|
|
4387
|
-
|
|
4388
2903
|
/**
|
|
4389
2904
|
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
4390
2905
|
*/
|
|
@@ -4441,80 +2956,6 @@ declare module 'stripe' {
|
|
|
4441
2956
|
type Type = 'classic' | 'flexible';
|
|
4442
2957
|
}
|
|
4443
2958
|
|
|
4444
|
-
interface BillingSchedule {
|
|
4445
|
-
/**
|
|
4446
|
-
* Configure billing schedule differently for individual subscription items.
|
|
4447
|
-
*/
|
|
4448
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
4449
|
-
|
|
4450
|
-
/**
|
|
4451
|
-
* The end date for the billing schedule.
|
|
4452
|
-
*/
|
|
4453
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
4454
|
-
|
|
4455
|
-
/**
|
|
4456
|
-
* Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
4457
|
-
*/
|
|
4458
|
-
key?: string;
|
|
4459
|
-
}
|
|
4460
|
-
|
|
4461
|
-
namespace BillingSchedule {
|
|
4462
|
-
interface AppliesTo {
|
|
4463
|
-
/**
|
|
4464
|
-
* The ID of the price object.
|
|
4465
|
-
*/
|
|
4466
|
-
price?: string;
|
|
4467
|
-
|
|
4468
|
-
/**
|
|
4469
|
-
* Controls which subscription items the billing schedule applies to.
|
|
4470
|
-
*/
|
|
4471
|
-
type: 'price';
|
|
4472
|
-
}
|
|
4473
|
-
|
|
4474
|
-
interface BillUntil {
|
|
4475
|
-
/**
|
|
4476
|
-
* Specifies the billing period.
|
|
4477
|
-
*/
|
|
4478
|
-
duration?: BillUntil.Duration;
|
|
4479
|
-
|
|
4480
|
-
/**
|
|
4481
|
-
* The end date of the billing schedule.
|
|
4482
|
-
*/
|
|
4483
|
-
timestamp?: number;
|
|
4484
|
-
|
|
4485
|
-
/**
|
|
4486
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
4487
|
-
*/
|
|
4488
|
-
type: BillUntil.Type;
|
|
4489
|
-
}
|
|
4490
|
-
|
|
4491
|
-
namespace BillUntil {
|
|
4492
|
-
interface Duration {
|
|
4493
|
-
/**
|
|
4494
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
4495
|
-
*/
|
|
4496
|
-
interval: Duration.Interval;
|
|
4497
|
-
|
|
4498
|
-
/**
|
|
4499
|
-
* The multiplier applied to the interval.
|
|
4500
|
-
*/
|
|
4501
|
-
interval_count?: number;
|
|
4502
|
-
}
|
|
4503
|
-
|
|
4504
|
-
namespace Duration {
|
|
4505
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4506
|
-
}
|
|
4507
|
-
|
|
4508
|
-
type Type =
|
|
4509
|
-
| 'amendment_end'
|
|
4510
|
-
| 'duration'
|
|
4511
|
-
| 'line_ends_at'
|
|
4512
|
-
| 'schedule_end'
|
|
4513
|
-
| 'timestamp'
|
|
4514
|
-
| 'upcoming_invoice';
|
|
4515
|
-
}
|
|
4516
|
-
}
|
|
4517
|
-
|
|
4518
2959
|
type CancelAt = 'max_period_end' | 'min_period_end';
|
|
4519
2960
|
|
|
4520
2961
|
interface Item {
|
|
@@ -4593,56 +3034,12 @@ declare module 'stripe' {
|
|
|
4593
3034
|
*/
|
|
4594
3035
|
discount?: string;
|
|
4595
3036
|
|
|
4596
|
-
/**
|
|
4597
|
-
* Details to determine how long the discount should be applied for.
|
|
4598
|
-
*/
|
|
4599
|
-
discount_end?: Discount.DiscountEnd;
|
|
4600
|
-
|
|
4601
3037
|
/**
|
|
4602
3038
|
* ID of the promotion code to create a new discount for.
|
|
4603
3039
|
*/
|
|
4604
3040
|
promotion_code?: string;
|
|
4605
3041
|
}
|
|
4606
3042
|
|
|
4607
|
-
namespace Discount {
|
|
4608
|
-
interface DiscountEnd {
|
|
4609
|
-
/**
|
|
4610
|
-
* Time span for the redeemed discount.
|
|
4611
|
-
*/
|
|
4612
|
-
duration?: DiscountEnd.Duration;
|
|
4613
|
-
|
|
4614
|
-
/**
|
|
4615
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4616
|
-
*/
|
|
4617
|
-
timestamp?: number;
|
|
4618
|
-
|
|
4619
|
-
/**
|
|
4620
|
-
* The type of calculation made to determine when the discount ends.
|
|
4621
|
-
*/
|
|
4622
|
-
type: DiscountEnd.Type;
|
|
4623
|
-
}
|
|
4624
|
-
|
|
4625
|
-
namespace DiscountEnd {
|
|
4626
|
-
interface Duration {
|
|
4627
|
-
/**
|
|
4628
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4629
|
-
*/
|
|
4630
|
-
interval: Duration.Interval;
|
|
4631
|
-
|
|
4632
|
-
/**
|
|
4633
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4634
|
-
*/
|
|
4635
|
-
interval_count: number;
|
|
4636
|
-
}
|
|
4637
|
-
|
|
4638
|
-
namespace Duration {
|
|
4639
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4640
|
-
}
|
|
4641
|
-
|
|
4642
|
-
type Type = 'duration' | 'timestamp';
|
|
4643
|
-
}
|
|
4644
|
-
}
|
|
4645
|
-
|
|
4646
3043
|
interface PriceData {
|
|
4647
3044
|
/**
|
|
4648
3045
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -4696,13 +3093,6 @@ declare module 'stripe' {
|
|
|
4696
3093
|
}
|
|
4697
3094
|
}
|
|
4698
3095
|
|
|
4699
|
-
interface Prebilling {
|
|
4700
|
-
/**
|
|
4701
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4702
|
-
*/
|
|
4703
|
-
iterations: number;
|
|
4704
|
-
}
|
|
4705
|
-
|
|
4706
3096
|
type ProrationBehavior =
|
|
4707
3097
|
| 'always_invoice'
|
|
4708
3098
|
| 'create_prorations'
|
|
@@ -4887,11 +3277,6 @@ declare module 'stripe' {
|
|
|
4887
3277
|
*/
|
|
4888
3278
|
id: string;
|
|
4889
3279
|
|
|
4890
|
-
/**
|
|
4891
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
4892
|
-
*/
|
|
4893
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
4894
|
-
|
|
4895
3280
|
/**
|
|
4896
3281
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
4897
3282
|
*/
|
|
@@ -4940,56 +3325,12 @@ declare module 'stripe' {
|
|
|
4940
3325
|
*/
|
|
4941
3326
|
discount?: string;
|
|
4942
3327
|
|
|
4943
|
-
/**
|
|
4944
|
-
* Details to determine how long the discount should be applied for.
|
|
4945
|
-
*/
|
|
4946
|
-
discount_end?: Discount.DiscountEnd;
|
|
4947
|
-
|
|
4948
3328
|
/**
|
|
4949
3329
|
* ID of the promotion code to create a new discount for.
|
|
4950
3330
|
*/
|
|
4951
3331
|
promotion_code?: string;
|
|
4952
3332
|
}
|
|
4953
3333
|
|
|
4954
|
-
namespace Discount {
|
|
4955
|
-
interface DiscountEnd {
|
|
4956
|
-
/**
|
|
4957
|
-
* Time span for the redeemed discount.
|
|
4958
|
-
*/
|
|
4959
|
-
duration?: DiscountEnd.Duration;
|
|
4960
|
-
|
|
4961
|
-
/**
|
|
4962
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4963
|
-
*/
|
|
4964
|
-
timestamp?: number;
|
|
4965
|
-
|
|
4966
|
-
/**
|
|
4967
|
-
* The type of calculation made to determine when the discount ends.
|
|
4968
|
-
*/
|
|
4969
|
-
type: DiscountEnd.Type;
|
|
4970
|
-
}
|
|
4971
|
-
|
|
4972
|
-
namespace DiscountEnd {
|
|
4973
|
-
interface Duration {
|
|
4974
|
-
/**
|
|
4975
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4976
|
-
*/
|
|
4977
|
-
interval: Duration.Interval;
|
|
4978
|
-
|
|
4979
|
-
/**
|
|
4980
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4981
|
-
*/
|
|
4982
|
-
interval_count: number;
|
|
4983
|
-
}
|
|
4984
|
-
|
|
4985
|
-
namespace Duration {
|
|
4986
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4987
|
-
}
|
|
4988
|
-
|
|
4989
|
-
type Type = 'duration' | 'timestamp';
|
|
4990
|
-
}
|
|
4991
|
-
}
|
|
4992
|
-
|
|
4993
3334
|
interface Period {
|
|
4994
3335
|
/**
|
|
4995
3336
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -5221,11 +3562,6 @@ declare module 'stripe' {
|
|
|
5221
3562
|
*/
|
|
5222
3563
|
expand?: Array<string>;
|
|
5223
3564
|
|
|
5224
|
-
/**
|
|
5225
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
5226
|
-
*/
|
|
5227
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
5228
|
-
|
|
5229
3565
|
/**
|
|
5230
3566
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
5231
3567
|
*/
|
|
@@ -5276,56 +3612,12 @@ declare module 'stripe' {
|
|
|
5276
3612
|
*/
|
|
5277
3613
|
discount?: string;
|
|
5278
3614
|
|
|
5279
|
-
/**
|
|
5280
|
-
* Details to determine how long the discount should be applied for.
|
|
5281
|
-
*/
|
|
5282
|
-
discount_end?: Discount.DiscountEnd;
|
|
5283
|
-
|
|
5284
3615
|
/**
|
|
5285
3616
|
* ID of the promotion code to create a new discount for.
|
|
5286
3617
|
*/
|
|
5287
3618
|
promotion_code?: string;
|
|
5288
3619
|
}
|
|
5289
3620
|
|
|
5290
|
-
namespace Discount {
|
|
5291
|
-
interface DiscountEnd {
|
|
5292
|
-
/**
|
|
5293
|
-
* Time span for the redeemed discount.
|
|
5294
|
-
*/
|
|
5295
|
-
duration?: DiscountEnd.Duration;
|
|
5296
|
-
|
|
5297
|
-
/**
|
|
5298
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5299
|
-
*/
|
|
5300
|
-
timestamp?: number;
|
|
5301
|
-
|
|
5302
|
-
/**
|
|
5303
|
-
* The type of calculation made to determine when the discount ends.
|
|
5304
|
-
*/
|
|
5305
|
-
type: DiscountEnd.Type;
|
|
5306
|
-
}
|
|
5307
|
-
|
|
5308
|
-
namespace DiscountEnd {
|
|
5309
|
-
interface Duration {
|
|
5310
|
-
/**
|
|
5311
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5312
|
-
*/
|
|
5313
|
-
interval: Duration.Interval;
|
|
5314
|
-
|
|
5315
|
-
/**
|
|
5316
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5317
|
-
*/
|
|
5318
|
-
interval_count: number;
|
|
5319
|
-
}
|
|
5320
|
-
|
|
5321
|
-
namespace Duration {
|
|
5322
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5323
|
-
}
|
|
5324
|
-
|
|
5325
|
-
type Type = 'duration' | 'timestamp';
|
|
5326
|
-
}
|
|
5327
|
-
}
|
|
5328
|
-
|
|
5329
3621
|
interface Period {
|
|
5330
3622
|
/**
|
|
5331
3623
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|