stripe 22.1.0 → 22.2.0-alpha.2
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 +2637 -11
- package/OPENAPI_VERSION +1 -1
- package/README.md +57 -65
- package/VERSION +1 -1
- package/cjs/Error.d.ts +53 -0
- package/cjs/Error.js +134 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/Types.d.ts +4 -2
- package/cjs/apiVersion.d.ts +1 -2
- package/cjs/apiVersion.js +2 -3
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +5 -1
- package/cjs/resources/AccountNotices.d.ts +140 -0
- package/cjs/resources/AccountNotices.js +29 -0
- package/cjs/resources/AccountNotices.js.map +1 -0
- package/cjs/resources/AccountSessions.d.ts +463 -0
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/AccountSignals.d.ts +110 -0
- package/cjs/resources/AccountSignals.js +4 -0
- package/cjs/resources/AccountSignals.js.map +1 -0
- package/cjs/resources/Accounts.d.ts +955 -3
- package/cjs/resources/Accounts.js +21 -0
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplicationFees.d.ts +28 -1
- package/cjs/resources/Balance.d.ts +134 -0
- package/cjs/resources/BalanceSettings.d.ts +18 -0
- package/cjs/resources/BalanceTransactions.d.ts +1 -1
- package/cjs/resources/BalanceTransfers.d.ts +160 -0
- package/cjs/resources/BalanceTransfers.js +15 -0
- package/cjs/resources/BalanceTransfers.js.map +1 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertRecovereds.d.ts +40 -0
- package/cjs/resources/Billing/AlertRecovereds.js +4 -0
- package/cjs/resources/Billing/AlertRecovereds.js.map +1 -0
- package/cjs/resources/Billing/AlertTriggereds.d.ts +57 -1
- package/cjs/resources/Billing/Alerts.d.ts +406 -5
- package/cjs/resources/Billing/Alerts.js +321 -5
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
- package/cjs/resources/Billing/Analytics/index.js +13 -0
- package/cjs/resources/Billing/Analytics/index.js.map +1 -0
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +126 -2
- package/cjs/resources/Billing/CreditBalanceSummary.js +39 -1
- package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/cjs/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/cjs/resources/Billing/CreditGrants.d.ts +85 -3
- package/cjs/resources/Billing/CreditGrants.js +134 -5
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/cjs/resources/Billing/Meters.d.ts +31 -0
- package/cjs/resources/Billing/index.d.ts +6 -0
- package/cjs/resources/Billing/index.js +2 -0
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/Capabilities.d.ts +2 -2
- package/cjs/resources/Capital/FinancingOffers.d.ts +191 -0
- package/cjs/resources/Capital/FinancingOffers.js +30 -0
- package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/Capital/FinancingSummary.d.ts +98 -0
- package/cjs/resources/Capital/FinancingSummary.js +15 -0
- package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
- package/cjs/resources/Capital/FinancingTransactions.d.ts +143 -0
- package/cjs/resources/Capital/FinancingTransactions.js +24 -0
- package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
- package/cjs/resources/Capital/index.d.ts +25 -0
- package/cjs/resources/Capital/index.js +17 -0
- package/cjs/resources/Capital/index.js.map +1 -0
- package/cjs/resources/Cards.d.ts +15 -0
- package/cjs/resources/Charges.d.ts +3513 -70
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +792 -9
- package/cjs/resources/Checkout/Sessions.js +88 -0
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -0
- package/cjs/resources/ConfirmationTokens.d.ts +100 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +110 -2
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +7 -1
- package/cjs/resources/CreditNotes.js +14 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/CustomerSessions.d.ts +68 -0
- package/cjs/resources/Customers.d.ts +7 -1
- package/cjs/resources/Customers.js +15 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1280 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +39 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/index.d.ts +16 -0
- package/cjs/resources/DelegatedCheckout/index.js +13 -0
- package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
- package/cjs/resources/Discounts.d.ts +19 -0
- package/cjs/resources/Disputes.d.ts +37 -0
- package/cjs/resources/Events.d.ts +560 -2
- package/cjs/resources/ExternalAccounts.d.ts +212 -1
- package/cjs/resources/ExternalAccounts.js +44 -0
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/cjs/resources/FinancialConnections/Accounts.d.ts +74 -4
- package/cjs/resources/FinancialConnections/Accounts.js +8 -0
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +87 -0
- package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
- package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/cjs/resources/FinancialConnections/Institutions.d.ts +101 -0
- package/cjs/resources/FinancialConnections/Institutions.js +23 -0
- package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
- package/cjs/resources/FinancialConnections/Sessions.d.ts +155 -7
- package/cjs/resources/FinancialConnections/index.d.ts +21 -6
- package/cjs/resources/FinancialConnections/index.js +4 -0
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/FrMealVouchersOnboardings.d.ts +173 -0
- package/cjs/resources/FrMealVouchersOnboardings.js +42 -0
- package/cjs/resources/FrMealVouchersOnboardings.js.map +1 -0
- package/cjs/resources/FxQuotes.d.ts +212 -0
- package/cjs/resources/FxQuotes.js +29 -0
- package/cjs/resources/FxQuotes.js.map +1 -0
- package/cjs/resources/Identity/BlocklistEntries.d.ts +157 -0
- package/cjs/resources/Identity/BlocklistEntries.js +54 -0
- package/cjs/resources/Identity/BlocklistEntries.js.map +1 -0
- package/cjs/resources/Identity/VerificationReports.d.ts +33 -2
- package/cjs/resources/Identity/VerificationReports.js.map +1 -1
- package/cjs/resources/Identity/VerificationSessions.d.ts +11 -3
- package/cjs/resources/Identity/index.d.ts +18 -10
- package/cjs/resources/Identity/index.js +2 -0
- package/cjs/resources/Identity/index.js.map +1 -1
- package/cjs/resources/InvoiceItems.d.ts +185 -2
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +174 -4
- package/cjs/resources/Invoices.d.ts +2024 -35
- package/cjs/resources/Invoices.js +70 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +255 -0
- package/cjs/resources/Issuing/Cardholders.d.ts +5 -4
- package/cjs/resources/Issuing/Cards.d.ts +36 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +47 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/cjs/resources/Issuing/Disputes.d.ts +140 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/cjs/resources/Issuing/Programs.d.ts +95 -0
- package/cjs/resources/Issuing/Programs.js +35 -0
- package/cjs/resources/Issuing/Programs.js.map +1 -0
- package/cjs/resources/Issuing/Settlements.d.ts +85 -0
- package/cjs/resources/Issuing/Settlements.js +4 -0
- package/cjs/resources/Issuing/Settlements.js.map +1 -0
- package/cjs/resources/Issuing/Transactions.d.ts +157 -0
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +55 -22
- package/cjs/resources/Issuing/index.js +8 -0
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +29 -2
- package/cjs/resources/Mandates.d.ts +33 -1
- package/cjs/resources/Mandates.js +8 -0
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/Margins.d.ts +115 -0
- package/cjs/resources/Margins.js +35 -0
- package/cjs/resources/Margins.js.map +1 -0
- package/cjs/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js +15 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/cjs/resources/Orchestration/index.d.ts +12 -0
- package/cjs/resources/Orchestration/index.js +13 -0
- package/cjs/resources/Orchestration/index.js.map +1 -0
- package/cjs/resources/Orders.d.ts +4761 -0
- package/cjs/resources/Orders.js +457 -0
- package/cjs/resources/Orders.js.map +1 -0
- package/cjs/resources/PaymentAttemptRecords.d.ts +441 -1
- package/cjs/resources/PaymentAttemptRecords.js +42 -0
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
- package/cjs/resources/PaymentIntents.d.ts +16370 -3527
- package/cjs/resources/PaymentIntents.js +40 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +74 -12
- package/cjs/resources/PaymentMethodBalances.d.ts +46 -0
- package/cjs/resources/PaymentMethodBalances.js +4 -0
- package/cjs/resources/PaymentMethodBalances.js.map +1 -0
- package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/cjs/resources/PaymentMethods.d.ts +216 -3
- package/cjs/resources/PaymentMethods.js +6 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +323 -21
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Persons.d.ts +24 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +64 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/cjs/resources/Privacy/RedactionJobs.d.ts +229 -0
- package/cjs/resources/Privacy/RedactionJobs.js +73 -0
- package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
- package/cjs/resources/Privacy/index.d.ts +22 -0
- package/cjs/resources/Privacy/index.js +13 -0
- package/cjs/resources/Privacy/index.js.map +1 -0
- package/cjs/resources/ProductCatalog/TrialOffers.d.ts +127 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/cjs/resources/ProductCatalog/index.d.ts +12 -0
- package/cjs/resources/ProductCatalog/index.js +13 -0
- package/cjs/resources/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/Products.d.ts +141 -0
- package/cjs/resources/Profiles.d.ts +26 -0
- package/cjs/resources/Profiles.js +4 -0
- package/cjs/resources/Profiles.js.map +1 -0
- package/cjs/resources/PromotionCodes.d.ts +12 -0
- package/cjs/resources/PromotionCodes.js +28 -0
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/QuoteLines.d.ts +684 -0
- package/cjs/resources/QuoteLines.js +4 -0
- package/cjs/resources/QuoteLines.js.map +1 -0
- package/cjs/resources/QuotePreviewInvoices.d.ts +1153 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +897 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +3548 -254
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +270 -0
- package/cjs/resources/Radar/AccountEvaluations.js +27 -0
- package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
- package/cjs/resources/Radar/CustomerEvaluations.d.ts +242 -0
- package/cjs/resources/Radar/CustomerEvaluations.js +21 -0
- package/cjs/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.d.ts +435 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js +15 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +63 -1
- package/cjs/resources/Radar/index.d.ts +34 -16
- package/cjs/resources/Radar/index.js +6 -0
- package/cjs/resources/Radar/index.js.map +1 -1
- package/cjs/resources/Refunds.d.ts +11 -0
- package/cjs/resources/Reserve/Holds.d.ts +53 -1
- package/cjs/resources/Reserve/Holds.js +19 -0
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +16 -0
- package/cjs/resources/Reserve/Plans.js +11 -0
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +41 -1
- package/cjs/resources/Reserve/Releases.js +19 -0
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +14 -3
- package/cjs/resources/Reserve/index.js +10 -2
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/RiskSignals.d.ts +10 -0
- package/cjs/resources/RiskSignals.js +4 -0
- package/cjs/resources/RiskSignals.js.map +1 -0
- package/cjs/resources/SetupAttempts.d.ts +26 -1
- package/cjs/resources/SetupIntents.d.ts +491 -11
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1101 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/IssuedTokens.d.ts +322 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/index.d.ts +19 -0
- package/cjs/resources/SharedPayment/index.js +15 -0
- package/cjs/resources/SharedPayment/index.js.map +1 -0
- package/cjs/resources/Sources.d.ts +16 -1
- package/cjs/resources/SubscriptionItems.d.ts +251 -0
- package/cjs/resources/SubscriptionSchedules.d.ts +1943 -19
- package/cjs/resources/SubscriptionSchedules.js +48 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +1040 -16
- package/cjs/resources/Subscriptions.js +236 -1
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -2
- package/cjs/resources/Tax/Calculations.d.ts +7 -3
- package/cjs/resources/Tax/Forms.d.ts +230 -0
- package/cjs/resources/Tax/Forms.js +32 -0
- package/cjs/resources/Tax/Forms.js.map +1 -0
- package/cjs/resources/Tax/Locations.d.ts +108 -0
- package/cjs/resources/Tax/Locations.js +33 -0
- package/cjs/resources/Tax/Locations.js.map +1 -0
- package/cjs/resources/Tax/Registrations.d.ts +155 -2
- package/cjs/resources/Tax/Transactions.d.ts +2 -2
- package/cjs/resources/Tax/index.d.ts +27 -13
- package/cjs/resources/Tax/index.js +4 -0
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +15 -0
- package/cjs/resources/Terminal/Configurations.d.ts +27 -0
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +52 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/cjs/resources/Terminal/Readers.d.ts +51 -1
- package/cjs/resources/Terminal/index.d.ts +5 -0
- package/cjs/resources/Terminal/index.js +2 -0
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/Capital/index.js +13 -0
- package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
- package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
- package/cjs/resources/TestHelpers/PaymentIntents.d.ts +36 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js +15 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/cjs/resources/TestHelpers/index.d.ts +14 -6
- package/cjs/resources/TestHelpers/index.js +12 -6
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Tokens.d.ts +56 -0
- package/cjs/resources/Transfers.d.ts +12 -0
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/TransitBalances.d.ts +25 -0
- package/cjs/resources/TransitBalances.js +4 -0
- package/cjs/resources/TransitBalances.js.map +1 -0
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings.d.ts +284 -0
- package/cjs/resources/V2/Billing/BillSettings.js +41 -0
- package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.d.ts +88 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js +4 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js +23 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences.d.ts +1015 -0
- package/cjs/resources/V2/Billing/Cadences.js +264 -0
- package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings.d.ts +779 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +35 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/cjs/resources/V2/Billing/IntentActions.d.ts +607 -0
- package/cjs/resources/V2/Billing/IntentActions.js +4 -0
- package/cjs/resources/V2/Billing/IntentActions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +70 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents.d.ts +1257 -0
- package/cjs/resources/V2/Billing/Intents.js +87 -0
- package/cjs/resources/V2/Billing/Intents.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.d.ts +82 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js +4 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +64 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees.d.ts +378 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +148 -0
- package/cjs/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/cjs/resources/V2/Billing/LicensedItems.d.ts +174 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +35 -0
- package/cjs/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/cjs/resources/V2/Billing/MeterEventAdjustments.d.ts +5 -5
- package/cjs/resources/V2/Billing/MeterEventSession.d.ts +4 -4
- package/cjs/resources/V2/Billing/MeterEventSession.js +1 -1
- package/cjs/resources/V2/Billing/MeteredItems.d.ts +222 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +35 -0
- package/cjs/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/cjs/resources/V2/Billing/OneTimeItems.d.ts +174 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js +35 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.d.ts +84 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.d.ts +624 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +296 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +41 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +23 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans.d.ts +177 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +43 -0
- package/cjs/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/cjs/resources/V2/Billing/Profiles.d.ts +166 -0
- package/cjs/resources/V2/Billing/Profiles.js +35 -0
- package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardRates.d.ts +115 -0
- package/cjs/resources/V2/Billing/RateCardRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.d.ts +219 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +41 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js +4 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +35 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +110 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +23 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards.d.ts +357 -0
- package/cjs/resources/V2/Billing/RateCards.js +76 -0
- package/cjs/resources/V2/Billing/RateCards.js.map +1 -0
- package/cjs/resources/V2/Billing/ServiceActions.d.ts +514 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +162 -0
- package/cjs/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/cjs/resources/V2/Billing/index.d.ts +161 -6
- package/cjs/resources/V2/Billing/index.js +30 -0
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.d.ts +99 -0
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js +156 -0
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -0
- package/cjs/resources/V2/Commerce/ProductCatalog/index.d.ts +8 -0
- package/cjs/resources/V2/Commerce/ProductCatalog/index.js +13 -0
- package/cjs/resources/V2/Commerce/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/V2/Commerce/ProductCatalogImports.d.ts +183 -0
- package/cjs/resources/V2/Commerce/ProductCatalogImports.js +4 -0
- package/cjs/resources/V2/Commerce/ProductCatalogImports.js.map +1 -0
- package/cjs/resources/V2/Commerce/index.d.ts +13 -0
- package/cjs/resources/V2/Commerce/index.js +13 -0
- package/cjs/resources/V2/Commerce/index.js.map +1 -0
- package/cjs/resources/V2/Core/AccountEvaluations.d.ts +160 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js +15 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/cjs/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/cjs/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/cjs/resources/V2/Core/AccountTokens.d.ts +222 -4
- package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +3 -2
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js +2 -1
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts.d.ts +5319 -75
- package/cjs/resources/V2/Core/Accounts.js +1 -1
- package/cjs/resources/V2/Core/ApprovalRequests.d.ts +334 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js +46 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/cjs/resources/V2/Core/BatchJobs.d.ts +373 -0
- package/cjs/resources/V2/Core/BatchJobs.js +225 -0
- package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.d.ts +229 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +31 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/cjs/resources/V2/Core/ConnectionSessions.d.ts +90 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js +21 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/cjs/resources/V2/Core/EventDestinations.d.ts +50 -3
- package/cjs/resources/V2/Core/Events.d.ts +7325 -204
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +62 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
- package/cjs/resources/V2/Core/Vault/index.js +15 -0
- package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
- package/cjs/resources/V2/Core/index.d.ts +51 -14
- package/cjs/resources/V2/Core/index.js +12 -0
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js +36 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.d.ts +82 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js +4 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/cjs/resources/V2/Data/Analytics/index.js +13 -0
- package/cjs/resources/V2/Data/Analytics/index.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Data/index.d.ts +13 -0
- package/cjs/resources/V2/Data/index.js +15 -0
- package/cjs/resources/V2/Data/index.js.map +1 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/cjs/resources/V2/Extend/Workflows.d.ts +123 -0
- package/cjs/resources/V2/Extend/Workflows.js +30 -0
- package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
- package/cjs/resources/V2/Extend/index.d.ts +20 -0
- package/cjs/resources/V2/Extend/index.js +15 -0
- package/cjs/resources/V2/Extend/index.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/cjs/resources/V2/Iam/ActivityLogs.d.ts +204 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js +17 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/cjs/resources/V2/Iam/ApiKeys.d.ts +280 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +47 -0
- package/cjs/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/cjs/resources/V2/Iam/index.d.ts +22 -0
- package/cjs/resources/V2/Iam/index.js +15 -0
- package/cjs/resources/V2/Iam/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +139 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.d.ts +135 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +31 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +412 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +44 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +308 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +524 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +320 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +342 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +270 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +451 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +237 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.d.ts +120 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +27 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +245 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +276 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +118 -0
- package/cjs/resources/V2/MoneyManagement/index.js +43 -0
- package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +96 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/cjs/resources/V2/Network/index.d.ts +13 -0
- package/cjs/resources/V2/Network/index.js +13 -0
- package/cjs/resources/V2/Network/index.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.d.ts +827 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +53 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +77 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js +4 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +35 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.d.ts +213 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +53 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/cjs/resources/V2/Payments/index.d.ts +31 -0
- package/cjs/resources/V2/Payments/index.js +15 -0
- package/cjs/resources/V2/Payments/index.js.map +1 -0
- package/cjs/resources/V2/Reporting/ReportRuns.d.ts +173 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js +50 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/cjs/resources/V2/Reporting/Reports.d.ts +110 -0
- package/cjs/resources/V2/Reporting/Reports.js +17 -0
- package/cjs/resources/V2/Reporting/Reports.js.map +1 -0
- package/cjs/resources/V2/Reporting/index.d.ts +18 -0
- package/cjs/resources/V2/Reporting/index.js +15 -0
- package/cjs/resources/V2/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Tax/ManualRules.d.ts +335 -0
- package/cjs/resources/V2/Tax/ManualRules.js +193 -0
- package/cjs/resources/V2/Tax/ManualRules.js.map +1 -0
- package/cjs/resources/V2/Tax/index.d.ts +16 -0
- package/cjs/resources/V2/Tax/index.js +13 -0
- package/cjs/resources/V2/Tax/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +15 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/index.d.ts +10 -0
- package/cjs/resources/V2/TestHelpers/index.js +15 -0
- package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/index.d.ts +39 -0
- package/cjs/resources/V2/index.js +24 -2
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +2 -2
- package/cjs/resources.d.ts +14 -0
- package/cjs/resources.js +240 -12
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.core.d.ts +84 -28
- package/cjs/stripe.core.js +59 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +53 -0
- package/esm/Error.js +117 -0
- package/esm/Error.js.map +1 -1
- package/esm/Types.d.ts +4 -2
- package/esm/apiVersion.d.ts +1 -2
- package/esm/apiVersion.js +1 -2
- package/esm/apiVersion.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +5 -1
- package/esm/resources/AccountNotices.d.ts +140 -0
- package/esm/resources/AccountNotices.js +25 -0
- package/esm/resources/AccountNotices.js.map +1 -0
- package/esm/resources/AccountSessions.d.ts +463 -0
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/AccountSignals.d.ts +110 -0
- package/esm/resources/AccountSignals.js +3 -0
- package/esm/resources/AccountSignals.js.map +1 -0
- package/esm/resources/Accounts.d.ts +955 -3
- package/esm/resources/Accounts.js +21 -0
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplicationFees.d.ts +28 -1
- package/esm/resources/Balance.d.ts +134 -0
- package/esm/resources/BalanceSettings.d.ts +18 -0
- package/esm/resources/BalanceTransactions.d.ts +1 -1
- package/esm/resources/BalanceTransfers.d.ts +160 -0
- package/esm/resources/BalanceTransfers.js +11 -0
- package/esm/resources/BalanceTransfers.js.map +1 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertRecovereds.d.ts +40 -0
- package/esm/resources/Billing/AlertRecovereds.js +3 -0
- package/esm/resources/Billing/AlertRecovereds.js.map +1 -0
- package/esm/resources/Billing/AlertTriggereds.d.ts +57 -1
- package/esm/resources/Billing/Alerts.d.ts +406 -5
- package/esm/resources/Billing/Alerts.js +321 -5
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/esm/resources/Billing/Analytics/index.d.ts +15 -0
- package/esm/resources/Billing/Analytics/index.js +9 -0
- package/esm/resources/Billing/Analytics/index.js.map +1 -0
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +126 -2
- package/esm/resources/Billing/CreditBalanceSummary.js +39 -1
- package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/esm/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/esm/resources/Billing/CreditGrants.d.ts +85 -3
- package/esm/resources/Billing/CreditGrants.js +134 -5
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/esm/resources/Billing/Meters.d.ts +31 -0
- package/esm/resources/Billing/index.d.ts +6 -0
- package/esm/resources/Billing/index.js +2 -0
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/Capabilities.d.ts +2 -2
- package/esm/resources/Capital/FinancingOffers.d.ts +191 -0
- package/esm/resources/Capital/FinancingOffers.js +26 -0
- package/esm/resources/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/Capital/FinancingSummary.d.ts +98 -0
- package/esm/resources/Capital/FinancingSummary.js +11 -0
- package/esm/resources/Capital/FinancingSummary.js.map +1 -0
- package/esm/resources/Capital/FinancingTransactions.d.ts +143 -0
- package/esm/resources/Capital/FinancingTransactions.js +20 -0
- package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
- package/esm/resources/Capital/index.d.ts +25 -0
- package/esm/resources/Capital/index.js +13 -0
- package/esm/resources/Capital/index.js.map +1 -0
- package/esm/resources/Cards.d.ts +15 -0
- package/esm/resources/Charges.d.ts +3513 -70
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +792 -9
- package/esm/resources/Checkout/Sessions.js +88 -0
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -0
- package/esm/resources/ConfirmationTokens.d.ts +100 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/Coupons.d.ts +110 -2
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +7 -1
- package/esm/resources/CreditNotes.js +14 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/CustomerSessions.d.ts +68 -0
- package/esm/resources/Customers.d.ts +7 -1
- package/esm/resources/Customers.js +15 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1280 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +35 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/esm/resources/DelegatedCheckout/index.d.ts +16 -0
- package/esm/resources/DelegatedCheckout/index.js +9 -0
- package/esm/resources/DelegatedCheckout/index.js.map +1 -0
- package/esm/resources/Discounts.d.ts +19 -0
- package/esm/resources/Disputes.d.ts +37 -0
- package/esm/resources/Events.d.ts +560 -2
- package/esm/resources/ExternalAccounts.d.ts +212 -1
- package/esm/resources/ExternalAccounts.js +42 -1
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/esm/resources/FinancialConnections/Accounts.d.ts +74 -4
- package/esm/resources/FinancialConnections/Accounts.js +8 -0
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +87 -0
- package/esm/resources/FinancialConnections/Authorizations.js +11 -0
- package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/esm/resources/FinancialConnections/Institutions.d.ts +101 -0
- package/esm/resources/FinancialConnections/Institutions.js +19 -0
- package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
- package/esm/resources/FinancialConnections/Sessions.d.ts +155 -7
- package/esm/resources/FinancialConnections/index.d.ts +21 -6
- package/esm/resources/FinancialConnections/index.js +4 -0
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/FrMealVouchersOnboardings.d.ts +173 -0
- package/esm/resources/FrMealVouchersOnboardings.js +38 -0
- package/esm/resources/FrMealVouchersOnboardings.js.map +1 -0
- package/esm/resources/FxQuotes.d.ts +212 -0
- package/esm/resources/FxQuotes.js +25 -0
- package/esm/resources/FxQuotes.js.map +1 -0
- package/esm/resources/Identity/BlocklistEntries.d.ts +157 -0
- package/esm/resources/Identity/BlocklistEntries.js +50 -0
- package/esm/resources/Identity/BlocklistEntries.js.map +1 -0
- package/esm/resources/Identity/VerificationReports.d.ts +33 -2
- package/esm/resources/Identity/VerificationReports.js.map +1 -1
- package/esm/resources/Identity/VerificationSessions.d.ts +11 -3
- package/esm/resources/Identity/index.d.ts +18 -10
- package/esm/resources/Identity/index.js +2 -0
- package/esm/resources/Identity/index.js.map +1 -1
- package/esm/resources/InvoiceItems.d.ts +185 -2
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +174 -4
- package/esm/resources/Invoices.d.ts +2024 -35
- package/esm/resources/Invoices.js +70 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +255 -0
- package/esm/resources/Issuing/Cardholders.d.ts +5 -4
- package/esm/resources/Issuing/Cards.d.ts +36 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +640 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +43 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +95 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/esm/resources/Issuing/Disputes.d.ts +140 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/esm/resources/Issuing/Programs.d.ts +95 -0
- package/esm/resources/Issuing/Programs.js +31 -0
- package/esm/resources/Issuing/Programs.js.map +1 -0
- package/esm/resources/Issuing/Settlements.d.ts +85 -0
- package/esm/resources/Issuing/Settlements.js +3 -0
- package/esm/resources/Issuing/Settlements.js.map +1 -0
- package/esm/resources/Issuing/Transactions.d.ts +157 -0
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +55 -22
- package/esm/resources/Issuing/index.js +8 -0
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +29 -2
- package/esm/resources/Mandates.d.ts +33 -1
- package/esm/resources/Mandates.js +8 -0
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/Margins.d.ts +115 -0
- package/esm/resources/Margins.js +31 -0
- package/esm/resources/Margins.js.map +1 -0
- package/esm/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/esm/resources/Orchestration/PaymentAttempts.js +11 -0
- package/esm/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/esm/resources/Orchestration/index.d.ts +12 -0
- package/esm/resources/Orchestration/index.js +9 -0
- package/esm/resources/Orchestration/index.js.map +1 -0
- package/esm/resources/Orders.d.ts +4761 -0
- package/esm/resources/Orders.js +453 -0
- package/esm/resources/Orders.js.map +1 -0
- package/esm/resources/PaymentAttemptRecords.d.ts +441 -1
- package/esm/resources/PaymentAttemptRecords.js +42 -0
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
- package/esm/resources/PaymentIntents.d.ts +16370 -3527
- package/esm/resources/PaymentIntents.js +40 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +74 -12
- package/esm/resources/PaymentMethodBalances.d.ts +46 -0
- package/esm/resources/PaymentMethodBalances.js +3 -0
- package/esm/resources/PaymentMethodBalances.js.map +1 -0
- package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/esm/resources/PaymentMethods.d.ts +216 -3
- package/esm/resources/PaymentMethods.js +6 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +323 -21
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Persons.d.ts +24 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +64 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +37 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/esm/resources/Privacy/RedactionJobs.d.ts +229 -0
- package/esm/resources/Privacy/RedactionJobs.js +69 -0
- package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
- package/esm/resources/Privacy/index.d.ts +22 -0
- package/esm/resources/Privacy/index.js +9 -0
- package/esm/resources/Privacy/index.js.map +1 -0
- package/esm/resources/ProductCatalog/TrialOffers.d.ts +127 -0
- package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
- package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/esm/resources/ProductCatalog/index.d.ts +12 -0
- package/esm/resources/ProductCatalog/index.js +9 -0
- package/esm/resources/ProductCatalog/index.js.map +1 -0
- package/esm/resources/Products.d.ts +141 -0
- package/esm/resources/Profiles.d.ts +26 -0
- package/esm/resources/Profiles.js +3 -0
- package/esm/resources/Profiles.js.map +1 -0
- package/esm/resources/PromotionCodes.d.ts +12 -0
- package/esm/resources/PromotionCodes.js +28 -0
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/QuoteLines.d.ts +684 -0
- package/esm/resources/QuoteLines.js +3 -0
- package/esm/resources/QuoteLines.js.map +1 -0
- package/esm/resources/QuotePreviewInvoices.d.ts +1153 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +897 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +3548 -254
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +270 -0
- package/esm/resources/Radar/AccountEvaluations.js +23 -0
- package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
- package/esm/resources/Radar/CustomerEvaluations.d.ts +242 -0
- package/esm/resources/Radar/CustomerEvaluations.js +17 -0
- package/esm/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.d.ts +435 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js +11 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/esm/resources/Radar/PaymentEvaluations.d.ts +63 -1
- package/esm/resources/Radar/index.d.ts +34 -16
- package/esm/resources/Radar/index.js +6 -0
- package/esm/resources/Radar/index.js.map +1 -1
- package/esm/resources/Refunds.d.ts +11 -0
- package/esm/resources/Reserve/Holds.d.ts +53 -1
- package/esm/resources/Reserve/Holds.js +17 -1
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +16 -0
- package/esm/resources/Reserve/Plans.js +9 -1
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +41 -1
- package/esm/resources/Reserve/Releases.js +17 -1
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +14 -3
- package/esm/resources/Reserve/index.js +10 -2
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/RiskSignals.d.ts +10 -0
- package/esm/resources/RiskSignals.js +3 -0
- package/esm/resources/RiskSignals.js.map +1 -0
- package/esm/resources/SetupAttempts.d.ts +26 -1
- package/esm/resources/SetupIntents.d.ts +491 -11
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +1101 -0
- package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
- package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/IssuedTokens.d.ts +322 -0
- package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
- package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/index.d.ts +19 -0
- package/esm/resources/SharedPayment/index.js +11 -0
- package/esm/resources/SharedPayment/index.js.map +1 -0
- package/esm/resources/Sources.d.ts +16 -1
- package/esm/resources/SubscriptionItems.d.ts +251 -0
- package/esm/resources/SubscriptionSchedules.d.ts +1943 -19
- package/esm/resources/SubscriptionSchedules.js +48 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +1040 -16
- package/esm/resources/Subscriptions.js +236 -1
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +6 -2
- package/esm/resources/Tax/Calculations.d.ts +7 -3
- package/esm/resources/Tax/Forms.d.ts +230 -0
- package/esm/resources/Tax/Forms.js +28 -0
- package/esm/resources/Tax/Forms.js.map +1 -0
- package/esm/resources/Tax/Locations.d.ts +108 -0
- package/esm/resources/Tax/Locations.js +29 -0
- package/esm/resources/Tax/Locations.js.map +1 -0
- package/esm/resources/Tax/Registrations.d.ts +155 -2
- package/esm/resources/Tax/Transactions.d.ts +2 -2
- package/esm/resources/Tax/index.d.ts +27 -13
- package/esm/resources/Tax/index.js +4 -0
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +15 -0
- package/esm/resources/Terminal/Configurations.d.ts +27 -0
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +52 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
- package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/esm/resources/Terminal/Readers.d.ts +51 -1
- package/esm/resources/Terminal/index.d.ts +5 -0
- package/esm/resources/Terminal/index.js +2 -0
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/esm/resources/TestHelpers/Capital/index.js +9 -0
- package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
- package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
- package/esm/resources/TestHelpers/PaymentIntents.d.ts +36 -0
- package/esm/resources/TestHelpers/PaymentIntents.js +11 -0
- package/esm/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/esm/resources/TestHelpers/index.d.ts +14 -6
- package/esm/resources/TestHelpers/index.js +6 -0
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Tokens.d.ts +56 -0
- package/esm/resources/Transfers.d.ts +12 -0
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/TransitBalances.d.ts +25 -0
- package/esm/resources/TransitBalances.js +3 -0
- package/esm/resources/TransitBalances.js.map +1 -0
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +75 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings.d.ts +284 -0
- package/esm/resources/V2/Billing/BillSettings.js +37 -0
- package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.d.ts +88 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js +3 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js +19 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences.d.ts +1015 -0
- package/esm/resources/V2/Billing/Cadences.js +260 -0
- package/esm/resources/V2/Billing/Cadences.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +240 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings.d.ts +779 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
- package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +31 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/esm/resources/V2/Billing/IntentActions.d.ts +607 -0
- package/esm/resources/V2/Billing/IntentActions.js +3 -0
- package/esm/resources/V2/Billing/IntentActions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +66 -0
- package/esm/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents.d.ts +1257 -0
- package/esm/resources/V2/Billing/Intents.js +83 -0
- package/esm/resources/V2/Billing/Intents.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.d.ts +82 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js +3 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +60 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees.d.ts +378 -0
- package/esm/resources/V2/Billing/LicenseFees.js +144 -0
- package/esm/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/esm/resources/V2/Billing/LicensedItems.d.ts +174 -0
- package/esm/resources/V2/Billing/LicensedItems.js +31 -0
- package/esm/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/esm/resources/V2/Billing/MeterEventAdjustments.d.ts +5 -5
- package/esm/resources/V2/Billing/MeterEventSession.d.ts +4 -4
- package/esm/resources/V2/Billing/MeterEventSession.js +1 -1
- package/esm/resources/V2/Billing/MeteredItems.d.ts +222 -0
- package/esm/resources/V2/Billing/MeteredItems.js +31 -0
- package/esm/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/esm/resources/V2/Billing/OneTimeItems.d.ts +174 -0
- package/esm/resources/V2/Billing/OneTimeItems.js +31 -0
- package/esm/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.d.ts +84 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.d.ts +624 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +292 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +37 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +19 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans.d.ts +177 -0
- package/esm/resources/V2/Billing/PricingPlans.js +39 -0
- package/esm/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/esm/resources/V2/Billing/Profiles.d.ts +166 -0
- package/esm/resources/V2/Billing/Profiles.js +31 -0
- package/esm/resources/V2/Billing/Profiles.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardRates.d.ts +115 -0
- package/esm/resources/V2/Billing/RateCardRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.d.ts +219 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +37 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/esm/resources/V2/Billing/RateCardVersions.js +3 -0
- package/esm/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +31 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +106 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +19 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards.d.ts +357 -0
- package/esm/resources/V2/Billing/RateCards.js +72 -0
- package/esm/resources/V2/Billing/RateCards.js.map +1 -0
- package/esm/resources/V2/Billing/ServiceActions.d.ts +514 -0
- package/esm/resources/V2/Billing/ServiceActions.js +158 -0
- package/esm/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/esm/resources/V2/Billing/index.d.ts +161 -6
- package/esm/resources/V2/Billing/index.js +30 -0
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.d.ts +99 -0
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.js +152 -0
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.js.map +1 -0
- package/esm/resources/V2/Commerce/ProductCatalog/index.d.ts +8 -0
- package/esm/resources/V2/Commerce/ProductCatalog/index.js +9 -0
- package/esm/resources/V2/Commerce/ProductCatalog/index.js.map +1 -0
- package/esm/resources/V2/Commerce/ProductCatalogImports.d.ts +183 -0
- package/esm/resources/V2/Commerce/ProductCatalogImports.js +3 -0
- package/esm/resources/V2/Commerce/ProductCatalogImports.js.map +1 -0
- package/esm/resources/V2/Commerce/index.d.ts +13 -0
- package/esm/resources/V2/Commerce/index.js +9 -0
- package/esm/resources/V2/Commerce/index.js.map +1 -0
- package/esm/resources/V2/Core/AccountEvaluations.d.ts +160 -0
- package/esm/resources/V2/Core/AccountEvaluations.js +11 -0
- package/esm/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/esm/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/esm/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/esm/resources/V2/Core/AccountTokens.d.ts +222 -4
- package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +3 -2
- package/esm/resources/V2/Core/Accounts/PersonTokens.js +2 -1
- package/esm/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts.d.ts +5319 -75
- package/esm/resources/V2/Core/Accounts.js +1 -1
- package/esm/resources/V2/Core/ApprovalRequests.d.ts +334 -0
- package/esm/resources/V2/Core/ApprovalRequests.js +42 -0
- package/esm/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/esm/resources/V2/Core/BatchJobs.d.ts +373 -0
- package/esm/resources/V2/Core/BatchJobs.js +221 -0
- package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.d.ts +229 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +27 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/esm/resources/V2/Core/ConnectionSessions.d.ts +90 -0
- package/esm/resources/V2/Core/ConnectionSessions.js +17 -0
- package/esm/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/esm/resources/V2/Core/EventDestinations.d.ts +50 -3
- package/esm/resources/V2/Core/Events.d.ts +7325 -204
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +285 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +254 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +58 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
- package/esm/resources/V2/Core/Vault/index.js +11 -0
- package/esm/resources/V2/Core/Vault/index.js.map +1 -0
- package/esm/resources/V2/Core/index.d.ts +51 -14
- package/esm/resources/V2/Core/index.js +12 -0
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js +32 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.d.ts +82 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js +3 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/esm/resources/V2/Data/Analytics/index.js +9 -0
- package/esm/resources/V2/Data/Analytics/index.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +156 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/esm/resources/V2/Data/Reporting/index.js +9 -0
- package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Data/index.d.ts +13 -0
- package/esm/resources/V2/Data/index.js +11 -0
- package/esm/resources/V2/Data/index.js.map +1 -0
- package/esm/resources/V2/Extend/WorkflowRuns.d.ts +166 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/esm/resources/V2/Extend/Workflows.d.ts +123 -0
- package/esm/resources/V2/Extend/Workflows.js +26 -0
- package/esm/resources/V2/Extend/Workflows.js.map +1 -0
- package/esm/resources/V2/Extend/index.d.ts +20 -0
- package/esm/resources/V2/Extend/index.js +11 -0
- package/esm/resources/V2/Extend/index.js.map +1 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/esm/resources/V2/Iam/ActivityLogs.d.ts +204 -0
- package/esm/resources/V2/Iam/ActivityLogs.js +13 -0
- package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/esm/resources/V2/Iam/ApiKeys.d.ts +280 -0
- package/esm/resources/V2/Iam/ApiKeys.js +43 -0
- package/esm/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/esm/resources/V2/Iam/index.d.ts +22 -0
- package/esm/resources/V2/Iam/index.js +11 -0
- package/esm/resources/V2/Iam/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +139 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.d.ts +135 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +27 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +412 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +40 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +308 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +254 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +524 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +320 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +342 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +270 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +96 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +451 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +237 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.d.ts +120 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +23 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +245 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Transactions.d.ts +276 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +118 -0
- package/esm/resources/V2/MoneyManagement/index.js +39 -0
- package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +96 -0
- package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
- package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/esm/resources/V2/Network/index.d.ts +13 -0
- package/esm/resources/V2/Network/index.js +9 -0
- package/esm/resources/V2/Network/index.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +147 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/esm/resources/V2/Payments/OffSessionPayments.d.ts +827 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +49 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +77 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js +3 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +31 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.d.ts +213 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +49 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/esm/resources/V2/Payments/index.d.ts +31 -0
- package/esm/resources/V2/Payments/index.js +11 -0
- package/esm/resources/V2/Payments/index.js.map +1 -0
- package/esm/resources/V2/Reporting/ReportRuns.d.ts +173 -0
- package/esm/resources/V2/Reporting/ReportRuns.js +46 -0
- package/esm/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/esm/resources/V2/Reporting/Reports.d.ts +110 -0
- package/esm/resources/V2/Reporting/Reports.js +13 -0
- package/esm/resources/V2/Reporting/Reports.js.map +1 -0
- package/esm/resources/V2/Reporting/index.d.ts +18 -0
- package/esm/resources/V2/Reporting/index.js +11 -0
- package/esm/resources/V2/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Tax/ManualRules.d.ts +335 -0
- package/esm/resources/V2/Tax/ManualRules.js +189 -0
- package/esm/resources/V2/Tax/ManualRules.js.map +1 -0
- package/esm/resources/V2/Tax/index.d.ts +16 -0
- package/esm/resources/V2/Tax/index.js +9 -0
- package/esm/resources/V2/Tax/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +11 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/esm/resources/V2/TestHelpers/index.d.ts +10 -0
- package/esm/resources/V2/TestHelpers/index.js +11 -0
- package/esm/resources/V2/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/index.d.ts +39 -0
- package/esm/resources/V2/index.js +22 -0
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +2 -2
- package/esm/resources.d.ts +14 -0
- package/esm/resources.js +221 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +84 -28
- package/esm/stripe.core.js +29 -1
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +84 -28
- package/esm/stripe.esm.node.js +29 -1
- package/esm/stripe.esm.node.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import { StripeResource } from '../StripeResource.js';
|
|
2
2
|
import { Application, DeletedApplication } from './Applications.js';
|
|
3
3
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
4
|
+
import { Invoice } from './Invoices.js';
|
|
4
5
|
import { Subscription } from './Subscriptions.js';
|
|
6
|
+
import { Price, DeletedPrice } from './Prices.js';
|
|
5
7
|
import { PaymentMethod } from './PaymentMethods.js';
|
|
6
8
|
import { Account } from './Accounts.js';
|
|
7
9
|
import { TaxId, DeletedTaxId } from './TaxIds.js';
|
|
8
10
|
import { TaxRate } from './TaxRates.js';
|
|
9
|
-
import { Price, DeletedPrice } from './Prices.js';
|
|
10
11
|
import { Coupon } from './Coupons.js';
|
|
11
12
|
import { PromotionCode } from './PromotionCodes.js';
|
|
12
13
|
import { Plan, DeletedPlan } from './Plans.js';
|
|
@@ -30,6 +31,10 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
30
31
|
* Updates an existing subscription schedule.
|
|
31
32
|
*/
|
|
32
33
|
update(id: string, params?: SubscriptionScheduleUpdateParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
34
|
+
/**
|
|
35
|
+
* Amends an existing subscription schedule.
|
|
36
|
+
*/
|
|
37
|
+
amend(id: string, params?: SubscriptionScheduleAmendParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
33
38
|
/**
|
|
34
39
|
* Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
|
|
35
40
|
*/
|
|
@@ -38,6 +43,18 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
38
43
|
* Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
|
|
39
44
|
*/
|
|
40
45
|
release(id: string, params?: SubscriptionScheduleReleaseParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
46
|
+
serializeBatchCreate(params?: Record<string, unknown>, options?: {
|
|
47
|
+
apiVersion?: string;
|
|
48
|
+
stripeContext?: string;
|
|
49
|
+
}): string;
|
|
50
|
+
serializeBatchUpdate(schedule: string, params?: Record<string, unknown>, options?: {
|
|
51
|
+
apiVersion?: string;
|
|
52
|
+
stripeContext?: string;
|
|
53
|
+
}): string;
|
|
54
|
+
serializeBatchCancel(schedule: string, params?: Record<string, unknown>, options?: {
|
|
55
|
+
apiVersion?: string;
|
|
56
|
+
stripeContext?: string;
|
|
57
|
+
}): string;
|
|
41
58
|
}
|
|
42
59
|
export interface SubscriptionSchedule {
|
|
43
60
|
/**
|
|
@@ -52,10 +69,18 @@ export interface SubscriptionSchedule {
|
|
|
52
69
|
* ID of the Connect Application that created the schedule.
|
|
53
70
|
*/
|
|
54
71
|
application: string | Application | DeletedApplication | null;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
*/
|
|
75
|
+
billing_behavior?: SubscriptionSchedule.BillingBehavior;
|
|
55
76
|
/**
|
|
56
77
|
* The billing mode of the subscription.
|
|
57
78
|
*/
|
|
58
79
|
billing_mode: SubscriptionSchedule.BillingMode;
|
|
80
|
+
/**
|
|
81
|
+
* Billing schedules for this subscription schedule.
|
|
82
|
+
*/
|
|
83
|
+
billing_schedules?: Array<SubscriptionSchedule.BillingSchedule>;
|
|
59
84
|
/**
|
|
60
85
|
* Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
61
86
|
*/
|
|
@@ -85,6 +110,14 @@ export interface SubscriptionSchedule {
|
|
|
85
110
|
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
|
86
111
|
*/
|
|
87
112
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
113
|
+
/**
|
|
114
|
+
* Details of the most recent price migration that failed for the subscription schedule.
|
|
115
|
+
*/
|
|
116
|
+
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
117
|
+
/**
|
|
118
|
+
* The most recent invoice this subscription schedule has generated.
|
|
119
|
+
*/
|
|
120
|
+
latest_invoice?: string | Invoice | null;
|
|
88
121
|
/**
|
|
89
122
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
90
123
|
*/
|
|
@@ -97,6 +130,10 @@ export interface SubscriptionSchedule {
|
|
|
97
130
|
* Configuration for the subscription schedule's phases.
|
|
98
131
|
*/
|
|
99
132
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
133
|
+
/**
|
|
134
|
+
* Time period and invoice for a Subscription billed in advance.
|
|
135
|
+
*/
|
|
136
|
+
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
100
137
|
/**
|
|
101
138
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
102
139
|
*/
|
|
@@ -119,6 +156,7 @@ export interface SubscriptionSchedule {
|
|
|
119
156
|
test_clock: string | TestHelpers.TestClock | null;
|
|
120
157
|
}
|
|
121
158
|
export declare namespace SubscriptionSchedule {
|
|
159
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
122
160
|
interface BillingMode {
|
|
123
161
|
/**
|
|
124
162
|
* Configure behavior for flexible billing mode
|
|
@@ -133,6 +171,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
133
171
|
*/
|
|
134
172
|
updated_at?: number;
|
|
135
173
|
}
|
|
174
|
+
interface BillingSchedule {
|
|
175
|
+
/**
|
|
176
|
+
* Specifies which subscription items the billing schedule applies to.
|
|
177
|
+
*/
|
|
178
|
+
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
179
|
+
/**
|
|
180
|
+
* Specifies the end of billing period.
|
|
181
|
+
*/
|
|
182
|
+
bill_until: BillingSchedule.BillUntil;
|
|
183
|
+
/**
|
|
184
|
+
* Unique identifier for the billing schedule.
|
|
185
|
+
*/
|
|
186
|
+
key: string;
|
|
187
|
+
}
|
|
136
188
|
interface CurrentPhase {
|
|
137
189
|
/**
|
|
138
190
|
* The end of this phase of the subscription schedule.
|
|
@@ -174,12 +226,30 @@ export declare namespace SubscriptionSchedule {
|
|
|
174
226
|
* The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
175
227
|
*/
|
|
176
228
|
on_behalf_of: string | Account | null;
|
|
229
|
+
/**
|
|
230
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
231
|
+
*/
|
|
232
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
177
233
|
/**
|
|
178
234
|
* The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
179
235
|
*/
|
|
180
236
|
transfer_data: DefaultSettings.TransferData | null;
|
|
181
237
|
}
|
|
182
238
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
239
|
+
interface LastPriceMigrationError {
|
|
240
|
+
/**
|
|
241
|
+
* The time at which the price migration encountered an error.
|
|
242
|
+
*/
|
|
243
|
+
errored_at: number;
|
|
244
|
+
/**
|
|
245
|
+
* The involved price pairs in each failed transition.
|
|
246
|
+
*/
|
|
247
|
+
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
248
|
+
/**
|
|
249
|
+
* The type of error encountered by the price migration.
|
|
250
|
+
*/
|
|
251
|
+
type: 'price_uniqueness_violation';
|
|
252
|
+
}
|
|
183
253
|
interface Phase {
|
|
184
254
|
/**
|
|
185
255
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -222,6 +292,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
222
292
|
* The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
|
223
293
|
*/
|
|
224
294
|
discounts: Array<Phase.Discount>;
|
|
295
|
+
/**
|
|
296
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
297
|
+
*/
|
|
298
|
+
effective_at?: Phase.EffectiveAt | null;
|
|
225
299
|
/**
|
|
226
300
|
* The end of this phase of the subscription schedule.
|
|
227
301
|
*/
|
|
@@ -242,6 +316,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
242
316
|
* The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
243
317
|
*/
|
|
244
318
|
on_behalf_of: string | Account | null;
|
|
319
|
+
/**
|
|
320
|
+
* 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://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
321
|
+
*/
|
|
322
|
+
pause_collection?: Phase.PauseCollection | null;
|
|
245
323
|
/**
|
|
246
324
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
247
325
|
*/
|
|
@@ -254,10 +332,36 @@ export declare namespace SubscriptionSchedule {
|
|
|
254
332
|
* The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
255
333
|
*/
|
|
256
334
|
transfer_data: Phase.TransferData | null;
|
|
335
|
+
/**
|
|
336
|
+
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
337
|
+
*/
|
|
338
|
+
trial_continuation?: Phase.TrialContinuation | null;
|
|
257
339
|
/**
|
|
258
340
|
* When the trial ends within the phase.
|
|
259
341
|
*/
|
|
260
342
|
trial_end: number | null;
|
|
343
|
+
/**
|
|
344
|
+
* Settings related to any trials on the subscription during this phase.
|
|
345
|
+
*/
|
|
346
|
+
trial_settings?: Phase.TrialSettings | null;
|
|
347
|
+
}
|
|
348
|
+
interface Prebilling {
|
|
349
|
+
/**
|
|
350
|
+
* ID of the prebilling invoice.
|
|
351
|
+
*/
|
|
352
|
+
invoice: string | Invoice;
|
|
353
|
+
/**
|
|
354
|
+
* The end of the last period for which the invoice pre-bills.
|
|
355
|
+
*/
|
|
356
|
+
period_end: number;
|
|
357
|
+
/**
|
|
358
|
+
* The start of the first period for which the invoice pre-bills.
|
|
359
|
+
*/
|
|
360
|
+
period_start: number;
|
|
361
|
+
/**
|
|
362
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
363
|
+
*/
|
|
364
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
261
365
|
}
|
|
262
366
|
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released';
|
|
263
367
|
namespace BillingMode {
|
|
@@ -272,6 +376,52 @@ export declare namespace SubscriptionSchedule {
|
|
|
272
376
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
273
377
|
}
|
|
274
378
|
}
|
|
379
|
+
namespace BillingSchedule {
|
|
380
|
+
interface AppliesTo {
|
|
381
|
+
/**
|
|
382
|
+
* The billing schedule will apply to the subscription item with the given price ID.
|
|
383
|
+
*/
|
|
384
|
+
price: string | Price | null;
|
|
385
|
+
/**
|
|
386
|
+
* Controls which subscription items the billing schedule applies to.
|
|
387
|
+
*/
|
|
388
|
+
type: 'price';
|
|
389
|
+
}
|
|
390
|
+
interface BillUntil {
|
|
391
|
+
/**
|
|
392
|
+
* The timestamp the billing schedule will apply until.
|
|
393
|
+
*/
|
|
394
|
+
computed_timestamp: number;
|
|
395
|
+
/**
|
|
396
|
+
* Specifies the billing period.
|
|
397
|
+
*/
|
|
398
|
+
duration: BillUntil.Duration | null;
|
|
399
|
+
/**
|
|
400
|
+
* If specified, the billing schedule will apply until the specified timestamp.
|
|
401
|
+
*/
|
|
402
|
+
timestamp: number | null;
|
|
403
|
+
/**
|
|
404
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
405
|
+
*/
|
|
406
|
+
type: BillUntil.Type;
|
|
407
|
+
}
|
|
408
|
+
namespace BillUntil {
|
|
409
|
+
interface Duration {
|
|
410
|
+
/**
|
|
411
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
412
|
+
*/
|
|
413
|
+
interval: Duration.Interval;
|
|
414
|
+
/**
|
|
415
|
+
* The multiplier applied to the interval.
|
|
416
|
+
*/
|
|
417
|
+
interval_count: number | null;
|
|
418
|
+
}
|
|
419
|
+
type Type = 'duration' | 'timestamp';
|
|
420
|
+
namespace Duration {
|
|
421
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
422
|
+
}
|
|
423
|
+
}
|
|
424
|
+
}
|
|
275
425
|
namespace DefaultSettings {
|
|
276
426
|
interface AutomaticTax {
|
|
277
427
|
/**
|
|
@@ -310,6 +460,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
310
460
|
days_until_due: number | null;
|
|
311
461
|
issuer: InvoiceSettings.Issuer;
|
|
312
462
|
}
|
|
463
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
313
464
|
interface TransferData {
|
|
314
465
|
/**
|
|
315
466
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -332,7 +483,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
332
483
|
type: Liability.Type;
|
|
333
484
|
}
|
|
334
485
|
namespace Liability {
|
|
335
|
-
type Type = 'account' | 'self';
|
|
486
|
+
type Type = 'account' | 'application' | 'self';
|
|
336
487
|
}
|
|
337
488
|
}
|
|
338
489
|
namespace InvoiceSettings {
|
|
@@ -347,10 +498,22 @@ export declare namespace SubscriptionSchedule {
|
|
|
347
498
|
type: Issuer.Type;
|
|
348
499
|
}
|
|
349
500
|
namespace Issuer {
|
|
350
|
-
type Type = 'account' | 'self';
|
|
501
|
+
type Type = 'account' | 'application' | 'self';
|
|
351
502
|
}
|
|
352
503
|
}
|
|
353
504
|
}
|
|
505
|
+
namespace LastPriceMigrationError {
|
|
506
|
+
interface FailedTransition {
|
|
507
|
+
/**
|
|
508
|
+
* The original price to be migrated.
|
|
509
|
+
*/
|
|
510
|
+
source_price: string;
|
|
511
|
+
/**
|
|
512
|
+
* The intended resulting price of the migration.
|
|
513
|
+
*/
|
|
514
|
+
target_price: string;
|
|
515
|
+
}
|
|
516
|
+
}
|
|
354
517
|
namespace Phase {
|
|
355
518
|
interface AddInvoiceItem {
|
|
356
519
|
/**
|
|
@@ -410,11 +573,17 @@ export declare namespace SubscriptionSchedule {
|
|
|
410
573
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
411
574
|
*/
|
|
412
575
|
discount: string | Discount | null;
|
|
576
|
+
/**
|
|
577
|
+
* Details to determine how long the discount should be applied for.
|
|
578
|
+
*/
|
|
579
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
413
580
|
/**
|
|
414
581
|
* ID of the promotion code to create a new discount for.
|
|
415
582
|
*/
|
|
416
583
|
promotion_code: string | PromotionCode | null;
|
|
584
|
+
settings?: Discount.Settings;
|
|
417
585
|
}
|
|
586
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
418
587
|
interface InvoiceSettings {
|
|
419
588
|
/**
|
|
420
589
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -458,6 +627,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
458
627
|
* The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
|
459
628
|
*/
|
|
460
629
|
tax_rates?: Array<TaxRate> | null;
|
|
630
|
+
/**
|
|
631
|
+
* Options that configure the trial on the subscription item.
|
|
632
|
+
*/
|
|
633
|
+
trial?: Item.Trial | null;
|
|
634
|
+
/**
|
|
635
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
636
|
+
*/
|
|
637
|
+
trial_offer?: string | null;
|
|
638
|
+
}
|
|
639
|
+
interface PauseCollection {
|
|
640
|
+
/**
|
|
641
|
+
* The payment collection behavior for this subscription while paused.
|
|
642
|
+
*/
|
|
643
|
+
behavior: PauseCollection.Behavior;
|
|
461
644
|
}
|
|
462
645
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
463
646
|
interface TransferData {
|
|
@@ -470,6 +653,13 @@ export declare namespace SubscriptionSchedule {
|
|
|
470
653
|
*/
|
|
471
654
|
destination: string | Account;
|
|
472
655
|
}
|
|
656
|
+
type TrialContinuation = 'continue' | 'none';
|
|
657
|
+
interface TrialSettings {
|
|
658
|
+
/**
|
|
659
|
+
* Defines how the subscription should behave when a trial ends.
|
|
660
|
+
*/
|
|
661
|
+
end_behavior: TrialSettings.EndBehavior | null;
|
|
662
|
+
}
|
|
473
663
|
namespace AddInvoiceItem {
|
|
474
664
|
interface Discount {
|
|
475
665
|
/**
|
|
@@ -480,6 +670,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
480
670
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
481
671
|
*/
|
|
482
672
|
discount: string | Discount | null;
|
|
673
|
+
/**
|
|
674
|
+
* Details to determine how long the discount should be applied for.
|
|
675
|
+
*/
|
|
676
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
483
677
|
/**
|
|
484
678
|
* ID of the promotion code to create a new discount for.
|
|
485
679
|
*/
|
|
@@ -489,6 +683,18 @@ export declare namespace SubscriptionSchedule {
|
|
|
489
683
|
end: Period.End;
|
|
490
684
|
start: Period.Start;
|
|
491
685
|
}
|
|
686
|
+
namespace Discount {
|
|
687
|
+
interface DiscountEnd {
|
|
688
|
+
/**
|
|
689
|
+
* The discount end timestamp.
|
|
690
|
+
*/
|
|
691
|
+
timestamp: number | null;
|
|
692
|
+
/**
|
|
693
|
+
* The discount end type.
|
|
694
|
+
*/
|
|
695
|
+
type: 'timestamp';
|
|
696
|
+
}
|
|
697
|
+
}
|
|
492
698
|
namespace Period {
|
|
493
699
|
interface End {
|
|
494
700
|
/**
|
|
@@ -530,7 +736,61 @@ export declare namespace SubscriptionSchedule {
|
|
|
530
736
|
type: Liability.Type;
|
|
531
737
|
}
|
|
532
738
|
namespace Liability {
|
|
533
|
-
type Type = 'account' | 'self';
|
|
739
|
+
type Type = 'account' | 'application' | 'self';
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
namespace Discount {
|
|
743
|
+
interface DiscountEnd {
|
|
744
|
+
/**
|
|
745
|
+
* The discount end timestamp.
|
|
746
|
+
*/
|
|
747
|
+
timestamp: number | null;
|
|
748
|
+
/**
|
|
749
|
+
* The discount end type.
|
|
750
|
+
*/
|
|
751
|
+
type: 'timestamp';
|
|
752
|
+
}
|
|
753
|
+
interface Settings {
|
|
754
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
755
|
+
/**
|
|
756
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
757
|
+
*/
|
|
758
|
+
start_date: Settings.StartDate;
|
|
759
|
+
}
|
|
760
|
+
namespace Settings {
|
|
761
|
+
interface ServicePeriodAnchorConfig {
|
|
762
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
763
|
+
/**
|
|
764
|
+
* The type of service period anchor config.
|
|
765
|
+
*/
|
|
766
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
767
|
+
}
|
|
768
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
769
|
+
namespace ServicePeriodAnchorConfig {
|
|
770
|
+
interface Custom {
|
|
771
|
+
/**
|
|
772
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
773
|
+
*/
|
|
774
|
+
day_of_month: number;
|
|
775
|
+
/**
|
|
776
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
777
|
+
*/
|
|
778
|
+
hour: number | null;
|
|
779
|
+
/**
|
|
780
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
781
|
+
*/
|
|
782
|
+
minute: number | null;
|
|
783
|
+
/**
|
|
784
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
785
|
+
*/
|
|
786
|
+
month: number | null;
|
|
787
|
+
/**
|
|
788
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
789
|
+
*/
|
|
790
|
+
second: number | null;
|
|
791
|
+
}
|
|
792
|
+
type Type = 'custom' | 'inherit';
|
|
793
|
+
}
|
|
534
794
|
}
|
|
535
795
|
}
|
|
536
796
|
namespace InvoiceSettings {
|
|
@@ -545,7 +805,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
545
805
|
type: Issuer.Type;
|
|
546
806
|
}
|
|
547
807
|
namespace Issuer {
|
|
548
|
-
type Type = 'account' | 'self';
|
|
808
|
+
type Type = 'account' | 'application' | 'self';
|
|
549
809
|
}
|
|
550
810
|
}
|
|
551
811
|
namespace Item {
|
|
@@ -564,19 +824,116 @@ export declare namespace SubscriptionSchedule {
|
|
|
564
824
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
565
825
|
*/
|
|
566
826
|
discount: string | Discount | null;
|
|
827
|
+
/**
|
|
828
|
+
* Details to determine how long the discount should be applied for.
|
|
829
|
+
*/
|
|
830
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
567
831
|
/**
|
|
568
832
|
* ID of the promotion code to create a new discount for.
|
|
569
833
|
*/
|
|
570
834
|
promotion_code: string | PromotionCode | null;
|
|
835
|
+
settings?: Discount.Settings;
|
|
836
|
+
}
|
|
837
|
+
interface Trial {
|
|
838
|
+
/**
|
|
839
|
+
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
840
|
+
*/
|
|
841
|
+
converts_to?: Array<string> | null;
|
|
842
|
+
/**
|
|
843
|
+
* Determines the type of trial for this item.
|
|
844
|
+
*/
|
|
845
|
+
type: Trial.Type;
|
|
846
|
+
}
|
|
847
|
+
namespace Discount {
|
|
848
|
+
interface DiscountEnd {
|
|
849
|
+
/**
|
|
850
|
+
* The discount end timestamp.
|
|
851
|
+
*/
|
|
852
|
+
timestamp: number | null;
|
|
853
|
+
/**
|
|
854
|
+
* The discount end type.
|
|
855
|
+
*/
|
|
856
|
+
type: 'timestamp';
|
|
857
|
+
}
|
|
858
|
+
interface Settings {
|
|
859
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
860
|
+
/**
|
|
861
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
862
|
+
*/
|
|
863
|
+
start_date: Settings.StartDate;
|
|
864
|
+
}
|
|
865
|
+
namespace Settings {
|
|
866
|
+
interface ServicePeriodAnchorConfig {
|
|
867
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
868
|
+
/**
|
|
869
|
+
* The type of service period anchor config.
|
|
870
|
+
*/
|
|
871
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
872
|
+
}
|
|
873
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
874
|
+
namespace ServicePeriodAnchorConfig {
|
|
875
|
+
interface Custom {
|
|
876
|
+
/**
|
|
877
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
878
|
+
*/
|
|
879
|
+
day_of_month: number;
|
|
880
|
+
/**
|
|
881
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
882
|
+
*/
|
|
883
|
+
hour: number | null;
|
|
884
|
+
/**
|
|
885
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
886
|
+
*/
|
|
887
|
+
minute: number | null;
|
|
888
|
+
/**
|
|
889
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
890
|
+
*/
|
|
891
|
+
month: number | null;
|
|
892
|
+
/**
|
|
893
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
894
|
+
*/
|
|
895
|
+
second: number | null;
|
|
896
|
+
}
|
|
897
|
+
type Type = 'custom' | 'inherit';
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
}
|
|
901
|
+
namespace Trial {
|
|
902
|
+
type Type = 'free' | 'paid';
|
|
903
|
+
}
|
|
904
|
+
}
|
|
905
|
+
namespace PauseCollection {
|
|
906
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
907
|
+
}
|
|
908
|
+
namespace TrialSettings {
|
|
909
|
+
interface EndBehavior {
|
|
910
|
+
/**
|
|
911
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
912
|
+
*/
|
|
913
|
+
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
914
|
+
}
|
|
915
|
+
namespace EndBehavior {
|
|
916
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
571
917
|
}
|
|
572
918
|
}
|
|
573
919
|
}
|
|
920
|
+
namespace Prebilling {
|
|
921
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
922
|
+
}
|
|
574
923
|
}
|
|
575
924
|
export interface SubscriptionScheduleCreateParams {
|
|
925
|
+
/**
|
|
926
|
+
* 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.
|
|
927
|
+
*/
|
|
928
|
+
billing_behavior?: SubscriptionScheduleCreateParams.BillingBehavior;
|
|
576
929
|
/**
|
|
577
930
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
578
931
|
*/
|
|
579
932
|
billing_mode?: SubscriptionScheduleCreateParams.BillingMode;
|
|
933
|
+
/**
|
|
934
|
+
* Sets the billing schedules for the subscription schedule.
|
|
935
|
+
*/
|
|
936
|
+
billing_schedules?: Array<SubscriptionScheduleCreateParams.BillingSchedule>;
|
|
580
937
|
/**
|
|
581
938
|
* The identifier of the customer to create the subscription schedule for.
|
|
582
939
|
*/
|
|
@@ -609,12 +966,17 @@ export interface SubscriptionScheduleCreateParams {
|
|
|
609
966
|
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
|
|
610
967
|
*/
|
|
611
968
|
phases?: Array<SubscriptionScheduleCreateParams.Phase>;
|
|
969
|
+
/**
|
|
970
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
971
|
+
*/
|
|
972
|
+
prebilling?: SubscriptionScheduleCreateParams.Prebilling;
|
|
612
973
|
/**
|
|
613
974
|
* When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
|
|
614
975
|
*/
|
|
615
976
|
start_date?: number | 'now';
|
|
616
977
|
}
|
|
617
978
|
export declare namespace SubscriptionScheduleCreateParams {
|
|
979
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
618
980
|
interface BillingMode {
|
|
619
981
|
/**
|
|
620
982
|
* Configure behavior for flexible billing mode.
|
|
@@ -625,6 +987,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
625
987
|
*/
|
|
626
988
|
type: BillingMode.Type;
|
|
627
989
|
}
|
|
990
|
+
interface BillingSchedule {
|
|
991
|
+
/**
|
|
992
|
+
* Configure billing schedule differently for individual subscription items.
|
|
993
|
+
*/
|
|
994
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
995
|
+
/**
|
|
996
|
+
* The end date for the billing schedule.
|
|
997
|
+
*/
|
|
998
|
+
bill_until: BillingSchedule.BillUntil;
|
|
999
|
+
/**
|
|
1000
|
+
* 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.
|
|
1001
|
+
*/
|
|
1002
|
+
key?: string;
|
|
1003
|
+
}
|
|
628
1004
|
interface DefaultSettings {
|
|
629
1005
|
/**
|
|
630
1006
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
|
@@ -662,6 +1038,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
662
1038
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
663
1039
|
*/
|
|
664
1040
|
on_behalf_of?: Emptyable<string>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1043
|
+
*/
|
|
1044
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
665
1045
|
/**
|
|
666
1046
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
667
1047
|
*/
|
|
@@ -717,6 +1097,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
717
1097
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
718
1098
|
*/
|
|
719
1099
|
duration?: Phase.Duration;
|
|
1100
|
+
/**
|
|
1101
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1102
|
+
*/
|
|
1103
|
+
effective_at?: Phase.EffectiveAt;
|
|
720
1104
|
/**
|
|
721
1105
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
722
1106
|
*/
|
|
@@ -737,6 +1121,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
737
1121
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
738
1122
|
*/
|
|
739
1123
|
on_behalf_of?: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* 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://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
1126
|
+
*/
|
|
1127
|
+
pause_collection?: Phase.PauseCollection;
|
|
740
1128
|
/**
|
|
741
1129
|
* Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/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://docs.stripe.com/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.
|
|
742
1130
|
*/
|
|
@@ -749,10 +1137,28 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
749
1137
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
750
1138
|
*/
|
|
751
1139
|
trial?: boolean;
|
|
1140
|
+
/**
|
|
1141
|
+
* Specify trial behavior when crossing phase boundaries
|
|
1142
|
+
*/
|
|
1143
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
752
1144
|
/**
|
|
753
1145
|
* 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`
|
|
754
1146
|
*/
|
|
755
1147
|
trial_end?: number;
|
|
1148
|
+
/**
|
|
1149
|
+
* Settings related to subscription trials.
|
|
1150
|
+
*/
|
|
1151
|
+
trial_settings?: Phase.TrialSettings;
|
|
1152
|
+
}
|
|
1153
|
+
interface Prebilling {
|
|
1154
|
+
/**
|
|
1155
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
1156
|
+
*/
|
|
1157
|
+
iterations: number;
|
|
1158
|
+
/**
|
|
1159
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1160
|
+
*/
|
|
1161
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
756
1162
|
}
|
|
757
1163
|
namespace BillingMode {
|
|
758
1164
|
interface Flexible {
|
|
@@ -766,6 +1172,48 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
766
1172
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
767
1173
|
}
|
|
768
1174
|
}
|
|
1175
|
+
namespace BillingSchedule {
|
|
1176
|
+
interface AppliesTo {
|
|
1177
|
+
/**
|
|
1178
|
+
* The ID of the price object.
|
|
1179
|
+
*/
|
|
1180
|
+
price?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* Controls which subscription items the billing schedule applies to.
|
|
1183
|
+
*/
|
|
1184
|
+
type: 'price';
|
|
1185
|
+
}
|
|
1186
|
+
interface BillUntil {
|
|
1187
|
+
/**
|
|
1188
|
+
* Specifies the billing period.
|
|
1189
|
+
*/
|
|
1190
|
+
duration?: BillUntil.Duration;
|
|
1191
|
+
/**
|
|
1192
|
+
* The end date of the billing schedule.
|
|
1193
|
+
*/
|
|
1194
|
+
timestamp?: number;
|
|
1195
|
+
/**
|
|
1196
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1197
|
+
*/
|
|
1198
|
+
type: BillUntil.Type;
|
|
1199
|
+
}
|
|
1200
|
+
namespace BillUntil {
|
|
1201
|
+
interface Duration {
|
|
1202
|
+
/**
|
|
1203
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1204
|
+
*/
|
|
1205
|
+
interval: Duration.Interval;
|
|
1206
|
+
/**
|
|
1207
|
+
* The multiplier applied to the interval.
|
|
1208
|
+
*/
|
|
1209
|
+
interval_count?: number;
|
|
1210
|
+
}
|
|
1211
|
+
type Type = 'duration' | 'timestamp';
|
|
1212
|
+
namespace Duration {
|
|
1213
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1214
|
+
}
|
|
1215
|
+
}
|
|
1216
|
+
}
|
|
769
1217
|
namespace DefaultSettings {
|
|
770
1218
|
interface AutomaticTax {
|
|
771
1219
|
/**
|
|
@@ -803,6 +1251,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
803
1251
|
*/
|
|
804
1252
|
issuer?: InvoiceSettings.Issuer;
|
|
805
1253
|
}
|
|
1254
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
806
1255
|
interface TransferData {
|
|
807
1256
|
/**
|
|
808
1257
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -825,7 +1274,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
825
1274
|
type: Liability.Type;
|
|
826
1275
|
}
|
|
827
1276
|
namespace Liability {
|
|
828
|
-
type Type = 'account' | 'self';
|
|
1277
|
+
type Type = 'account' | 'application' | 'self';
|
|
829
1278
|
}
|
|
830
1279
|
}
|
|
831
1280
|
namespace InvoiceSettings {
|
|
@@ -840,7 +1289,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
840
1289
|
type: Issuer.Type;
|
|
841
1290
|
}
|
|
842
1291
|
namespace Issuer {
|
|
843
|
-
type Type = 'account' | 'self';
|
|
1292
|
+
type Type = 'account' | 'application' | 'self';
|
|
844
1293
|
}
|
|
845
1294
|
}
|
|
846
1295
|
}
|
|
@@ -906,10 +1355,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
906
1355
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
907
1356
|
*/
|
|
908
1357
|
discount?: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* Details to determine how long the discount should be applied for.
|
|
1360
|
+
*/
|
|
1361
|
+
discount_end?: Discount.DiscountEnd;
|
|
909
1362
|
/**
|
|
910
1363
|
* ID of the promotion code to create a new discount for.
|
|
911
1364
|
*/
|
|
912
1365
|
promotion_code?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* Settings for discount application including service period anchoring.
|
|
1368
|
+
*/
|
|
1369
|
+
settings?: Discount.Settings;
|
|
913
1370
|
}
|
|
914
1371
|
interface Duration {
|
|
915
1372
|
/**
|
|
@@ -921,6 +1378,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
921
1378
|
*/
|
|
922
1379
|
interval_count?: number;
|
|
923
1380
|
}
|
|
1381
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
924
1382
|
interface InvoiceSettings {
|
|
925
1383
|
/**
|
|
926
1384
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -968,6 +1426,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
968
1426
|
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
969
1427
|
*/
|
|
970
1428
|
tax_rates?: Emptyable<Array<string>>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Options that configure the trial on the subscription item.
|
|
1431
|
+
*/
|
|
1432
|
+
trial?: Item.Trial;
|
|
1433
|
+
/**
|
|
1434
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
1435
|
+
*/
|
|
1436
|
+
trial_offer?: string;
|
|
1437
|
+
}
|
|
1438
|
+
interface PauseCollection {
|
|
1439
|
+
/**
|
|
1440
|
+
* The payment collection behavior for this subscription while paused.
|
|
1441
|
+
*/
|
|
1442
|
+
behavior: PauseCollection.Behavior;
|
|
971
1443
|
}
|
|
972
1444
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
973
1445
|
interface TransferData {
|
|
@@ -980,6 +1452,13 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
980
1452
|
*/
|
|
981
1453
|
destination: string;
|
|
982
1454
|
}
|
|
1455
|
+
type TrialContinuation = 'continue' | 'none';
|
|
1456
|
+
interface TrialSettings {
|
|
1457
|
+
/**
|
|
1458
|
+
* Defines how the subscription should behave when a trial ends.
|
|
1459
|
+
*/
|
|
1460
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
1461
|
+
}
|
|
983
1462
|
namespace AddInvoiceItem {
|
|
984
1463
|
interface Discount {
|
|
985
1464
|
/**
|
|
@@ -990,6 +1469,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
990
1469
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
991
1470
|
*/
|
|
992
1471
|
discount?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* Details to determine how long the discount should be applied for.
|
|
1474
|
+
*/
|
|
1475
|
+
discount_end?: Discount.DiscountEnd;
|
|
993
1476
|
/**
|
|
994
1477
|
* ID of the promotion code to create a new discount for.
|
|
995
1478
|
*/
|
|
@@ -1027,6 +1510,38 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1027
1510
|
*/
|
|
1028
1511
|
unit_amount_decimal?: Decimal;
|
|
1029
1512
|
}
|
|
1513
|
+
namespace Discount {
|
|
1514
|
+
interface DiscountEnd {
|
|
1515
|
+
/**
|
|
1516
|
+
* Time span for the redeemed discount.
|
|
1517
|
+
*/
|
|
1518
|
+
duration?: DiscountEnd.Duration;
|
|
1519
|
+
/**
|
|
1520
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1521
|
+
*/
|
|
1522
|
+
timestamp?: number;
|
|
1523
|
+
/**
|
|
1524
|
+
* The type of calculation made to determine when the discount ends.
|
|
1525
|
+
*/
|
|
1526
|
+
type: DiscountEnd.Type;
|
|
1527
|
+
}
|
|
1528
|
+
namespace DiscountEnd {
|
|
1529
|
+
interface Duration {
|
|
1530
|
+
/**
|
|
1531
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1532
|
+
*/
|
|
1533
|
+
interval: Duration.Interval;
|
|
1534
|
+
/**
|
|
1535
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1536
|
+
*/
|
|
1537
|
+
interval_count: number;
|
|
1538
|
+
}
|
|
1539
|
+
type Type = 'duration' | 'timestamp';
|
|
1540
|
+
namespace Duration {
|
|
1541
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1542
|
+
}
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1030
1545
|
namespace Period {
|
|
1031
1546
|
interface End {
|
|
1032
1547
|
/**
|
|
@@ -1071,7 +1586,87 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1071
1586
|
type: Liability.Type;
|
|
1072
1587
|
}
|
|
1073
1588
|
namespace Liability {
|
|
1074
|
-
type Type = 'account' | 'self';
|
|
1589
|
+
type Type = 'account' | 'application' | 'self';
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
namespace Discount {
|
|
1593
|
+
interface DiscountEnd {
|
|
1594
|
+
/**
|
|
1595
|
+
* Time span for the redeemed discount.
|
|
1596
|
+
*/
|
|
1597
|
+
duration?: DiscountEnd.Duration;
|
|
1598
|
+
/**
|
|
1599
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1600
|
+
*/
|
|
1601
|
+
timestamp?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* The type of calculation made to determine when the discount ends.
|
|
1604
|
+
*/
|
|
1605
|
+
type: DiscountEnd.Type;
|
|
1606
|
+
}
|
|
1607
|
+
interface Settings {
|
|
1608
|
+
/**
|
|
1609
|
+
* Configures service period cycle anchoring.
|
|
1610
|
+
*/
|
|
1611
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1612
|
+
/**
|
|
1613
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
1614
|
+
*/
|
|
1615
|
+
start_date?: Settings.StartDate;
|
|
1616
|
+
}
|
|
1617
|
+
namespace DiscountEnd {
|
|
1618
|
+
interface Duration {
|
|
1619
|
+
/**
|
|
1620
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1621
|
+
*/
|
|
1622
|
+
interval: Duration.Interval;
|
|
1623
|
+
/**
|
|
1624
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1625
|
+
*/
|
|
1626
|
+
interval_count: number;
|
|
1627
|
+
}
|
|
1628
|
+
type Type = 'duration' | 'timestamp';
|
|
1629
|
+
namespace Duration {
|
|
1630
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
namespace Settings {
|
|
1634
|
+
interface ServicePeriodAnchorConfig {
|
|
1635
|
+
/**
|
|
1636
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1637
|
+
*/
|
|
1638
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1639
|
+
/**
|
|
1640
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1641
|
+
*/
|
|
1642
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
1643
|
+
}
|
|
1644
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1645
|
+
namespace ServicePeriodAnchorConfig {
|
|
1646
|
+
interface Custom {
|
|
1647
|
+
/**
|
|
1648
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1649
|
+
*/
|
|
1650
|
+
day_of_month: number;
|
|
1651
|
+
/**
|
|
1652
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1653
|
+
*/
|
|
1654
|
+
hour?: number;
|
|
1655
|
+
/**
|
|
1656
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1657
|
+
*/
|
|
1658
|
+
minute?: number;
|
|
1659
|
+
/**
|
|
1660
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1661
|
+
*/
|
|
1662
|
+
month?: number;
|
|
1663
|
+
/**
|
|
1664
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1665
|
+
*/
|
|
1666
|
+
second?: number;
|
|
1667
|
+
}
|
|
1668
|
+
type Type = 'custom' | 'inherit';
|
|
1669
|
+
}
|
|
1075
1670
|
}
|
|
1076
1671
|
}
|
|
1077
1672
|
namespace Duration {
|
|
@@ -1089,7 +1684,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1089
1684
|
type: Issuer.Type;
|
|
1090
1685
|
}
|
|
1091
1686
|
namespace Issuer {
|
|
1092
|
-
type Type = 'account' | 'self';
|
|
1687
|
+
type Type = 'account' | 'application' | 'self';
|
|
1093
1688
|
}
|
|
1094
1689
|
}
|
|
1095
1690
|
namespace Item {
|
|
@@ -1108,10 +1703,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1108
1703
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1109
1704
|
*/
|
|
1110
1705
|
discount?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* Details to determine how long the discount should be applied for.
|
|
1708
|
+
*/
|
|
1709
|
+
discount_end?: Discount.DiscountEnd;
|
|
1111
1710
|
/**
|
|
1112
1711
|
* ID of the promotion code to create a new discount for.
|
|
1113
1712
|
*/
|
|
1114
1713
|
promotion_code?: string;
|
|
1714
|
+
/**
|
|
1715
|
+
* Settings for discount application including service period anchoring.
|
|
1716
|
+
*/
|
|
1717
|
+
settings?: Discount.Settings;
|
|
1115
1718
|
}
|
|
1116
1719
|
interface PriceData {
|
|
1117
1720
|
/**
|
|
@@ -1139,23 +1742,133 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1139
1742
|
*/
|
|
1140
1743
|
unit_amount_decimal?: Decimal;
|
|
1141
1744
|
}
|
|
1142
|
-
|
|
1143
|
-
|
|
1745
|
+
interface Trial {
|
|
1746
|
+
/**
|
|
1747
|
+
* 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.
|
|
1748
|
+
*/
|
|
1749
|
+
converts_to?: Array<string>;
|
|
1750
|
+
/**
|
|
1751
|
+
* Determines the type of trial for this item.
|
|
1752
|
+
*/
|
|
1753
|
+
type: Trial.Type;
|
|
1754
|
+
}
|
|
1755
|
+
namespace Discount {
|
|
1756
|
+
interface DiscountEnd {
|
|
1144
1757
|
/**
|
|
1145
|
-
*
|
|
1758
|
+
* Time span for the redeemed discount.
|
|
1146
1759
|
*/
|
|
1147
|
-
|
|
1760
|
+
duration?: DiscountEnd.Duration;
|
|
1148
1761
|
/**
|
|
1149
|
-
*
|
|
1762
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1150
1763
|
*/
|
|
1151
|
-
|
|
1764
|
+
timestamp?: number;
|
|
1765
|
+
/**
|
|
1766
|
+
* The type of calculation made to determine when the discount ends.
|
|
1767
|
+
*/
|
|
1768
|
+
type: DiscountEnd.Type;
|
|
1769
|
+
}
|
|
1770
|
+
interface Settings {
|
|
1771
|
+
/**
|
|
1772
|
+
* Configures service period cycle anchoring.
|
|
1773
|
+
*/
|
|
1774
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1775
|
+
/**
|
|
1776
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
1777
|
+
*/
|
|
1778
|
+
start_date?: Settings.StartDate;
|
|
1779
|
+
}
|
|
1780
|
+
namespace DiscountEnd {
|
|
1781
|
+
interface Duration {
|
|
1782
|
+
/**
|
|
1783
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1784
|
+
*/
|
|
1785
|
+
interval: Duration.Interval;
|
|
1786
|
+
/**
|
|
1787
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1788
|
+
*/
|
|
1789
|
+
interval_count: number;
|
|
1790
|
+
}
|
|
1791
|
+
type Type = 'duration' | 'timestamp';
|
|
1792
|
+
namespace Duration {
|
|
1793
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1794
|
+
}
|
|
1795
|
+
}
|
|
1796
|
+
namespace Settings {
|
|
1797
|
+
interface ServicePeriodAnchorConfig {
|
|
1798
|
+
/**
|
|
1799
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1800
|
+
*/
|
|
1801
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1802
|
+
/**
|
|
1803
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1804
|
+
*/
|
|
1805
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
1806
|
+
}
|
|
1807
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1808
|
+
namespace ServicePeriodAnchorConfig {
|
|
1809
|
+
interface Custom {
|
|
1810
|
+
/**
|
|
1811
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1812
|
+
*/
|
|
1813
|
+
day_of_month: number;
|
|
1814
|
+
/**
|
|
1815
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1816
|
+
*/
|
|
1817
|
+
hour?: number;
|
|
1818
|
+
/**
|
|
1819
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1820
|
+
*/
|
|
1821
|
+
minute?: number;
|
|
1822
|
+
/**
|
|
1823
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1824
|
+
*/
|
|
1825
|
+
month?: number;
|
|
1826
|
+
/**
|
|
1827
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1828
|
+
*/
|
|
1829
|
+
second?: number;
|
|
1830
|
+
}
|
|
1831
|
+
type Type = 'custom' | 'inherit';
|
|
1832
|
+
}
|
|
1833
|
+
}
|
|
1834
|
+
}
|
|
1835
|
+
namespace PriceData {
|
|
1836
|
+
interface Recurring {
|
|
1837
|
+
/**
|
|
1838
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
1839
|
+
*/
|
|
1840
|
+
interval: Recurring.Interval;
|
|
1841
|
+
/**
|
|
1842
|
+
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
1843
|
+
*/
|
|
1844
|
+
interval_count?: number;
|
|
1152
1845
|
}
|
|
1153
1846
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
1154
1847
|
namespace Recurring {
|
|
1155
1848
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1156
1849
|
}
|
|
1157
1850
|
}
|
|
1851
|
+
namespace Trial {
|
|
1852
|
+
type Type = 'free' | 'paid';
|
|
1853
|
+
}
|
|
1854
|
+
}
|
|
1855
|
+
namespace PauseCollection {
|
|
1856
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1158
1857
|
}
|
|
1858
|
+
namespace TrialSettings {
|
|
1859
|
+
interface EndBehavior {
|
|
1860
|
+
/**
|
|
1861
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1862
|
+
*/
|
|
1863
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
1864
|
+
}
|
|
1865
|
+
namespace EndBehavior {
|
|
1866
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
1867
|
+
}
|
|
1868
|
+
}
|
|
1869
|
+
}
|
|
1870
|
+
namespace Prebilling {
|
|
1871
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
1159
1872
|
}
|
|
1160
1873
|
}
|
|
1161
1874
|
export interface SubscriptionScheduleRetrieveParams {
|
|
@@ -1165,6 +1878,14 @@ export interface SubscriptionScheduleRetrieveParams {
|
|
|
1165
1878
|
expand?: Array<string>;
|
|
1166
1879
|
}
|
|
1167
1880
|
export interface SubscriptionScheduleUpdateParams {
|
|
1881
|
+
/**
|
|
1882
|
+
* 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.
|
|
1883
|
+
*/
|
|
1884
|
+
billing_behavior?: SubscriptionScheduleUpdateParams.BillingBehavior;
|
|
1885
|
+
/**
|
|
1886
|
+
* Sets the billing schedules for the subscription schedule.
|
|
1887
|
+
*/
|
|
1888
|
+
billing_schedules?: Emptyable<Array<SubscriptionScheduleUpdateParams.BillingSchedule>>;
|
|
1168
1889
|
/**
|
|
1169
1890
|
* Object representing the subscription schedule's default settings.
|
|
1170
1891
|
*/
|
|
@@ -1185,12 +1906,31 @@ export interface SubscriptionScheduleUpdateParams {
|
|
|
1185
1906
|
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
|
|
1186
1907
|
*/
|
|
1187
1908
|
phases?: Array<SubscriptionScheduleUpdateParams.Phase>;
|
|
1909
|
+
/**
|
|
1910
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1911
|
+
*/
|
|
1912
|
+
prebilling?: SubscriptionScheduleUpdateParams.Prebilling;
|
|
1188
1913
|
/**
|
|
1189
1914
|
* If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
|
|
1190
1915
|
*/
|
|
1191
1916
|
proration_behavior?: SubscriptionScheduleUpdateParams.ProrationBehavior;
|
|
1192
1917
|
}
|
|
1193
1918
|
export declare namespace SubscriptionScheduleUpdateParams {
|
|
1919
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1920
|
+
interface BillingSchedule {
|
|
1921
|
+
/**
|
|
1922
|
+
* Configure billing schedule differently for individual subscription items.
|
|
1923
|
+
*/
|
|
1924
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1925
|
+
/**
|
|
1926
|
+
* The end date for the billing schedule.
|
|
1927
|
+
*/
|
|
1928
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
1929
|
+
/**
|
|
1930
|
+
* 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.
|
|
1931
|
+
*/
|
|
1932
|
+
key?: string;
|
|
1933
|
+
}
|
|
1194
1934
|
interface DefaultSettings {
|
|
1195
1935
|
/**
|
|
1196
1936
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
|
@@ -1228,6 +1968,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1228
1968
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1229
1969
|
*/
|
|
1230
1970
|
on_behalf_of?: Emptyable<string>;
|
|
1971
|
+
/**
|
|
1972
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1973
|
+
*/
|
|
1974
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
1231
1975
|
/**
|
|
1232
1976
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
1233
1977
|
*/
|
|
@@ -1283,6 +2027,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1283
2027
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
1284
2028
|
*/
|
|
1285
2029
|
duration?: Phase.Duration;
|
|
2030
|
+
/**
|
|
2031
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2032
|
+
*/
|
|
2033
|
+
effective_at?: Phase.EffectiveAt;
|
|
1286
2034
|
/**
|
|
1287
2035
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
1288
2036
|
*/
|
|
@@ -1303,6 +2051,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1303
2051
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1304
2052
|
*/
|
|
1305
2053
|
on_behalf_of?: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* 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://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
2056
|
+
*/
|
|
2057
|
+
pause_collection?: Phase.PauseCollection;
|
|
1306
2058
|
/**
|
|
1307
2059
|
* Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/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://docs.stripe.com/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.
|
|
1308
2060
|
*/
|
|
@@ -1319,12 +2071,72 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1319
2071
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1320
2072
|
*/
|
|
1321
2073
|
trial?: boolean;
|
|
2074
|
+
/**
|
|
2075
|
+
* Specify trial behavior when crossing phase boundaries
|
|
2076
|
+
*/
|
|
2077
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
1322
2078
|
/**
|
|
1323
2079
|
* 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`
|
|
1324
2080
|
*/
|
|
1325
2081
|
trial_end?: number | 'now';
|
|
2082
|
+
/**
|
|
2083
|
+
* Settings related to subscription trials.
|
|
2084
|
+
*/
|
|
2085
|
+
trial_settings?: Phase.TrialSettings;
|
|
2086
|
+
}
|
|
2087
|
+
interface Prebilling {
|
|
2088
|
+
/**
|
|
2089
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
2090
|
+
*/
|
|
2091
|
+
iterations: number;
|
|
2092
|
+
/**
|
|
2093
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2094
|
+
*/
|
|
2095
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
1326
2096
|
}
|
|
1327
2097
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2098
|
+
namespace BillingSchedule {
|
|
2099
|
+
interface AppliesTo {
|
|
2100
|
+
/**
|
|
2101
|
+
* The ID of the price object.
|
|
2102
|
+
*/
|
|
2103
|
+
price?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* Controls which subscription items the billing schedule applies to.
|
|
2106
|
+
*/
|
|
2107
|
+
type: 'price';
|
|
2108
|
+
}
|
|
2109
|
+
interface BillUntil {
|
|
2110
|
+
/**
|
|
2111
|
+
* Specifies the billing period.
|
|
2112
|
+
*/
|
|
2113
|
+
duration?: BillUntil.Duration;
|
|
2114
|
+
/**
|
|
2115
|
+
* The end date of the billing schedule.
|
|
2116
|
+
*/
|
|
2117
|
+
timestamp?: number;
|
|
2118
|
+
/**
|
|
2119
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
2120
|
+
*/
|
|
2121
|
+
type: BillUntil.Type;
|
|
2122
|
+
}
|
|
2123
|
+
namespace BillUntil {
|
|
2124
|
+
interface Duration {
|
|
2125
|
+
/**
|
|
2126
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
2127
|
+
*/
|
|
2128
|
+
interval: Duration.Interval;
|
|
2129
|
+
/**
|
|
2130
|
+
* The multiplier applied to the interval.
|
|
2131
|
+
*/
|
|
2132
|
+
interval_count?: number;
|
|
2133
|
+
}
|
|
2134
|
+
type Type = 'duration' | 'timestamp';
|
|
2135
|
+
namespace Duration {
|
|
2136
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
}
|
|
1328
2140
|
namespace DefaultSettings {
|
|
1329
2141
|
interface AutomaticTax {
|
|
1330
2142
|
/**
|
|
@@ -1362,6 +2174,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1362
2174
|
*/
|
|
1363
2175
|
issuer?: InvoiceSettings.Issuer;
|
|
1364
2176
|
}
|
|
2177
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1365
2178
|
interface TransferData {
|
|
1366
2179
|
/**
|
|
1367
2180
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -1384,7 +2197,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1384
2197
|
type: Liability.Type;
|
|
1385
2198
|
}
|
|
1386
2199
|
namespace Liability {
|
|
1387
|
-
type Type = 'account' | 'self';
|
|
2200
|
+
type Type = 'account' | 'application' | 'self';
|
|
1388
2201
|
}
|
|
1389
2202
|
}
|
|
1390
2203
|
namespace InvoiceSettings {
|
|
@@ -1399,7 +2212,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1399
2212
|
type: Issuer.Type;
|
|
1400
2213
|
}
|
|
1401
2214
|
namespace Issuer {
|
|
1402
|
-
type Type = 'account' | 'self';
|
|
2215
|
+
type Type = 'account' | 'application' | 'self';
|
|
1403
2216
|
}
|
|
1404
2217
|
}
|
|
1405
2218
|
}
|
|
@@ -1465,10 +2278,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1465
2278
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1466
2279
|
*/
|
|
1467
2280
|
discount?: string;
|
|
2281
|
+
/**
|
|
2282
|
+
* Details to determine how long the discount should be applied for.
|
|
2283
|
+
*/
|
|
2284
|
+
discount_end?: Discount.DiscountEnd;
|
|
1468
2285
|
/**
|
|
1469
2286
|
* ID of the promotion code to create a new discount for.
|
|
1470
2287
|
*/
|
|
1471
2288
|
promotion_code?: string;
|
|
2289
|
+
/**
|
|
2290
|
+
* Settings for discount application including service period anchoring.
|
|
2291
|
+
*/
|
|
2292
|
+
settings?: Discount.Settings;
|
|
1472
2293
|
}
|
|
1473
2294
|
interface Duration {
|
|
1474
2295
|
/**
|
|
@@ -1480,6 +2301,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1480
2301
|
*/
|
|
1481
2302
|
interval_count?: number;
|
|
1482
2303
|
}
|
|
2304
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1483
2305
|
interface InvoiceSettings {
|
|
1484
2306
|
/**
|
|
1485
2307
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -1527,6 +2349,20 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1527
2349
|
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
1528
2350
|
*/
|
|
1529
2351
|
tax_rates?: Emptyable<Array<string>>;
|
|
2352
|
+
/**
|
|
2353
|
+
* Options that configure the trial on the subscription item.
|
|
2354
|
+
*/
|
|
2355
|
+
trial?: Item.Trial;
|
|
2356
|
+
/**
|
|
2357
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
2358
|
+
*/
|
|
2359
|
+
trial_offer?: string;
|
|
2360
|
+
}
|
|
2361
|
+
interface PauseCollection {
|
|
2362
|
+
/**
|
|
2363
|
+
* The payment collection behavior for this subscription while paused.
|
|
2364
|
+
*/
|
|
2365
|
+
behavior: PauseCollection.Behavior;
|
|
1530
2366
|
}
|
|
1531
2367
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1532
2368
|
interface TransferData {
|
|
@@ -1539,6 +2375,13 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1539
2375
|
*/
|
|
1540
2376
|
destination: string;
|
|
1541
2377
|
}
|
|
2378
|
+
type TrialContinuation = 'continue' | 'none';
|
|
2379
|
+
interface TrialSettings {
|
|
2380
|
+
/**
|
|
2381
|
+
* Defines how the subscription should behave when a trial ends.
|
|
2382
|
+
*/
|
|
2383
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
2384
|
+
}
|
|
1542
2385
|
namespace AddInvoiceItem {
|
|
1543
2386
|
interface Discount {
|
|
1544
2387
|
/**
|
|
@@ -1549,6 +2392,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1549
2392
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1550
2393
|
*/
|
|
1551
2394
|
discount?: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* Details to determine how long the discount should be applied for.
|
|
2397
|
+
*/
|
|
2398
|
+
discount_end?: Discount.DiscountEnd;
|
|
1552
2399
|
/**
|
|
1553
2400
|
* ID of the promotion code to create a new discount for.
|
|
1554
2401
|
*/
|
|
@@ -1586,6 +2433,38 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1586
2433
|
*/
|
|
1587
2434
|
unit_amount_decimal?: Decimal;
|
|
1588
2435
|
}
|
|
2436
|
+
namespace Discount {
|
|
2437
|
+
interface DiscountEnd {
|
|
2438
|
+
/**
|
|
2439
|
+
* Time span for the redeemed discount.
|
|
2440
|
+
*/
|
|
2441
|
+
duration?: DiscountEnd.Duration;
|
|
2442
|
+
/**
|
|
2443
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2444
|
+
*/
|
|
2445
|
+
timestamp?: number;
|
|
2446
|
+
/**
|
|
2447
|
+
* The type of calculation made to determine when the discount ends.
|
|
2448
|
+
*/
|
|
2449
|
+
type: DiscountEnd.Type;
|
|
2450
|
+
}
|
|
2451
|
+
namespace DiscountEnd {
|
|
2452
|
+
interface Duration {
|
|
2453
|
+
/**
|
|
2454
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2455
|
+
*/
|
|
2456
|
+
interval: Duration.Interval;
|
|
2457
|
+
/**
|
|
2458
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2459
|
+
*/
|
|
2460
|
+
interval_count: number;
|
|
2461
|
+
}
|
|
2462
|
+
type Type = 'duration' | 'timestamp';
|
|
2463
|
+
namespace Duration {
|
|
2464
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2465
|
+
}
|
|
2466
|
+
}
|
|
2467
|
+
}
|
|
1589
2468
|
namespace Period {
|
|
1590
2469
|
interface End {
|
|
1591
2470
|
/**
|
|
@@ -1630,7 +2509,87 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1630
2509
|
type: Liability.Type;
|
|
1631
2510
|
}
|
|
1632
2511
|
namespace Liability {
|
|
1633
|
-
type Type = 'account' | 'self';
|
|
2512
|
+
type Type = 'account' | 'application' | 'self';
|
|
2513
|
+
}
|
|
2514
|
+
}
|
|
2515
|
+
namespace Discount {
|
|
2516
|
+
interface DiscountEnd {
|
|
2517
|
+
/**
|
|
2518
|
+
* Time span for the redeemed discount.
|
|
2519
|
+
*/
|
|
2520
|
+
duration?: DiscountEnd.Duration;
|
|
2521
|
+
/**
|
|
2522
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2523
|
+
*/
|
|
2524
|
+
timestamp?: number;
|
|
2525
|
+
/**
|
|
2526
|
+
* The type of calculation made to determine when the discount ends.
|
|
2527
|
+
*/
|
|
2528
|
+
type: DiscountEnd.Type;
|
|
2529
|
+
}
|
|
2530
|
+
interface Settings {
|
|
2531
|
+
/**
|
|
2532
|
+
* Configures service period cycle anchoring.
|
|
2533
|
+
*/
|
|
2534
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2535
|
+
/**
|
|
2536
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
2537
|
+
*/
|
|
2538
|
+
start_date?: Settings.StartDate;
|
|
2539
|
+
}
|
|
2540
|
+
namespace DiscountEnd {
|
|
2541
|
+
interface Duration {
|
|
2542
|
+
/**
|
|
2543
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2544
|
+
*/
|
|
2545
|
+
interval: Duration.Interval;
|
|
2546
|
+
/**
|
|
2547
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2548
|
+
*/
|
|
2549
|
+
interval_count: number;
|
|
2550
|
+
}
|
|
2551
|
+
type Type = 'duration' | 'timestamp';
|
|
2552
|
+
namespace Duration {
|
|
2553
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2554
|
+
}
|
|
2555
|
+
}
|
|
2556
|
+
namespace Settings {
|
|
2557
|
+
interface ServicePeriodAnchorConfig {
|
|
2558
|
+
/**
|
|
2559
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2560
|
+
*/
|
|
2561
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2562
|
+
/**
|
|
2563
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2564
|
+
*/
|
|
2565
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2566
|
+
}
|
|
2567
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2568
|
+
namespace ServicePeriodAnchorConfig {
|
|
2569
|
+
interface Custom {
|
|
2570
|
+
/**
|
|
2571
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2572
|
+
*/
|
|
2573
|
+
day_of_month: number;
|
|
2574
|
+
/**
|
|
2575
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2576
|
+
*/
|
|
2577
|
+
hour?: number;
|
|
2578
|
+
/**
|
|
2579
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2580
|
+
*/
|
|
2581
|
+
minute?: number;
|
|
2582
|
+
/**
|
|
2583
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2584
|
+
*/
|
|
2585
|
+
month?: number;
|
|
2586
|
+
/**
|
|
2587
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2588
|
+
*/
|
|
2589
|
+
second?: number;
|
|
2590
|
+
}
|
|
2591
|
+
type Type = 'custom' | 'inherit';
|
|
2592
|
+
}
|
|
1634
2593
|
}
|
|
1635
2594
|
}
|
|
1636
2595
|
namespace Duration {
|
|
@@ -1648,7 +2607,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1648
2607
|
type: Issuer.Type;
|
|
1649
2608
|
}
|
|
1650
2609
|
namespace Issuer {
|
|
1651
|
-
type Type = 'account' | 'self';
|
|
2610
|
+
type Type = 'account' | 'application' | 'self';
|
|
1652
2611
|
}
|
|
1653
2612
|
}
|
|
1654
2613
|
namespace Item {
|
|
@@ -1667,10 +2626,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1667
2626
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1668
2627
|
*/
|
|
1669
2628
|
discount?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Details to determine how long the discount should be applied for.
|
|
2631
|
+
*/
|
|
2632
|
+
discount_end?: Discount.DiscountEnd;
|
|
1670
2633
|
/**
|
|
1671
2634
|
* ID of the promotion code to create a new discount for.
|
|
1672
2635
|
*/
|
|
1673
2636
|
promotion_code?: string;
|
|
2637
|
+
/**
|
|
2638
|
+
* Settings for discount application including service period anchoring.
|
|
2639
|
+
*/
|
|
2640
|
+
settings?: Discount.Settings;
|
|
1674
2641
|
}
|
|
1675
2642
|
interface PriceData {
|
|
1676
2643
|
/**
|
|
@@ -1698,6 +2665,96 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1698
2665
|
*/
|
|
1699
2666
|
unit_amount_decimal?: Decimal;
|
|
1700
2667
|
}
|
|
2668
|
+
interface Trial {
|
|
2669
|
+
/**
|
|
2670
|
+
* 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.
|
|
2671
|
+
*/
|
|
2672
|
+
converts_to?: Array<string>;
|
|
2673
|
+
/**
|
|
2674
|
+
* Determines the type of trial for this item.
|
|
2675
|
+
*/
|
|
2676
|
+
type: Trial.Type;
|
|
2677
|
+
}
|
|
2678
|
+
namespace Discount {
|
|
2679
|
+
interface DiscountEnd {
|
|
2680
|
+
/**
|
|
2681
|
+
* Time span for the redeemed discount.
|
|
2682
|
+
*/
|
|
2683
|
+
duration?: DiscountEnd.Duration;
|
|
2684
|
+
/**
|
|
2685
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2686
|
+
*/
|
|
2687
|
+
timestamp?: number;
|
|
2688
|
+
/**
|
|
2689
|
+
* The type of calculation made to determine when the discount ends.
|
|
2690
|
+
*/
|
|
2691
|
+
type: DiscountEnd.Type;
|
|
2692
|
+
}
|
|
2693
|
+
interface Settings {
|
|
2694
|
+
/**
|
|
2695
|
+
* Configures service period cycle anchoring.
|
|
2696
|
+
*/
|
|
2697
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2698
|
+
/**
|
|
2699
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
2700
|
+
*/
|
|
2701
|
+
start_date?: Settings.StartDate;
|
|
2702
|
+
}
|
|
2703
|
+
namespace DiscountEnd {
|
|
2704
|
+
interface Duration {
|
|
2705
|
+
/**
|
|
2706
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2707
|
+
*/
|
|
2708
|
+
interval: Duration.Interval;
|
|
2709
|
+
/**
|
|
2710
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2711
|
+
*/
|
|
2712
|
+
interval_count: number;
|
|
2713
|
+
}
|
|
2714
|
+
type Type = 'duration' | 'timestamp';
|
|
2715
|
+
namespace Duration {
|
|
2716
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2717
|
+
}
|
|
2718
|
+
}
|
|
2719
|
+
namespace Settings {
|
|
2720
|
+
interface ServicePeriodAnchorConfig {
|
|
2721
|
+
/**
|
|
2722
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2723
|
+
*/
|
|
2724
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2725
|
+
/**
|
|
2726
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2727
|
+
*/
|
|
2728
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2729
|
+
}
|
|
2730
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2731
|
+
namespace ServicePeriodAnchorConfig {
|
|
2732
|
+
interface Custom {
|
|
2733
|
+
/**
|
|
2734
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2735
|
+
*/
|
|
2736
|
+
day_of_month: number;
|
|
2737
|
+
/**
|
|
2738
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2739
|
+
*/
|
|
2740
|
+
hour?: number;
|
|
2741
|
+
/**
|
|
2742
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2743
|
+
*/
|
|
2744
|
+
minute?: number;
|
|
2745
|
+
/**
|
|
2746
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2747
|
+
*/
|
|
2748
|
+
month?: number;
|
|
2749
|
+
/**
|
|
2750
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2751
|
+
*/
|
|
2752
|
+
second?: number;
|
|
2753
|
+
}
|
|
2754
|
+
type Type = 'custom' | 'inherit';
|
|
2755
|
+
}
|
|
2756
|
+
}
|
|
2757
|
+
}
|
|
1701
2758
|
namespace PriceData {
|
|
1702
2759
|
interface Recurring {
|
|
1703
2760
|
/**
|
|
@@ -1714,7 +2771,27 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1714
2771
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1715
2772
|
}
|
|
1716
2773
|
}
|
|
2774
|
+
namespace Trial {
|
|
2775
|
+
type Type = 'free' | 'paid';
|
|
2776
|
+
}
|
|
1717
2777
|
}
|
|
2778
|
+
namespace PauseCollection {
|
|
2779
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2780
|
+
}
|
|
2781
|
+
namespace TrialSettings {
|
|
2782
|
+
interface EndBehavior {
|
|
2783
|
+
/**
|
|
2784
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2785
|
+
*/
|
|
2786
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2787
|
+
}
|
|
2788
|
+
namespace EndBehavior {
|
|
2789
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
2790
|
+
}
|
|
2791
|
+
}
|
|
2792
|
+
}
|
|
2793
|
+
namespace Prebilling {
|
|
2794
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
1718
2795
|
}
|
|
1719
2796
|
}
|
|
1720
2797
|
export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
@@ -1751,6 +2828,847 @@ export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
|
1751
2828
|
*/
|
|
1752
2829
|
scheduled?: boolean;
|
|
1753
2830
|
}
|
|
2831
|
+
export interface SubscriptionScheduleAmendParams {
|
|
2832
|
+
/**
|
|
2833
|
+
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2834
|
+
*/
|
|
2835
|
+
amendments?: Array<SubscriptionScheduleAmendParams.Amendment>;
|
|
2836
|
+
/**
|
|
2837
|
+
* Specifies which fields in the response should be expanded.
|
|
2838
|
+
*/
|
|
2839
|
+
expand?: Array<string>;
|
|
2840
|
+
/**
|
|
2841
|
+
* Provide any time periods to bill in advance.
|
|
2842
|
+
*/
|
|
2843
|
+
prebilling?: Emptyable<Array<SubscriptionScheduleAmendParams.Prebilling>>;
|
|
2844
|
+
/**
|
|
2845
|
+
* In cases where the amendment changes the currently active phase,
|
|
2846
|
+
* specifies if and how to prorate at the time of the request.
|
|
2847
|
+
*/
|
|
2848
|
+
proration_behavior?: SubscriptionScheduleAmendParams.ProrationBehavior;
|
|
2849
|
+
/**
|
|
2850
|
+
* Changes to apply to the subscription schedule.
|
|
2851
|
+
*/
|
|
2852
|
+
schedule_settings?: SubscriptionScheduleAmendParams.ScheduleSettings;
|
|
2853
|
+
}
|
|
2854
|
+
export declare namespace SubscriptionScheduleAmendParams {
|
|
2855
|
+
interface Amendment {
|
|
2856
|
+
/**
|
|
2857
|
+
* 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.
|
|
2858
|
+
*/
|
|
2859
|
+
amendment_end?: Amendment.AmendmentEnd;
|
|
2860
|
+
/**
|
|
2861
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2862
|
+
*/
|
|
2863
|
+
amendment_start: Amendment.AmendmentStart;
|
|
2864
|
+
/**
|
|
2865
|
+
* 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.
|
|
2866
|
+
*/
|
|
2867
|
+
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2868
|
+
/**
|
|
2869
|
+
* Actions to apply to the billing schedules.
|
|
2870
|
+
*/
|
|
2871
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
2872
|
+
/**
|
|
2873
|
+
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2874
|
+
*/
|
|
2875
|
+
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2876
|
+
/**
|
|
2877
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2878
|
+
*/
|
|
2879
|
+
effective_at?: Amendment.EffectiveAt;
|
|
2880
|
+
/**
|
|
2881
|
+
* Changes to the subscription items during the amendment time span.
|
|
2882
|
+
*/
|
|
2883
|
+
item_actions?: Array<Amendment.ItemAction>;
|
|
2884
|
+
/**
|
|
2885
|
+
* Instructions for how to modify phase metadata
|
|
2886
|
+
*/
|
|
2887
|
+
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2888
|
+
/**
|
|
2889
|
+
* 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`.
|
|
2890
|
+
*/
|
|
2891
|
+
proration_behavior?: Amendment.ProrationBehavior;
|
|
2892
|
+
/**
|
|
2893
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2894
|
+
*/
|
|
2895
|
+
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2896
|
+
/**
|
|
2897
|
+
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2898
|
+
*/
|
|
2899
|
+
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2900
|
+
/**
|
|
2901
|
+
* Settings related to subscription trials.
|
|
2902
|
+
*/
|
|
2903
|
+
trial_settings?: Amendment.TrialSettings;
|
|
2904
|
+
}
|
|
2905
|
+
interface Prebilling {
|
|
2906
|
+
/**
|
|
2907
|
+
* The beginning of the prebilled time period. The default value is `now`.
|
|
2908
|
+
*/
|
|
2909
|
+
bill_from?: Prebilling.BillFrom;
|
|
2910
|
+
/**
|
|
2911
|
+
* The end of the prebilled time period.
|
|
2912
|
+
*/
|
|
2913
|
+
bill_until?: Prebilling.BillUntil;
|
|
2914
|
+
/**
|
|
2915
|
+
* When the prebilling invoice should be created. The default value is `now`.
|
|
2916
|
+
*/
|
|
2917
|
+
invoice_at?: 'now';
|
|
2918
|
+
/**
|
|
2919
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2920
|
+
*/
|
|
2921
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
2922
|
+
}
|
|
2923
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2924
|
+
interface ScheduleSettings {
|
|
2925
|
+
/**
|
|
2926
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
2927
|
+
*/
|
|
2928
|
+
end_behavior?: ScheduleSettings.EndBehavior;
|
|
2929
|
+
}
|
|
2930
|
+
namespace Amendment {
|
|
2931
|
+
interface AmendmentEnd {
|
|
2932
|
+
/**
|
|
2933
|
+
* Use the `end` time of a given discount.
|
|
2934
|
+
*/
|
|
2935
|
+
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2936
|
+
/**
|
|
2937
|
+
* Time span for the amendment starting from the `amendment_start`.
|
|
2938
|
+
*/
|
|
2939
|
+
duration?: AmendmentEnd.Duration;
|
|
2940
|
+
/**
|
|
2941
|
+
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2942
|
+
*/
|
|
2943
|
+
timestamp?: number;
|
|
2944
|
+
/**
|
|
2945
|
+
* Select one of three ways to pass the `amendment_end`.
|
|
2946
|
+
*/
|
|
2947
|
+
type: AmendmentEnd.Type;
|
|
2948
|
+
}
|
|
2949
|
+
interface AmendmentStart {
|
|
2950
|
+
/**
|
|
2951
|
+
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2952
|
+
*/
|
|
2953
|
+
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2954
|
+
/**
|
|
2955
|
+
* Use the `end` time of a given discount.
|
|
2956
|
+
*/
|
|
2957
|
+
discount_end?: AmendmentStart.DiscountEnd;
|
|
2958
|
+
/**
|
|
2959
|
+
* A precise Unix timestamp for the amendment to start.
|
|
2960
|
+
*/
|
|
2961
|
+
timestamp?: number;
|
|
2962
|
+
/**
|
|
2963
|
+
* Select one of three ways to pass the `amendment_start`.
|
|
2964
|
+
*/
|
|
2965
|
+
type: AmendmentStart.Type;
|
|
2966
|
+
}
|
|
2967
|
+
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
2968
|
+
interface BillingSchedulesAction {
|
|
2969
|
+
/**
|
|
2970
|
+
* Specify which subscription items the billing schedule applies to.
|
|
2971
|
+
*/
|
|
2972
|
+
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
2973
|
+
/**
|
|
2974
|
+
* Select the action.
|
|
2975
|
+
*/
|
|
2976
|
+
type: BillingSchedulesAction.Type;
|
|
2977
|
+
}
|
|
2978
|
+
interface DiscountAction {
|
|
2979
|
+
/**
|
|
2980
|
+
* Details of the discount to add.
|
|
2981
|
+
*/
|
|
2982
|
+
add?: DiscountAction.Add;
|
|
2983
|
+
/**
|
|
2984
|
+
* Details of the discount to remove.
|
|
2985
|
+
*/
|
|
2986
|
+
remove?: DiscountAction.Remove;
|
|
2987
|
+
/**
|
|
2988
|
+
* Details of the discount to replace the existing discounts with.
|
|
2989
|
+
*/
|
|
2990
|
+
set?: DiscountAction.Set;
|
|
2991
|
+
/**
|
|
2992
|
+
* Determines the type of discount action.
|
|
2993
|
+
*/
|
|
2994
|
+
type: DiscountAction.Type;
|
|
2995
|
+
}
|
|
2996
|
+
type EffectiveAt = 'amendment_start' | 'billing_period_start';
|
|
2997
|
+
interface ItemAction {
|
|
2998
|
+
/**
|
|
2999
|
+
* 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.
|
|
3000
|
+
*/
|
|
3001
|
+
add?: ItemAction.Add;
|
|
3002
|
+
/**
|
|
3003
|
+
* Details of the subscription item to remove.
|
|
3004
|
+
*/
|
|
3005
|
+
remove?: ItemAction.Remove;
|
|
3006
|
+
/**
|
|
3007
|
+
* 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.
|
|
3008
|
+
*/
|
|
3009
|
+
set?: ItemAction.Set;
|
|
3010
|
+
/**
|
|
3011
|
+
* Determines the type of item action.
|
|
3012
|
+
*/
|
|
3013
|
+
type: ItemAction.Type;
|
|
3014
|
+
}
|
|
3015
|
+
interface MetadataAction {
|
|
3016
|
+
/**
|
|
3017
|
+
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3018
|
+
*/
|
|
3019
|
+
add?: {
|
|
3020
|
+
[key: string]: string;
|
|
3021
|
+
};
|
|
3022
|
+
/**
|
|
3023
|
+
* Keys to remove from schedule phase metadata.
|
|
3024
|
+
*/
|
|
3025
|
+
remove?: Array<string>;
|
|
3026
|
+
/**
|
|
3027
|
+
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3028
|
+
*/
|
|
3029
|
+
set?: Emptyable<{
|
|
3030
|
+
[key: string]: string;
|
|
3031
|
+
}>;
|
|
3032
|
+
/**
|
|
3033
|
+
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3034
|
+
*/
|
|
3035
|
+
type: MetadataAction.Type;
|
|
3036
|
+
}
|
|
3037
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3038
|
+
interface SetPauseCollection {
|
|
3039
|
+
/**
|
|
3040
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
3041
|
+
*/
|
|
3042
|
+
set?: SetPauseCollection.Set;
|
|
3043
|
+
/**
|
|
3044
|
+
* Determines the type of the pause_collection amendment.
|
|
3045
|
+
*/
|
|
3046
|
+
type: SetPauseCollection.Type;
|
|
3047
|
+
}
|
|
3048
|
+
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3049
|
+
interface TrialSettings {
|
|
3050
|
+
/**
|
|
3051
|
+
* Defines how the subscription should behave when a trial ends.
|
|
3052
|
+
*/
|
|
3053
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
3054
|
+
}
|
|
3055
|
+
namespace AmendmentEnd {
|
|
3056
|
+
interface DiscountEnd {
|
|
3057
|
+
/**
|
|
3058
|
+
* The ID of a specific discount.
|
|
3059
|
+
*/
|
|
3060
|
+
discount: string;
|
|
3061
|
+
}
|
|
3062
|
+
interface Duration {
|
|
3063
|
+
/**
|
|
3064
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3065
|
+
*/
|
|
3066
|
+
interval: Duration.Interval;
|
|
3067
|
+
/**
|
|
3068
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3069
|
+
*/
|
|
3070
|
+
interval_count: number;
|
|
3071
|
+
}
|
|
3072
|
+
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3073
|
+
namespace Duration {
|
|
3074
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3075
|
+
}
|
|
3076
|
+
}
|
|
3077
|
+
namespace AmendmentStart {
|
|
3078
|
+
interface AmendmentEnd {
|
|
3079
|
+
/**
|
|
3080
|
+
* 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.
|
|
3081
|
+
*/
|
|
3082
|
+
index: number;
|
|
3083
|
+
}
|
|
3084
|
+
interface DiscountEnd {
|
|
3085
|
+
/**
|
|
3086
|
+
* The ID of a specific discount.
|
|
3087
|
+
*/
|
|
3088
|
+
discount: string;
|
|
3089
|
+
}
|
|
3090
|
+
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3091
|
+
}
|
|
3092
|
+
namespace BillingSchedulesAction {
|
|
3093
|
+
interface AppliesTo {
|
|
3094
|
+
/**
|
|
3095
|
+
* The ID of the price object.
|
|
3096
|
+
*/
|
|
3097
|
+
price?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* Controls which subscription items the billing schedule applies to.
|
|
3100
|
+
*/
|
|
3101
|
+
type: 'price';
|
|
3102
|
+
}
|
|
3103
|
+
type Type = 'remove' | 'set';
|
|
3104
|
+
}
|
|
3105
|
+
namespace DiscountAction {
|
|
3106
|
+
interface Add {
|
|
3107
|
+
/**
|
|
3108
|
+
* The coupon code to redeem.
|
|
3109
|
+
*/
|
|
3110
|
+
coupon?: string;
|
|
3111
|
+
/**
|
|
3112
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3113
|
+
*/
|
|
3114
|
+
discount?: string;
|
|
3115
|
+
/**
|
|
3116
|
+
* Details to determine how long the discount should be applied for.
|
|
3117
|
+
*/
|
|
3118
|
+
discount_end?: Add.DiscountEnd;
|
|
3119
|
+
/**
|
|
3120
|
+
* 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.
|
|
3121
|
+
*/
|
|
3122
|
+
index?: number;
|
|
3123
|
+
/**
|
|
3124
|
+
* The promotion code to redeem.
|
|
3125
|
+
*/
|
|
3126
|
+
promotion_code?: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* Settings for discount application including service period anchoring.
|
|
3129
|
+
*/
|
|
3130
|
+
settings?: Add.Settings;
|
|
3131
|
+
}
|
|
3132
|
+
interface Remove {
|
|
3133
|
+
/**
|
|
3134
|
+
* The coupon code to remove from the `discounts` array.
|
|
3135
|
+
*/
|
|
3136
|
+
coupon?: string;
|
|
3137
|
+
/**
|
|
3138
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
3139
|
+
*/
|
|
3140
|
+
discount?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
3143
|
+
*/
|
|
3144
|
+
promotion_code?: string;
|
|
3145
|
+
}
|
|
3146
|
+
interface Set {
|
|
3147
|
+
/**
|
|
3148
|
+
* The coupon code to replace the `discounts` array with.
|
|
3149
|
+
*/
|
|
3150
|
+
coupon?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
3153
|
+
*/
|
|
3154
|
+
discount?: string;
|
|
3155
|
+
/**
|
|
3156
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3157
|
+
*/
|
|
3158
|
+
promotion_code?: string;
|
|
3159
|
+
/**
|
|
3160
|
+
* Settings for discount application including service period anchoring.
|
|
3161
|
+
*/
|
|
3162
|
+
settings?: Set.Settings;
|
|
3163
|
+
}
|
|
3164
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3165
|
+
namespace Add {
|
|
3166
|
+
interface DiscountEnd {
|
|
3167
|
+
/**
|
|
3168
|
+
* The type of calculation made to determine when the discount ends.
|
|
3169
|
+
*/
|
|
3170
|
+
type: 'amendment_end';
|
|
3171
|
+
}
|
|
3172
|
+
interface Settings {
|
|
3173
|
+
/**
|
|
3174
|
+
* Configures service period cycle anchoring.
|
|
3175
|
+
*/
|
|
3176
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3177
|
+
/**
|
|
3178
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3179
|
+
*/
|
|
3180
|
+
start_date?: Settings.StartDate;
|
|
3181
|
+
}
|
|
3182
|
+
namespace Settings {
|
|
3183
|
+
interface ServicePeriodAnchorConfig {
|
|
3184
|
+
/**
|
|
3185
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3186
|
+
*/
|
|
3187
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3188
|
+
/**
|
|
3189
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3190
|
+
*/
|
|
3191
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3192
|
+
}
|
|
3193
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3194
|
+
namespace ServicePeriodAnchorConfig {
|
|
3195
|
+
interface Custom {
|
|
3196
|
+
/**
|
|
3197
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3198
|
+
*/
|
|
3199
|
+
day_of_month: number;
|
|
3200
|
+
/**
|
|
3201
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3202
|
+
*/
|
|
3203
|
+
hour?: number;
|
|
3204
|
+
/**
|
|
3205
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3206
|
+
*/
|
|
3207
|
+
minute?: number;
|
|
3208
|
+
/**
|
|
3209
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3210
|
+
*/
|
|
3211
|
+
month?: number;
|
|
3212
|
+
/**
|
|
3213
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3214
|
+
*/
|
|
3215
|
+
second?: number;
|
|
3216
|
+
}
|
|
3217
|
+
type Type = 'custom' | 'inherit';
|
|
3218
|
+
}
|
|
3219
|
+
}
|
|
3220
|
+
}
|
|
3221
|
+
namespace Set {
|
|
3222
|
+
interface Settings {
|
|
3223
|
+
/**
|
|
3224
|
+
* Configures service period cycle anchoring.
|
|
3225
|
+
*/
|
|
3226
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3227
|
+
/**
|
|
3228
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3229
|
+
*/
|
|
3230
|
+
start_date?: Settings.StartDate;
|
|
3231
|
+
}
|
|
3232
|
+
namespace Settings {
|
|
3233
|
+
interface ServicePeriodAnchorConfig {
|
|
3234
|
+
/**
|
|
3235
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3236
|
+
*/
|
|
3237
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3238
|
+
/**
|
|
3239
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3240
|
+
*/
|
|
3241
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3242
|
+
}
|
|
3243
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3244
|
+
namespace ServicePeriodAnchorConfig {
|
|
3245
|
+
interface Custom {
|
|
3246
|
+
/**
|
|
3247
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3248
|
+
*/
|
|
3249
|
+
day_of_month: number;
|
|
3250
|
+
/**
|
|
3251
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3252
|
+
*/
|
|
3253
|
+
hour?: number;
|
|
3254
|
+
/**
|
|
3255
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3256
|
+
*/
|
|
3257
|
+
minute?: number;
|
|
3258
|
+
/**
|
|
3259
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3260
|
+
*/
|
|
3261
|
+
month?: number;
|
|
3262
|
+
/**
|
|
3263
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3264
|
+
*/
|
|
3265
|
+
second?: number;
|
|
3266
|
+
}
|
|
3267
|
+
type Type = 'custom' | 'inherit';
|
|
3268
|
+
}
|
|
3269
|
+
}
|
|
3270
|
+
}
|
|
3271
|
+
}
|
|
3272
|
+
namespace ItemAction {
|
|
3273
|
+
interface Add {
|
|
3274
|
+
/**
|
|
3275
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3276
|
+
*/
|
|
3277
|
+
discounts?: Array<Add.Discount>;
|
|
3278
|
+
/**
|
|
3279
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
3280
|
+
*/
|
|
3281
|
+
metadata?: MetadataParam;
|
|
3282
|
+
/**
|
|
3283
|
+
* The ID of the price object.
|
|
3284
|
+
*/
|
|
3285
|
+
price: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* Quantity for this item.
|
|
3288
|
+
*/
|
|
3289
|
+
quantity?: number;
|
|
3290
|
+
/**
|
|
3291
|
+
* 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`.
|
|
3292
|
+
*/
|
|
3293
|
+
tax_rates?: Array<string>;
|
|
3294
|
+
/**
|
|
3295
|
+
* Options that configure the trial on the subscription item.
|
|
3296
|
+
*/
|
|
3297
|
+
trial?: Add.Trial;
|
|
3298
|
+
/**
|
|
3299
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3300
|
+
*/
|
|
3301
|
+
trial_offer?: string;
|
|
3302
|
+
}
|
|
3303
|
+
interface Remove {
|
|
3304
|
+
/**
|
|
3305
|
+
* ID of a price to remove.
|
|
3306
|
+
*/
|
|
3307
|
+
price: string;
|
|
3308
|
+
}
|
|
3309
|
+
interface Set {
|
|
3310
|
+
/**
|
|
3311
|
+
* 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`.
|
|
3312
|
+
*/
|
|
3313
|
+
discounts?: Array<Set.Discount>;
|
|
3314
|
+
/**
|
|
3315
|
+
* 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`.
|
|
3316
|
+
*/
|
|
3317
|
+
metadata?: MetadataParam;
|
|
3318
|
+
/**
|
|
3319
|
+
* The ID of the price object.
|
|
3320
|
+
*/
|
|
3321
|
+
price: string;
|
|
3322
|
+
/**
|
|
3323
|
+
* 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`.
|
|
3324
|
+
*/
|
|
3325
|
+
quantity?: number;
|
|
3326
|
+
/**
|
|
3327
|
+
* 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`.
|
|
3328
|
+
*/
|
|
3329
|
+
tax_rates?: Array<string>;
|
|
3330
|
+
/**
|
|
3331
|
+
* 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`.
|
|
3332
|
+
*/
|
|
3333
|
+
trial?: Set.Trial;
|
|
3334
|
+
/**
|
|
3335
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3336
|
+
*/
|
|
3337
|
+
trial_offer?: string;
|
|
3338
|
+
}
|
|
3339
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3340
|
+
namespace Add {
|
|
3341
|
+
interface Discount {
|
|
3342
|
+
/**
|
|
3343
|
+
* ID of the coupon to create a new discount for.
|
|
3344
|
+
*/
|
|
3345
|
+
coupon?: string;
|
|
3346
|
+
/**
|
|
3347
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3348
|
+
*/
|
|
3349
|
+
discount?: string;
|
|
3350
|
+
/**
|
|
3351
|
+
* Details to determine how long the discount should be applied for.
|
|
3352
|
+
*/
|
|
3353
|
+
discount_end?: Discount.DiscountEnd;
|
|
3354
|
+
/**
|
|
3355
|
+
* ID of the promotion code to create a new discount for.
|
|
3356
|
+
*/
|
|
3357
|
+
promotion_code?: string;
|
|
3358
|
+
/**
|
|
3359
|
+
* Settings for discount application including service period anchoring.
|
|
3360
|
+
*/
|
|
3361
|
+
settings?: Discount.Settings;
|
|
3362
|
+
}
|
|
3363
|
+
interface Trial {
|
|
3364
|
+
/**
|
|
3365
|
+
* 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.
|
|
3366
|
+
*/
|
|
3367
|
+
converts_to?: Array<string>;
|
|
3368
|
+
/**
|
|
3369
|
+
* Determines the type of trial for this item.
|
|
3370
|
+
*/
|
|
3371
|
+
type: Trial.Type;
|
|
3372
|
+
}
|
|
3373
|
+
namespace Discount {
|
|
3374
|
+
interface DiscountEnd {
|
|
3375
|
+
/**
|
|
3376
|
+
* Time span for the redeemed discount.
|
|
3377
|
+
*/
|
|
3378
|
+
duration?: DiscountEnd.Duration;
|
|
3379
|
+
/**
|
|
3380
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3381
|
+
*/
|
|
3382
|
+
timestamp?: number;
|
|
3383
|
+
/**
|
|
3384
|
+
* The type of calculation made to determine when the discount ends.
|
|
3385
|
+
*/
|
|
3386
|
+
type: DiscountEnd.Type;
|
|
3387
|
+
}
|
|
3388
|
+
interface Settings {
|
|
3389
|
+
/**
|
|
3390
|
+
* Configures service period cycle anchoring.
|
|
3391
|
+
*/
|
|
3392
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3393
|
+
/**
|
|
3394
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3395
|
+
*/
|
|
3396
|
+
start_date?: Settings.StartDate;
|
|
3397
|
+
}
|
|
3398
|
+
namespace DiscountEnd {
|
|
3399
|
+
interface Duration {
|
|
3400
|
+
/**
|
|
3401
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3402
|
+
*/
|
|
3403
|
+
interval: Duration.Interval;
|
|
3404
|
+
/**
|
|
3405
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3406
|
+
*/
|
|
3407
|
+
interval_count: number;
|
|
3408
|
+
}
|
|
3409
|
+
type Type = 'duration' | 'timestamp';
|
|
3410
|
+
namespace Duration {
|
|
3411
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3412
|
+
}
|
|
3413
|
+
}
|
|
3414
|
+
namespace Settings {
|
|
3415
|
+
interface ServicePeriodAnchorConfig {
|
|
3416
|
+
/**
|
|
3417
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3418
|
+
*/
|
|
3419
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3420
|
+
/**
|
|
3421
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3422
|
+
*/
|
|
3423
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3424
|
+
}
|
|
3425
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3426
|
+
namespace ServicePeriodAnchorConfig {
|
|
3427
|
+
interface Custom {
|
|
3428
|
+
/**
|
|
3429
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3430
|
+
*/
|
|
3431
|
+
day_of_month: number;
|
|
3432
|
+
/**
|
|
3433
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3434
|
+
*/
|
|
3435
|
+
hour?: number;
|
|
3436
|
+
/**
|
|
3437
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3438
|
+
*/
|
|
3439
|
+
minute?: number;
|
|
3440
|
+
/**
|
|
3441
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3442
|
+
*/
|
|
3443
|
+
month?: number;
|
|
3444
|
+
/**
|
|
3445
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3446
|
+
*/
|
|
3447
|
+
second?: number;
|
|
3448
|
+
}
|
|
3449
|
+
type Type = 'custom' | 'inherit';
|
|
3450
|
+
}
|
|
3451
|
+
}
|
|
3452
|
+
}
|
|
3453
|
+
namespace Trial {
|
|
3454
|
+
type Type = 'free' | 'paid';
|
|
3455
|
+
}
|
|
3456
|
+
}
|
|
3457
|
+
namespace Set {
|
|
3458
|
+
interface Discount {
|
|
3459
|
+
/**
|
|
3460
|
+
* ID of the coupon to create a new discount for.
|
|
3461
|
+
*/
|
|
3462
|
+
coupon?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3465
|
+
*/
|
|
3466
|
+
discount?: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Details to determine how long the discount should be applied for.
|
|
3469
|
+
*/
|
|
3470
|
+
discount_end?: Discount.DiscountEnd;
|
|
3471
|
+
/**
|
|
3472
|
+
* ID of the promotion code to create a new discount for.
|
|
3473
|
+
*/
|
|
3474
|
+
promotion_code?: string;
|
|
3475
|
+
/**
|
|
3476
|
+
* Settings for discount application including service period anchoring.
|
|
3477
|
+
*/
|
|
3478
|
+
settings?: Discount.Settings;
|
|
3479
|
+
}
|
|
3480
|
+
interface Trial {
|
|
3481
|
+
/**
|
|
3482
|
+
* 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.
|
|
3483
|
+
*/
|
|
3484
|
+
converts_to?: Array<string>;
|
|
3485
|
+
/**
|
|
3486
|
+
* Determines the type of trial for this item.
|
|
3487
|
+
*/
|
|
3488
|
+
type: Trial.Type;
|
|
3489
|
+
}
|
|
3490
|
+
namespace Discount {
|
|
3491
|
+
interface DiscountEnd {
|
|
3492
|
+
/**
|
|
3493
|
+
* Time span for the redeemed discount.
|
|
3494
|
+
*/
|
|
3495
|
+
duration?: DiscountEnd.Duration;
|
|
3496
|
+
/**
|
|
3497
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3498
|
+
*/
|
|
3499
|
+
timestamp?: number;
|
|
3500
|
+
/**
|
|
3501
|
+
* The type of calculation made to determine when the discount ends.
|
|
3502
|
+
*/
|
|
3503
|
+
type: DiscountEnd.Type;
|
|
3504
|
+
}
|
|
3505
|
+
interface Settings {
|
|
3506
|
+
/**
|
|
3507
|
+
* Configures service period cycle anchoring.
|
|
3508
|
+
*/
|
|
3509
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3510
|
+
/**
|
|
3511
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3512
|
+
*/
|
|
3513
|
+
start_date?: Settings.StartDate;
|
|
3514
|
+
}
|
|
3515
|
+
namespace DiscountEnd {
|
|
3516
|
+
interface Duration {
|
|
3517
|
+
/**
|
|
3518
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3519
|
+
*/
|
|
3520
|
+
interval: Duration.Interval;
|
|
3521
|
+
/**
|
|
3522
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3523
|
+
*/
|
|
3524
|
+
interval_count: number;
|
|
3525
|
+
}
|
|
3526
|
+
type Type = 'duration' | 'timestamp';
|
|
3527
|
+
namespace Duration {
|
|
3528
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3529
|
+
}
|
|
3530
|
+
}
|
|
3531
|
+
namespace Settings {
|
|
3532
|
+
interface ServicePeriodAnchorConfig {
|
|
3533
|
+
/**
|
|
3534
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3535
|
+
*/
|
|
3536
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3537
|
+
/**
|
|
3538
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3539
|
+
*/
|
|
3540
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3541
|
+
}
|
|
3542
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3543
|
+
namespace ServicePeriodAnchorConfig {
|
|
3544
|
+
interface Custom {
|
|
3545
|
+
/**
|
|
3546
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3547
|
+
*/
|
|
3548
|
+
day_of_month: number;
|
|
3549
|
+
/**
|
|
3550
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3551
|
+
*/
|
|
3552
|
+
hour?: number;
|
|
3553
|
+
/**
|
|
3554
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3555
|
+
*/
|
|
3556
|
+
minute?: number;
|
|
3557
|
+
/**
|
|
3558
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3559
|
+
*/
|
|
3560
|
+
month?: number;
|
|
3561
|
+
/**
|
|
3562
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3563
|
+
*/
|
|
3564
|
+
second?: number;
|
|
3565
|
+
}
|
|
3566
|
+
type Type = 'custom' | 'inherit';
|
|
3567
|
+
}
|
|
3568
|
+
}
|
|
3569
|
+
}
|
|
3570
|
+
namespace Trial {
|
|
3571
|
+
type Type = 'free' | 'paid';
|
|
3572
|
+
}
|
|
3573
|
+
}
|
|
3574
|
+
}
|
|
3575
|
+
namespace MetadataAction {
|
|
3576
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3577
|
+
}
|
|
3578
|
+
namespace SetPauseCollection {
|
|
3579
|
+
interface Set {
|
|
3580
|
+
/**
|
|
3581
|
+
* The payment collection behavior for this subscription while paused.
|
|
3582
|
+
*/
|
|
3583
|
+
behavior: Set.Behavior;
|
|
3584
|
+
}
|
|
3585
|
+
type Type = 'remove' | 'set';
|
|
3586
|
+
namespace Set {
|
|
3587
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3588
|
+
}
|
|
3589
|
+
}
|
|
3590
|
+
namespace TrialSettings {
|
|
3591
|
+
interface EndBehavior {
|
|
3592
|
+
/**
|
|
3593
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3594
|
+
*/
|
|
3595
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3596
|
+
}
|
|
3597
|
+
namespace EndBehavior {
|
|
3598
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
3599
|
+
}
|
|
3600
|
+
}
|
|
3601
|
+
}
|
|
3602
|
+
namespace Prebilling {
|
|
3603
|
+
interface BillFrom {
|
|
3604
|
+
/**
|
|
3605
|
+
* Start the prebilled period when a specified amendment begins.
|
|
3606
|
+
*/
|
|
3607
|
+
amendment_start?: BillFrom.AmendmentStart;
|
|
3608
|
+
/**
|
|
3609
|
+
* Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3610
|
+
*/
|
|
3611
|
+
timestamp?: number;
|
|
3612
|
+
/**
|
|
3613
|
+
* Select one of several ways to pass the `bill_from` value.
|
|
3614
|
+
*/
|
|
3615
|
+
type: BillFrom.Type;
|
|
3616
|
+
}
|
|
3617
|
+
interface BillUntil {
|
|
3618
|
+
/**
|
|
3619
|
+
* End the prebilled period when a specified amendment ends.
|
|
3620
|
+
*/
|
|
3621
|
+
amendment_end?: BillUntil.AmendmentEnd;
|
|
3622
|
+
/**
|
|
3623
|
+
* Time span for prebilling, starting from `bill_from`.
|
|
3624
|
+
*/
|
|
3625
|
+
duration?: BillUntil.Duration;
|
|
3626
|
+
/**
|
|
3627
|
+
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3628
|
+
*/
|
|
3629
|
+
timestamp?: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* Select one of several ways to pass the `bill_until` value.
|
|
3632
|
+
*/
|
|
3633
|
+
type: BillUntil.Type;
|
|
3634
|
+
}
|
|
3635
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
3636
|
+
namespace BillFrom {
|
|
3637
|
+
interface AmendmentStart {
|
|
3638
|
+
/**
|
|
3639
|
+
* The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
3640
|
+
*/
|
|
3641
|
+
index: number;
|
|
3642
|
+
}
|
|
3643
|
+
type Type = 'amendment_start' | 'now' | 'timestamp';
|
|
3644
|
+
}
|
|
3645
|
+
namespace BillUntil {
|
|
3646
|
+
interface AmendmentEnd {
|
|
3647
|
+
/**
|
|
3648
|
+
* 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.
|
|
3649
|
+
*/
|
|
3650
|
+
index: number;
|
|
3651
|
+
}
|
|
3652
|
+
interface Duration {
|
|
3653
|
+
/**
|
|
3654
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3655
|
+
*/
|
|
3656
|
+
interval: Duration.Interval;
|
|
3657
|
+
/**
|
|
3658
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3659
|
+
*/
|
|
3660
|
+
interval_count: number;
|
|
3661
|
+
}
|
|
3662
|
+
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
3663
|
+
namespace Duration {
|
|
3664
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3665
|
+
}
|
|
3666
|
+
}
|
|
3667
|
+
}
|
|
3668
|
+
namespace ScheduleSettings {
|
|
3669
|
+
type EndBehavior = 'cancel' | 'release';
|
|
3670
|
+
}
|
|
3671
|
+
}
|
|
1754
3672
|
export interface SubscriptionScheduleCancelParams {
|
|
1755
3673
|
/**
|
|
1756
3674
|
* Specifies which fields in the response should be expanded.
|
|
@@ -1775,3 +3693,9 @@ export interface SubscriptionScheduleReleaseParams {
|
|
|
1775
3693
|
*/
|
|
1776
3694
|
preserve_cancel_date?: boolean;
|
|
1777
3695
|
}
|
|
3696
|
+
export interface SubscriptionScheduleSerializeBatchCancelParams {
|
|
3697
|
+
}
|
|
3698
|
+
export interface SubscriptionScheduleSerializeBatchCreateParams {
|
|
3699
|
+
}
|
|
3700
|
+
export interface SubscriptionScheduleSerializeBatchUpdateParams {
|
|
3701
|
+
}
|