stripe 22.2.0 → 22.3.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 +2754 -12
- 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/RequestSender.d.ts +1 -1
- package/cjs/RequestSender.js +2 -2
- package/cjs/RequestSender.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +471 -0
- package/cjs/StripeEventNotificationHandler.js.map +1 -0
- 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 +1020 -6
- package/cjs/resources/Accounts.js +47 -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 +408 -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 +25 -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 +3515 -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 +130 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +128 -2
- package/cjs/resources/Coupons.js +41 -0
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +7 -1
- package/cjs/resources/CreditNotes.js +13 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/CustomerSessions.d.ts +74 -0
- package/cjs/resources/CustomerSessions.js +13 -0
- package/cjs/resources/CustomerSessions.js.map +1 -1
- package/cjs/resources/Customers.d.ts +85 -1
- package/cjs/resources/Customers.js +195 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +130 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js +4 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/Orders.d.ts +161 -0
- package/cjs/resources/DelegatedCheckout/Orders.js +15 -0
- package/cjs/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1418 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +47 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/index.d.ts +25 -0
- package/cjs/resources/DelegatedCheckout/index.js +15 -0
- package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
- package/cjs/resources/Discounts.d.ts +19 -0
- package/cjs/resources/Disputes.d.ts +43 -0
- package/cjs/resources/Disputes.js +14 -0
- package/cjs/resources/Disputes.js.map +1 -1
- package/cjs/resources/Events.d.ts +573 -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 +203 -2
- package/cjs/resources/InvoiceItems.js +41 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +174 -4
- package/cjs/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +2063 -20
- package/cjs/resources/Invoices.js +221 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +290 -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 +190 -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/Tokens.d.ts +22 -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 +453 -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 +16660 -3570
- 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/PaymentLocationCapabilities.d.ts +122 -0
- package/cjs/resources/PaymentLocationCapabilities.js +29 -0
- package/cjs/resources/PaymentLocationCapabilities.js.map +1 -0
- package/cjs/resources/PaymentLocations.d.ts +178 -0
- package/cjs/resources/PaymentLocations.js +41 -0
- package/cjs/resources/PaymentLocations.js.map +1 -0
- 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 +262 -3
- package/cjs/resources/PaymentMethods.js +20 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +351 -21
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Persons.d.ts +25 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +76 -0
- package/cjs/resources/Prices.js +27 -0
- package/cjs/resources/Prices.js.map +1 -1
- 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 +171 -0
- package/cjs/resources/Products.js +69 -0
- package/cjs/resources/Products.js.map +1 -1
- 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 +27 -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 +1173 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +901 -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 +214 -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/ValueListItems.d.ts +8 -0
- package/cjs/resources/Radar/ValueListItems.js +13 -0
- package/cjs/resources/Radar/ValueListItems.js.map +1 -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 +23 -0
- package/cjs/resources/Refunds.js +27 -0
- package/cjs/resources/Refunds.js.map +1 -1
- 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 +561 -11
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1137 -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 +265 -0
- package/cjs/resources/SubscriptionItems.js +41 -0
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +1949 -19
- package/cjs/resources/SubscriptionSchedules.js +61 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +965 -12
- package/cjs/resources/Subscriptions.js +289 -0
- 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 +171 -2
- package/cjs/resources/Tax/Registrations.js +27 -0
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +8 -0
- package/cjs/resources/Tax/Settings.js +13 -0
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/Transactions.d.ts +10 -2
- package/cjs/resources/Tax/Transactions.js +13 -0
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- 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/TaxIds.d.ts +6 -0
- package/cjs/resources/TaxIds.js +13 -0
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +12 -0
- package/cjs/resources/TaxRates.js +27 -0
- package/cjs/resources/TaxRates.js.map +1 -1
- 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 +17 -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 +88 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.d.ts +104 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js +33 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
- package/cjs/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js.map +1 -1
- 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 +61 -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/ContractLicensePricingQuantityChanges.d.ts +45 -0
- package/cjs/resources/V2/Billing/ContractLicensePricingQuantityChanges.js +4 -0
- package/cjs/resources/V2/Billing/ContractLicensePricingQuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.d.ts +23 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js +17 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.d.ts +8 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.js +15 -0
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts.d.ts +2028 -0
- package/cjs/resources/V2/Billing/Contracts.js +376 -0
- package/cjs/resources/V2/Billing/Contracts.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 +364 -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/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 +173 -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 +340 -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 +174 -6
- package/cjs/resources/V2/Billing/index.js +32 -0
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- 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 +220 -2
- package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts.d.ts +5570 -67
- 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/Events.d.ts +7601 -232
- package/cjs/resources/V2/Core/FeeBatches.d.ts +172 -0
- package/cjs/resources/V2/Core/FeeBatches.js +23 -0
- package/cjs/resources/V2/Core/FeeBatches.js.map +1 -0
- package/cjs/resources/V2/Core/FeeEntries.d.ts +178 -0
- package/cjs/resources/V2/Core/FeeEntries.js +23 -0
- package/cjs/resources/V2/Core/FeeEntries.js.map +1 -0
- 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 +63 -14
- package/cjs/resources/V2/Core/index.js +16 -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 +177 -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 +214 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js +23 -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 +23 -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/DebitDisputes.d.ts +171 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js +29 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +103 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js +4 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +44 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +53 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +417 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +50 -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 +321 -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 +458 -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 +251 -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 +249 -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 +280 -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 +128 -0
- package/cjs/resources/V2/MoneyManagement/index.js +45 -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 +194 -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/Signals/AccountSignals.d.ts +176 -0
- package/cjs/resources/V2/Signals/AccountSignals.js +58 -0
- package/cjs/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/cjs/resources/V2/Signals/index.d.ts +13 -0
- package/cjs/resources/V2/Signals/index.js +13 -0
- package/cjs/resources/V2/Signals/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 +22 -0
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +2 -2
- package/cjs/resources.d.ts +16 -0
- package/cjs/resources.js +256 -14
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.core.d.ts +115 -50
- package/cjs/stripe.core.js +67 -31
- package/cjs/stripe.core.js.map +1 -1
- package/cjs/utils.d.ts +1 -1
- package/cjs/utils.js +13 -2
- package/cjs/utils.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/RequestSender.d.ts +1 -1
- package/esm/RequestSender.js +2 -2
- package/esm/RequestSender.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +467 -0
- package/esm/StripeEventNotificationHandler.js.map +1 -0
- 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 +1020 -6
- package/esm/resources/Accounts.js +47 -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 +408 -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 +25 -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 +3515 -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 +130 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/Coupons.d.ts +128 -2
- package/esm/resources/Coupons.js +41 -0
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +7 -1
- package/esm/resources/CreditNotes.js +13 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/CustomerSessions.d.ts +74 -0
- package/esm/resources/CustomerSessions.js +13 -0
- package/esm/resources/CustomerSessions.js.map +1 -1
- package/esm/resources/Customers.d.ts +85 -1
- package/esm/resources/Customers.js +195 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +130 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js +3 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/esm/resources/DelegatedCheckout/Orders.d.ts +161 -0
- package/esm/resources/DelegatedCheckout/Orders.js +11 -0
- package/esm/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1418 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +43 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/esm/resources/DelegatedCheckout/index.d.ts +25 -0
- package/esm/resources/DelegatedCheckout/index.js +11 -0
- package/esm/resources/DelegatedCheckout/index.js.map +1 -0
- package/esm/resources/Discounts.d.ts +19 -0
- package/esm/resources/Disputes.d.ts +43 -0
- package/esm/resources/Disputes.js +14 -0
- package/esm/resources/Disputes.js.map +1 -1
- package/esm/resources/Events.d.ts +573 -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 +203 -2
- package/esm/resources/InvoiceItems.js +41 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +174 -4
- package/esm/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/esm/resources/InvoiceRenderingTemplates.js +28 -0
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +2063 -20
- package/esm/resources/Invoices.js +221 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +290 -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 +190 -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/Tokens.d.ts +22 -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 +453 -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 +16660 -3570
- 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/PaymentLocationCapabilities.d.ts +122 -0
- package/esm/resources/PaymentLocationCapabilities.js +25 -0
- package/esm/resources/PaymentLocationCapabilities.js.map +1 -0
- package/esm/resources/PaymentLocations.d.ts +178 -0
- package/esm/resources/PaymentLocations.js +37 -0
- package/esm/resources/PaymentLocations.js.map +1 -0
- 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 +262 -3
- package/esm/resources/PaymentMethods.js +20 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +351 -21
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Persons.d.ts +25 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +76 -0
- package/esm/resources/Prices.js +27 -0
- package/esm/resources/Prices.js.map +1 -1
- 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 +171 -0
- package/esm/resources/Products.js +69 -0
- package/esm/resources/Products.js.map +1 -1
- 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 +27 -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 +1173 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +901 -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 +214 -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/ValueListItems.d.ts +8 -0
- package/esm/resources/Radar/ValueListItems.js +13 -0
- package/esm/resources/Radar/ValueListItems.js.map +1 -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 +23 -0
- package/esm/resources/Refunds.js +27 -0
- package/esm/resources/Refunds.js.map +1 -1
- 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 +561 -11
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +1137 -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 +265 -0
- package/esm/resources/SubscriptionItems.js +41 -0
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +1949 -19
- package/esm/resources/SubscriptionSchedules.js +61 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +965 -12
- package/esm/resources/Subscriptions.js +289 -0
- 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 +171 -2
- package/esm/resources/Tax/Registrations.js +27 -0
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +8 -0
- package/esm/resources/Tax/Settings.js +13 -0
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/Transactions.d.ts +10 -2
- package/esm/resources/Tax/Transactions.js +13 -0
- package/esm/resources/Tax/Transactions.js.map +1 -1
- 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/TaxIds.d.ts +6 -0
- package/esm/resources/TaxIds.js +13 -0
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +12 -0
- package/esm/resources/TaxRates.js +27 -0
- package/esm/resources/TaxRates.js.map +1 -1
- 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 +17 -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 +88 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +8 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.d.ts +104 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js +29 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +16 -0
- package/esm/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js.map +1 -1
- 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 +61 -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/ContractLicensePricingQuantityChanges.d.ts +45 -0
- package/esm/resources/V2/Billing/ContractLicensePricingQuantityChanges.js +3 -0
- package/esm/resources/V2/Billing/ContractLicensePricingQuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.d.ts +23 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js +13 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing.d.ts +8 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing.js +11 -0
- package/esm/resources/V2/Billing/Contracts/LicensePricing.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts.d.ts +2028 -0
- package/esm/resources/V2/Billing/Contracts.js +372 -0
- package/esm/resources/V2/Billing/Contracts.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 +364 -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/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 +173 -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 +340 -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 +174 -6
- package/esm/resources/V2/Billing/index.js +32 -0
- package/esm/resources/V2/Billing/index.js.map +1 -1
- 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 +220 -2
- package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts.d.ts +5570 -67
- 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/Events.d.ts +7601 -232
- package/esm/resources/V2/Core/FeeBatches.d.ts +172 -0
- package/esm/resources/V2/Core/FeeBatches.js +19 -0
- package/esm/resources/V2/Core/FeeBatches.js.map +1 -0
- package/esm/resources/V2/Core/FeeEntries.d.ts +178 -0
- package/esm/resources/V2/Core/FeeEntries.js +19 -0
- package/esm/resources/V2/Core/FeeEntries.js.map +1 -0
- 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 +63 -14
- package/esm/resources/V2/Core/index.js +16 -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 +177 -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 +214 -0
- package/esm/resources/V2/Iam/ActivityLogs.js +19 -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 +23 -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/DebitDisputes.d.ts +171 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js +25 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +103 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js +3 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +44 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +49 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +417 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +46 -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 +321 -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 +458 -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 +251 -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 +249 -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 +280 -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 +128 -0
- package/esm/resources/V2/MoneyManagement/index.js +41 -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 +194 -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/Signals/AccountSignals.d.ts +176 -0
- package/esm/resources/V2/Signals/AccountSignals.js +54 -0
- package/esm/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/esm/resources/V2/Signals/index.d.ts +13 -0
- package/esm/resources/V2/Signals/index.js +9 -0
- package/esm/resources/V2/Signals/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 +16 -0
- package/esm/resources.js +233 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +115 -50
- package/esm/stripe.core.js +37 -1
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +115 -50
- package/esm/stripe.esm.node.js +37 -1
- package/esm/stripe.esm.node.js.map +1 -1
- package/esm/utils.d.ts +1 -1
- package/esm/utils.js +13 -2
- package/esm/utils.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,22 @@ 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;
|
|
58
|
+
serializeBatchRelease(schedule: string, params?: Record<string, unknown>, options?: {
|
|
59
|
+
apiVersion?: string;
|
|
60
|
+
stripeContext?: string;
|
|
61
|
+
}): string;
|
|
41
62
|
}
|
|
42
63
|
export interface SubscriptionSchedule {
|
|
43
64
|
/**
|
|
@@ -52,10 +73,18 @@ export interface SubscriptionSchedule {
|
|
|
52
73
|
* ID of the Connect Application that created the schedule.
|
|
53
74
|
*/
|
|
54
75
|
application: string | Application | DeletedApplication | null;
|
|
76
|
+
/**
|
|
77
|
+
* 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.
|
|
78
|
+
*/
|
|
79
|
+
billing_behavior?: SubscriptionSchedule.BillingBehavior;
|
|
55
80
|
/**
|
|
56
81
|
* The billing mode of the subscription.
|
|
57
82
|
*/
|
|
58
83
|
billing_mode: SubscriptionSchedule.BillingMode;
|
|
84
|
+
/**
|
|
85
|
+
* Billing schedules for this subscription schedule.
|
|
86
|
+
*/
|
|
87
|
+
billing_schedules?: Array<SubscriptionSchedule.BillingSchedule>;
|
|
59
88
|
/**
|
|
60
89
|
* Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
61
90
|
*/
|
|
@@ -85,6 +114,14 @@ export interface SubscriptionSchedule {
|
|
|
85
114
|
* 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
115
|
*/
|
|
87
116
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
117
|
+
/**
|
|
118
|
+
* Details of the most recent price migration that failed for the subscription schedule.
|
|
119
|
+
*/
|
|
120
|
+
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
121
|
+
/**
|
|
122
|
+
* The most recent invoice this subscription schedule has generated.
|
|
123
|
+
*/
|
|
124
|
+
latest_invoice?: string | Invoice | null;
|
|
88
125
|
/**
|
|
89
126
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
90
127
|
*/
|
|
@@ -97,6 +134,10 @@ export interface SubscriptionSchedule {
|
|
|
97
134
|
* Configuration for the subscription schedule's phases.
|
|
98
135
|
*/
|
|
99
136
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
137
|
+
/**
|
|
138
|
+
* Time period and invoice for a Subscription billed in advance.
|
|
139
|
+
*/
|
|
140
|
+
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
100
141
|
/**
|
|
101
142
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
102
143
|
*/
|
|
@@ -119,6 +160,7 @@ export interface SubscriptionSchedule {
|
|
|
119
160
|
test_clock: string | TestHelpers.TestClock | null;
|
|
120
161
|
}
|
|
121
162
|
export declare namespace SubscriptionSchedule {
|
|
163
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
122
164
|
interface BillingMode {
|
|
123
165
|
/**
|
|
124
166
|
* Configure behavior for flexible billing mode
|
|
@@ -133,6 +175,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
133
175
|
*/
|
|
134
176
|
updated_at?: number;
|
|
135
177
|
}
|
|
178
|
+
interface BillingSchedule {
|
|
179
|
+
/**
|
|
180
|
+
* Specifies which subscription items the billing schedule applies to.
|
|
181
|
+
*/
|
|
182
|
+
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
183
|
+
/**
|
|
184
|
+
* Specifies the end of billing period.
|
|
185
|
+
*/
|
|
186
|
+
bill_until: BillingSchedule.BillUntil;
|
|
187
|
+
/**
|
|
188
|
+
* Unique identifier for the billing schedule.
|
|
189
|
+
*/
|
|
190
|
+
key: string;
|
|
191
|
+
}
|
|
136
192
|
interface CurrentPhase {
|
|
137
193
|
/**
|
|
138
194
|
* The end of this phase of the subscription schedule.
|
|
@@ -174,12 +230,30 @@ export declare namespace SubscriptionSchedule {
|
|
|
174
230
|
* 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
231
|
*/
|
|
176
232
|
on_behalf_of: string | Account | null;
|
|
233
|
+
/**
|
|
234
|
+
* 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.
|
|
235
|
+
*/
|
|
236
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
177
237
|
/**
|
|
178
238
|
* 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
239
|
*/
|
|
180
240
|
transfer_data: DefaultSettings.TransferData | null;
|
|
181
241
|
}
|
|
182
242
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
243
|
+
interface LastPriceMigrationError {
|
|
244
|
+
/**
|
|
245
|
+
* The time at which the price migration encountered an error.
|
|
246
|
+
*/
|
|
247
|
+
errored_at: number;
|
|
248
|
+
/**
|
|
249
|
+
* The involved price pairs in each failed transition.
|
|
250
|
+
*/
|
|
251
|
+
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
252
|
+
/**
|
|
253
|
+
* The type of error encountered by the price migration.
|
|
254
|
+
*/
|
|
255
|
+
type: 'price_uniqueness_violation';
|
|
256
|
+
}
|
|
183
257
|
interface Phase {
|
|
184
258
|
/**
|
|
185
259
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -222,6 +296,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
222
296
|
* The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
|
223
297
|
*/
|
|
224
298
|
discounts: Array<Phase.Discount>;
|
|
299
|
+
/**
|
|
300
|
+
* 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.
|
|
301
|
+
*/
|
|
302
|
+
effective_at?: Phase.EffectiveAt | null;
|
|
225
303
|
/**
|
|
226
304
|
* The end of this phase of the subscription schedule.
|
|
227
305
|
*/
|
|
@@ -242,6 +320,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
242
320
|
* 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
321
|
*/
|
|
244
322
|
on_behalf_of: string | Account | null;
|
|
323
|
+
/**
|
|
324
|
+
* 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).
|
|
325
|
+
*/
|
|
326
|
+
pause_collection?: Phase.PauseCollection | null;
|
|
245
327
|
/**
|
|
246
328
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
247
329
|
*/
|
|
@@ -254,10 +336,36 @@ export declare namespace SubscriptionSchedule {
|
|
|
254
336
|
* 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
337
|
*/
|
|
256
338
|
transfer_data: Phase.TransferData | null;
|
|
339
|
+
/**
|
|
340
|
+
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
341
|
+
*/
|
|
342
|
+
trial_continuation?: Phase.TrialContinuation | null;
|
|
257
343
|
/**
|
|
258
344
|
* When the trial ends within the phase.
|
|
259
345
|
*/
|
|
260
346
|
trial_end: number | null;
|
|
347
|
+
/**
|
|
348
|
+
* Settings related to any trials on the subscription during this phase.
|
|
349
|
+
*/
|
|
350
|
+
trial_settings?: Phase.TrialSettings | null;
|
|
351
|
+
}
|
|
352
|
+
interface Prebilling {
|
|
353
|
+
/**
|
|
354
|
+
* ID of the prebilling invoice.
|
|
355
|
+
*/
|
|
356
|
+
invoice: string | Invoice;
|
|
357
|
+
/**
|
|
358
|
+
* The end of the last period for which the invoice pre-bills.
|
|
359
|
+
*/
|
|
360
|
+
period_end: number;
|
|
361
|
+
/**
|
|
362
|
+
* The start of the first period for which the invoice pre-bills.
|
|
363
|
+
*/
|
|
364
|
+
period_start: number;
|
|
365
|
+
/**
|
|
366
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
367
|
+
*/
|
|
368
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
261
369
|
}
|
|
262
370
|
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released';
|
|
263
371
|
namespace BillingMode {
|
|
@@ -272,6 +380,52 @@ export declare namespace SubscriptionSchedule {
|
|
|
272
380
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
273
381
|
}
|
|
274
382
|
}
|
|
383
|
+
namespace BillingSchedule {
|
|
384
|
+
interface AppliesTo {
|
|
385
|
+
/**
|
|
386
|
+
* The billing schedule will apply to the subscription item with the given price ID.
|
|
387
|
+
*/
|
|
388
|
+
price: string | Price | null;
|
|
389
|
+
/**
|
|
390
|
+
* Controls which subscription items the billing schedule applies to.
|
|
391
|
+
*/
|
|
392
|
+
type: 'price';
|
|
393
|
+
}
|
|
394
|
+
interface BillUntil {
|
|
395
|
+
/**
|
|
396
|
+
* The timestamp the billing schedule will apply until.
|
|
397
|
+
*/
|
|
398
|
+
computed_timestamp: number;
|
|
399
|
+
/**
|
|
400
|
+
* Specifies the billing period.
|
|
401
|
+
*/
|
|
402
|
+
duration: BillUntil.Duration | null;
|
|
403
|
+
/**
|
|
404
|
+
* If specified, the billing schedule will apply until the specified timestamp.
|
|
405
|
+
*/
|
|
406
|
+
timestamp: number | null;
|
|
407
|
+
/**
|
|
408
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
409
|
+
*/
|
|
410
|
+
type: BillUntil.Type;
|
|
411
|
+
}
|
|
412
|
+
namespace BillUntil {
|
|
413
|
+
interface Duration {
|
|
414
|
+
/**
|
|
415
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
416
|
+
*/
|
|
417
|
+
interval: Duration.Interval;
|
|
418
|
+
/**
|
|
419
|
+
* The multiplier applied to the interval.
|
|
420
|
+
*/
|
|
421
|
+
interval_count: number | null;
|
|
422
|
+
}
|
|
423
|
+
type Type = 'duration' | 'timestamp';
|
|
424
|
+
namespace Duration {
|
|
425
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
}
|
|
275
429
|
namespace DefaultSettings {
|
|
276
430
|
interface AutomaticTax {
|
|
277
431
|
/**
|
|
@@ -310,6 +464,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
310
464
|
days_until_due: number | null;
|
|
311
465
|
issuer: InvoiceSettings.Issuer;
|
|
312
466
|
}
|
|
467
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
313
468
|
interface TransferData {
|
|
314
469
|
/**
|
|
315
470
|
* 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 +487,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
332
487
|
type: Liability.Type;
|
|
333
488
|
}
|
|
334
489
|
namespace Liability {
|
|
335
|
-
type Type = 'account' | 'self';
|
|
490
|
+
type Type = 'account' | 'application' | 'self';
|
|
336
491
|
}
|
|
337
492
|
}
|
|
338
493
|
namespace InvoiceSettings {
|
|
@@ -347,10 +502,22 @@ export declare namespace SubscriptionSchedule {
|
|
|
347
502
|
type: Issuer.Type;
|
|
348
503
|
}
|
|
349
504
|
namespace Issuer {
|
|
350
|
-
type Type = 'account' | 'self';
|
|
505
|
+
type Type = 'account' | 'application' | 'self';
|
|
351
506
|
}
|
|
352
507
|
}
|
|
353
508
|
}
|
|
509
|
+
namespace LastPriceMigrationError {
|
|
510
|
+
interface FailedTransition {
|
|
511
|
+
/**
|
|
512
|
+
* The original price to be migrated.
|
|
513
|
+
*/
|
|
514
|
+
source_price: string;
|
|
515
|
+
/**
|
|
516
|
+
* The intended resulting price of the migration.
|
|
517
|
+
*/
|
|
518
|
+
target_price: string;
|
|
519
|
+
}
|
|
520
|
+
}
|
|
354
521
|
namespace Phase {
|
|
355
522
|
interface AddInvoiceItem {
|
|
356
523
|
/**
|
|
@@ -414,11 +581,17 @@ export declare namespace SubscriptionSchedule {
|
|
|
414
581
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
415
582
|
*/
|
|
416
583
|
discount: string | Discount | null;
|
|
584
|
+
/**
|
|
585
|
+
* Details to determine how long the discount should be applied for.
|
|
586
|
+
*/
|
|
587
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
417
588
|
/**
|
|
418
589
|
* ID of the promotion code to create a new discount for.
|
|
419
590
|
*/
|
|
420
591
|
promotion_code: string | PromotionCode | null;
|
|
592
|
+
settings?: Discount.Settings;
|
|
421
593
|
}
|
|
594
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
422
595
|
interface InvoiceSettings {
|
|
423
596
|
/**
|
|
424
597
|
* 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.
|
|
@@ -462,6 +635,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
462
635
|
* 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`.
|
|
463
636
|
*/
|
|
464
637
|
tax_rates?: Array<TaxRate> | null;
|
|
638
|
+
/**
|
|
639
|
+
* Options that configure the trial on the subscription item.
|
|
640
|
+
*/
|
|
641
|
+
trial?: Item.Trial | null;
|
|
642
|
+
/**
|
|
643
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
644
|
+
*/
|
|
645
|
+
trial_offer?: string | null;
|
|
646
|
+
}
|
|
647
|
+
interface PauseCollection {
|
|
648
|
+
/**
|
|
649
|
+
* The payment collection behavior for this subscription while paused.
|
|
650
|
+
*/
|
|
651
|
+
behavior: PauseCollection.Behavior;
|
|
465
652
|
}
|
|
466
653
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
467
654
|
interface TransferData {
|
|
@@ -474,6 +661,13 @@ export declare namespace SubscriptionSchedule {
|
|
|
474
661
|
*/
|
|
475
662
|
destination: string | Account;
|
|
476
663
|
}
|
|
664
|
+
type TrialContinuation = 'continue' | 'none';
|
|
665
|
+
interface TrialSettings {
|
|
666
|
+
/**
|
|
667
|
+
* Defines how the subscription should behave when a trial ends.
|
|
668
|
+
*/
|
|
669
|
+
end_behavior: TrialSettings.EndBehavior | null;
|
|
670
|
+
}
|
|
477
671
|
namespace AddInvoiceItem {
|
|
478
672
|
interface Discount {
|
|
479
673
|
/**
|
|
@@ -484,6 +678,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
484
678
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
485
679
|
*/
|
|
486
680
|
discount: string | Discount | null;
|
|
681
|
+
/**
|
|
682
|
+
* Details to determine how long the discount should be applied for.
|
|
683
|
+
*/
|
|
684
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
487
685
|
/**
|
|
488
686
|
* ID of the promotion code to create a new discount for.
|
|
489
687
|
*/
|
|
@@ -493,6 +691,18 @@ export declare namespace SubscriptionSchedule {
|
|
|
493
691
|
end: Period.End;
|
|
494
692
|
start: Period.Start;
|
|
495
693
|
}
|
|
694
|
+
namespace Discount {
|
|
695
|
+
interface DiscountEnd {
|
|
696
|
+
/**
|
|
697
|
+
* The discount end timestamp.
|
|
698
|
+
*/
|
|
699
|
+
timestamp: number | null;
|
|
700
|
+
/**
|
|
701
|
+
* The discount end type.
|
|
702
|
+
*/
|
|
703
|
+
type: 'timestamp';
|
|
704
|
+
}
|
|
705
|
+
}
|
|
496
706
|
namespace Period {
|
|
497
707
|
interface End {
|
|
498
708
|
/**
|
|
@@ -534,7 +744,61 @@ export declare namespace SubscriptionSchedule {
|
|
|
534
744
|
type: Liability.Type;
|
|
535
745
|
}
|
|
536
746
|
namespace Liability {
|
|
537
|
-
type Type = 'account' | 'self';
|
|
747
|
+
type Type = 'account' | 'application' | 'self';
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
namespace Discount {
|
|
751
|
+
interface DiscountEnd {
|
|
752
|
+
/**
|
|
753
|
+
* The discount end timestamp.
|
|
754
|
+
*/
|
|
755
|
+
timestamp: number | null;
|
|
756
|
+
/**
|
|
757
|
+
* The discount end type.
|
|
758
|
+
*/
|
|
759
|
+
type: 'timestamp';
|
|
760
|
+
}
|
|
761
|
+
interface Settings {
|
|
762
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
763
|
+
/**
|
|
764
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
765
|
+
*/
|
|
766
|
+
start_date: Settings.StartDate;
|
|
767
|
+
}
|
|
768
|
+
namespace Settings {
|
|
769
|
+
interface ServicePeriodAnchorConfig {
|
|
770
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
771
|
+
/**
|
|
772
|
+
* The type of service period anchor config.
|
|
773
|
+
*/
|
|
774
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
775
|
+
}
|
|
776
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
777
|
+
namespace ServicePeriodAnchorConfig {
|
|
778
|
+
interface Custom {
|
|
779
|
+
/**
|
|
780
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
781
|
+
*/
|
|
782
|
+
day_of_month: number;
|
|
783
|
+
/**
|
|
784
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
785
|
+
*/
|
|
786
|
+
hour: number | null;
|
|
787
|
+
/**
|
|
788
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
789
|
+
*/
|
|
790
|
+
minute: number | null;
|
|
791
|
+
/**
|
|
792
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
793
|
+
*/
|
|
794
|
+
month: number | null;
|
|
795
|
+
/**
|
|
796
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
797
|
+
*/
|
|
798
|
+
second: number | null;
|
|
799
|
+
}
|
|
800
|
+
type Type = 'custom' | 'inherit';
|
|
801
|
+
}
|
|
538
802
|
}
|
|
539
803
|
}
|
|
540
804
|
namespace InvoiceSettings {
|
|
@@ -549,7 +813,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
549
813
|
type: Issuer.Type;
|
|
550
814
|
}
|
|
551
815
|
namespace Issuer {
|
|
552
|
-
type Type = 'account' | 'self';
|
|
816
|
+
type Type = 'account' | 'application' | 'self';
|
|
553
817
|
}
|
|
554
818
|
}
|
|
555
819
|
namespace Item {
|
|
@@ -568,19 +832,116 @@ export declare namespace SubscriptionSchedule {
|
|
|
568
832
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
569
833
|
*/
|
|
570
834
|
discount: string | Discount | null;
|
|
835
|
+
/**
|
|
836
|
+
* Details to determine how long the discount should be applied for.
|
|
837
|
+
*/
|
|
838
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
571
839
|
/**
|
|
572
840
|
* ID of the promotion code to create a new discount for.
|
|
573
841
|
*/
|
|
574
842
|
promotion_code: string | PromotionCode | null;
|
|
843
|
+
settings?: Discount.Settings;
|
|
844
|
+
}
|
|
845
|
+
interface Trial {
|
|
846
|
+
/**
|
|
847
|
+
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
848
|
+
*/
|
|
849
|
+
converts_to?: Array<string> | null;
|
|
850
|
+
/**
|
|
851
|
+
* Determines the type of trial for this item.
|
|
852
|
+
*/
|
|
853
|
+
type: Trial.Type;
|
|
854
|
+
}
|
|
855
|
+
namespace Discount {
|
|
856
|
+
interface DiscountEnd {
|
|
857
|
+
/**
|
|
858
|
+
* The discount end timestamp.
|
|
859
|
+
*/
|
|
860
|
+
timestamp: number | null;
|
|
861
|
+
/**
|
|
862
|
+
* The discount end type.
|
|
863
|
+
*/
|
|
864
|
+
type: 'timestamp';
|
|
865
|
+
}
|
|
866
|
+
interface Settings {
|
|
867
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
868
|
+
/**
|
|
869
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
870
|
+
*/
|
|
871
|
+
start_date: Settings.StartDate;
|
|
872
|
+
}
|
|
873
|
+
namespace Settings {
|
|
874
|
+
interface ServicePeriodAnchorConfig {
|
|
875
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
876
|
+
/**
|
|
877
|
+
* The type of service period anchor config.
|
|
878
|
+
*/
|
|
879
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
880
|
+
}
|
|
881
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
882
|
+
namespace ServicePeriodAnchorConfig {
|
|
883
|
+
interface Custom {
|
|
884
|
+
/**
|
|
885
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
886
|
+
*/
|
|
887
|
+
day_of_month: number;
|
|
888
|
+
/**
|
|
889
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
890
|
+
*/
|
|
891
|
+
hour: number | null;
|
|
892
|
+
/**
|
|
893
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
894
|
+
*/
|
|
895
|
+
minute: number | null;
|
|
896
|
+
/**
|
|
897
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
898
|
+
*/
|
|
899
|
+
month: number | null;
|
|
900
|
+
/**
|
|
901
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
902
|
+
*/
|
|
903
|
+
second: number | null;
|
|
904
|
+
}
|
|
905
|
+
type Type = 'custom' | 'inherit';
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
namespace Trial {
|
|
910
|
+
type Type = 'free' | 'paid';
|
|
911
|
+
}
|
|
912
|
+
}
|
|
913
|
+
namespace PauseCollection {
|
|
914
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
915
|
+
}
|
|
916
|
+
namespace TrialSettings {
|
|
917
|
+
interface EndBehavior {
|
|
918
|
+
/**
|
|
919
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
920
|
+
*/
|
|
921
|
+
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
922
|
+
}
|
|
923
|
+
namespace EndBehavior {
|
|
924
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
575
925
|
}
|
|
576
926
|
}
|
|
577
927
|
}
|
|
928
|
+
namespace Prebilling {
|
|
929
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
930
|
+
}
|
|
578
931
|
}
|
|
579
932
|
export interface SubscriptionScheduleCreateParams {
|
|
933
|
+
/**
|
|
934
|
+
* 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.
|
|
935
|
+
*/
|
|
936
|
+
billing_behavior?: SubscriptionScheduleCreateParams.BillingBehavior;
|
|
580
937
|
/**
|
|
581
938
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
582
939
|
*/
|
|
583
940
|
billing_mode?: SubscriptionScheduleCreateParams.BillingMode;
|
|
941
|
+
/**
|
|
942
|
+
* Sets the billing schedules for the subscription schedule.
|
|
943
|
+
*/
|
|
944
|
+
billing_schedules?: Array<SubscriptionScheduleCreateParams.BillingSchedule>;
|
|
584
945
|
/**
|
|
585
946
|
* The identifier of the customer to create the subscription schedule for.
|
|
586
947
|
*/
|
|
@@ -613,12 +974,17 @@ export interface SubscriptionScheduleCreateParams {
|
|
|
613
974
|
* 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.
|
|
614
975
|
*/
|
|
615
976
|
phases?: Array<SubscriptionScheduleCreateParams.Phase>;
|
|
977
|
+
/**
|
|
978
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
979
|
+
*/
|
|
980
|
+
prebilling?: SubscriptionScheduleCreateParams.Prebilling;
|
|
616
981
|
/**
|
|
617
982
|
* 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.
|
|
618
983
|
*/
|
|
619
984
|
start_date?: number | 'now';
|
|
620
985
|
}
|
|
621
986
|
export declare namespace SubscriptionScheduleCreateParams {
|
|
987
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
622
988
|
interface BillingMode {
|
|
623
989
|
/**
|
|
624
990
|
* Configure behavior for flexible billing mode.
|
|
@@ -629,6 +995,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
629
995
|
*/
|
|
630
996
|
type: BillingMode.Type;
|
|
631
997
|
}
|
|
998
|
+
interface BillingSchedule {
|
|
999
|
+
/**
|
|
1000
|
+
* Configure billing schedule differently for individual subscription items.
|
|
1001
|
+
*/
|
|
1002
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1003
|
+
/**
|
|
1004
|
+
* The end date for the billing schedule.
|
|
1005
|
+
*/
|
|
1006
|
+
bill_until: BillingSchedule.BillUntil;
|
|
1007
|
+
/**
|
|
1008
|
+
* 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.
|
|
1009
|
+
*/
|
|
1010
|
+
key?: string;
|
|
1011
|
+
}
|
|
632
1012
|
interface DefaultSettings {
|
|
633
1013
|
/**
|
|
634
1014
|
* 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).
|
|
@@ -666,6 +1046,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
666
1046
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
667
1047
|
*/
|
|
668
1048
|
on_behalf_of?: Emptyable<string>;
|
|
1049
|
+
/**
|
|
1050
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1051
|
+
*/
|
|
1052
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
669
1053
|
/**
|
|
670
1054
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
671
1055
|
*/
|
|
@@ -721,6 +1105,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
721
1105
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
722
1106
|
*/
|
|
723
1107
|
duration?: Phase.Duration;
|
|
1108
|
+
/**
|
|
1109
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1110
|
+
*/
|
|
1111
|
+
effective_at?: Phase.EffectiveAt;
|
|
724
1112
|
/**
|
|
725
1113
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
726
1114
|
*/
|
|
@@ -741,6 +1129,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
741
1129
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
742
1130
|
*/
|
|
743
1131
|
on_behalf_of?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* 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).
|
|
1134
|
+
*/
|
|
1135
|
+
pause_collection?: Phase.PauseCollection;
|
|
744
1136
|
/**
|
|
745
1137
|
* 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.
|
|
746
1138
|
*/
|
|
@@ -753,10 +1145,28 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
753
1145
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
754
1146
|
*/
|
|
755
1147
|
trial?: boolean;
|
|
1148
|
+
/**
|
|
1149
|
+
* Specify trial behavior when crossing phase boundaries
|
|
1150
|
+
*/
|
|
1151
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
756
1152
|
/**
|
|
757
1153
|
* 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`
|
|
758
1154
|
*/
|
|
759
1155
|
trial_end?: number;
|
|
1156
|
+
/**
|
|
1157
|
+
* Settings related to subscription trials.
|
|
1158
|
+
*/
|
|
1159
|
+
trial_settings?: Phase.TrialSettings;
|
|
1160
|
+
}
|
|
1161
|
+
interface Prebilling {
|
|
1162
|
+
/**
|
|
1163
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
1164
|
+
*/
|
|
1165
|
+
iterations: number;
|
|
1166
|
+
/**
|
|
1167
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1168
|
+
*/
|
|
1169
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
760
1170
|
}
|
|
761
1171
|
namespace BillingMode {
|
|
762
1172
|
interface Flexible {
|
|
@@ -770,6 +1180,48 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
770
1180
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
771
1181
|
}
|
|
772
1182
|
}
|
|
1183
|
+
namespace BillingSchedule {
|
|
1184
|
+
interface AppliesTo {
|
|
1185
|
+
/**
|
|
1186
|
+
* The ID of the price object.
|
|
1187
|
+
*/
|
|
1188
|
+
price?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* Controls which subscription items the billing schedule applies to.
|
|
1191
|
+
*/
|
|
1192
|
+
type: 'price';
|
|
1193
|
+
}
|
|
1194
|
+
interface BillUntil {
|
|
1195
|
+
/**
|
|
1196
|
+
* Specifies the billing period.
|
|
1197
|
+
*/
|
|
1198
|
+
duration?: BillUntil.Duration;
|
|
1199
|
+
/**
|
|
1200
|
+
* The end date of the billing schedule.
|
|
1201
|
+
*/
|
|
1202
|
+
timestamp?: number;
|
|
1203
|
+
/**
|
|
1204
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1205
|
+
*/
|
|
1206
|
+
type: BillUntil.Type;
|
|
1207
|
+
}
|
|
1208
|
+
namespace BillUntil {
|
|
1209
|
+
interface Duration {
|
|
1210
|
+
/**
|
|
1211
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1212
|
+
*/
|
|
1213
|
+
interval: Duration.Interval;
|
|
1214
|
+
/**
|
|
1215
|
+
* The multiplier applied to the interval.
|
|
1216
|
+
*/
|
|
1217
|
+
interval_count?: number;
|
|
1218
|
+
}
|
|
1219
|
+
type Type = 'duration' | 'timestamp';
|
|
1220
|
+
namespace Duration {
|
|
1221
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
773
1225
|
namespace DefaultSettings {
|
|
774
1226
|
interface AutomaticTax {
|
|
775
1227
|
/**
|
|
@@ -807,6 +1259,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
807
1259
|
*/
|
|
808
1260
|
issuer?: InvoiceSettings.Issuer;
|
|
809
1261
|
}
|
|
1262
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
810
1263
|
interface TransferData {
|
|
811
1264
|
/**
|
|
812
1265
|
* 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.
|
|
@@ -829,7 +1282,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
829
1282
|
type: Liability.Type;
|
|
830
1283
|
}
|
|
831
1284
|
namespace Liability {
|
|
832
|
-
type Type = 'account' | 'self';
|
|
1285
|
+
type Type = 'account' | 'application' | 'self';
|
|
833
1286
|
}
|
|
834
1287
|
}
|
|
835
1288
|
namespace InvoiceSettings {
|
|
@@ -844,7 +1297,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
844
1297
|
type: Issuer.Type;
|
|
845
1298
|
}
|
|
846
1299
|
namespace Issuer {
|
|
847
|
-
type Type = 'account' | 'self';
|
|
1300
|
+
type Type = 'account' | 'application' | 'self';
|
|
848
1301
|
}
|
|
849
1302
|
}
|
|
850
1303
|
}
|
|
@@ -914,10 +1367,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
914
1367
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
915
1368
|
*/
|
|
916
1369
|
discount?: string;
|
|
1370
|
+
/**
|
|
1371
|
+
* Details to determine how long the discount should be applied for.
|
|
1372
|
+
*/
|
|
1373
|
+
discount_end?: Discount.DiscountEnd;
|
|
917
1374
|
/**
|
|
918
1375
|
* ID of the promotion code to create a new discount for.
|
|
919
1376
|
*/
|
|
920
1377
|
promotion_code?: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Settings for discount application including service period anchoring.
|
|
1380
|
+
*/
|
|
1381
|
+
settings?: Discount.Settings;
|
|
921
1382
|
}
|
|
922
1383
|
interface Duration {
|
|
923
1384
|
/**
|
|
@@ -929,6 +1390,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
929
1390
|
*/
|
|
930
1391
|
interval_count?: number;
|
|
931
1392
|
}
|
|
1393
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
932
1394
|
interface InvoiceSettings {
|
|
933
1395
|
/**
|
|
934
1396
|
* 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.
|
|
@@ -976,6 +1438,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
976
1438
|
* 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.
|
|
977
1439
|
*/
|
|
978
1440
|
tax_rates?: Emptyable<Array<string>>;
|
|
1441
|
+
/**
|
|
1442
|
+
* Options that configure the trial on the subscription item.
|
|
1443
|
+
*/
|
|
1444
|
+
trial?: Item.Trial;
|
|
1445
|
+
/**
|
|
1446
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
1447
|
+
*/
|
|
1448
|
+
trial_offer?: string;
|
|
1449
|
+
}
|
|
1450
|
+
interface PauseCollection {
|
|
1451
|
+
/**
|
|
1452
|
+
* The payment collection behavior for this subscription while paused.
|
|
1453
|
+
*/
|
|
1454
|
+
behavior: PauseCollection.Behavior;
|
|
979
1455
|
}
|
|
980
1456
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
981
1457
|
interface TransferData {
|
|
@@ -988,6 +1464,13 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
988
1464
|
*/
|
|
989
1465
|
destination: string;
|
|
990
1466
|
}
|
|
1467
|
+
type TrialContinuation = 'continue' | 'none';
|
|
1468
|
+
interface TrialSettings {
|
|
1469
|
+
/**
|
|
1470
|
+
* Defines how the subscription should behave when a trial ends.
|
|
1471
|
+
*/
|
|
1472
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
1473
|
+
}
|
|
991
1474
|
namespace AddInvoiceItem {
|
|
992
1475
|
interface Discount {
|
|
993
1476
|
/**
|
|
@@ -998,6 +1481,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
998
1481
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
999
1482
|
*/
|
|
1000
1483
|
discount?: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* Details to determine how long the discount should be applied for.
|
|
1486
|
+
*/
|
|
1487
|
+
discount_end?: Discount.DiscountEnd;
|
|
1001
1488
|
/**
|
|
1002
1489
|
* ID of the promotion code to create a new discount for.
|
|
1003
1490
|
*/
|
|
@@ -1035,6 +1522,38 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1035
1522
|
*/
|
|
1036
1523
|
unit_amount_decimal?: Decimal;
|
|
1037
1524
|
}
|
|
1525
|
+
namespace Discount {
|
|
1526
|
+
interface DiscountEnd {
|
|
1527
|
+
/**
|
|
1528
|
+
* Time span for the redeemed discount.
|
|
1529
|
+
*/
|
|
1530
|
+
duration?: DiscountEnd.Duration;
|
|
1531
|
+
/**
|
|
1532
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1533
|
+
*/
|
|
1534
|
+
timestamp?: number;
|
|
1535
|
+
/**
|
|
1536
|
+
* The type of calculation made to determine when the discount ends.
|
|
1537
|
+
*/
|
|
1538
|
+
type: DiscountEnd.Type;
|
|
1539
|
+
}
|
|
1540
|
+
namespace DiscountEnd {
|
|
1541
|
+
interface Duration {
|
|
1542
|
+
/**
|
|
1543
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1544
|
+
*/
|
|
1545
|
+
interval: Duration.Interval;
|
|
1546
|
+
/**
|
|
1547
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1548
|
+
*/
|
|
1549
|
+
interval_count: number;
|
|
1550
|
+
}
|
|
1551
|
+
type Type = 'duration' | 'timestamp';
|
|
1552
|
+
namespace Duration {
|
|
1553
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1038
1557
|
namespace Period {
|
|
1039
1558
|
interface End {
|
|
1040
1559
|
/**
|
|
@@ -1079,7 +1598,87 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1079
1598
|
type: Liability.Type;
|
|
1080
1599
|
}
|
|
1081
1600
|
namespace Liability {
|
|
1082
|
-
type Type = 'account' | 'self';
|
|
1601
|
+
type Type = 'account' | 'application' | 'self';
|
|
1602
|
+
}
|
|
1603
|
+
}
|
|
1604
|
+
namespace Discount {
|
|
1605
|
+
interface DiscountEnd {
|
|
1606
|
+
/**
|
|
1607
|
+
* Time span for the redeemed discount.
|
|
1608
|
+
*/
|
|
1609
|
+
duration?: DiscountEnd.Duration;
|
|
1610
|
+
/**
|
|
1611
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1612
|
+
*/
|
|
1613
|
+
timestamp?: number;
|
|
1614
|
+
/**
|
|
1615
|
+
* The type of calculation made to determine when the discount ends.
|
|
1616
|
+
*/
|
|
1617
|
+
type: DiscountEnd.Type;
|
|
1618
|
+
}
|
|
1619
|
+
interface Settings {
|
|
1620
|
+
/**
|
|
1621
|
+
* Configures service period cycle anchoring.
|
|
1622
|
+
*/
|
|
1623
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1624
|
+
/**
|
|
1625
|
+
* 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.
|
|
1626
|
+
*/
|
|
1627
|
+
start_date?: Settings.StartDate;
|
|
1628
|
+
}
|
|
1629
|
+
namespace DiscountEnd {
|
|
1630
|
+
interface Duration {
|
|
1631
|
+
/**
|
|
1632
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1633
|
+
*/
|
|
1634
|
+
interval: Duration.Interval;
|
|
1635
|
+
/**
|
|
1636
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1637
|
+
*/
|
|
1638
|
+
interval_count: number;
|
|
1639
|
+
}
|
|
1640
|
+
type Type = 'duration' | 'timestamp';
|
|
1641
|
+
namespace Duration {
|
|
1642
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
namespace Settings {
|
|
1646
|
+
interface ServicePeriodAnchorConfig {
|
|
1647
|
+
/**
|
|
1648
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1649
|
+
*/
|
|
1650
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1651
|
+
/**
|
|
1652
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1653
|
+
*/
|
|
1654
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
1655
|
+
}
|
|
1656
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1657
|
+
namespace ServicePeriodAnchorConfig {
|
|
1658
|
+
interface Custom {
|
|
1659
|
+
/**
|
|
1660
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1661
|
+
*/
|
|
1662
|
+
day_of_month: number;
|
|
1663
|
+
/**
|
|
1664
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1665
|
+
*/
|
|
1666
|
+
hour?: number;
|
|
1667
|
+
/**
|
|
1668
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1669
|
+
*/
|
|
1670
|
+
minute?: number;
|
|
1671
|
+
/**
|
|
1672
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1673
|
+
*/
|
|
1674
|
+
month?: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1677
|
+
*/
|
|
1678
|
+
second?: number;
|
|
1679
|
+
}
|
|
1680
|
+
type Type = 'custom' | 'inherit';
|
|
1681
|
+
}
|
|
1083
1682
|
}
|
|
1084
1683
|
}
|
|
1085
1684
|
namespace Duration {
|
|
@@ -1097,7 +1696,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1097
1696
|
type: Issuer.Type;
|
|
1098
1697
|
}
|
|
1099
1698
|
namespace Issuer {
|
|
1100
|
-
type Type = 'account' | 'self';
|
|
1699
|
+
type Type = 'account' | 'application' | 'self';
|
|
1101
1700
|
}
|
|
1102
1701
|
}
|
|
1103
1702
|
namespace Item {
|
|
@@ -1116,10 +1715,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1116
1715
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1117
1716
|
*/
|
|
1118
1717
|
discount?: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* Details to determine how long the discount should be applied for.
|
|
1720
|
+
*/
|
|
1721
|
+
discount_end?: Discount.DiscountEnd;
|
|
1119
1722
|
/**
|
|
1120
1723
|
* ID of the promotion code to create a new discount for.
|
|
1121
1724
|
*/
|
|
1122
1725
|
promotion_code?: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* Settings for discount application including service period anchoring.
|
|
1728
|
+
*/
|
|
1729
|
+
settings?: Discount.Settings;
|
|
1123
1730
|
}
|
|
1124
1731
|
interface PriceData {
|
|
1125
1732
|
/**
|
|
@@ -1147,23 +1754,133 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1147
1754
|
*/
|
|
1148
1755
|
unit_amount_decimal?: Decimal;
|
|
1149
1756
|
}
|
|
1150
|
-
|
|
1151
|
-
|
|
1757
|
+
interface Trial {
|
|
1758
|
+
/**
|
|
1759
|
+
* 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.
|
|
1760
|
+
*/
|
|
1761
|
+
converts_to?: Array<string>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Determines the type of trial for this item.
|
|
1764
|
+
*/
|
|
1765
|
+
type: Trial.Type;
|
|
1766
|
+
}
|
|
1767
|
+
namespace Discount {
|
|
1768
|
+
interface DiscountEnd {
|
|
1152
1769
|
/**
|
|
1153
|
-
*
|
|
1770
|
+
* Time span for the redeemed discount.
|
|
1154
1771
|
*/
|
|
1155
|
-
|
|
1772
|
+
duration?: DiscountEnd.Duration;
|
|
1156
1773
|
/**
|
|
1157
|
-
*
|
|
1774
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1158
1775
|
*/
|
|
1159
|
-
|
|
1776
|
+
timestamp?: number;
|
|
1777
|
+
/**
|
|
1778
|
+
* The type of calculation made to determine when the discount ends.
|
|
1779
|
+
*/
|
|
1780
|
+
type: DiscountEnd.Type;
|
|
1781
|
+
}
|
|
1782
|
+
interface Settings {
|
|
1783
|
+
/**
|
|
1784
|
+
* Configures service period cycle anchoring.
|
|
1785
|
+
*/
|
|
1786
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1787
|
+
/**
|
|
1788
|
+
* 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.
|
|
1789
|
+
*/
|
|
1790
|
+
start_date?: Settings.StartDate;
|
|
1791
|
+
}
|
|
1792
|
+
namespace DiscountEnd {
|
|
1793
|
+
interface Duration {
|
|
1794
|
+
/**
|
|
1795
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1796
|
+
*/
|
|
1797
|
+
interval: Duration.Interval;
|
|
1798
|
+
/**
|
|
1799
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1800
|
+
*/
|
|
1801
|
+
interval_count: number;
|
|
1802
|
+
}
|
|
1803
|
+
type Type = 'duration' | 'timestamp';
|
|
1804
|
+
namespace Duration {
|
|
1805
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
namespace Settings {
|
|
1809
|
+
interface ServicePeriodAnchorConfig {
|
|
1810
|
+
/**
|
|
1811
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1812
|
+
*/
|
|
1813
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1814
|
+
/**
|
|
1815
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1816
|
+
*/
|
|
1817
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
1818
|
+
}
|
|
1819
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1820
|
+
namespace ServicePeriodAnchorConfig {
|
|
1821
|
+
interface Custom {
|
|
1822
|
+
/**
|
|
1823
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1824
|
+
*/
|
|
1825
|
+
day_of_month: number;
|
|
1826
|
+
/**
|
|
1827
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1828
|
+
*/
|
|
1829
|
+
hour?: number;
|
|
1830
|
+
/**
|
|
1831
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1832
|
+
*/
|
|
1833
|
+
minute?: number;
|
|
1834
|
+
/**
|
|
1835
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1836
|
+
*/
|
|
1837
|
+
month?: number;
|
|
1838
|
+
/**
|
|
1839
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1840
|
+
*/
|
|
1841
|
+
second?: number;
|
|
1842
|
+
}
|
|
1843
|
+
type Type = 'custom' | 'inherit';
|
|
1844
|
+
}
|
|
1845
|
+
}
|
|
1846
|
+
}
|
|
1847
|
+
namespace PriceData {
|
|
1848
|
+
interface Recurring {
|
|
1849
|
+
/**
|
|
1850
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
1851
|
+
*/
|
|
1852
|
+
interval: Recurring.Interval;
|
|
1853
|
+
/**
|
|
1854
|
+
* 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).
|
|
1855
|
+
*/
|
|
1856
|
+
interval_count?: number;
|
|
1160
1857
|
}
|
|
1161
1858
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
1162
1859
|
namespace Recurring {
|
|
1163
1860
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1164
1861
|
}
|
|
1165
1862
|
}
|
|
1863
|
+
namespace Trial {
|
|
1864
|
+
type Type = 'free' | 'paid';
|
|
1865
|
+
}
|
|
1866
|
+
}
|
|
1867
|
+
namespace PauseCollection {
|
|
1868
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1166
1869
|
}
|
|
1870
|
+
namespace TrialSettings {
|
|
1871
|
+
interface EndBehavior {
|
|
1872
|
+
/**
|
|
1873
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1874
|
+
*/
|
|
1875
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
1876
|
+
}
|
|
1877
|
+
namespace EndBehavior {
|
|
1878
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
1879
|
+
}
|
|
1880
|
+
}
|
|
1881
|
+
}
|
|
1882
|
+
namespace Prebilling {
|
|
1883
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
1167
1884
|
}
|
|
1168
1885
|
}
|
|
1169
1886
|
export interface SubscriptionScheduleRetrieveParams {
|
|
@@ -1173,6 +1890,14 @@ export interface SubscriptionScheduleRetrieveParams {
|
|
|
1173
1890
|
expand?: Array<string>;
|
|
1174
1891
|
}
|
|
1175
1892
|
export interface SubscriptionScheduleUpdateParams {
|
|
1893
|
+
/**
|
|
1894
|
+
* 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.
|
|
1895
|
+
*/
|
|
1896
|
+
billing_behavior?: SubscriptionScheduleUpdateParams.BillingBehavior;
|
|
1897
|
+
/**
|
|
1898
|
+
* Sets the billing schedules for the subscription schedule.
|
|
1899
|
+
*/
|
|
1900
|
+
billing_schedules?: Emptyable<Array<SubscriptionScheduleUpdateParams.BillingSchedule>>;
|
|
1176
1901
|
/**
|
|
1177
1902
|
* Object representing the subscription schedule's default settings.
|
|
1178
1903
|
*/
|
|
@@ -1193,12 +1918,31 @@ export interface SubscriptionScheduleUpdateParams {
|
|
|
1193
1918
|
* 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.
|
|
1194
1919
|
*/
|
|
1195
1920
|
phases?: Array<SubscriptionScheduleUpdateParams.Phase>;
|
|
1921
|
+
/**
|
|
1922
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1923
|
+
*/
|
|
1924
|
+
prebilling?: SubscriptionScheduleUpdateParams.Prebilling;
|
|
1196
1925
|
/**
|
|
1197
1926
|
* 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`.
|
|
1198
1927
|
*/
|
|
1199
1928
|
proration_behavior?: SubscriptionScheduleUpdateParams.ProrationBehavior;
|
|
1200
1929
|
}
|
|
1201
1930
|
export declare namespace SubscriptionScheduleUpdateParams {
|
|
1931
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1932
|
+
interface BillingSchedule {
|
|
1933
|
+
/**
|
|
1934
|
+
* Configure billing schedule differently for individual subscription items.
|
|
1935
|
+
*/
|
|
1936
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1937
|
+
/**
|
|
1938
|
+
* The end date for the billing schedule.
|
|
1939
|
+
*/
|
|
1940
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
1941
|
+
/**
|
|
1942
|
+
* 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.
|
|
1943
|
+
*/
|
|
1944
|
+
key?: string;
|
|
1945
|
+
}
|
|
1202
1946
|
interface DefaultSettings {
|
|
1203
1947
|
/**
|
|
1204
1948
|
* 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).
|
|
@@ -1236,6 +1980,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1236
1980
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1237
1981
|
*/
|
|
1238
1982
|
on_behalf_of?: Emptyable<string>;
|
|
1983
|
+
/**
|
|
1984
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1985
|
+
*/
|
|
1986
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
1239
1987
|
/**
|
|
1240
1988
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
1241
1989
|
*/
|
|
@@ -1291,6 +2039,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1291
2039
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
1292
2040
|
*/
|
|
1293
2041
|
duration?: Phase.Duration;
|
|
2042
|
+
/**
|
|
2043
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2044
|
+
*/
|
|
2045
|
+
effective_at?: Phase.EffectiveAt;
|
|
1294
2046
|
/**
|
|
1295
2047
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
1296
2048
|
*/
|
|
@@ -1311,6 +2063,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1311
2063
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1312
2064
|
*/
|
|
1313
2065
|
on_behalf_of?: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* 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).
|
|
2068
|
+
*/
|
|
2069
|
+
pause_collection?: Phase.PauseCollection;
|
|
1314
2070
|
/**
|
|
1315
2071
|
* 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.
|
|
1316
2072
|
*/
|
|
@@ -1327,12 +2083,72 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1327
2083
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1328
2084
|
*/
|
|
1329
2085
|
trial?: boolean;
|
|
2086
|
+
/**
|
|
2087
|
+
* Specify trial behavior when crossing phase boundaries
|
|
2088
|
+
*/
|
|
2089
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
1330
2090
|
/**
|
|
1331
2091
|
* 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`
|
|
1332
2092
|
*/
|
|
1333
2093
|
trial_end?: number | 'now';
|
|
2094
|
+
/**
|
|
2095
|
+
* Settings related to subscription trials.
|
|
2096
|
+
*/
|
|
2097
|
+
trial_settings?: Phase.TrialSettings;
|
|
2098
|
+
}
|
|
2099
|
+
interface Prebilling {
|
|
2100
|
+
/**
|
|
2101
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
2102
|
+
*/
|
|
2103
|
+
iterations: number;
|
|
2104
|
+
/**
|
|
2105
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2106
|
+
*/
|
|
2107
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
1334
2108
|
}
|
|
1335
2109
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2110
|
+
namespace BillingSchedule {
|
|
2111
|
+
interface AppliesTo {
|
|
2112
|
+
/**
|
|
2113
|
+
* The ID of the price object.
|
|
2114
|
+
*/
|
|
2115
|
+
price?: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* Controls which subscription items the billing schedule applies to.
|
|
2118
|
+
*/
|
|
2119
|
+
type: 'price';
|
|
2120
|
+
}
|
|
2121
|
+
interface BillUntil {
|
|
2122
|
+
/**
|
|
2123
|
+
* Specifies the billing period.
|
|
2124
|
+
*/
|
|
2125
|
+
duration?: BillUntil.Duration;
|
|
2126
|
+
/**
|
|
2127
|
+
* The end date of the billing schedule.
|
|
2128
|
+
*/
|
|
2129
|
+
timestamp?: number;
|
|
2130
|
+
/**
|
|
2131
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
2132
|
+
*/
|
|
2133
|
+
type: BillUntil.Type;
|
|
2134
|
+
}
|
|
2135
|
+
namespace BillUntil {
|
|
2136
|
+
interface Duration {
|
|
2137
|
+
/**
|
|
2138
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
2139
|
+
*/
|
|
2140
|
+
interval: Duration.Interval;
|
|
2141
|
+
/**
|
|
2142
|
+
* The multiplier applied to the interval.
|
|
2143
|
+
*/
|
|
2144
|
+
interval_count?: number;
|
|
2145
|
+
}
|
|
2146
|
+
type Type = 'duration' | 'timestamp';
|
|
2147
|
+
namespace Duration {
|
|
2148
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2149
|
+
}
|
|
2150
|
+
}
|
|
2151
|
+
}
|
|
1336
2152
|
namespace DefaultSettings {
|
|
1337
2153
|
interface AutomaticTax {
|
|
1338
2154
|
/**
|
|
@@ -1370,6 +2186,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1370
2186
|
*/
|
|
1371
2187
|
issuer?: InvoiceSettings.Issuer;
|
|
1372
2188
|
}
|
|
2189
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1373
2190
|
interface TransferData {
|
|
1374
2191
|
/**
|
|
1375
2192
|
* 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.
|
|
@@ -1392,7 +2209,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1392
2209
|
type: Liability.Type;
|
|
1393
2210
|
}
|
|
1394
2211
|
namespace Liability {
|
|
1395
|
-
type Type = 'account' | 'self';
|
|
2212
|
+
type Type = 'account' | 'application' | 'self';
|
|
1396
2213
|
}
|
|
1397
2214
|
}
|
|
1398
2215
|
namespace InvoiceSettings {
|
|
@@ -1407,7 +2224,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1407
2224
|
type: Issuer.Type;
|
|
1408
2225
|
}
|
|
1409
2226
|
namespace Issuer {
|
|
1410
|
-
type Type = 'account' | 'self';
|
|
2227
|
+
type Type = 'account' | 'application' | 'self';
|
|
1411
2228
|
}
|
|
1412
2229
|
}
|
|
1413
2230
|
}
|
|
@@ -1477,10 +2294,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1477
2294
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1478
2295
|
*/
|
|
1479
2296
|
discount?: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* Details to determine how long the discount should be applied for.
|
|
2299
|
+
*/
|
|
2300
|
+
discount_end?: Discount.DiscountEnd;
|
|
1480
2301
|
/**
|
|
1481
2302
|
* ID of the promotion code to create a new discount for.
|
|
1482
2303
|
*/
|
|
1483
2304
|
promotion_code?: string;
|
|
2305
|
+
/**
|
|
2306
|
+
* Settings for discount application including service period anchoring.
|
|
2307
|
+
*/
|
|
2308
|
+
settings?: Discount.Settings;
|
|
1484
2309
|
}
|
|
1485
2310
|
interface Duration {
|
|
1486
2311
|
/**
|
|
@@ -1492,6 +2317,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1492
2317
|
*/
|
|
1493
2318
|
interval_count?: number;
|
|
1494
2319
|
}
|
|
2320
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1495
2321
|
interface InvoiceSettings {
|
|
1496
2322
|
/**
|
|
1497
2323
|
* 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.
|
|
@@ -1539,6 +2365,20 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1539
2365
|
* 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.
|
|
1540
2366
|
*/
|
|
1541
2367
|
tax_rates?: Emptyable<Array<string>>;
|
|
2368
|
+
/**
|
|
2369
|
+
* Options that configure the trial on the subscription item.
|
|
2370
|
+
*/
|
|
2371
|
+
trial?: Item.Trial;
|
|
2372
|
+
/**
|
|
2373
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
2374
|
+
*/
|
|
2375
|
+
trial_offer?: string;
|
|
2376
|
+
}
|
|
2377
|
+
interface PauseCollection {
|
|
2378
|
+
/**
|
|
2379
|
+
* The payment collection behavior for this subscription while paused.
|
|
2380
|
+
*/
|
|
2381
|
+
behavior: PauseCollection.Behavior;
|
|
1542
2382
|
}
|
|
1543
2383
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1544
2384
|
interface TransferData {
|
|
@@ -1551,6 +2391,13 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1551
2391
|
*/
|
|
1552
2392
|
destination: string;
|
|
1553
2393
|
}
|
|
2394
|
+
type TrialContinuation = 'continue' | 'none';
|
|
2395
|
+
interface TrialSettings {
|
|
2396
|
+
/**
|
|
2397
|
+
* Defines how the subscription should behave when a trial ends.
|
|
2398
|
+
*/
|
|
2399
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
2400
|
+
}
|
|
1554
2401
|
namespace AddInvoiceItem {
|
|
1555
2402
|
interface Discount {
|
|
1556
2403
|
/**
|
|
@@ -1561,6 +2408,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1561
2408
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1562
2409
|
*/
|
|
1563
2410
|
discount?: string;
|
|
2411
|
+
/**
|
|
2412
|
+
* Details to determine how long the discount should be applied for.
|
|
2413
|
+
*/
|
|
2414
|
+
discount_end?: Discount.DiscountEnd;
|
|
1564
2415
|
/**
|
|
1565
2416
|
* ID of the promotion code to create a new discount for.
|
|
1566
2417
|
*/
|
|
@@ -1598,6 +2449,38 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1598
2449
|
*/
|
|
1599
2450
|
unit_amount_decimal?: Decimal;
|
|
1600
2451
|
}
|
|
2452
|
+
namespace Discount {
|
|
2453
|
+
interface DiscountEnd {
|
|
2454
|
+
/**
|
|
2455
|
+
* Time span for the redeemed discount.
|
|
2456
|
+
*/
|
|
2457
|
+
duration?: DiscountEnd.Duration;
|
|
2458
|
+
/**
|
|
2459
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2460
|
+
*/
|
|
2461
|
+
timestamp?: number;
|
|
2462
|
+
/**
|
|
2463
|
+
* The type of calculation made to determine when the discount ends.
|
|
2464
|
+
*/
|
|
2465
|
+
type: DiscountEnd.Type;
|
|
2466
|
+
}
|
|
2467
|
+
namespace DiscountEnd {
|
|
2468
|
+
interface Duration {
|
|
2469
|
+
/**
|
|
2470
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2471
|
+
*/
|
|
2472
|
+
interval: Duration.Interval;
|
|
2473
|
+
/**
|
|
2474
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2475
|
+
*/
|
|
2476
|
+
interval_count: number;
|
|
2477
|
+
}
|
|
2478
|
+
type Type = 'duration' | 'timestamp';
|
|
2479
|
+
namespace Duration {
|
|
2480
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2481
|
+
}
|
|
2482
|
+
}
|
|
2483
|
+
}
|
|
1601
2484
|
namespace Period {
|
|
1602
2485
|
interface End {
|
|
1603
2486
|
/**
|
|
@@ -1642,7 +2525,87 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1642
2525
|
type: Liability.Type;
|
|
1643
2526
|
}
|
|
1644
2527
|
namespace Liability {
|
|
1645
|
-
type Type = 'account' | 'self';
|
|
2528
|
+
type Type = 'account' | 'application' | 'self';
|
|
2529
|
+
}
|
|
2530
|
+
}
|
|
2531
|
+
namespace Discount {
|
|
2532
|
+
interface DiscountEnd {
|
|
2533
|
+
/**
|
|
2534
|
+
* Time span for the redeemed discount.
|
|
2535
|
+
*/
|
|
2536
|
+
duration?: DiscountEnd.Duration;
|
|
2537
|
+
/**
|
|
2538
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2539
|
+
*/
|
|
2540
|
+
timestamp?: number;
|
|
2541
|
+
/**
|
|
2542
|
+
* The type of calculation made to determine when the discount ends.
|
|
2543
|
+
*/
|
|
2544
|
+
type: DiscountEnd.Type;
|
|
2545
|
+
}
|
|
2546
|
+
interface Settings {
|
|
2547
|
+
/**
|
|
2548
|
+
* Configures service period cycle anchoring.
|
|
2549
|
+
*/
|
|
2550
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2551
|
+
/**
|
|
2552
|
+
* 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.
|
|
2553
|
+
*/
|
|
2554
|
+
start_date?: Settings.StartDate;
|
|
2555
|
+
}
|
|
2556
|
+
namespace DiscountEnd {
|
|
2557
|
+
interface Duration {
|
|
2558
|
+
/**
|
|
2559
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2560
|
+
*/
|
|
2561
|
+
interval: Duration.Interval;
|
|
2562
|
+
/**
|
|
2563
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2564
|
+
*/
|
|
2565
|
+
interval_count: number;
|
|
2566
|
+
}
|
|
2567
|
+
type Type = 'duration' | 'timestamp';
|
|
2568
|
+
namespace Duration {
|
|
2569
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2570
|
+
}
|
|
2571
|
+
}
|
|
2572
|
+
namespace Settings {
|
|
2573
|
+
interface ServicePeriodAnchorConfig {
|
|
2574
|
+
/**
|
|
2575
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2576
|
+
*/
|
|
2577
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2578
|
+
/**
|
|
2579
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2580
|
+
*/
|
|
2581
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2582
|
+
}
|
|
2583
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2584
|
+
namespace ServicePeriodAnchorConfig {
|
|
2585
|
+
interface Custom {
|
|
2586
|
+
/**
|
|
2587
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2588
|
+
*/
|
|
2589
|
+
day_of_month: number;
|
|
2590
|
+
/**
|
|
2591
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2592
|
+
*/
|
|
2593
|
+
hour?: number;
|
|
2594
|
+
/**
|
|
2595
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2596
|
+
*/
|
|
2597
|
+
minute?: number;
|
|
2598
|
+
/**
|
|
2599
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2600
|
+
*/
|
|
2601
|
+
month?: number;
|
|
2602
|
+
/**
|
|
2603
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2604
|
+
*/
|
|
2605
|
+
second?: number;
|
|
2606
|
+
}
|
|
2607
|
+
type Type = 'custom' | 'inherit';
|
|
2608
|
+
}
|
|
1646
2609
|
}
|
|
1647
2610
|
}
|
|
1648
2611
|
namespace Duration {
|
|
@@ -1660,7 +2623,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1660
2623
|
type: Issuer.Type;
|
|
1661
2624
|
}
|
|
1662
2625
|
namespace Issuer {
|
|
1663
|
-
type Type = 'account' | 'self';
|
|
2626
|
+
type Type = 'account' | 'application' | 'self';
|
|
1664
2627
|
}
|
|
1665
2628
|
}
|
|
1666
2629
|
namespace Item {
|
|
@@ -1679,10 +2642,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1679
2642
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1680
2643
|
*/
|
|
1681
2644
|
discount?: string;
|
|
2645
|
+
/**
|
|
2646
|
+
* Details to determine how long the discount should be applied for.
|
|
2647
|
+
*/
|
|
2648
|
+
discount_end?: Discount.DiscountEnd;
|
|
1682
2649
|
/**
|
|
1683
2650
|
* ID of the promotion code to create a new discount for.
|
|
1684
2651
|
*/
|
|
1685
2652
|
promotion_code?: string;
|
|
2653
|
+
/**
|
|
2654
|
+
* Settings for discount application including service period anchoring.
|
|
2655
|
+
*/
|
|
2656
|
+
settings?: Discount.Settings;
|
|
1686
2657
|
}
|
|
1687
2658
|
interface PriceData {
|
|
1688
2659
|
/**
|
|
@@ -1710,6 +2681,96 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1710
2681
|
*/
|
|
1711
2682
|
unit_amount_decimal?: Decimal;
|
|
1712
2683
|
}
|
|
2684
|
+
interface Trial {
|
|
2685
|
+
/**
|
|
2686
|
+
* 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.
|
|
2687
|
+
*/
|
|
2688
|
+
converts_to?: Array<string>;
|
|
2689
|
+
/**
|
|
2690
|
+
* Determines the type of trial for this item.
|
|
2691
|
+
*/
|
|
2692
|
+
type: Trial.Type;
|
|
2693
|
+
}
|
|
2694
|
+
namespace Discount {
|
|
2695
|
+
interface DiscountEnd {
|
|
2696
|
+
/**
|
|
2697
|
+
* Time span for the redeemed discount.
|
|
2698
|
+
*/
|
|
2699
|
+
duration?: DiscountEnd.Duration;
|
|
2700
|
+
/**
|
|
2701
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2702
|
+
*/
|
|
2703
|
+
timestamp?: number;
|
|
2704
|
+
/**
|
|
2705
|
+
* The type of calculation made to determine when the discount ends.
|
|
2706
|
+
*/
|
|
2707
|
+
type: DiscountEnd.Type;
|
|
2708
|
+
}
|
|
2709
|
+
interface Settings {
|
|
2710
|
+
/**
|
|
2711
|
+
* Configures service period cycle anchoring.
|
|
2712
|
+
*/
|
|
2713
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2714
|
+
/**
|
|
2715
|
+
* 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.
|
|
2716
|
+
*/
|
|
2717
|
+
start_date?: Settings.StartDate;
|
|
2718
|
+
}
|
|
2719
|
+
namespace DiscountEnd {
|
|
2720
|
+
interface Duration {
|
|
2721
|
+
/**
|
|
2722
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2723
|
+
*/
|
|
2724
|
+
interval: Duration.Interval;
|
|
2725
|
+
/**
|
|
2726
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2727
|
+
*/
|
|
2728
|
+
interval_count: number;
|
|
2729
|
+
}
|
|
2730
|
+
type Type = 'duration' | 'timestamp';
|
|
2731
|
+
namespace Duration {
|
|
2732
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2733
|
+
}
|
|
2734
|
+
}
|
|
2735
|
+
namespace Settings {
|
|
2736
|
+
interface ServicePeriodAnchorConfig {
|
|
2737
|
+
/**
|
|
2738
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2739
|
+
*/
|
|
2740
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2741
|
+
/**
|
|
2742
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2743
|
+
*/
|
|
2744
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2745
|
+
}
|
|
2746
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2747
|
+
namespace ServicePeriodAnchorConfig {
|
|
2748
|
+
interface Custom {
|
|
2749
|
+
/**
|
|
2750
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2751
|
+
*/
|
|
2752
|
+
day_of_month: number;
|
|
2753
|
+
/**
|
|
2754
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2755
|
+
*/
|
|
2756
|
+
hour?: number;
|
|
2757
|
+
/**
|
|
2758
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2759
|
+
*/
|
|
2760
|
+
minute?: number;
|
|
2761
|
+
/**
|
|
2762
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2763
|
+
*/
|
|
2764
|
+
month?: number;
|
|
2765
|
+
/**
|
|
2766
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2767
|
+
*/
|
|
2768
|
+
second?: number;
|
|
2769
|
+
}
|
|
2770
|
+
type Type = 'custom' | 'inherit';
|
|
2771
|
+
}
|
|
2772
|
+
}
|
|
2773
|
+
}
|
|
1713
2774
|
namespace PriceData {
|
|
1714
2775
|
interface Recurring {
|
|
1715
2776
|
/**
|
|
@@ -1726,7 +2787,27 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1726
2787
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1727
2788
|
}
|
|
1728
2789
|
}
|
|
2790
|
+
namespace Trial {
|
|
2791
|
+
type Type = 'free' | 'paid';
|
|
2792
|
+
}
|
|
1729
2793
|
}
|
|
2794
|
+
namespace PauseCollection {
|
|
2795
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2796
|
+
}
|
|
2797
|
+
namespace TrialSettings {
|
|
2798
|
+
interface EndBehavior {
|
|
2799
|
+
/**
|
|
2800
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2801
|
+
*/
|
|
2802
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2803
|
+
}
|
|
2804
|
+
namespace EndBehavior {
|
|
2805
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
2806
|
+
}
|
|
2807
|
+
}
|
|
2808
|
+
}
|
|
2809
|
+
namespace Prebilling {
|
|
2810
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
1730
2811
|
}
|
|
1731
2812
|
}
|
|
1732
2813
|
export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
@@ -1763,6 +2844,847 @@ export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
|
1763
2844
|
*/
|
|
1764
2845
|
scheduled?: boolean;
|
|
1765
2846
|
}
|
|
2847
|
+
export interface SubscriptionScheduleAmendParams {
|
|
2848
|
+
/**
|
|
2849
|
+
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2850
|
+
*/
|
|
2851
|
+
amendments?: Array<SubscriptionScheduleAmendParams.Amendment>;
|
|
2852
|
+
/**
|
|
2853
|
+
* Specifies which fields in the response should be expanded.
|
|
2854
|
+
*/
|
|
2855
|
+
expand?: Array<string>;
|
|
2856
|
+
/**
|
|
2857
|
+
* Provide any time periods to bill in advance.
|
|
2858
|
+
*/
|
|
2859
|
+
prebilling?: Emptyable<Array<SubscriptionScheduleAmendParams.Prebilling>>;
|
|
2860
|
+
/**
|
|
2861
|
+
* In cases where the amendment changes the currently active phase,
|
|
2862
|
+
* specifies if and how to prorate at the time of the request.
|
|
2863
|
+
*/
|
|
2864
|
+
proration_behavior?: SubscriptionScheduleAmendParams.ProrationBehavior;
|
|
2865
|
+
/**
|
|
2866
|
+
* Changes to apply to the subscription schedule.
|
|
2867
|
+
*/
|
|
2868
|
+
schedule_settings?: SubscriptionScheduleAmendParams.ScheduleSettings;
|
|
2869
|
+
}
|
|
2870
|
+
export declare namespace SubscriptionScheduleAmendParams {
|
|
2871
|
+
interface Amendment {
|
|
2872
|
+
/**
|
|
2873
|
+
* 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.
|
|
2874
|
+
*/
|
|
2875
|
+
amendment_end?: Amendment.AmendmentEnd;
|
|
2876
|
+
/**
|
|
2877
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2878
|
+
*/
|
|
2879
|
+
amendment_start: Amendment.AmendmentStart;
|
|
2880
|
+
/**
|
|
2881
|
+
* 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.
|
|
2882
|
+
*/
|
|
2883
|
+
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2884
|
+
/**
|
|
2885
|
+
* Actions to apply to the billing schedules.
|
|
2886
|
+
*/
|
|
2887
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
2888
|
+
/**
|
|
2889
|
+
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2890
|
+
*/
|
|
2891
|
+
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2892
|
+
/**
|
|
2893
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2894
|
+
*/
|
|
2895
|
+
effective_at?: Amendment.EffectiveAt;
|
|
2896
|
+
/**
|
|
2897
|
+
* Changes to the subscription items during the amendment time span.
|
|
2898
|
+
*/
|
|
2899
|
+
item_actions?: Array<Amendment.ItemAction>;
|
|
2900
|
+
/**
|
|
2901
|
+
* Instructions for how to modify phase metadata
|
|
2902
|
+
*/
|
|
2903
|
+
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2904
|
+
/**
|
|
2905
|
+
* 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`.
|
|
2906
|
+
*/
|
|
2907
|
+
proration_behavior?: Amendment.ProrationBehavior;
|
|
2908
|
+
/**
|
|
2909
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2910
|
+
*/
|
|
2911
|
+
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2912
|
+
/**
|
|
2913
|
+
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2914
|
+
*/
|
|
2915
|
+
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2916
|
+
/**
|
|
2917
|
+
* Settings related to subscription trials.
|
|
2918
|
+
*/
|
|
2919
|
+
trial_settings?: Amendment.TrialSettings;
|
|
2920
|
+
}
|
|
2921
|
+
interface Prebilling {
|
|
2922
|
+
/**
|
|
2923
|
+
* The beginning of the prebilled time period. The default value is `now`.
|
|
2924
|
+
*/
|
|
2925
|
+
bill_from?: Prebilling.BillFrom;
|
|
2926
|
+
/**
|
|
2927
|
+
* The end of the prebilled time period.
|
|
2928
|
+
*/
|
|
2929
|
+
bill_until?: Prebilling.BillUntil;
|
|
2930
|
+
/**
|
|
2931
|
+
* When the prebilling invoice should be created. The default value is `now`.
|
|
2932
|
+
*/
|
|
2933
|
+
invoice_at?: 'now';
|
|
2934
|
+
/**
|
|
2935
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2936
|
+
*/
|
|
2937
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
2938
|
+
}
|
|
2939
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2940
|
+
interface ScheduleSettings {
|
|
2941
|
+
/**
|
|
2942
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
2943
|
+
*/
|
|
2944
|
+
end_behavior?: ScheduleSettings.EndBehavior;
|
|
2945
|
+
}
|
|
2946
|
+
namespace Amendment {
|
|
2947
|
+
interface AmendmentEnd {
|
|
2948
|
+
/**
|
|
2949
|
+
* Use the `end` time of a given discount.
|
|
2950
|
+
*/
|
|
2951
|
+
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2952
|
+
/**
|
|
2953
|
+
* Time span for the amendment starting from the `amendment_start`.
|
|
2954
|
+
*/
|
|
2955
|
+
duration?: AmendmentEnd.Duration;
|
|
2956
|
+
/**
|
|
2957
|
+
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2958
|
+
*/
|
|
2959
|
+
timestamp?: number;
|
|
2960
|
+
/**
|
|
2961
|
+
* Select one of three ways to pass the `amendment_end`.
|
|
2962
|
+
*/
|
|
2963
|
+
type: AmendmentEnd.Type;
|
|
2964
|
+
}
|
|
2965
|
+
interface AmendmentStart {
|
|
2966
|
+
/**
|
|
2967
|
+
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2968
|
+
*/
|
|
2969
|
+
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2970
|
+
/**
|
|
2971
|
+
* Use the `end` time of a given discount.
|
|
2972
|
+
*/
|
|
2973
|
+
discount_end?: AmendmentStart.DiscountEnd;
|
|
2974
|
+
/**
|
|
2975
|
+
* A precise Unix timestamp for the amendment to start.
|
|
2976
|
+
*/
|
|
2977
|
+
timestamp?: number;
|
|
2978
|
+
/**
|
|
2979
|
+
* Select one of three ways to pass the `amendment_start`.
|
|
2980
|
+
*/
|
|
2981
|
+
type: AmendmentStart.Type;
|
|
2982
|
+
}
|
|
2983
|
+
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
2984
|
+
interface BillingSchedulesAction {
|
|
2985
|
+
/**
|
|
2986
|
+
* Specify which subscription items the billing schedule applies to.
|
|
2987
|
+
*/
|
|
2988
|
+
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
2989
|
+
/**
|
|
2990
|
+
* Select the action.
|
|
2991
|
+
*/
|
|
2992
|
+
type: BillingSchedulesAction.Type;
|
|
2993
|
+
}
|
|
2994
|
+
interface DiscountAction {
|
|
2995
|
+
/**
|
|
2996
|
+
* Details of the discount to add.
|
|
2997
|
+
*/
|
|
2998
|
+
add?: DiscountAction.Add;
|
|
2999
|
+
/**
|
|
3000
|
+
* Details of the discount to remove.
|
|
3001
|
+
*/
|
|
3002
|
+
remove?: DiscountAction.Remove;
|
|
3003
|
+
/**
|
|
3004
|
+
* Details of the discount to replace the existing discounts with.
|
|
3005
|
+
*/
|
|
3006
|
+
set?: DiscountAction.Set;
|
|
3007
|
+
/**
|
|
3008
|
+
* Determines the type of discount action.
|
|
3009
|
+
*/
|
|
3010
|
+
type: DiscountAction.Type;
|
|
3011
|
+
}
|
|
3012
|
+
type EffectiveAt = 'amendment_start' | 'billing_period_start';
|
|
3013
|
+
interface ItemAction {
|
|
3014
|
+
/**
|
|
3015
|
+
* 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.
|
|
3016
|
+
*/
|
|
3017
|
+
add?: ItemAction.Add;
|
|
3018
|
+
/**
|
|
3019
|
+
* Details of the subscription item to remove.
|
|
3020
|
+
*/
|
|
3021
|
+
remove?: ItemAction.Remove;
|
|
3022
|
+
/**
|
|
3023
|
+
* 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.
|
|
3024
|
+
*/
|
|
3025
|
+
set?: ItemAction.Set;
|
|
3026
|
+
/**
|
|
3027
|
+
* Determines the type of item action.
|
|
3028
|
+
*/
|
|
3029
|
+
type: ItemAction.Type;
|
|
3030
|
+
}
|
|
3031
|
+
interface MetadataAction {
|
|
3032
|
+
/**
|
|
3033
|
+
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3034
|
+
*/
|
|
3035
|
+
add?: {
|
|
3036
|
+
[key: string]: string;
|
|
3037
|
+
};
|
|
3038
|
+
/**
|
|
3039
|
+
* Keys to remove from schedule phase metadata.
|
|
3040
|
+
*/
|
|
3041
|
+
remove?: Array<string>;
|
|
3042
|
+
/**
|
|
3043
|
+
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3044
|
+
*/
|
|
3045
|
+
set?: Emptyable<{
|
|
3046
|
+
[key: string]: string;
|
|
3047
|
+
}>;
|
|
3048
|
+
/**
|
|
3049
|
+
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3050
|
+
*/
|
|
3051
|
+
type: MetadataAction.Type;
|
|
3052
|
+
}
|
|
3053
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3054
|
+
interface SetPauseCollection {
|
|
3055
|
+
/**
|
|
3056
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
3057
|
+
*/
|
|
3058
|
+
set?: SetPauseCollection.Set;
|
|
3059
|
+
/**
|
|
3060
|
+
* Determines the type of the pause_collection amendment.
|
|
3061
|
+
*/
|
|
3062
|
+
type: SetPauseCollection.Type;
|
|
3063
|
+
}
|
|
3064
|
+
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3065
|
+
interface TrialSettings {
|
|
3066
|
+
/**
|
|
3067
|
+
* Defines how the subscription should behave when a trial ends.
|
|
3068
|
+
*/
|
|
3069
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
3070
|
+
}
|
|
3071
|
+
namespace AmendmentEnd {
|
|
3072
|
+
interface DiscountEnd {
|
|
3073
|
+
/**
|
|
3074
|
+
* The ID of a specific discount.
|
|
3075
|
+
*/
|
|
3076
|
+
discount: string;
|
|
3077
|
+
}
|
|
3078
|
+
interface Duration {
|
|
3079
|
+
/**
|
|
3080
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3081
|
+
*/
|
|
3082
|
+
interval: Duration.Interval;
|
|
3083
|
+
/**
|
|
3084
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3085
|
+
*/
|
|
3086
|
+
interval_count: number;
|
|
3087
|
+
}
|
|
3088
|
+
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3089
|
+
namespace Duration {
|
|
3090
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3091
|
+
}
|
|
3092
|
+
}
|
|
3093
|
+
namespace AmendmentStart {
|
|
3094
|
+
interface AmendmentEnd {
|
|
3095
|
+
/**
|
|
3096
|
+
* 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.
|
|
3097
|
+
*/
|
|
3098
|
+
index: number;
|
|
3099
|
+
}
|
|
3100
|
+
interface DiscountEnd {
|
|
3101
|
+
/**
|
|
3102
|
+
* The ID of a specific discount.
|
|
3103
|
+
*/
|
|
3104
|
+
discount: string;
|
|
3105
|
+
}
|
|
3106
|
+
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3107
|
+
}
|
|
3108
|
+
namespace BillingSchedulesAction {
|
|
3109
|
+
interface AppliesTo {
|
|
3110
|
+
/**
|
|
3111
|
+
* The ID of the price object.
|
|
3112
|
+
*/
|
|
3113
|
+
price?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* Controls which subscription items the billing schedule applies to.
|
|
3116
|
+
*/
|
|
3117
|
+
type: 'price';
|
|
3118
|
+
}
|
|
3119
|
+
type Type = 'remove' | 'set';
|
|
3120
|
+
}
|
|
3121
|
+
namespace DiscountAction {
|
|
3122
|
+
interface Add {
|
|
3123
|
+
/**
|
|
3124
|
+
* The coupon code to redeem.
|
|
3125
|
+
*/
|
|
3126
|
+
coupon?: string;
|
|
3127
|
+
/**
|
|
3128
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3129
|
+
*/
|
|
3130
|
+
discount?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Details to determine how long the discount should be applied for.
|
|
3133
|
+
*/
|
|
3134
|
+
discount_end?: Add.DiscountEnd;
|
|
3135
|
+
/**
|
|
3136
|
+
* 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.
|
|
3137
|
+
*/
|
|
3138
|
+
index?: number;
|
|
3139
|
+
/**
|
|
3140
|
+
* The promotion code to redeem.
|
|
3141
|
+
*/
|
|
3142
|
+
promotion_code?: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* Settings for discount application including service period anchoring.
|
|
3145
|
+
*/
|
|
3146
|
+
settings?: Add.Settings;
|
|
3147
|
+
}
|
|
3148
|
+
interface Remove {
|
|
3149
|
+
/**
|
|
3150
|
+
* The coupon code to remove from the `discounts` array.
|
|
3151
|
+
*/
|
|
3152
|
+
coupon?: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
3155
|
+
*/
|
|
3156
|
+
discount?: string;
|
|
3157
|
+
/**
|
|
3158
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
3159
|
+
*/
|
|
3160
|
+
promotion_code?: string;
|
|
3161
|
+
}
|
|
3162
|
+
interface Set {
|
|
3163
|
+
/**
|
|
3164
|
+
* The coupon code to replace the `discounts` array with.
|
|
3165
|
+
*/
|
|
3166
|
+
coupon?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
3169
|
+
*/
|
|
3170
|
+
discount?: string;
|
|
3171
|
+
/**
|
|
3172
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3173
|
+
*/
|
|
3174
|
+
promotion_code?: string;
|
|
3175
|
+
/**
|
|
3176
|
+
* Settings for discount application including service period anchoring.
|
|
3177
|
+
*/
|
|
3178
|
+
settings?: Set.Settings;
|
|
3179
|
+
}
|
|
3180
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3181
|
+
namespace Add {
|
|
3182
|
+
interface DiscountEnd {
|
|
3183
|
+
/**
|
|
3184
|
+
* The type of calculation made to determine when the discount ends.
|
|
3185
|
+
*/
|
|
3186
|
+
type: 'amendment_end';
|
|
3187
|
+
}
|
|
3188
|
+
interface Settings {
|
|
3189
|
+
/**
|
|
3190
|
+
* Configures service period cycle anchoring.
|
|
3191
|
+
*/
|
|
3192
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3193
|
+
/**
|
|
3194
|
+
* 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.
|
|
3195
|
+
*/
|
|
3196
|
+
start_date?: Settings.StartDate;
|
|
3197
|
+
}
|
|
3198
|
+
namespace Settings {
|
|
3199
|
+
interface ServicePeriodAnchorConfig {
|
|
3200
|
+
/**
|
|
3201
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3202
|
+
*/
|
|
3203
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3204
|
+
/**
|
|
3205
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3206
|
+
*/
|
|
3207
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3208
|
+
}
|
|
3209
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3210
|
+
namespace ServicePeriodAnchorConfig {
|
|
3211
|
+
interface Custom {
|
|
3212
|
+
/**
|
|
3213
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3214
|
+
*/
|
|
3215
|
+
day_of_month: number;
|
|
3216
|
+
/**
|
|
3217
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3218
|
+
*/
|
|
3219
|
+
hour?: number;
|
|
3220
|
+
/**
|
|
3221
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3222
|
+
*/
|
|
3223
|
+
minute?: number;
|
|
3224
|
+
/**
|
|
3225
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3226
|
+
*/
|
|
3227
|
+
month?: number;
|
|
3228
|
+
/**
|
|
3229
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3230
|
+
*/
|
|
3231
|
+
second?: number;
|
|
3232
|
+
}
|
|
3233
|
+
type Type = 'custom' | 'inherit';
|
|
3234
|
+
}
|
|
3235
|
+
}
|
|
3236
|
+
}
|
|
3237
|
+
namespace Set {
|
|
3238
|
+
interface Settings {
|
|
3239
|
+
/**
|
|
3240
|
+
* Configures service period cycle anchoring.
|
|
3241
|
+
*/
|
|
3242
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3243
|
+
/**
|
|
3244
|
+
* 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.
|
|
3245
|
+
*/
|
|
3246
|
+
start_date?: Settings.StartDate;
|
|
3247
|
+
}
|
|
3248
|
+
namespace Settings {
|
|
3249
|
+
interface ServicePeriodAnchorConfig {
|
|
3250
|
+
/**
|
|
3251
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3252
|
+
*/
|
|
3253
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3254
|
+
/**
|
|
3255
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3256
|
+
*/
|
|
3257
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3258
|
+
}
|
|
3259
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3260
|
+
namespace ServicePeriodAnchorConfig {
|
|
3261
|
+
interface Custom {
|
|
3262
|
+
/**
|
|
3263
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3264
|
+
*/
|
|
3265
|
+
day_of_month: number;
|
|
3266
|
+
/**
|
|
3267
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3268
|
+
*/
|
|
3269
|
+
hour?: number;
|
|
3270
|
+
/**
|
|
3271
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3272
|
+
*/
|
|
3273
|
+
minute?: number;
|
|
3274
|
+
/**
|
|
3275
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3276
|
+
*/
|
|
3277
|
+
month?: number;
|
|
3278
|
+
/**
|
|
3279
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3280
|
+
*/
|
|
3281
|
+
second?: number;
|
|
3282
|
+
}
|
|
3283
|
+
type Type = 'custom' | 'inherit';
|
|
3284
|
+
}
|
|
3285
|
+
}
|
|
3286
|
+
}
|
|
3287
|
+
}
|
|
3288
|
+
namespace ItemAction {
|
|
3289
|
+
interface Add {
|
|
3290
|
+
/**
|
|
3291
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3292
|
+
*/
|
|
3293
|
+
discounts?: Array<Add.Discount>;
|
|
3294
|
+
/**
|
|
3295
|
+
* 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`.
|
|
3296
|
+
*/
|
|
3297
|
+
metadata?: MetadataParam;
|
|
3298
|
+
/**
|
|
3299
|
+
* The ID of the price object.
|
|
3300
|
+
*/
|
|
3301
|
+
price: string;
|
|
3302
|
+
/**
|
|
3303
|
+
* Quantity for this item.
|
|
3304
|
+
*/
|
|
3305
|
+
quantity?: number;
|
|
3306
|
+
/**
|
|
3307
|
+
* 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`.
|
|
3308
|
+
*/
|
|
3309
|
+
tax_rates?: Array<string>;
|
|
3310
|
+
/**
|
|
3311
|
+
* Options that configure the trial on the subscription item.
|
|
3312
|
+
*/
|
|
3313
|
+
trial?: Add.Trial;
|
|
3314
|
+
/**
|
|
3315
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3316
|
+
*/
|
|
3317
|
+
trial_offer?: string;
|
|
3318
|
+
}
|
|
3319
|
+
interface Remove {
|
|
3320
|
+
/**
|
|
3321
|
+
* ID of a price to remove.
|
|
3322
|
+
*/
|
|
3323
|
+
price: string;
|
|
3324
|
+
}
|
|
3325
|
+
interface Set {
|
|
3326
|
+
/**
|
|
3327
|
+
* 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`.
|
|
3328
|
+
*/
|
|
3329
|
+
discounts?: Array<Set.Discount>;
|
|
3330
|
+
/**
|
|
3331
|
+
* 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`.
|
|
3332
|
+
*/
|
|
3333
|
+
metadata?: MetadataParam;
|
|
3334
|
+
/**
|
|
3335
|
+
* The ID of the price object.
|
|
3336
|
+
*/
|
|
3337
|
+
price: string;
|
|
3338
|
+
/**
|
|
3339
|
+
* 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`.
|
|
3340
|
+
*/
|
|
3341
|
+
quantity?: number;
|
|
3342
|
+
/**
|
|
3343
|
+
* 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`.
|
|
3344
|
+
*/
|
|
3345
|
+
tax_rates?: Array<string>;
|
|
3346
|
+
/**
|
|
3347
|
+
* 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`.
|
|
3348
|
+
*/
|
|
3349
|
+
trial?: Set.Trial;
|
|
3350
|
+
/**
|
|
3351
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3352
|
+
*/
|
|
3353
|
+
trial_offer?: string;
|
|
3354
|
+
}
|
|
3355
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3356
|
+
namespace Add {
|
|
3357
|
+
interface Discount {
|
|
3358
|
+
/**
|
|
3359
|
+
* ID of the coupon to create a new discount for.
|
|
3360
|
+
*/
|
|
3361
|
+
coupon?: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3364
|
+
*/
|
|
3365
|
+
discount?: string;
|
|
3366
|
+
/**
|
|
3367
|
+
* Details to determine how long the discount should be applied for.
|
|
3368
|
+
*/
|
|
3369
|
+
discount_end?: Discount.DiscountEnd;
|
|
3370
|
+
/**
|
|
3371
|
+
* ID of the promotion code to create a new discount for.
|
|
3372
|
+
*/
|
|
3373
|
+
promotion_code?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* Settings for discount application including service period anchoring.
|
|
3376
|
+
*/
|
|
3377
|
+
settings?: Discount.Settings;
|
|
3378
|
+
}
|
|
3379
|
+
interface Trial {
|
|
3380
|
+
/**
|
|
3381
|
+
* 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.
|
|
3382
|
+
*/
|
|
3383
|
+
converts_to?: Array<string>;
|
|
3384
|
+
/**
|
|
3385
|
+
* Determines the type of trial for this item.
|
|
3386
|
+
*/
|
|
3387
|
+
type: Trial.Type;
|
|
3388
|
+
}
|
|
3389
|
+
namespace Discount {
|
|
3390
|
+
interface DiscountEnd {
|
|
3391
|
+
/**
|
|
3392
|
+
* Time span for the redeemed discount.
|
|
3393
|
+
*/
|
|
3394
|
+
duration?: DiscountEnd.Duration;
|
|
3395
|
+
/**
|
|
3396
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3397
|
+
*/
|
|
3398
|
+
timestamp?: number;
|
|
3399
|
+
/**
|
|
3400
|
+
* The type of calculation made to determine when the discount ends.
|
|
3401
|
+
*/
|
|
3402
|
+
type: DiscountEnd.Type;
|
|
3403
|
+
}
|
|
3404
|
+
interface Settings {
|
|
3405
|
+
/**
|
|
3406
|
+
* Configures service period cycle anchoring.
|
|
3407
|
+
*/
|
|
3408
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3409
|
+
/**
|
|
3410
|
+
* 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.
|
|
3411
|
+
*/
|
|
3412
|
+
start_date?: Settings.StartDate;
|
|
3413
|
+
}
|
|
3414
|
+
namespace DiscountEnd {
|
|
3415
|
+
interface Duration {
|
|
3416
|
+
/**
|
|
3417
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3418
|
+
*/
|
|
3419
|
+
interval: Duration.Interval;
|
|
3420
|
+
/**
|
|
3421
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3422
|
+
*/
|
|
3423
|
+
interval_count: number;
|
|
3424
|
+
}
|
|
3425
|
+
type Type = 'duration' | 'timestamp';
|
|
3426
|
+
namespace Duration {
|
|
3427
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3428
|
+
}
|
|
3429
|
+
}
|
|
3430
|
+
namespace Settings {
|
|
3431
|
+
interface ServicePeriodAnchorConfig {
|
|
3432
|
+
/**
|
|
3433
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3434
|
+
*/
|
|
3435
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3436
|
+
/**
|
|
3437
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3438
|
+
*/
|
|
3439
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3440
|
+
}
|
|
3441
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3442
|
+
namespace ServicePeriodAnchorConfig {
|
|
3443
|
+
interface Custom {
|
|
3444
|
+
/**
|
|
3445
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3446
|
+
*/
|
|
3447
|
+
day_of_month: number;
|
|
3448
|
+
/**
|
|
3449
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3450
|
+
*/
|
|
3451
|
+
hour?: number;
|
|
3452
|
+
/**
|
|
3453
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3454
|
+
*/
|
|
3455
|
+
minute?: number;
|
|
3456
|
+
/**
|
|
3457
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3458
|
+
*/
|
|
3459
|
+
month?: number;
|
|
3460
|
+
/**
|
|
3461
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3462
|
+
*/
|
|
3463
|
+
second?: number;
|
|
3464
|
+
}
|
|
3465
|
+
type Type = 'custom' | 'inherit';
|
|
3466
|
+
}
|
|
3467
|
+
}
|
|
3468
|
+
}
|
|
3469
|
+
namespace Trial {
|
|
3470
|
+
type Type = 'free' | 'paid';
|
|
3471
|
+
}
|
|
3472
|
+
}
|
|
3473
|
+
namespace Set {
|
|
3474
|
+
interface Discount {
|
|
3475
|
+
/**
|
|
3476
|
+
* ID of the coupon to create a new discount for.
|
|
3477
|
+
*/
|
|
3478
|
+
coupon?: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3481
|
+
*/
|
|
3482
|
+
discount?: string;
|
|
3483
|
+
/**
|
|
3484
|
+
* Details to determine how long the discount should be applied for.
|
|
3485
|
+
*/
|
|
3486
|
+
discount_end?: Discount.DiscountEnd;
|
|
3487
|
+
/**
|
|
3488
|
+
* ID of the promotion code to create a new discount for.
|
|
3489
|
+
*/
|
|
3490
|
+
promotion_code?: string;
|
|
3491
|
+
/**
|
|
3492
|
+
* Settings for discount application including service period anchoring.
|
|
3493
|
+
*/
|
|
3494
|
+
settings?: Discount.Settings;
|
|
3495
|
+
}
|
|
3496
|
+
interface Trial {
|
|
3497
|
+
/**
|
|
3498
|
+
* 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.
|
|
3499
|
+
*/
|
|
3500
|
+
converts_to?: Array<string>;
|
|
3501
|
+
/**
|
|
3502
|
+
* Determines the type of trial for this item.
|
|
3503
|
+
*/
|
|
3504
|
+
type: Trial.Type;
|
|
3505
|
+
}
|
|
3506
|
+
namespace Discount {
|
|
3507
|
+
interface DiscountEnd {
|
|
3508
|
+
/**
|
|
3509
|
+
* Time span for the redeemed discount.
|
|
3510
|
+
*/
|
|
3511
|
+
duration?: DiscountEnd.Duration;
|
|
3512
|
+
/**
|
|
3513
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3514
|
+
*/
|
|
3515
|
+
timestamp?: number;
|
|
3516
|
+
/**
|
|
3517
|
+
* The type of calculation made to determine when the discount ends.
|
|
3518
|
+
*/
|
|
3519
|
+
type: DiscountEnd.Type;
|
|
3520
|
+
}
|
|
3521
|
+
interface Settings {
|
|
3522
|
+
/**
|
|
3523
|
+
* Configures service period cycle anchoring.
|
|
3524
|
+
*/
|
|
3525
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3526
|
+
/**
|
|
3527
|
+
* 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.
|
|
3528
|
+
*/
|
|
3529
|
+
start_date?: Settings.StartDate;
|
|
3530
|
+
}
|
|
3531
|
+
namespace DiscountEnd {
|
|
3532
|
+
interface Duration {
|
|
3533
|
+
/**
|
|
3534
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3535
|
+
*/
|
|
3536
|
+
interval: Duration.Interval;
|
|
3537
|
+
/**
|
|
3538
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3539
|
+
*/
|
|
3540
|
+
interval_count: number;
|
|
3541
|
+
}
|
|
3542
|
+
type Type = 'duration' | 'timestamp';
|
|
3543
|
+
namespace Duration {
|
|
3544
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3545
|
+
}
|
|
3546
|
+
}
|
|
3547
|
+
namespace Settings {
|
|
3548
|
+
interface ServicePeriodAnchorConfig {
|
|
3549
|
+
/**
|
|
3550
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3551
|
+
*/
|
|
3552
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3553
|
+
/**
|
|
3554
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3555
|
+
*/
|
|
3556
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3557
|
+
}
|
|
3558
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3559
|
+
namespace ServicePeriodAnchorConfig {
|
|
3560
|
+
interface Custom {
|
|
3561
|
+
/**
|
|
3562
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3563
|
+
*/
|
|
3564
|
+
day_of_month: number;
|
|
3565
|
+
/**
|
|
3566
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3567
|
+
*/
|
|
3568
|
+
hour?: number;
|
|
3569
|
+
/**
|
|
3570
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3571
|
+
*/
|
|
3572
|
+
minute?: number;
|
|
3573
|
+
/**
|
|
3574
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3575
|
+
*/
|
|
3576
|
+
month?: number;
|
|
3577
|
+
/**
|
|
3578
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3579
|
+
*/
|
|
3580
|
+
second?: number;
|
|
3581
|
+
}
|
|
3582
|
+
type Type = 'custom' | 'inherit';
|
|
3583
|
+
}
|
|
3584
|
+
}
|
|
3585
|
+
}
|
|
3586
|
+
namespace Trial {
|
|
3587
|
+
type Type = 'free' | 'paid';
|
|
3588
|
+
}
|
|
3589
|
+
}
|
|
3590
|
+
}
|
|
3591
|
+
namespace MetadataAction {
|
|
3592
|
+
type Type = 'add' | 'remove' | 'set';
|
|
3593
|
+
}
|
|
3594
|
+
namespace SetPauseCollection {
|
|
3595
|
+
interface Set {
|
|
3596
|
+
/**
|
|
3597
|
+
* The payment collection behavior for this subscription while paused.
|
|
3598
|
+
*/
|
|
3599
|
+
behavior: Set.Behavior;
|
|
3600
|
+
}
|
|
3601
|
+
type Type = 'remove' | 'set';
|
|
3602
|
+
namespace Set {
|
|
3603
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3604
|
+
}
|
|
3605
|
+
}
|
|
3606
|
+
namespace TrialSettings {
|
|
3607
|
+
interface EndBehavior {
|
|
3608
|
+
/**
|
|
3609
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3610
|
+
*/
|
|
3611
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3612
|
+
}
|
|
3613
|
+
namespace EndBehavior {
|
|
3614
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
3615
|
+
}
|
|
3616
|
+
}
|
|
3617
|
+
}
|
|
3618
|
+
namespace Prebilling {
|
|
3619
|
+
interface BillFrom {
|
|
3620
|
+
/**
|
|
3621
|
+
* Start the prebilled period when a specified amendment begins.
|
|
3622
|
+
*/
|
|
3623
|
+
amendment_start?: BillFrom.AmendmentStart;
|
|
3624
|
+
/**
|
|
3625
|
+
* Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3626
|
+
*/
|
|
3627
|
+
timestamp?: number;
|
|
3628
|
+
/**
|
|
3629
|
+
* Select one of several ways to pass the `bill_from` value.
|
|
3630
|
+
*/
|
|
3631
|
+
type: BillFrom.Type;
|
|
3632
|
+
}
|
|
3633
|
+
interface BillUntil {
|
|
3634
|
+
/**
|
|
3635
|
+
* End the prebilled period when a specified amendment ends.
|
|
3636
|
+
*/
|
|
3637
|
+
amendment_end?: BillUntil.AmendmentEnd;
|
|
3638
|
+
/**
|
|
3639
|
+
* Time span for prebilling, starting from `bill_from`.
|
|
3640
|
+
*/
|
|
3641
|
+
duration?: BillUntil.Duration;
|
|
3642
|
+
/**
|
|
3643
|
+
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3644
|
+
*/
|
|
3645
|
+
timestamp?: number;
|
|
3646
|
+
/**
|
|
3647
|
+
* Select one of several ways to pass the `bill_until` value.
|
|
3648
|
+
*/
|
|
3649
|
+
type: BillUntil.Type;
|
|
3650
|
+
}
|
|
3651
|
+
type UpdateBehavior = 'prebill' | 'reset';
|
|
3652
|
+
namespace BillFrom {
|
|
3653
|
+
interface AmendmentStart {
|
|
3654
|
+
/**
|
|
3655
|
+
* 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.
|
|
3656
|
+
*/
|
|
3657
|
+
index: number;
|
|
3658
|
+
}
|
|
3659
|
+
type Type = 'amendment_start' | 'now' | 'timestamp';
|
|
3660
|
+
}
|
|
3661
|
+
namespace BillUntil {
|
|
3662
|
+
interface AmendmentEnd {
|
|
3663
|
+
/**
|
|
3664
|
+
* 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.
|
|
3665
|
+
*/
|
|
3666
|
+
index: number;
|
|
3667
|
+
}
|
|
3668
|
+
interface Duration {
|
|
3669
|
+
/**
|
|
3670
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3671
|
+
*/
|
|
3672
|
+
interval: Duration.Interval;
|
|
3673
|
+
/**
|
|
3674
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3675
|
+
*/
|
|
3676
|
+
interval_count: number;
|
|
3677
|
+
}
|
|
3678
|
+
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
3679
|
+
namespace Duration {
|
|
3680
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3681
|
+
}
|
|
3682
|
+
}
|
|
3683
|
+
}
|
|
3684
|
+
namespace ScheduleSettings {
|
|
3685
|
+
type EndBehavior = 'cancel' | 'release';
|
|
3686
|
+
}
|
|
3687
|
+
}
|
|
1766
3688
|
export interface SubscriptionScheduleCancelParams {
|
|
1767
3689
|
/**
|
|
1768
3690
|
* Specifies which fields in the response should be expanded.
|
|
@@ -1787,3 +3709,11 @@ export interface SubscriptionScheduleReleaseParams {
|
|
|
1787
3709
|
*/
|
|
1788
3710
|
preserve_cancel_date?: boolean;
|
|
1789
3711
|
}
|
|
3712
|
+
export interface SubscriptionScheduleSerializeBatchCancelParams {
|
|
3713
|
+
}
|
|
3714
|
+
export interface SubscriptionScheduleSerializeBatchCreateParams {
|
|
3715
|
+
}
|
|
3716
|
+
export interface SubscriptionScheduleSerializeBatchReleaseParams {
|
|
3717
|
+
}
|
|
3718
|
+
export interface SubscriptionScheduleSerializeBatchUpdateParams {
|
|
3719
|
+
}
|