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