stripe 22.5.0 → 22.6.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 +3251 -12
- package/OPENAPI_VERSION +1 -1
- package/README.md +51 -60
- package/VERSION +1 -1
- package/cjs/Error.d.ts +61 -0
- package/cjs/Error.js +143 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/RequestSender.d.ts +1 -1
- package/cjs/RequestSender.js +14 -5
- package/cjs/RequestSender.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +505 -0
- package/cjs/StripeEventNotificationHandler.js.map +1 -0
- package/cjs/Types.d.ts +9 -2
- package/cjs/Types.js.map +1 -1
- package/cjs/apiVersion.d.ts +2 -2
- package/cjs/apiVersion.js +2 -2
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +8 -4
- 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 +564 -0
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/AccountSignals.d.ts +111 -0
- package/cjs/resources/AccountSignals.js +4 -0
- package/cjs/resources/AccountSignals.js.map +1 -0
- package/cjs/resources/Accounts.d.ts +1143 -85
- 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 +2 -2
- 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 +4 -4
- package/cjs/resources/Billing/AlertNotifications.d.ts +75 -0
- package/cjs/resources/Billing/AlertNotifications.js +4 -0
- package/cjs/resources/Billing/AlertNotifications.js.map +1 -0
- package/cjs/resources/Billing/AlertRecovereds.d.ts +56 -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 +448 -5
- package/cjs/resources/Billing/Alerts.js +329 -5
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +89 -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 +136 -3
- 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 +105 -3
- package/cjs/resources/Billing/CreditGrants.js +134 -5
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/FeedbackOptions.d.ts +32 -0
- package/cjs/resources/Billing/FeedbackOptions.js +4 -0
- package/cjs/resources/Billing/FeedbackOptions.js.map +1 -0
- 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 +13 -0
- package/cjs/resources/Billing/index.js +2 -0
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/BillingPortal/Configurations.d.ts +14 -9
- package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
- package/cjs/resources/BillingPortal/Sessions.d.ts +17 -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 +102 -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 +29 -1
- package/cjs/resources/CashBalances.d.ts +2 -1
- package/cjs/resources/Charges.d.ts +3382 -85
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1224 -43
- 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/Climate/Orders.d.ts +1 -1
- package/cjs/resources/Climate/Products.d.ts +1 -1
- package/cjs/resources/ConfirmationTokens.d.ts +153 -8
- 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 +17 -3
- package/cjs/resources/CreditNotes.d.ts +12 -6
- package/cjs/resources/CreditNotes.js +13 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/Crypto/CustomerConsumerWallets.d.ts +30 -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 +80 -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/DepositAddresses.d.ts +128 -0
- package/cjs/resources/Crypto/DepositAddresses.js +31 -0
- package/cjs/resources/Crypto/DepositAddresses.js.map +1 -0
- package/cjs/resources/Crypto/OnrampSessions.d.ts +425 -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 +61 -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 +41 -0
- package/cjs/resources/Crypto/index.js +19 -0
- package/cjs/resources/Crypto/index.js.map +1 -0
- package/cjs/resources/CustomerSessions.d.ts +94 -0
- package/cjs/resources/CustomerSessions.js +13 -0
- package/cjs/resources/CustomerSessions.js.map +1 -1
- package/cjs/resources/Customers.d.ts +126 -12
- package/cjs/resources/Customers.js +195 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +129 -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 +1424 -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 +640 -3
- 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/Files.d.ts +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 +105 -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 +46 -1
- package/cjs/resources/FinancialConnections/Authorizations.js +11 -0
- package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -1
- 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 +128 -9
- package/cjs/resources/FinancialConnections/Transactions.d.ts +76 -0
- package/cjs/resources/FinancialConnections/index.d.ts +21 -9
- package/cjs/resources/FinancialConnections/index.js +4 -0
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- 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 +249 -0
- package/cjs/resources/GiftCardOperations.js +15 -0
- package/cjs/resources/GiftCardOperations.js.map +1 -0
- package/cjs/resources/GiftCards.d.ts +181 -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 +226 -8
- package/cjs/resources/InvoiceItems.js +41 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +175 -5
- package/cjs/resources/InvoicePayments.d.ts +1 -1
- package/cjs/resources/InvoiceRenderingTemplates.d.ts +15 -3
- package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +2211 -61
- package/cjs/resources/Invoices.js +221 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +730 -1
- package/cjs/resources/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +40 -22
- package/cjs/resources/Issuing/Cards.d.ts +97 -15
- 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 +233 -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 +49 -4
- 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 +696 -19
- package/cjs/resources/PaymentAttemptRecords.js +48 -0
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
- package/cjs/resources/PaymentIntents.d.ts +17309 -3551
- package/cjs/resources/PaymentIntents.js +46 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +84 -22
- package/cjs/resources/PaymentLocationCapabilities.d.ts +123 -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 +420 -0
- package/cjs/resources/PaymentMethods.d.ts +311 -14
- package/cjs/resources/PaymentMethods.js +20 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentPlans.d.ts +427 -0
- package/cjs/resources/PaymentPlans.js +35 -0
- package/cjs/resources/PaymentPlans.js.map +1 -0
- package/cjs/resources/PaymentRecords.d.ts +754 -37
- package/cjs/resources/PaymentRecords.js +18 -0
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Payouts.d.ts +3 -3
- package/cjs/resources/Persons.d.ts +25 -2
- package/cjs/resources/Plans.d.ts +21 -5
- package/cjs/resources/Prices.d.ts +91 -15
- package/cjs/resources/Prices.js +27 -0
- package/cjs/resources/Prices.js.map +1 -1
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -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 +158 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js +29 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/cjs/resources/ProductCatalog/index.d.ts +14 -0
- package/cjs/resources/ProductCatalog/index.js +13 -0
- package/cjs/resources/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/Products.d.ts +205 -7
- package/cjs/resources/Products.js +69 -0
- package/cjs/resources/Products.js.map +1 -1
- package/cjs/resources/Profiles.d.ts +68 -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 +1210 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +1087 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +3558 -264
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +309 -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 +245 -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 +116 -2
- package/cjs/resources/Radar/ValueListItems.d.ts +39 -1
- package/cjs/resources/Radar/ValueListItems.js +13 -0
- package/cjs/resources/Radar/ValueListItems.js.map +1 -1
- package/cjs/resources/Radar/ValueLists.d.ts +2 -2
- 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 +41 -2
- package/cjs/resources/Refunds.js +27 -0
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reporting/ReportRuns.d.ts +3 -3
- 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/Reviews.d.ts +2 -2
- 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 +42 -8
- package/cjs/resources/SetupAttempts.js.map +1 -1
- package/cjs/resources/SetupIntents.d.ts +667 -51
- package/cjs/resources/SetupIntents.js.map +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +425 -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 +344 -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/ShippingRates.d.ts +6 -6
- package/cjs/resources/SourceTransactions.d.ts +2 -1
- package/cjs/resources/Sources.d.ts +43 -15
- package/cjs/resources/SubscriptionItems.d.ts +273 -8
- package/cjs/resources/SubscriptionItems.js +41 -0
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +2463 -90
- package/cjs/resources/SubscriptionSchedules.js +61 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +1011 -43
- package/cjs/resources/Subscriptions.js +290 -1
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/cjs/resources/Tax/Calculations.d.ts +49 -7
- 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 +112 -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 +441 -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 +10 -2
- package/cjs/resources/Tax/Settings.js +13 -0
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/Transactions.d.ts +11 -3
- 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 +16 -1
- 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 +9 -3
- package/cjs/resources/TaxIds.js +13 -0
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +13 -1
- 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 +211 -6
- package/cjs/resources/Terminal/Readers.js +24 -0
- package/cjs/resources/Terminal/Readers.js.map +1 -1
- package/cjs/resources/Terminal/index.d.ts +9 -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 +82 -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 +104 -5
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +115 -13
- package/cjs/resources/TestHelpers/Issuing/Disputes.d.ts +127 -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 +121 -11
- 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 +38 -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/Terminal/Readers.d.ts +15 -1
- 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 +84 -2
- package/cjs/resources/Topups.d.ts +4 -4
- package/cjs/resources/Topups.js.map +1 -1
- package/cjs/resources/Transfers.d.ts +14 -2
- 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 +72 -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 +281 -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 +237 -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 +776 -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 +1512 -0
- package/cjs/resources/V2/Billing/Contracts.js +331 -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 +1261 -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 +159 -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 +16131 -1984
- package/cjs/resources/V2/Core/Accounts.js +10379 -53
- package/cjs/resources/V2/Core/Accounts.js.map +1 -1
- package/cjs/resources/V2/Core/ApprovalRequests.d.ts +331 -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 +8083 -223
- package/cjs/resources/V2/Core/FeeBatches.d.ts +234 -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 +200 -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 +423 -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 +537 -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 +280 -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 +252 -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 +74 -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 +172 -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 +163 -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 +120 -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 +218 -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 +305 -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 +169 -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 +49 -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 +438 -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 +251 -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 +329 -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 +318 -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 +648 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js +57 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -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 +481 -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/ReceivedDebitMandates.d.ts +166 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js +29 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -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 +34 -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 +266 -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 +321 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +29 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +153 -0
- package/cjs/resources/V2/MoneyManagement/index.js +51 -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 +835 -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 +191 -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/Risk/Inquiries.d.ts +143 -0
- package/cjs/resources/V2/Risk/Inquiries.js +29 -0
- package/cjs/resources/V2/Risk/Inquiries.js.map +1 -0
- package/cjs/resources/V2/Risk/index.d.ts +14 -0
- package/cjs/resources/V2/Risk/index.js +13 -0
- package/cjs/resources/V2/Risk/index.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountActivity.d.ts +424 -0
- package/cjs/resources/V2/Signals/AccountActivity.js +27 -0
- package/cjs/resources/V2/Signals/AccountActivity.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.js +59 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountSignals.d.ts +281 -0
- package/cjs/resources/V2/Signals/AccountSignals.js +110 -0
- package/cjs/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/cjs/resources/V2/Signals/index.d.ts +26 -0
- package/cjs/resources/V2/Signals/index.js +17 -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/Operations.d.ts +43 -0
- package/cjs/resources/V2/Tax/Operations.js +15 -0
- package/cjs/resources/V2/Tax/Operations.js.map +1 -0
- package/cjs/resources/V2/Tax/OperationsResolveAddressResults.d.ts +68 -0
- package/cjs/resources/V2/Tax/OperationsResolveAddressResults.js +4 -0
- package/cjs/resources/V2/Tax/OperationsResolveAddressResults.js.map +1 -0
- package/cjs/resources/V2/Tax/index.d.ts +21 -0
- package/cjs/resources/V2/Tax/index.js +15 -0
- package/cjs/resources/V2/Tax/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -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 +42 -0
- package/cjs/resources/V2/index.js +24 -0
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +3 -3
- package/cjs/resources.d.ts +20 -0
- package/cjs/resources.js +296 -18
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +17320 -2862
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +163 -54
- package/cjs/stripe.core.js +74 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +61 -0
- package/esm/Error.js +125 -0
- package/esm/Error.js.map +1 -1
- package/esm/RequestSender.d.ts +1 -1
- package/esm/RequestSender.js +14 -5
- package/esm/RequestSender.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +501 -0
- package/esm/StripeEventNotificationHandler.js.map +1 -0
- package/esm/Types.d.ts +9 -2
- package/esm/Types.js.map +1 -1
- package/esm/apiVersion.d.ts +2 -2
- package/esm/apiVersion.js +2 -2
- package/esm/apiVersion.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +8 -4
- 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 +564 -0
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/AccountSignals.d.ts +111 -0
- package/esm/resources/AccountSignals.js +3 -0
- package/esm/resources/AccountSignals.js.map +1 -0
- package/esm/resources/Accounts.d.ts +1143 -85
- 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 +2 -2
- 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 +4 -4
- package/esm/resources/Billing/AlertNotifications.d.ts +75 -0
- package/esm/resources/Billing/AlertNotifications.js +3 -0
- package/esm/resources/Billing/AlertNotifications.js.map +1 -0
- package/esm/resources/Billing/AlertRecovereds.d.ts +56 -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 +448 -5
- package/esm/resources/Billing/Alerts.js +329 -5
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +89 -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 +136 -3
- 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 +105 -3
- package/esm/resources/Billing/CreditGrants.js +134 -5
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/FeedbackOptions.d.ts +32 -0
- package/esm/resources/Billing/FeedbackOptions.js +3 -0
- package/esm/resources/Billing/FeedbackOptions.js.map +1 -0
- 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 +13 -0
- package/esm/resources/Billing/index.js +2 -0
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/BillingPortal/Configurations.d.ts +14 -9
- package/esm/resources/BillingPortal/Configurations.js.map +1 -1
- package/esm/resources/BillingPortal/Sessions.d.ts +17 -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 +102 -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 +29 -1
- package/esm/resources/CashBalances.d.ts +2 -1
- package/esm/resources/Charges.d.ts +3382 -85
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1224 -43
- 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/Climate/Orders.d.ts +1 -1
- package/esm/resources/Climate/Products.d.ts +1 -1
- package/esm/resources/ConfirmationTokens.d.ts +153 -8
- 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 +17 -3
- package/esm/resources/CreditNotes.d.ts +12 -6
- package/esm/resources/CreditNotes.js +13 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/Crypto/CustomerConsumerWallets.d.ts +30 -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 +80 -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/DepositAddresses.d.ts +128 -0
- package/esm/resources/Crypto/DepositAddresses.js +27 -0
- package/esm/resources/Crypto/DepositAddresses.js.map +1 -0
- package/esm/resources/Crypto/OnrampSessions.d.ts +425 -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 +61 -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 +41 -0
- package/esm/resources/Crypto/index.js +15 -0
- package/esm/resources/Crypto/index.js.map +1 -0
- package/esm/resources/CustomerSessions.d.ts +94 -0
- package/esm/resources/CustomerSessions.js +13 -0
- package/esm/resources/CustomerSessions.js.map +1 -1
- package/esm/resources/Customers.d.ts +126 -12
- package/esm/resources/Customers.js +195 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +129 -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 +1424 -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 +640 -3
- 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/Files.d.ts +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 +105 -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 +46 -1
- package/esm/resources/FinancialConnections/Authorizations.js +9 -1
- package/esm/resources/FinancialConnections/Authorizations.js.map +1 -1
- 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 +128 -9
- package/esm/resources/FinancialConnections/Transactions.d.ts +76 -0
- package/esm/resources/FinancialConnections/index.d.ts +21 -9
- package/esm/resources/FinancialConnections/index.js +4 -0
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- 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 +249 -0
- package/esm/resources/GiftCardOperations.js +11 -0
- package/esm/resources/GiftCardOperations.js.map +1 -0
- package/esm/resources/GiftCards.d.ts +181 -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 +226 -8
- package/esm/resources/InvoiceItems.js +41 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +175 -5
- package/esm/resources/InvoicePayments.d.ts +1 -1
- package/esm/resources/InvoiceRenderingTemplates.d.ts +15 -3
- package/esm/resources/InvoiceRenderingTemplates.js +28 -0
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +2211 -61
- package/esm/resources/Invoices.js +221 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +730 -1
- package/esm/resources/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +40 -22
- package/esm/resources/Issuing/Cards.d.ts +97 -15
- 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 +233 -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 +49 -4
- 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 +696 -19
- package/esm/resources/PaymentAttemptRecords.js +48 -0
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
- package/esm/resources/PaymentIntents.d.ts +17309 -3551
- package/esm/resources/PaymentIntents.js +46 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +84 -22
- package/esm/resources/PaymentLocationCapabilities.d.ts +123 -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 +420 -0
- package/esm/resources/PaymentMethods.d.ts +311 -14
- package/esm/resources/PaymentMethods.js +20 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentPlans.d.ts +427 -0
- package/esm/resources/PaymentPlans.js +31 -0
- package/esm/resources/PaymentPlans.js.map +1 -0
- package/esm/resources/PaymentRecords.d.ts +754 -37
- package/esm/resources/PaymentRecords.js +18 -0
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Payouts.d.ts +3 -3
- package/esm/resources/Persons.d.ts +25 -2
- package/esm/resources/Plans.d.ts +21 -5
- package/esm/resources/Prices.d.ts +91 -15
- package/esm/resources/Prices.js +27 -0
- package/esm/resources/Prices.js.map +1 -1
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -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 +158 -0
- package/esm/resources/ProductCatalog/TrialOffers.js +25 -0
- package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/esm/resources/ProductCatalog/index.d.ts +14 -0
- package/esm/resources/ProductCatalog/index.js +9 -0
- package/esm/resources/ProductCatalog/index.js.map +1 -0
- package/esm/resources/Products.d.ts +205 -7
- package/esm/resources/Products.js +69 -0
- package/esm/resources/Products.js.map +1 -1
- package/esm/resources/Profiles.d.ts +68 -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 +1210 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +1087 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +3558 -264
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +309 -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 +245 -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 +116 -2
- package/esm/resources/Radar/ValueListItems.d.ts +39 -1
- package/esm/resources/Radar/ValueListItems.js +13 -0
- package/esm/resources/Radar/ValueListItems.js.map +1 -1
- package/esm/resources/Radar/ValueLists.d.ts +2 -2
- 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 +41 -2
- package/esm/resources/Refunds.js +27 -0
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reporting/ReportRuns.d.ts +3 -3
- 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/Reviews.d.ts +2 -2
- 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 +42 -8
- package/esm/resources/SetupAttempts.js.map +1 -1
- package/esm/resources/SetupIntents.d.ts +667 -51
- package/esm/resources/SetupIntents.js.map +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +425 -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 +344 -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/ShippingRates.d.ts +6 -6
- package/esm/resources/SourceTransactions.d.ts +2 -1
- package/esm/resources/Sources.d.ts +43 -15
- package/esm/resources/SubscriptionItems.d.ts +273 -8
- package/esm/resources/SubscriptionItems.js +41 -0
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +2463 -90
- package/esm/resources/SubscriptionSchedules.js +61 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +1011 -43
- package/esm/resources/Subscriptions.js +290 -1
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/esm/resources/Tax/Calculations.d.ts +49 -7
- 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 +112 -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 +441 -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 +10 -2
- package/esm/resources/Tax/Settings.js +13 -0
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/Transactions.d.ts +11 -3
- 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 +16 -1
- 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 +9 -3
- package/esm/resources/TaxIds.js +13 -0
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +13 -1
- 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 +211 -6
- package/esm/resources/Terminal/Readers.js +24 -0
- package/esm/resources/Terminal/Readers.js.map +1 -1
- package/esm/resources/Terminal/index.d.ts +9 -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 +82 -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 +104 -5
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +115 -13
- package/esm/resources/TestHelpers/Issuing/Disputes.d.ts +127 -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 +121 -11
- 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 +38 -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/Terminal/Readers.d.ts +15 -1
- 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 +84 -2
- package/esm/resources/Topups.d.ts +4 -4
- package/esm/resources/Topups.js.map +1 -1
- package/esm/resources/Transfers.d.ts +14 -2
- 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 +72 -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 +281 -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 +237 -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 +776 -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 +1512 -0
- package/esm/resources/V2/Billing/Contracts.js +327 -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 +1261 -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 +159 -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 +16131 -1984
- package/esm/resources/V2/Core/Accounts.js +10379 -53
- package/esm/resources/V2/Core/Accounts.js.map +1 -1
- package/esm/resources/V2/Core/ApprovalRequests.d.ts +331 -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 +8083 -223
- package/esm/resources/V2/Core/FeeBatches.d.ts +234 -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 +200 -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 +423 -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 +537 -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 +280 -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 +252 -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 +74 -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 +172 -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 +163 -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 +120 -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 +218 -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 +305 -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 +169 -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 +49 -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 +438 -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 +251 -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 +329 -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 +318 -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 +648 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js +53 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -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 +481 -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/ReceivedDebitMandates.d.ts +166 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js +25 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -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 +34 -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 +266 -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 +321 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +25 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +153 -0
- package/esm/resources/V2/MoneyManagement/index.js +47 -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 +835 -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 +191 -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/Risk/Inquiries.d.ts +143 -0
- package/esm/resources/V2/Risk/Inquiries.js +25 -0
- package/esm/resources/V2/Risk/Inquiries.js.map +1 -0
- package/esm/resources/V2/Risk/index.d.ts +14 -0
- package/esm/resources/V2/Risk/index.js +9 -0
- package/esm/resources/V2/Risk/index.js.map +1 -0
- package/esm/resources/V2/Signals/AccountActivity.d.ts +424 -0
- package/esm/resources/V2/Signals/AccountActivity.js +23 -0
- package/esm/resources/V2/Signals/AccountActivity.js.map +1 -0
- package/esm/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
- package/esm/resources/V2/Signals/AccountEvaluations.js +55 -0
- package/esm/resources/V2/Signals/AccountEvaluations.js.map +1 -0
- package/esm/resources/V2/Signals/AccountSignals.d.ts +281 -0
- package/esm/resources/V2/Signals/AccountSignals.js +106 -0
- package/esm/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/esm/resources/V2/Signals/index.d.ts +26 -0
- package/esm/resources/V2/Signals/index.js +13 -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/Operations.d.ts +43 -0
- package/esm/resources/V2/Tax/Operations.js +11 -0
- package/esm/resources/V2/Tax/Operations.js.map +1 -0
- package/esm/resources/V2/Tax/OperationsResolveAddressResults.d.ts +68 -0
- package/esm/resources/V2/Tax/OperationsResolveAddressResults.js +3 -0
- package/esm/resources/V2/Tax/OperationsResolveAddressResults.js.map +1 -0
- package/esm/resources/V2/Tax/index.d.ts +21 -0
- package/esm/resources/V2/Tax/index.js +11 -0
- package/esm/resources/V2/Tax/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -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 +42 -0
- package/esm/resources/V2/index.js +24 -0
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +3 -3
- package/esm/resources.d.ts +20 -0
- package/esm/resources.js +266 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +163 -54
- package/esm/stripe.core.js +45 -2
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +163 -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
|
*/
|
|
@@ -94,10 +131,18 @@ export interface SubscriptionSchedule {
|
|
|
94
131
|
* 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.
|
|
95
132
|
*/
|
|
96
133
|
metadata: Metadata | null;
|
|
134
|
+
/**
|
|
135
|
+
* The pause schedules for this subscription schedule.
|
|
136
|
+
*/
|
|
137
|
+
pause_schedules?: Array<SubscriptionSchedule.PauseSchedule>;
|
|
97
138
|
/**
|
|
98
139
|
* Configuration for the subscription schedule's phases.
|
|
99
140
|
*/
|
|
100
141
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
142
|
+
/**
|
|
143
|
+
* Time period and invoice for a Subscription billed in advance.
|
|
144
|
+
*/
|
|
145
|
+
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
101
146
|
/**
|
|
102
147
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
103
148
|
*/
|
|
@@ -120,6 +165,7 @@ export interface SubscriptionSchedule {
|
|
|
120
165
|
test_clock: string | TestHelpers.TestClock | null;
|
|
121
166
|
}
|
|
122
167
|
export declare namespace SubscriptionSchedule {
|
|
168
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front' | OtherString;
|
|
123
169
|
interface BillingMode {
|
|
124
170
|
/**
|
|
125
171
|
* Configure behavior for flexible billing mode
|
|
@@ -134,6 +180,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
134
180
|
*/
|
|
135
181
|
updated_at?: number;
|
|
136
182
|
}
|
|
183
|
+
interface BillingSchedule {
|
|
184
|
+
/**
|
|
185
|
+
* Specifies which subscription items the billing schedule applies to.
|
|
186
|
+
*/
|
|
187
|
+
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
188
|
+
/**
|
|
189
|
+
* Specifies the end of billing period.
|
|
190
|
+
*/
|
|
191
|
+
bill_until: BillingSchedule.BillUntil;
|
|
192
|
+
/**
|
|
193
|
+
* Unique identifier for the billing schedule.
|
|
194
|
+
*/
|
|
195
|
+
key: string;
|
|
196
|
+
}
|
|
137
197
|
interface CurrentPhase {
|
|
138
198
|
/**
|
|
139
199
|
* The end of this phase of the subscription schedule.
|
|
@@ -175,12 +235,41 @@ export declare namespace SubscriptionSchedule {
|
|
|
175
235
|
* 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
236
|
*/
|
|
177
237
|
on_behalf_of: string | Account | null;
|
|
238
|
+
/**
|
|
239
|
+
* 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.
|
|
240
|
+
*/
|
|
241
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
178
242
|
/**
|
|
179
243
|
* 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
244
|
*/
|
|
181
245
|
transfer_data: DefaultSettings.TransferData | null;
|
|
182
246
|
}
|
|
183
247
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew' | OtherString;
|
|
248
|
+
interface LastPriceMigrationError {
|
|
249
|
+
/**
|
|
250
|
+
* The time at which the price migration encountered an error.
|
|
251
|
+
*/
|
|
252
|
+
errored_at: number;
|
|
253
|
+
/**
|
|
254
|
+
* The involved price pairs in each failed transition.
|
|
255
|
+
*/
|
|
256
|
+
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
257
|
+
/**
|
|
258
|
+
* The type of error encountered by the price migration.
|
|
259
|
+
*/
|
|
260
|
+
type: 'price_uniqueness_violation';
|
|
261
|
+
}
|
|
262
|
+
interface PauseSchedule {
|
|
263
|
+
/**
|
|
264
|
+
* A unique identifier for this pause schedule.
|
|
265
|
+
*/
|
|
266
|
+
key: string;
|
|
267
|
+
pause: PauseSchedule.Pause;
|
|
268
|
+
/**
|
|
269
|
+
* Details about when and how the subscription resumes.
|
|
270
|
+
*/
|
|
271
|
+
resume: PauseSchedule.Resume | null;
|
|
272
|
+
}
|
|
184
273
|
interface Phase {
|
|
185
274
|
/**
|
|
186
275
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -223,6 +312,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
223
312
|
* The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
|
224
313
|
*/
|
|
225
314
|
discounts: Array<Phase.Discount>;
|
|
315
|
+
/**
|
|
316
|
+
* 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.
|
|
317
|
+
*/
|
|
318
|
+
effective_at?: Phase.EffectiveAt | null;
|
|
226
319
|
/**
|
|
227
320
|
* The end of this phase of the subscription schedule.
|
|
228
321
|
*/
|
|
@@ -243,6 +336,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
243
336
|
* 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
337
|
*/
|
|
245
338
|
on_behalf_of: string | Account | null;
|
|
339
|
+
/**
|
|
340
|
+
* 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).
|
|
341
|
+
*/
|
|
342
|
+
pause_collection?: Phase.PauseCollection | null;
|
|
246
343
|
/**
|
|
247
344
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
248
345
|
*/
|
|
@@ -259,12 +356,38 @@ export declare namespace SubscriptionSchedule {
|
|
|
259
356
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
260
357
|
*/
|
|
261
358
|
trial?: boolean;
|
|
359
|
+
/**
|
|
360
|
+
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
361
|
+
*/
|
|
362
|
+
trial_continuation?: Phase.TrialContinuation | null;
|
|
262
363
|
/**
|
|
263
364
|
* When the trial ends within the phase.
|
|
264
365
|
*/
|
|
265
366
|
trial_end: number | null;
|
|
367
|
+
/**
|
|
368
|
+
* Settings related to any trials on the subscription during this phase.
|
|
369
|
+
*/
|
|
370
|
+
trial_settings?: Phase.TrialSettings | null;
|
|
371
|
+
}
|
|
372
|
+
interface Prebilling {
|
|
373
|
+
/**
|
|
374
|
+
* ID of the prebilling invoice.
|
|
375
|
+
*/
|
|
376
|
+
invoice: string | Invoice;
|
|
377
|
+
/**
|
|
378
|
+
* The end of the last period for which the invoice pre-bills.
|
|
379
|
+
*/
|
|
380
|
+
period_end: number;
|
|
381
|
+
/**
|
|
382
|
+
* The start of the first period for which the invoice pre-bills.
|
|
383
|
+
*/
|
|
384
|
+
period_start: number;
|
|
385
|
+
/**
|
|
386
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
387
|
+
*/
|
|
388
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
266
389
|
}
|
|
267
|
-
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released';
|
|
390
|
+
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released' | OtherString;
|
|
268
391
|
namespace BillingMode {
|
|
269
392
|
interface Flexible {
|
|
270
393
|
/**
|
|
@@ -274,7 +397,53 @@ export declare namespace SubscriptionSchedule {
|
|
|
274
397
|
}
|
|
275
398
|
type Type = 'classic' | 'flexible' | OtherString;
|
|
276
399
|
namespace Flexible {
|
|
277
|
-
type ProrationDiscounts = 'included' | 'itemized';
|
|
400
|
+
type ProrationDiscounts = 'included' | 'itemized' | OtherString;
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
namespace BillingSchedule {
|
|
404
|
+
interface AppliesTo {
|
|
405
|
+
/**
|
|
406
|
+
* The billing schedule will apply to the subscription item with the given price ID.
|
|
407
|
+
*/
|
|
408
|
+
price: string | Price | null;
|
|
409
|
+
/**
|
|
410
|
+
* Controls which subscription items the billing schedule applies to.
|
|
411
|
+
*/
|
|
412
|
+
type: 'price';
|
|
413
|
+
}
|
|
414
|
+
interface BillUntil {
|
|
415
|
+
/**
|
|
416
|
+
* The timestamp the billing schedule will apply until.
|
|
417
|
+
*/
|
|
418
|
+
computed_timestamp: number;
|
|
419
|
+
/**
|
|
420
|
+
* Specifies the billing period.
|
|
421
|
+
*/
|
|
422
|
+
duration: BillUntil.Duration | null;
|
|
423
|
+
/**
|
|
424
|
+
* If specified, the billing schedule will apply until the specified timestamp.
|
|
425
|
+
*/
|
|
426
|
+
timestamp: number | null;
|
|
427
|
+
/**
|
|
428
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
429
|
+
*/
|
|
430
|
+
type: BillUntil.Type;
|
|
431
|
+
}
|
|
432
|
+
namespace BillUntil {
|
|
433
|
+
interface Duration {
|
|
434
|
+
/**
|
|
435
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
436
|
+
*/
|
|
437
|
+
interval: Duration.Interval;
|
|
438
|
+
/**
|
|
439
|
+
* The multiplier applied to the interval.
|
|
440
|
+
*/
|
|
441
|
+
interval_count: number | null;
|
|
442
|
+
}
|
|
443
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
444
|
+
namespace Duration {
|
|
445
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
446
|
+
}
|
|
278
447
|
}
|
|
279
448
|
}
|
|
280
449
|
namespace DefaultSettings {
|
|
@@ -292,7 +461,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
292
461
|
*/
|
|
293
462
|
liability: AutomaticTax.Liability | null;
|
|
294
463
|
}
|
|
295
|
-
type BillingCycleAnchor = 'automatic' | 'phase_start';
|
|
464
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
296
465
|
interface BillingThresholds {
|
|
297
466
|
/**
|
|
298
467
|
* Monetary threshold that triggers the subscription to create an invoice
|
|
@@ -327,6 +496,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
327
496
|
footer: string | null;
|
|
328
497
|
issuer: InvoiceSettings.Issuer;
|
|
329
498
|
}
|
|
499
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
330
500
|
interface TransferData {
|
|
331
501
|
/**
|
|
332
502
|
* 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.
|
|
@@ -349,7 +519,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
349
519
|
type: Liability.Type;
|
|
350
520
|
}
|
|
351
521
|
namespace Liability {
|
|
352
|
-
type Type = 'account' | 'self' | OtherString;
|
|
522
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
353
523
|
}
|
|
354
524
|
}
|
|
355
525
|
namespace InvoiceSettings {
|
|
@@ -374,7 +544,141 @@ export declare namespace SubscriptionSchedule {
|
|
|
374
544
|
type: Issuer.Type;
|
|
375
545
|
}
|
|
376
546
|
namespace Issuer {
|
|
377
|
-
type Type = 'account' | 'self' | OtherString;
|
|
547
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
}
|
|
551
|
+
namespace LastPriceMigrationError {
|
|
552
|
+
interface FailedTransition {
|
|
553
|
+
/**
|
|
554
|
+
* The original price to be migrated.
|
|
555
|
+
*/
|
|
556
|
+
source_price: string;
|
|
557
|
+
/**
|
|
558
|
+
* The intended resulting price of the migration.
|
|
559
|
+
*/
|
|
560
|
+
target_price: string;
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
namespace PauseSchedule {
|
|
564
|
+
interface Pause {
|
|
565
|
+
/**
|
|
566
|
+
* Time at which the subscription pauses.
|
|
567
|
+
*/
|
|
568
|
+
pause_at: number;
|
|
569
|
+
/**
|
|
570
|
+
* Settings controlling billing behavior during the pause.
|
|
571
|
+
*/
|
|
572
|
+
settings: Pause.Settings | null;
|
|
573
|
+
status: Pause.Status;
|
|
574
|
+
}
|
|
575
|
+
interface Resume {
|
|
576
|
+
/**
|
|
577
|
+
* Time at which the subscription resumes.
|
|
578
|
+
*/
|
|
579
|
+
resume_at: number;
|
|
580
|
+
settings: Resume.Settings;
|
|
581
|
+
status: Resume.Status;
|
|
582
|
+
}
|
|
583
|
+
namespace Pause {
|
|
584
|
+
interface Settings {
|
|
585
|
+
bill_for: Settings.BillFor;
|
|
586
|
+
/**
|
|
587
|
+
* Determines how to handle debits and credits when pausing.
|
|
588
|
+
*/
|
|
589
|
+
invoicing_behavior: Settings.InvoicingBehavior;
|
|
590
|
+
/**
|
|
591
|
+
* The type of pause settings.
|
|
592
|
+
*/
|
|
593
|
+
type: 'subscription';
|
|
594
|
+
}
|
|
595
|
+
interface Status {
|
|
596
|
+
error?: Status.Error;
|
|
597
|
+
/**
|
|
598
|
+
* The lifecycle state of the pause operation.
|
|
599
|
+
*/
|
|
600
|
+
type: Status.Type;
|
|
601
|
+
}
|
|
602
|
+
namespace Settings {
|
|
603
|
+
interface BillFor {
|
|
604
|
+
outstanding_usage_through: BillFor.OutstandingUsageThrough;
|
|
605
|
+
unused_time_from: BillFor.UnusedTimeFrom;
|
|
606
|
+
}
|
|
607
|
+
type InvoicingBehavior = 'invoice' | 'pending_invoice_item' | OtherString;
|
|
608
|
+
namespace BillFor {
|
|
609
|
+
interface OutstandingUsageThrough {
|
|
610
|
+
/**
|
|
611
|
+
* The type of outstanding usage billing behavior.
|
|
612
|
+
*/
|
|
613
|
+
type: OutstandingUsageThrough.Type;
|
|
614
|
+
}
|
|
615
|
+
interface UnusedTimeFrom {
|
|
616
|
+
/**
|
|
617
|
+
* The type of unused time credit behavior.
|
|
618
|
+
*/
|
|
619
|
+
type: UnusedTimeFrom.Type;
|
|
620
|
+
}
|
|
621
|
+
namespace OutstandingUsageThrough {
|
|
622
|
+
type Type = 'none' | 'pause_at' | OtherString;
|
|
623
|
+
}
|
|
624
|
+
namespace UnusedTimeFrom {
|
|
625
|
+
type Type = 'item_current_period_start' | 'none' | 'pause_at' | OtherString;
|
|
626
|
+
}
|
|
627
|
+
}
|
|
628
|
+
}
|
|
629
|
+
namespace Status {
|
|
630
|
+
interface Error {
|
|
631
|
+
/**
|
|
632
|
+
* A machine-readable error code.
|
|
633
|
+
*/
|
|
634
|
+
code?: string;
|
|
635
|
+
/**
|
|
636
|
+
* A description of the error.
|
|
637
|
+
*/
|
|
638
|
+
message: string;
|
|
639
|
+
}
|
|
640
|
+
type Type = 'error' | 'scheduled' | 'succeeded' | OtherString;
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
namespace Resume {
|
|
644
|
+
interface Settings {
|
|
645
|
+
/**
|
|
646
|
+
* The billing cycle anchor that applies when the subscription is resumed.
|
|
647
|
+
*/
|
|
648
|
+
billing_cycle_anchor: Settings.BillingCycleAnchor;
|
|
649
|
+
/**
|
|
650
|
+
* Controls whether Stripe attempts payment on the resumption invoice and how that affects the subscription's status.
|
|
651
|
+
*/
|
|
652
|
+
payment_behavior: Settings.PaymentBehavior;
|
|
653
|
+
/**
|
|
654
|
+
* Determines how to handle prorations resulting from the billing_cycle_anchor change on resume.
|
|
655
|
+
*/
|
|
656
|
+
proration_behavior: Settings.ProrationBehavior;
|
|
657
|
+
}
|
|
658
|
+
interface Status {
|
|
659
|
+
error?: Status.Error;
|
|
660
|
+
/**
|
|
661
|
+
* The lifecycle state of the resume operation.
|
|
662
|
+
*/
|
|
663
|
+
type: Status.Type;
|
|
664
|
+
}
|
|
665
|
+
namespace Settings {
|
|
666
|
+
type BillingCycleAnchor = 'resume_at' | 'unchanged' | OtherString;
|
|
667
|
+
type PaymentBehavior = 'resume_on_payment_attempt' | 'resume_on_payment_success' | OtherString;
|
|
668
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
669
|
+
}
|
|
670
|
+
namespace Status {
|
|
671
|
+
interface Error {
|
|
672
|
+
/**
|
|
673
|
+
* A machine-readable error code.
|
|
674
|
+
*/
|
|
675
|
+
code?: string;
|
|
676
|
+
/**
|
|
677
|
+
* A description of the error.
|
|
678
|
+
*/
|
|
679
|
+
message: string;
|
|
680
|
+
}
|
|
681
|
+
type Type = 'error' | 'pending' | 'requires_action' | 'scheduled' | 'succeeded' | OtherString;
|
|
378
682
|
}
|
|
379
683
|
}
|
|
380
684
|
}
|
|
@@ -420,7 +724,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
420
724
|
*/
|
|
421
725
|
liability: AutomaticTax.Liability | null;
|
|
422
726
|
}
|
|
423
|
-
type BillingCycleAnchor = 'automatic' | 'phase_start';
|
|
727
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
424
728
|
interface BillingThresholds {
|
|
425
729
|
/**
|
|
426
730
|
* Monetary threshold that triggers the subscription to create an invoice
|
|
@@ -431,7 +735,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
431
735
|
*/
|
|
432
736
|
reset_billing_cycle_anchor: boolean | null;
|
|
433
737
|
}
|
|
434
|
-
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
738
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
|
|
435
739
|
interface Discount {
|
|
436
740
|
/**
|
|
437
741
|
* ID of the coupon to create a new discount for.
|
|
@@ -441,11 +745,17 @@ export declare namespace SubscriptionSchedule {
|
|
|
441
745
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
442
746
|
*/
|
|
443
747
|
discount: string | _Discount | null;
|
|
748
|
+
/**
|
|
749
|
+
* Details to determine how long the discount should be applied for.
|
|
750
|
+
*/
|
|
751
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
444
752
|
/**
|
|
445
753
|
* ID of the promotion code to create a new discount for.
|
|
446
754
|
*/
|
|
447
755
|
promotion_code: string | PromotionCode | null;
|
|
756
|
+
settings?: Discount.Settings;
|
|
448
757
|
}
|
|
758
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
449
759
|
interface InvoiceSettings {
|
|
450
760
|
/**
|
|
451
761
|
* 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.
|
|
@@ -501,8 +811,22 @@ export declare namespace SubscriptionSchedule {
|
|
|
501
811
|
* 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`.
|
|
502
812
|
*/
|
|
503
813
|
tax_rates?: Array<TaxRate> | null;
|
|
814
|
+
/**
|
|
815
|
+
* Options that configure the trial on the subscription item.
|
|
816
|
+
*/
|
|
817
|
+
trial?: Item.Trial | null;
|
|
818
|
+
/**
|
|
819
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
820
|
+
*/
|
|
821
|
+
trial_offer?: string | null;
|
|
822
|
+
}
|
|
823
|
+
interface PauseCollection {
|
|
824
|
+
/**
|
|
825
|
+
* The payment collection behavior for this subscription while paused.
|
|
826
|
+
*/
|
|
827
|
+
behavior: PauseCollection.Behavior;
|
|
504
828
|
}
|
|
505
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
829
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
506
830
|
interface TransferData {
|
|
507
831
|
/**
|
|
508
832
|
* 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.
|
|
@@ -513,6 +837,13 @@ export declare namespace SubscriptionSchedule {
|
|
|
513
837
|
*/
|
|
514
838
|
destination: string | Account;
|
|
515
839
|
}
|
|
840
|
+
type TrialContinuation = 'continue' | 'none' | OtherString;
|
|
841
|
+
interface TrialSettings {
|
|
842
|
+
/**
|
|
843
|
+
* Defines how the subscription should behave when a trial ends.
|
|
844
|
+
*/
|
|
845
|
+
end_behavior: TrialSettings.EndBehavior | null;
|
|
846
|
+
}
|
|
516
847
|
namespace AddInvoiceItem {
|
|
517
848
|
interface Discount {
|
|
518
849
|
/**
|
|
@@ -523,6 +854,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
523
854
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
524
855
|
*/
|
|
525
856
|
discount: string | _Discount | null;
|
|
857
|
+
/**
|
|
858
|
+
* Details to determine how long the discount should be applied for.
|
|
859
|
+
*/
|
|
860
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
526
861
|
/**
|
|
527
862
|
* ID of the promotion code to create a new discount for.
|
|
528
863
|
*/
|
|
@@ -532,6 +867,18 @@ export declare namespace SubscriptionSchedule {
|
|
|
532
867
|
end: Period.End;
|
|
533
868
|
start: Period.Start;
|
|
534
869
|
}
|
|
870
|
+
namespace Discount {
|
|
871
|
+
interface DiscountEnd {
|
|
872
|
+
/**
|
|
873
|
+
* The discount end timestamp.
|
|
874
|
+
*/
|
|
875
|
+
timestamp: number | null;
|
|
876
|
+
/**
|
|
877
|
+
* The discount end type.
|
|
878
|
+
*/
|
|
879
|
+
type: 'timestamp';
|
|
880
|
+
}
|
|
881
|
+
}
|
|
535
882
|
namespace Period {
|
|
536
883
|
interface End {
|
|
537
884
|
/**
|
|
@@ -573,7 +920,61 @@ export declare namespace SubscriptionSchedule {
|
|
|
573
920
|
type: Liability.Type;
|
|
574
921
|
}
|
|
575
922
|
namespace Liability {
|
|
576
|
-
type Type = 'account' | 'self' | OtherString;
|
|
923
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
924
|
+
}
|
|
925
|
+
}
|
|
926
|
+
namespace Discount {
|
|
927
|
+
interface DiscountEnd {
|
|
928
|
+
/**
|
|
929
|
+
* The discount end timestamp.
|
|
930
|
+
*/
|
|
931
|
+
timestamp: number | null;
|
|
932
|
+
/**
|
|
933
|
+
* The discount end type.
|
|
934
|
+
*/
|
|
935
|
+
type: 'timestamp';
|
|
936
|
+
}
|
|
937
|
+
interface Settings {
|
|
938
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
939
|
+
/**
|
|
940
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
941
|
+
*/
|
|
942
|
+
start_date: Settings.StartDate;
|
|
943
|
+
}
|
|
944
|
+
namespace Settings {
|
|
945
|
+
interface ServicePeriodAnchorConfig {
|
|
946
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
947
|
+
/**
|
|
948
|
+
* The type of service period anchor config.
|
|
949
|
+
*/
|
|
950
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
951
|
+
}
|
|
952
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
953
|
+
namespace ServicePeriodAnchorConfig {
|
|
954
|
+
interface Custom {
|
|
955
|
+
/**
|
|
956
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
957
|
+
*/
|
|
958
|
+
day_of_month: number;
|
|
959
|
+
/**
|
|
960
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
961
|
+
*/
|
|
962
|
+
hour: number | null;
|
|
963
|
+
/**
|
|
964
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
965
|
+
*/
|
|
966
|
+
minute: number | null;
|
|
967
|
+
/**
|
|
968
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
969
|
+
*/
|
|
970
|
+
month: number | null;
|
|
971
|
+
/**
|
|
972
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
973
|
+
*/
|
|
974
|
+
second: number | null;
|
|
975
|
+
}
|
|
976
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
977
|
+
}
|
|
577
978
|
}
|
|
578
979
|
}
|
|
579
980
|
namespace InvoiceSettings {
|
|
@@ -598,7 +999,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
598
999
|
type: Issuer.Type;
|
|
599
1000
|
}
|
|
600
1001
|
namespace Issuer {
|
|
601
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1002
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
602
1003
|
}
|
|
603
1004
|
}
|
|
604
1005
|
namespace Item {
|
|
@@ -617,19 +1018,116 @@ export declare namespace SubscriptionSchedule {
|
|
|
617
1018
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
618
1019
|
*/
|
|
619
1020
|
discount: string | _Discount | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Details to determine how long the discount should be applied for.
|
|
1023
|
+
*/
|
|
1024
|
+
discount_end?: Discount.DiscountEnd | null;
|
|
620
1025
|
/**
|
|
621
1026
|
* ID of the promotion code to create a new discount for.
|
|
622
1027
|
*/
|
|
623
1028
|
promotion_code: string | PromotionCode | null;
|
|
1029
|
+
settings?: Discount.Settings;
|
|
1030
|
+
}
|
|
1031
|
+
interface Trial {
|
|
1032
|
+
/**
|
|
1033
|
+
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
1034
|
+
*/
|
|
1035
|
+
converts_to?: Array<string> | null;
|
|
1036
|
+
/**
|
|
1037
|
+
* Determines the type of trial for this item.
|
|
1038
|
+
*/
|
|
1039
|
+
type: Trial.Type;
|
|
1040
|
+
}
|
|
1041
|
+
namespace Discount {
|
|
1042
|
+
interface DiscountEnd {
|
|
1043
|
+
/**
|
|
1044
|
+
* The discount end timestamp.
|
|
1045
|
+
*/
|
|
1046
|
+
timestamp: number | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* The discount end type.
|
|
1049
|
+
*/
|
|
1050
|
+
type: 'timestamp';
|
|
1051
|
+
}
|
|
1052
|
+
interface Settings {
|
|
1053
|
+
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
1054
|
+
/**
|
|
1055
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
1056
|
+
*/
|
|
1057
|
+
start_date: Settings.StartDate;
|
|
1058
|
+
}
|
|
1059
|
+
namespace Settings {
|
|
1060
|
+
interface ServicePeriodAnchorConfig {
|
|
1061
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1062
|
+
/**
|
|
1063
|
+
* The type of service period anchor config.
|
|
1064
|
+
*/
|
|
1065
|
+
type: ServicePeriodAnchorConfig.Type;
|
|
1066
|
+
}
|
|
1067
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
1068
|
+
namespace ServicePeriodAnchorConfig {
|
|
1069
|
+
interface Custom {
|
|
1070
|
+
/**
|
|
1071
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1072
|
+
*/
|
|
1073
|
+
day_of_month: number;
|
|
1074
|
+
/**
|
|
1075
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1076
|
+
*/
|
|
1077
|
+
hour: number | null;
|
|
1078
|
+
/**
|
|
1079
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1080
|
+
*/
|
|
1081
|
+
minute: number | null;
|
|
1082
|
+
/**
|
|
1083
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1084
|
+
*/
|
|
1085
|
+
month: number | null;
|
|
1086
|
+
/**
|
|
1087
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1088
|
+
*/
|
|
1089
|
+
second: number | null;
|
|
1090
|
+
}
|
|
1091
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
namespace Trial {
|
|
1096
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
1097
|
+
}
|
|
1098
|
+
}
|
|
1099
|
+
namespace PauseCollection {
|
|
1100
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
1101
|
+
}
|
|
1102
|
+
namespace TrialSettings {
|
|
1103
|
+
interface EndBehavior {
|
|
1104
|
+
/**
|
|
1105
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1106
|
+
*/
|
|
1107
|
+
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
1108
|
+
}
|
|
1109
|
+
namespace EndBehavior {
|
|
1110
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
624
1111
|
}
|
|
625
1112
|
}
|
|
626
1113
|
}
|
|
1114
|
+
namespace Prebilling {
|
|
1115
|
+
type UpdateBehavior = 'prebill' | 'reset' | OtherString;
|
|
1116
|
+
}
|
|
627
1117
|
}
|
|
628
1118
|
export interface SubscriptionScheduleCreateParams {
|
|
1119
|
+
/**
|
|
1120
|
+
* 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.
|
|
1121
|
+
*/
|
|
1122
|
+
billing_behavior?: SubscriptionScheduleCreateParams.BillingBehavior;
|
|
629
1123
|
/**
|
|
630
1124
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
631
1125
|
*/
|
|
632
1126
|
billing_mode?: SubscriptionScheduleCreateParams.BillingMode;
|
|
1127
|
+
/**
|
|
1128
|
+
* Sets the billing schedules for the subscription schedule.
|
|
1129
|
+
*/
|
|
1130
|
+
billing_schedules?: Array<SubscriptionScheduleCreateParams.BillingSchedule>;
|
|
633
1131
|
/**
|
|
634
1132
|
* The identifier of the customer to create the subscription schedule for.
|
|
635
1133
|
*/
|
|
@@ -658,16 +1156,25 @@ export interface SubscriptionScheduleCreateParams {
|
|
|
658
1156
|
* 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`.
|
|
659
1157
|
*/
|
|
660
1158
|
metadata?: Emptyable<MetadataParam>;
|
|
1159
|
+
/**
|
|
1160
|
+
* Configures the subscription's pause behavior and, optionally, its resume behavior. Only one entry is supported.
|
|
1161
|
+
*/
|
|
1162
|
+
pause_schedules?: Array<SubscriptionScheduleCreateParams.PauseSchedule>;
|
|
661
1163
|
/**
|
|
662
1164
|
* 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.
|
|
663
1165
|
*/
|
|
664
1166
|
phases?: Array<SubscriptionScheduleCreateParams.Phase>;
|
|
1167
|
+
/**
|
|
1168
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1169
|
+
*/
|
|
1170
|
+
prebilling?: SubscriptionScheduleCreateParams.Prebilling;
|
|
665
1171
|
/**
|
|
666
1172
|
* When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately, and to avoid unexpected behavior due to request delays or clock skew resulting in a slightly backdated or postdated start. 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.
|
|
667
1173
|
*/
|
|
668
1174
|
start_date?: number | 'now';
|
|
669
1175
|
}
|
|
670
1176
|
export declare namespace SubscriptionScheduleCreateParams {
|
|
1177
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front' | OtherString;
|
|
671
1178
|
interface BillingMode {
|
|
672
1179
|
/**
|
|
673
1180
|
* Configure behavior for flexible billing mode.
|
|
@@ -678,6 +1185,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
678
1185
|
*/
|
|
679
1186
|
type: BillingMode.Type;
|
|
680
1187
|
}
|
|
1188
|
+
interface BillingSchedule {
|
|
1189
|
+
/**
|
|
1190
|
+
* Configure billing schedule differently for individual subscription items.
|
|
1191
|
+
*/
|
|
1192
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1193
|
+
/**
|
|
1194
|
+
* The end date for the billing schedule.
|
|
1195
|
+
*/
|
|
1196
|
+
bill_until: BillingSchedule.BillUntil;
|
|
1197
|
+
/**
|
|
1198
|
+
* 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.
|
|
1199
|
+
*/
|
|
1200
|
+
key?: string;
|
|
1201
|
+
}
|
|
681
1202
|
interface DefaultSettings {
|
|
682
1203
|
/**
|
|
683
1204
|
* 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).
|
|
@@ -715,12 +1236,30 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
715
1236
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
716
1237
|
*/
|
|
717
1238
|
on_behalf_of?: Emptyable<string>;
|
|
1239
|
+
/**
|
|
1240
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1241
|
+
*/
|
|
1242
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
718
1243
|
/**
|
|
719
1244
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
720
1245
|
*/
|
|
721
1246
|
transfer_data?: Emptyable<DefaultSettings.TransferData>;
|
|
722
1247
|
}
|
|
723
1248
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew' | OtherString;
|
|
1249
|
+
interface PauseSchedule {
|
|
1250
|
+
/**
|
|
1251
|
+
* A unique identifier for this pause schedule entry.
|
|
1252
|
+
*/
|
|
1253
|
+
key?: string;
|
|
1254
|
+
/**
|
|
1255
|
+
* Configuration for when and how the subscription pauses.
|
|
1256
|
+
*/
|
|
1257
|
+
pause?: PauseSchedule.Pause;
|
|
1258
|
+
/**
|
|
1259
|
+
* Configuration for when and how the subscription resumes.
|
|
1260
|
+
*/
|
|
1261
|
+
resume?: PauseSchedule.Resume;
|
|
1262
|
+
}
|
|
724
1263
|
interface Phase {
|
|
725
1264
|
/**
|
|
726
1265
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
|
@@ -770,6 +1309,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
770
1309
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
771
1310
|
*/
|
|
772
1311
|
duration?: Phase.Duration;
|
|
1312
|
+
/**
|
|
1313
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1314
|
+
*/
|
|
1315
|
+
effective_at?: Phase.EffectiveAt;
|
|
773
1316
|
/**
|
|
774
1317
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
775
1318
|
*/
|
|
@@ -790,6 +1333,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
790
1333
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
791
1334
|
*/
|
|
792
1335
|
on_behalf_of?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* 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).
|
|
1338
|
+
*/
|
|
1339
|
+
pause_collection?: Phase.PauseCollection;
|
|
793
1340
|
/**
|
|
794
1341
|
* 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.
|
|
795
1342
|
*/
|
|
@@ -802,10 +1349,28 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
802
1349
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
803
1350
|
*/
|
|
804
1351
|
trial?: boolean;
|
|
1352
|
+
/**
|
|
1353
|
+
* Specify trial behavior when crossing phase boundaries
|
|
1354
|
+
*/
|
|
1355
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
805
1356
|
/**
|
|
806
1357
|
* 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`
|
|
807
1358
|
*/
|
|
808
1359
|
trial_end?: number;
|
|
1360
|
+
/**
|
|
1361
|
+
* Settings related to subscription trials.
|
|
1362
|
+
*/
|
|
1363
|
+
trial_settings?: Phase.TrialSettings;
|
|
1364
|
+
}
|
|
1365
|
+
interface Prebilling {
|
|
1366
|
+
/**
|
|
1367
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
1368
|
+
*/
|
|
1369
|
+
iterations: number;
|
|
1370
|
+
/**
|
|
1371
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1372
|
+
*/
|
|
1373
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
809
1374
|
}
|
|
810
1375
|
namespace BillingMode {
|
|
811
1376
|
interface Flexible {
|
|
@@ -816,7 +1381,49 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
816
1381
|
}
|
|
817
1382
|
type Type = 'classic' | 'flexible' | OtherString;
|
|
818
1383
|
namespace Flexible {
|
|
819
|
-
type ProrationDiscounts = 'included' | 'itemized';
|
|
1384
|
+
type ProrationDiscounts = 'included' | 'itemized' | OtherString;
|
|
1385
|
+
}
|
|
1386
|
+
}
|
|
1387
|
+
namespace BillingSchedule {
|
|
1388
|
+
interface AppliesTo {
|
|
1389
|
+
/**
|
|
1390
|
+
* The ID of the price object.
|
|
1391
|
+
*/
|
|
1392
|
+
price?: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* Controls which subscription items the billing schedule applies to.
|
|
1395
|
+
*/
|
|
1396
|
+
type: 'price';
|
|
1397
|
+
}
|
|
1398
|
+
interface BillUntil {
|
|
1399
|
+
/**
|
|
1400
|
+
* Specifies the billing period.
|
|
1401
|
+
*/
|
|
1402
|
+
duration?: BillUntil.Duration;
|
|
1403
|
+
/**
|
|
1404
|
+
* The end date of the billing schedule.
|
|
1405
|
+
*/
|
|
1406
|
+
timestamp?: number;
|
|
1407
|
+
/**
|
|
1408
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1409
|
+
*/
|
|
1410
|
+
type: BillUntil.Type;
|
|
1411
|
+
}
|
|
1412
|
+
namespace BillUntil {
|
|
1413
|
+
interface Duration {
|
|
1414
|
+
/**
|
|
1415
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1416
|
+
*/
|
|
1417
|
+
interval: Duration.Interval;
|
|
1418
|
+
/**
|
|
1419
|
+
* The multiplier applied to the interval.
|
|
1420
|
+
*/
|
|
1421
|
+
interval_count?: number;
|
|
1422
|
+
}
|
|
1423
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
1424
|
+
namespace Duration {
|
|
1425
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1426
|
+
}
|
|
820
1427
|
}
|
|
821
1428
|
}
|
|
822
1429
|
namespace DefaultSettings {
|
|
@@ -830,7 +1437,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
830
1437
|
*/
|
|
831
1438
|
liability?: AutomaticTax.Liability;
|
|
832
1439
|
}
|
|
833
|
-
type BillingCycleAnchor = 'automatic' | 'phase_start';
|
|
1440
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
834
1441
|
interface BillingThresholds {
|
|
835
1442
|
/**
|
|
836
1443
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -841,7 +1448,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
841
1448
|
*/
|
|
842
1449
|
reset_billing_cycle_anchor?: boolean;
|
|
843
1450
|
}
|
|
844
|
-
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
1451
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
|
|
845
1452
|
interface InvoiceSettings {
|
|
846
1453
|
/**
|
|
847
1454
|
* The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
|
@@ -859,6 +1466,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
859
1466
|
*/
|
|
860
1467
|
issuer?: InvoiceSettings.Issuer;
|
|
861
1468
|
}
|
|
1469
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
862
1470
|
interface TransferData {
|
|
863
1471
|
/**
|
|
864
1472
|
* 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.
|
|
@@ -881,7 +1489,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
881
1489
|
type: Liability.Type;
|
|
882
1490
|
}
|
|
883
1491
|
namespace Liability {
|
|
884
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1492
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
885
1493
|
}
|
|
886
1494
|
}
|
|
887
1495
|
namespace InvoiceSettings {
|
|
@@ -906,22 +1514,157 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
906
1514
|
type: Issuer.Type;
|
|
907
1515
|
}
|
|
908
1516
|
namespace Issuer {
|
|
909
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1517
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
910
1518
|
}
|
|
911
1519
|
}
|
|
912
1520
|
}
|
|
913
|
-
namespace
|
|
914
|
-
interface
|
|
1521
|
+
namespace PauseSchedule {
|
|
1522
|
+
interface Pause {
|
|
915
1523
|
/**
|
|
916
|
-
*
|
|
1524
|
+
* When to pause the subscription.
|
|
917
1525
|
*/
|
|
918
|
-
|
|
1526
|
+
pause_at: Pause.PauseAt;
|
|
919
1527
|
/**
|
|
920
|
-
*
|
|
1528
|
+
* Settings controlling billing behavior during the pause.
|
|
921
1529
|
*/
|
|
922
|
-
|
|
1530
|
+
settings?: Pause.Settings;
|
|
1531
|
+
}
|
|
1532
|
+
interface Resume {
|
|
923
1533
|
/**
|
|
924
|
-
*
|
|
1534
|
+
* When to resume the subscription.
|
|
1535
|
+
*/
|
|
1536
|
+
resume_at: Resume.ResumeAt;
|
|
1537
|
+
/**
|
|
1538
|
+
* Settings controlling how the subscription resumes.
|
|
1539
|
+
*/
|
|
1540
|
+
settings?: Resume.Settings;
|
|
1541
|
+
}
|
|
1542
|
+
namespace Pause {
|
|
1543
|
+
interface PauseAt {
|
|
1544
|
+
/**
|
|
1545
|
+
* The Unix timestamp at which to pause the subscription. Required when `type` is `timestamp`.
|
|
1546
|
+
*/
|
|
1547
|
+
timestamp?: number;
|
|
1548
|
+
/**
|
|
1549
|
+
* When to pause the subscription. Use `now` to pause immediately or `timestamp` to pause at a specific time.
|
|
1550
|
+
*/
|
|
1551
|
+
type: PauseAt.Type;
|
|
1552
|
+
}
|
|
1553
|
+
interface Settings {
|
|
1554
|
+
/**
|
|
1555
|
+
* Controls what to bill for when pausing the subscription.
|
|
1556
|
+
*/
|
|
1557
|
+
bill_for?: Settings.BillFor;
|
|
1558
|
+
/**
|
|
1559
|
+
* Determines whether to generate an invoice for outstanding amounts when pausing.
|
|
1560
|
+
*/
|
|
1561
|
+
invoicing_behavior?: Settings.InvoicingBehavior;
|
|
1562
|
+
/**
|
|
1563
|
+
* The pause type. Currently only `subscription` is supported.
|
|
1564
|
+
*/
|
|
1565
|
+
type?: 'subscription';
|
|
1566
|
+
}
|
|
1567
|
+
namespace PauseAt {
|
|
1568
|
+
type Type = 'now' | 'timestamp' | OtherString;
|
|
1569
|
+
}
|
|
1570
|
+
namespace Settings {
|
|
1571
|
+
interface BillFor {
|
|
1572
|
+
/**
|
|
1573
|
+
* Controls whether to collect metered usage accrued up to the pause date.
|
|
1574
|
+
*/
|
|
1575
|
+
outstanding_usage_through?: BillFor.OutstandingUsageThrough;
|
|
1576
|
+
/**
|
|
1577
|
+
* Controls how unused time on subscription items is credited when pausing.
|
|
1578
|
+
*/
|
|
1579
|
+
unused_time_from?: BillFor.UnusedTimeFrom;
|
|
1580
|
+
}
|
|
1581
|
+
type InvoicingBehavior = 'invoice' | 'pending_invoice_item' | OtherString;
|
|
1582
|
+
namespace BillFor {
|
|
1583
|
+
interface OutstandingUsageThrough {
|
|
1584
|
+
/**
|
|
1585
|
+
* Determines whether to collect metered usage accrued up to the pause date.
|
|
1586
|
+
*/
|
|
1587
|
+
type?: OutstandingUsageThrough.Type;
|
|
1588
|
+
}
|
|
1589
|
+
interface UnusedTimeFrom {
|
|
1590
|
+
/**
|
|
1591
|
+
* Determines which point in the billing period unused time is credited from.
|
|
1592
|
+
*/
|
|
1593
|
+
type?: UnusedTimeFrom.Type;
|
|
1594
|
+
}
|
|
1595
|
+
namespace OutstandingUsageThrough {
|
|
1596
|
+
type Type = 'none' | 'pause_at' | OtherString;
|
|
1597
|
+
}
|
|
1598
|
+
namespace UnusedTimeFrom {
|
|
1599
|
+
type Type = 'item_current_period_start' | 'none' | 'pause_at' | OtherString;
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1602
|
+
}
|
|
1603
|
+
}
|
|
1604
|
+
namespace Resume {
|
|
1605
|
+
interface ResumeAt {
|
|
1606
|
+
/**
|
|
1607
|
+
* The duration after which to resume the subscription. Required when `type` is `duration`.
|
|
1608
|
+
*/
|
|
1609
|
+
duration?: ResumeAt.Duration;
|
|
1610
|
+
/**
|
|
1611
|
+
* The Unix timestamp at which to resume the subscription. Required when `type` is `timestamp`.
|
|
1612
|
+
*/
|
|
1613
|
+
timestamp?: number;
|
|
1614
|
+
/**
|
|
1615
|
+
* When to resume the subscription. Use `now` to resume immediately, `duration` to resume after a set duration, or `timestamp` to resume at a specific time.
|
|
1616
|
+
*/
|
|
1617
|
+
type: ResumeAt.Type;
|
|
1618
|
+
}
|
|
1619
|
+
interface Settings {
|
|
1620
|
+
/**
|
|
1621
|
+
* Controls the billing cycle anchor when the subscription resumes.
|
|
1622
|
+
*/
|
|
1623
|
+
billing_cycle_anchor?: Settings.BillingCycleAnchor;
|
|
1624
|
+
/**
|
|
1625
|
+
* Controls whether Stripe attempts payment on the resumption invoice and how payment affects the subscription's status. The default is `resume_on_payment_success`.
|
|
1626
|
+
*/
|
|
1627
|
+
payment_behavior?: Settings.PaymentBehavior;
|
|
1628
|
+
/**
|
|
1629
|
+
* Determines how to handle prorations when the subscription resumes. The default is `create_prorations`.
|
|
1630
|
+
*/
|
|
1631
|
+
proration_behavior?: Settings.ProrationBehavior;
|
|
1632
|
+
}
|
|
1633
|
+
namespace ResumeAt {
|
|
1634
|
+
interface Duration {
|
|
1635
|
+
/**
|
|
1636
|
+
* The time unit for the resume duration. One of `day`, `week`, `month`, or `year`.
|
|
1637
|
+
*/
|
|
1638
|
+
interval: Duration.Interval;
|
|
1639
|
+
/**
|
|
1640
|
+
* The number of intervals after which the subscription resumes.
|
|
1641
|
+
*/
|
|
1642
|
+
interval_count?: number;
|
|
1643
|
+
}
|
|
1644
|
+
type Type = 'duration' | 'now' | 'timestamp' | OtherString;
|
|
1645
|
+
namespace Duration {
|
|
1646
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1647
|
+
}
|
|
1648
|
+
}
|
|
1649
|
+
namespace Settings {
|
|
1650
|
+
type BillingCycleAnchor = 'resume_at' | 'unchanged' | OtherString;
|
|
1651
|
+
type PaymentBehavior = 'resume_on_payment_attempt' | 'resume_on_payment_success' | OtherString;
|
|
1652
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
1653
|
+
}
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
namespace Phase {
|
|
1657
|
+
interface AddInvoiceItem {
|
|
1658
|
+
/**
|
|
1659
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
1660
|
+
*/
|
|
1661
|
+
discountable?: boolean;
|
|
1662
|
+
/**
|
|
1663
|
+
* The coupons to redeem into discounts for the item.
|
|
1664
|
+
*/
|
|
1665
|
+
discounts?: Array<AddInvoiceItem.Discount>;
|
|
1666
|
+
/**
|
|
1667
|
+
* 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`.
|
|
925
1668
|
*/
|
|
926
1669
|
metadata?: MetadataParam;
|
|
927
1670
|
/**
|
|
@@ -955,7 +1698,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
955
1698
|
*/
|
|
956
1699
|
liability?: AutomaticTax.Liability;
|
|
957
1700
|
}
|
|
958
|
-
type BillingCycleAnchor = 'automatic' | 'phase_start';
|
|
1701
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
959
1702
|
interface BillingThresholds {
|
|
960
1703
|
/**
|
|
961
1704
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -966,7 +1709,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
966
1709
|
*/
|
|
967
1710
|
reset_billing_cycle_anchor?: boolean;
|
|
968
1711
|
}
|
|
969
|
-
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
1712
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
|
|
970
1713
|
interface Discount {
|
|
971
1714
|
/**
|
|
972
1715
|
* ID of the coupon to create a new discount for.
|
|
@@ -976,10 +1719,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
976
1719
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
977
1720
|
*/
|
|
978
1721
|
discount?: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* Details to determine how long the discount should be applied for.
|
|
1724
|
+
*/
|
|
1725
|
+
discount_end?: Discount.DiscountEnd;
|
|
979
1726
|
/**
|
|
980
1727
|
* ID of the promotion code to create a new discount for.
|
|
981
1728
|
*/
|
|
982
1729
|
promotion_code?: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* Settings for discount application including service period anchoring.
|
|
1732
|
+
*/
|
|
1733
|
+
settings?: Discount.Settings;
|
|
983
1734
|
}
|
|
984
1735
|
interface Duration {
|
|
985
1736
|
/**
|
|
@@ -991,6 +1742,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
991
1742
|
*/
|
|
992
1743
|
interval_count?: number;
|
|
993
1744
|
}
|
|
1745
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
994
1746
|
interface InvoiceSettings {
|
|
995
1747
|
/**
|
|
996
1748
|
* 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.
|
|
@@ -1050,6 +1802,20 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1050
1802
|
* 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.
|
|
1051
1803
|
*/
|
|
1052
1804
|
tax_rates?: Emptyable<Array<string>>;
|
|
1805
|
+
/**
|
|
1806
|
+
* Options that configure the trial on the subscription item.
|
|
1807
|
+
*/
|
|
1808
|
+
trial?: Item.Trial;
|
|
1809
|
+
/**
|
|
1810
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
1811
|
+
*/
|
|
1812
|
+
trial_offer?: string;
|
|
1813
|
+
}
|
|
1814
|
+
interface PauseCollection {
|
|
1815
|
+
/**
|
|
1816
|
+
* The payment collection behavior for this subscription while paused.
|
|
1817
|
+
*/
|
|
1818
|
+
behavior: PauseCollection.Behavior;
|
|
1053
1819
|
}
|
|
1054
1820
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
1055
1821
|
interface TransferData {
|
|
@@ -1062,6 +1828,13 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1062
1828
|
*/
|
|
1063
1829
|
destination: string;
|
|
1064
1830
|
}
|
|
1831
|
+
type TrialContinuation = 'continue' | 'none' | OtherString;
|
|
1832
|
+
interface TrialSettings {
|
|
1833
|
+
/**
|
|
1834
|
+
* Defines how the subscription should behave when a trial ends.
|
|
1835
|
+
*/
|
|
1836
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
1837
|
+
}
|
|
1065
1838
|
namespace AddInvoiceItem {
|
|
1066
1839
|
interface Discount {
|
|
1067
1840
|
/**
|
|
@@ -1072,6 +1845,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1072
1845
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1073
1846
|
*/
|
|
1074
1847
|
discount?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* Details to determine how long the discount should be applied for.
|
|
1850
|
+
*/
|
|
1851
|
+
discount_end?: Discount.DiscountEnd;
|
|
1075
1852
|
/**
|
|
1076
1853
|
* ID of the promotion code to create a new discount for.
|
|
1077
1854
|
*/
|
|
@@ -1109,6 +1886,38 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1109
1886
|
*/
|
|
1110
1887
|
unit_amount_decimal?: Decimal;
|
|
1111
1888
|
}
|
|
1889
|
+
namespace Discount {
|
|
1890
|
+
interface DiscountEnd {
|
|
1891
|
+
/**
|
|
1892
|
+
* Time span for the redeemed discount.
|
|
1893
|
+
*/
|
|
1894
|
+
duration?: DiscountEnd.Duration;
|
|
1895
|
+
/**
|
|
1896
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1897
|
+
*/
|
|
1898
|
+
timestamp?: number;
|
|
1899
|
+
/**
|
|
1900
|
+
* The type of calculation made to determine when the discount ends.
|
|
1901
|
+
*/
|
|
1902
|
+
type: DiscountEnd.Type;
|
|
1903
|
+
}
|
|
1904
|
+
namespace DiscountEnd {
|
|
1905
|
+
interface Duration {
|
|
1906
|
+
/**
|
|
1907
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1908
|
+
*/
|
|
1909
|
+
interval: Duration.Interval;
|
|
1910
|
+
/**
|
|
1911
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1912
|
+
*/
|
|
1913
|
+
interval_count: number;
|
|
1914
|
+
}
|
|
1915
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
1916
|
+
namespace Duration {
|
|
1917
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1918
|
+
}
|
|
1919
|
+
}
|
|
1920
|
+
}
|
|
1112
1921
|
namespace Period {
|
|
1113
1922
|
interface End {
|
|
1114
1923
|
/**
|
|
@@ -1138,7 +1947,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1138
1947
|
}
|
|
1139
1948
|
}
|
|
1140
1949
|
namespace PriceData {
|
|
1141
|
-
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
1950
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
|
|
1142
1951
|
}
|
|
1143
1952
|
}
|
|
1144
1953
|
namespace AutomaticTax {
|
|
@@ -1153,11 +1962,91 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1153
1962
|
type: Liability.Type;
|
|
1154
1963
|
}
|
|
1155
1964
|
namespace Liability {
|
|
1156
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1965
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1966
|
+
}
|
|
1967
|
+
}
|
|
1968
|
+
namespace Discount {
|
|
1969
|
+
interface DiscountEnd {
|
|
1970
|
+
/**
|
|
1971
|
+
* Time span for the redeemed discount.
|
|
1972
|
+
*/
|
|
1973
|
+
duration?: DiscountEnd.Duration;
|
|
1974
|
+
/**
|
|
1975
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1976
|
+
*/
|
|
1977
|
+
timestamp?: number;
|
|
1978
|
+
/**
|
|
1979
|
+
* The type of calculation made to determine when the discount ends.
|
|
1980
|
+
*/
|
|
1981
|
+
type: DiscountEnd.Type;
|
|
1982
|
+
}
|
|
1983
|
+
interface Settings {
|
|
1984
|
+
/**
|
|
1985
|
+
* Configures service period cycle anchoring.
|
|
1986
|
+
*/
|
|
1987
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1988
|
+
/**
|
|
1989
|
+
* 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.
|
|
1990
|
+
*/
|
|
1991
|
+
start_date?: Settings.StartDate;
|
|
1992
|
+
}
|
|
1993
|
+
namespace DiscountEnd {
|
|
1994
|
+
interface Duration {
|
|
1995
|
+
/**
|
|
1996
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1997
|
+
*/
|
|
1998
|
+
interval: Duration.Interval;
|
|
1999
|
+
/**
|
|
2000
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2001
|
+
*/
|
|
2002
|
+
interval_count: number;
|
|
2003
|
+
}
|
|
2004
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2005
|
+
namespace Duration {
|
|
2006
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2007
|
+
}
|
|
2008
|
+
}
|
|
2009
|
+
namespace Settings {
|
|
2010
|
+
interface ServicePeriodAnchorConfig {
|
|
2011
|
+
/**
|
|
2012
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2013
|
+
*/
|
|
2014
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2015
|
+
/**
|
|
2016
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2017
|
+
*/
|
|
2018
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2019
|
+
}
|
|
2020
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
2021
|
+
namespace ServicePeriodAnchorConfig {
|
|
2022
|
+
interface Custom {
|
|
2023
|
+
/**
|
|
2024
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2025
|
+
*/
|
|
2026
|
+
day_of_month: number;
|
|
2027
|
+
/**
|
|
2028
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2029
|
+
*/
|
|
2030
|
+
hour?: number;
|
|
2031
|
+
/**
|
|
2032
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2033
|
+
*/
|
|
2034
|
+
minute?: number;
|
|
2035
|
+
/**
|
|
2036
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2037
|
+
*/
|
|
2038
|
+
month?: number;
|
|
2039
|
+
/**
|
|
2040
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2041
|
+
*/
|
|
2042
|
+
second?: number;
|
|
2043
|
+
}
|
|
2044
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2045
|
+
}
|
|
1157
2046
|
}
|
|
1158
2047
|
}
|
|
1159
2048
|
namespace Duration {
|
|
1160
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2049
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1161
2050
|
}
|
|
1162
2051
|
namespace InvoiceSettings {
|
|
1163
2052
|
interface CustomField {
|
|
@@ -1181,7 +2070,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1181
2070
|
type: Issuer.Type;
|
|
1182
2071
|
}
|
|
1183
2072
|
namespace Issuer {
|
|
1184
|
-
type Type = 'account' | 'self' | OtherString;
|
|
2073
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1185
2074
|
}
|
|
1186
2075
|
}
|
|
1187
2076
|
namespace Item {
|
|
@@ -1200,10 +2089,18 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1200
2089
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1201
2090
|
*/
|
|
1202
2091
|
discount?: string;
|
|
2092
|
+
/**
|
|
2093
|
+
* Details to determine how long the discount should be applied for.
|
|
2094
|
+
*/
|
|
2095
|
+
discount_end?: Discount.DiscountEnd;
|
|
1203
2096
|
/**
|
|
1204
2097
|
* ID of the promotion code to create a new discount for.
|
|
1205
2098
|
*/
|
|
1206
2099
|
promotion_code?: string;
|
|
2100
|
+
/**
|
|
2101
|
+
* Settings for discount application including service period anchoring.
|
|
2102
|
+
*/
|
|
2103
|
+
settings?: Discount.Settings;
|
|
1207
2104
|
}
|
|
1208
2105
|
interface PriceData {
|
|
1209
2106
|
/**
|
|
@@ -1231,6 +2128,96 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1231
2128
|
*/
|
|
1232
2129
|
unit_amount_decimal?: Decimal;
|
|
1233
2130
|
}
|
|
2131
|
+
interface Trial {
|
|
2132
|
+
/**
|
|
2133
|
+
* 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.
|
|
2134
|
+
*/
|
|
2135
|
+
converts_to?: Array<string>;
|
|
2136
|
+
/**
|
|
2137
|
+
* Determines the type of trial for this item.
|
|
2138
|
+
*/
|
|
2139
|
+
type: Trial.Type;
|
|
2140
|
+
}
|
|
2141
|
+
namespace Discount {
|
|
2142
|
+
interface DiscountEnd {
|
|
2143
|
+
/**
|
|
2144
|
+
* Time span for the redeemed discount.
|
|
2145
|
+
*/
|
|
2146
|
+
duration?: DiscountEnd.Duration;
|
|
2147
|
+
/**
|
|
2148
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2149
|
+
*/
|
|
2150
|
+
timestamp?: number;
|
|
2151
|
+
/**
|
|
2152
|
+
* The type of calculation made to determine when the discount ends.
|
|
2153
|
+
*/
|
|
2154
|
+
type: DiscountEnd.Type;
|
|
2155
|
+
}
|
|
2156
|
+
interface Settings {
|
|
2157
|
+
/**
|
|
2158
|
+
* Configures service period cycle anchoring.
|
|
2159
|
+
*/
|
|
2160
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2161
|
+
/**
|
|
2162
|
+
* 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.
|
|
2163
|
+
*/
|
|
2164
|
+
start_date?: Settings.StartDate;
|
|
2165
|
+
}
|
|
2166
|
+
namespace DiscountEnd {
|
|
2167
|
+
interface Duration {
|
|
2168
|
+
/**
|
|
2169
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2170
|
+
*/
|
|
2171
|
+
interval: Duration.Interval;
|
|
2172
|
+
/**
|
|
2173
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2174
|
+
*/
|
|
2175
|
+
interval_count: number;
|
|
2176
|
+
}
|
|
2177
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2178
|
+
namespace Duration {
|
|
2179
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2180
|
+
}
|
|
2181
|
+
}
|
|
2182
|
+
namespace Settings {
|
|
2183
|
+
interface ServicePeriodAnchorConfig {
|
|
2184
|
+
/**
|
|
2185
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2186
|
+
*/
|
|
2187
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2188
|
+
/**
|
|
2189
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2190
|
+
*/
|
|
2191
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2192
|
+
}
|
|
2193
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
2194
|
+
namespace ServicePeriodAnchorConfig {
|
|
2195
|
+
interface Custom {
|
|
2196
|
+
/**
|
|
2197
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2198
|
+
*/
|
|
2199
|
+
day_of_month: number;
|
|
2200
|
+
/**
|
|
2201
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2202
|
+
*/
|
|
2203
|
+
hour?: number;
|
|
2204
|
+
/**
|
|
2205
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2206
|
+
*/
|
|
2207
|
+
minute?: number;
|
|
2208
|
+
/**
|
|
2209
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2210
|
+
*/
|
|
2211
|
+
month?: number;
|
|
2212
|
+
/**
|
|
2213
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2214
|
+
*/
|
|
2215
|
+
second?: number;
|
|
2216
|
+
}
|
|
2217
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2218
|
+
}
|
|
2219
|
+
}
|
|
2220
|
+
}
|
|
1234
2221
|
namespace PriceData {
|
|
1235
2222
|
interface Recurring {
|
|
1236
2223
|
/**
|
|
@@ -1242,13 +2229,33 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1242
2229
|
*/
|
|
1243
2230
|
interval_count?: number;
|
|
1244
2231
|
}
|
|
1245
|
-
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
2232
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
|
|
1246
2233
|
namespace Recurring {
|
|
1247
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2234
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1248
2235
|
}
|
|
1249
2236
|
}
|
|
2237
|
+
namespace Trial {
|
|
2238
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
2239
|
+
}
|
|
2240
|
+
}
|
|
2241
|
+
namespace PauseCollection {
|
|
2242
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
2243
|
+
}
|
|
2244
|
+
namespace TrialSettings {
|
|
2245
|
+
interface EndBehavior {
|
|
2246
|
+
/**
|
|
2247
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2248
|
+
*/
|
|
2249
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2250
|
+
}
|
|
2251
|
+
namespace EndBehavior {
|
|
2252
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
2253
|
+
}
|
|
1250
2254
|
}
|
|
1251
2255
|
}
|
|
2256
|
+
namespace Prebilling {
|
|
2257
|
+
type UpdateBehavior = 'prebill' | 'reset' | OtherString;
|
|
2258
|
+
}
|
|
1252
2259
|
}
|
|
1253
2260
|
export interface SubscriptionScheduleRetrieveParams {
|
|
1254
2261
|
/**
|
|
@@ -1257,6 +2264,14 @@ export interface SubscriptionScheduleRetrieveParams {
|
|
|
1257
2264
|
expand?: Array<string>;
|
|
1258
2265
|
}
|
|
1259
2266
|
export interface SubscriptionScheduleUpdateParams {
|
|
2267
|
+
/**
|
|
2268
|
+
* 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.
|
|
2269
|
+
*/
|
|
2270
|
+
billing_behavior?: SubscriptionScheduleUpdateParams.BillingBehavior;
|
|
2271
|
+
/**
|
|
2272
|
+
* Sets the billing schedules for the subscription schedule.
|
|
2273
|
+
*/
|
|
2274
|
+
billing_schedules?: Emptyable<Array<SubscriptionScheduleUpdateParams.BillingSchedule>>;
|
|
1260
2275
|
/**
|
|
1261
2276
|
* Object representing the subscription schedule's default settings.
|
|
1262
2277
|
*/
|
|
@@ -1273,16 +2288,39 @@ export interface SubscriptionScheduleUpdateParams {
|
|
|
1273
2288
|
* 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`.
|
|
1274
2289
|
*/
|
|
1275
2290
|
metadata?: Emptyable<MetadataParam>;
|
|
2291
|
+
/**
|
|
2292
|
+
* Configures the subscription's pause behavior and, optionally, its resume behavior. Only one entry is supported. Include a key to update an existing entry. Omit to leave an existing pause schedule unchanged, or pass "" to clear it.
|
|
2293
|
+
*/
|
|
2294
|
+
pause_schedules?: Emptyable<Array<SubscriptionScheduleUpdateParams.PauseSchedule>>;
|
|
1276
2295
|
/**
|
|
1277
2296
|
* 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.
|
|
1278
2297
|
*/
|
|
1279
2298
|
phases?: Array<SubscriptionScheduleUpdateParams.Phase>;
|
|
2299
|
+
/**
|
|
2300
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
2301
|
+
*/
|
|
2302
|
+
prebilling?: SubscriptionScheduleUpdateParams.Prebilling;
|
|
1280
2303
|
/**
|
|
1281
2304
|
* 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`.
|
|
1282
2305
|
*/
|
|
1283
2306
|
proration_behavior?: SubscriptionScheduleUpdateParams.ProrationBehavior;
|
|
1284
2307
|
}
|
|
1285
2308
|
export declare namespace SubscriptionScheduleUpdateParams {
|
|
2309
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front' | OtherString;
|
|
2310
|
+
interface BillingSchedule {
|
|
2311
|
+
/**
|
|
2312
|
+
* Configure billing schedule differently for individual subscription items.
|
|
2313
|
+
*/
|
|
2314
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
2315
|
+
/**
|
|
2316
|
+
* The end date for the billing schedule.
|
|
2317
|
+
*/
|
|
2318
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
2319
|
+
/**
|
|
2320
|
+
* 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.
|
|
2321
|
+
*/
|
|
2322
|
+
key?: string;
|
|
2323
|
+
}
|
|
1286
2324
|
interface DefaultSettings {
|
|
1287
2325
|
/**
|
|
1288
2326
|
* 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).
|
|
@@ -1320,12 +2358,30 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1320
2358
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1321
2359
|
*/
|
|
1322
2360
|
on_behalf_of?: Emptyable<string>;
|
|
2361
|
+
/**
|
|
2362
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2363
|
+
*/
|
|
2364
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
1323
2365
|
/**
|
|
1324
2366
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
1325
2367
|
*/
|
|
1326
2368
|
transfer_data?: Emptyable<DefaultSettings.TransferData>;
|
|
1327
2369
|
}
|
|
1328
2370
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew' | OtherString;
|
|
2371
|
+
interface PauseSchedule {
|
|
2372
|
+
/**
|
|
2373
|
+
* A unique identifier for this pause schedule entry.
|
|
2374
|
+
*/
|
|
2375
|
+
key?: string;
|
|
2376
|
+
/**
|
|
2377
|
+
* Configuration for when and how the subscription pauses.
|
|
2378
|
+
*/
|
|
2379
|
+
pause?: PauseSchedule.Pause;
|
|
2380
|
+
/**
|
|
2381
|
+
* Configuration for when and how the subscription resumes.
|
|
2382
|
+
*/
|
|
2383
|
+
resume?: Emptyable<PauseSchedule.Resume>;
|
|
2384
|
+
}
|
|
1329
2385
|
interface Phase {
|
|
1330
2386
|
/**
|
|
1331
2387
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
|
@@ -1375,6 +2431,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1375
2431
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
1376
2432
|
*/
|
|
1377
2433
|
duration?: Phase.Duration;
|
|
2434
|
+
/**
|
|
2435
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2436
|
+
*/
|
|
2437
|
+
effective_at?: Phase.EffectiveAt;
|
|
1378
2438
|
/**
|
|
1379
2439
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
1380
2440
|
*/
|
|
@@ -1395,6 +2455,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1395
2455
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1396
2456
|
*/
|
|
1397
2457
|
on_behalf_of?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* 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).
|
|
2460
|
+
*/
|
|
2461
|
+
pause_collection?: Phase.PauseCollection;
|
|
1398
2462
|
/**
|
|
1399
2463
|
* 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.
|
|
1400
2464
|
*/
|
|
@@ -1411,12 +2475,72 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1411
2475
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1412
2476
|
*/
|
|
1413
2477
|
trial?: boolean;
|
|
2478
|
+
/**
|
|
2479
|
+
* Specify trial behavior when crossing phase boundaries
|
|
2480
|
+
*/
|
|
2481
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
1414
2482
|
/**
|
|
1415
2483
|
* Sets the phase to trialing from the start date to this date. Must be within the phase. When combined with `trial=true`, it must match the phase end date.
|
|
1416
2484
|
*/
|
|
1417
2485
|
trial_end?: number | 'now';
|
|
2486
|
+
/**
|
|
2487
|
+
* Settings related to subscription trials.
|
|
2488
|
+
*/
|
|
2489
|
+
trial_settings?: Phase.TrialSettings;
|
|
2490
|
+
}
|
|
2491
|
+
interface Prebilling {
|
|
2492
|
+
/**
|
|
2493
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
2494
|
+
*/
|
|
2495
|
+
iterations: number;
|
|
2496
|
+
/**
|
|
2497
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2498
|
+
*/
|
|
2499
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
1418
2500
|
}
|
|
1419
2501
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
2502
|
+
namespace BillingSchedule {
|
|
2503
|
+
interface AppliesTo {
|
|
2504
|
+
/**
|
|
2505
|
+
* The ID of the price object.
|
|
2506
|
+
*/
|
|
2507
|
+
price?: string;
|
|
2508
|
+
/**
|
|
2509
|
+
* Controls which subscription items the billing schedule applies to.
|
|
2510
|
+
*/
|
|
2511
|
+
type: 'price';
|
|
2512
|
+
}
|
|
2513
|
+
interface BillUntil {
|
|
2514
|
+
/**
|
|
2515
|
+
* Specifies the billing period.
|
|
2516
|
+
*/
|
|
2517
|
+
duration?: BillUntil.Duration;
|
|
2518
|
+
/**
|
|
2519
|
+
* The end date of the billing schedule.
|
|
2520
|
+
*/
|
|
2521
|
+
timestamp?: number;
|
|
2522
|
+
/**
|
|
2523
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
2524
|
+
*/
|
|
2525
|
+
type: BillUntil.Type;
|
|
2526
|
+
}
|
|
2527
|
+
namespace BillUntil {
|
|
2528
|
+
interface Duration {
|
|
2529
|
+
/**
|
|
2530
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
2531
|
+
*/
|
|
2532
|
+
interval: Duration.Interval;
|
|
2533
|
+
/**
|
|
2534
|
+
* The multiplier applied to the interval.
|
|
2535
|
+
*/
|
|
2536
|
+
interval_count?: number;
|
|
2537
|
+
}
|
|
2538
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2539
|
+
namespace Duration {
|
|
2540
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2541
|
+
}
|
|
2542
|
+
}
|
|
2543
|
+
}
|
|
1420
2544
|
namespace DefaultSettings {
|
|
1421
2545
|
interface AutomaticTax {
|
|
1422
2546
|
/**
|
|
@@ -1428,7 +2552,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1428
2552
|
*/
|
|
1429
2553
|
liability?: AutomaticTax.Liability;
|
|
1430
2554
|
}
|
|
1431
|
-
type BillingCycleAnchor = 'automatic' | 'phase_start';
|
|
2555
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
1432
2556
|
interface BillingThresholds {
|
|
1433
2557
|
/**
|
|
1434
2558
|
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
@@ -1439,7 +2563,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1439
2563
|
*/
|
|
1440
2564
|
reset_billing_cycle_anchor?: boolean;
|
|
1441
2565
|
}
|
|
1442
|
-
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
2566
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
|
|
1443
2567
|
interface InvoiceSettings {
|
|
1444
2568
|
/**
|
|
1445
2569
|
* The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
|
@@ -1457,6 +2581,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1457
2581
|
*/
|
|
1458
2582
|
issuer?: InvoiceSettings.Issuer;
|
|
1459
2583
|
}
|
|
2584
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
1460
2585
|
interface TransferData {
|
|
1461
2586
|
/**
|
|
1462
2587
|
* 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.
|
|
@@ -1479,7 +2604,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1479
2604
|
type: Liability.Type;
|
|
1480
2605
|
}
|
|
1481
2606
|
namespace Liability {
|
|
1482
|
-
type Type = 'account' | 'self' | OtherString;
|
|
2607
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1483
2608
|
}
|
|
1484
2609
|
}
|
|
1485
2610
|
namespace InvoiceSettings {
|
|
@@ -1504,69 +2629,204 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1504
2629
|
type: Issuer.Type;
|
|
1505
2630
|
}
|
|
1506
2631
|
namespace Issuer {
|
|
1507
|
-
type Type = 'account' | 'self' | OtherString;
|
|
2632
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1508
2633
|
}
|
|
1509
2634
|
}
|
|
1510
2635
|
}
|
|
1511
|
-
namespace
|
|
1512
|
-
interface
|
|
1513
|
-
/**
|
|
1514
|
-
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
1515
|
-
*/
|
|
1516
|
-
discountable?: boolean;
|
|
1517
|
-
/**
|
|
1518
|
-
* The coupons to redeem into discounts for the item.
|
|
1519
|
-
*/
|
|
1520
|
-
discounts?: Array<AddInvoiceItem.Discount>;
|
|
1521
|
-
/**
|
|
1522
|
-
* 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`.
|
|
1523
|
-
*/
|
|
1524
|
-
metadata?: MetadataParam;
|
|
1525
|
-
/**
|
|
1526
|
-
* The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
1527
|
-
*/
|
|
1528
|
-
period?: AddInvoiceItem.Period;
|
|
1529
|
-
/**
|
|
1530
|
-
* The ID of the price object. One of `price` or `price_data` is required.
|
|
1531
|
-
*/
|
|
1532
|
-
price?: string;
|
|
1533
|
-
/**
|
|
1534
|
-
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
1535
|
-
*/
|
|
1536
|
-
price_data?: AddInvoiceItem.PriceData;
|
|
1537
|
-
/**
|
|
1538
|
-
* Quantity for this item. Defaults to 1.
|
|
1539
|
-
*/
|
|
1540
|
-
quantity?: number;
|
|
1541
|
-
/**
|
|
1542
|
-
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
|
1543
|
-
*/
|
|
1544
|
-
tax_rates?: Emptyable<Array<string>>;
|
|
1545
|
-
}
|
|
1546
|
-
interface AutomaticTax {
|
|
2636
|
+
namespace PauseSchedule {
|
|
2637
|
+
interface Pause {
|
|
1547
2638
|
/**
|
|
1548
|
-
*
|
|
2639
|
+
* When to pause the subscription.
|
|
1549
2640
|
*/
|
|
1550
|
-
|
|
2641
|
+
pause_at?: Pause.PauseAt;
|
|
1551
2642
|
/**
|
|
1552
|
-
*
|
|
2643
|
+
* Settings controlling billing behavior during the pause.
|
|
1553
2644
|
*/
|
|
1554
|
-
|
|
2645
|
+
settings?: Pause.Settings;
|
|
1555
2646
|
}
|
|
1556
|
-
|
|
1557
|
-
interface BillingThresholds {
|
|
2647
|
+
interface Resume {
|
|
1558
2648
|
/**
|
|
1559
|
-
*
|
|
2649
|
+
* When to resume the subscription.
|
|
1560
2650
|
*/
|
|
1561
|
-
|
|
2651
|
+
resume_at?: Resume.ResumeAt;
|
|
1562
2652
|
/**
|
|
1563
|
-
*
|
|
2653
|
+
* Settings controlling how the subscription resumes.
|
|
1564
2654
|
*/
|
|
1565
|
-
|
|
2655
|
+
settings?: Resume.Settings;
|
|
1566
2656
|
}
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
2657
|
+
namespace Pause {
|
|
2658
|
+
interface PauseAt {
|
|
2659
|
+
/**
|
|
2660
|
+
* The Unix timestamp at which to pause the subscription. Required when `type` is `timestamp`.
|
|
2661
|
+
*/
|
|
2662
|
+
timestamp?: number;
|
|
2663
|
+
/**
|
|
2664
|
+
* When to pause the subscription. Use `now` to pause immediately or `timestamp` to pause at a specific time.
|
|
2665
|
+
*/
|
|
2666
|
+
type: PauseAt.Type;
|
|
2667
|
+
}
|
|
2668
|
+
interface Settings {
|
|
2669
|
+
/**
|
|
2670
|
+
* Controls what to bill for when pausing the subscription.
|
|
2671
|
+
*/
|
|
2672
|
+
bill_for?: Settings.BillFor;
|
|
2673
|
+
/**
|
|
2674
|
+
* Determines whether to generate an invoice for outstanding amounts when pausing.
|
|
2675
|
+
*/
|
|
2676
|
+
invoicing_behavior?: Settings.InvoicingBehavior;
|
|
2677
|
+
/**
|
|
2678
|
+
* The pause type. Currently only `subscription` is supported.
|
|
2679
|
+
*/
|
|
2680
|
+
type?: 'subscription';
|
|
2681
|
+
}
|
|
2682
|
+
namespace PauseAt {
|
|
2683
|
+
type Type = 'now' | 'timestamp' | OtherString;
|
|
2684
|
+
}
|
|
2685
|
+
namespace Settings {
|
|
2686
|
+
interface BillFor {
|
|
2687
|
+
/**
|
|
2688
|
+
* Controls whether to collect metered usage accrued up to the pause date.
|
|
2689
|
+
*/
|
|
2690
|
+
outstanding_usage_through?: BillFor.OutstandingUsageThrough;
|
|
2691
|
+
/**
|
|
2692
|
+
* Controls how unused time on subscription items is credited when pausing.
|
|
2693
|
+
*/
|
|
2694
|
+
unused_time_from?: BillFor.UnusedTimeFrom;
|
|
2695
|
+
}
|
|
2696
|
+
type InvoicingBehavior = 'invoice' | 'pending_invoice_item' | OtherString;
|
|
2697
|
+
namespace BillFor {
|
|
2698
|
+
interface OutstandingUsageThrough {
|
|
2699
|
+
/**
|
|
2700
|
+
* Determines whether to collect metered usage accrued up to the pause date.
|
|
2701
|
+
*/
|
|
2702
|
+
type?: OutstandingUsageThrough.Type;
|
|
2703
|
+
}
|
|
2704
|
+
interface UnusedTimeFrom {
|
|
2705
|
+
/**
|
|
2706
|
+
* Determines which point in the billing period unused time is credited from.
|
|
2707
|
+
*/
|
|
2708
|
+
type?: UnusedTimeFrom.Type;
|
|
2709
|
+
}
|
|
2710
|
+
namespace OutstandingUsageThrough {
|
|
2711
|
+
type Type = 'none' | 'pause_at' | OtherString;
|
|
2712
|
+
}
|
|
2713
|
+
namespace UnusedTimeFrom {
|
|
2714
|
+
type Type = 'item_current_period_start' | 'none' | 'pause_at' | OtherString;
|
|
2715
|
+
}
|
|
2716
|
+
}
|
|
2717
|
+
}
|
|
2718
|
+
}
|
|
2719
|
+
namespace Resume {
|
|
2720
|
+
interface ResumeAt {
|
|
2721
|
+
/**
|
|
2722
|
+
* The duration after which to resume the subscription. Required when `type` is `duration`.
|
|
2723
|
+
*/
|
|
2724
|
+
duration?: ResumeAt.Duration;
|
|
2725
|
+
/**
|
|
2726
|
+
* The Unix timestamp at which to resume the subscription. Required when `type` is `timestamp`.
|
|
2727
|
+
*/
|
|
2728
|
+
timestamp?: number;
|
|
2729
|
+
/**
|
|
2730
|
+
* When to resume the subscription. Use `now` to resume immediately, `duration` to resume after a set duration, or `timestamp` to resume at a specific time.
|
|
2731
|
+
*/
|
|
2732
|
+
type: ResumeAt.Type;
|
|
2733
|
+
}
|
|
2734
|
+
interface Settings {
|
|
2735
|
+
/**
|
|
2736
|
+
* Controls the billing cycle anchor when the subscription resumes.
|
|
2737
|
+
*/
|
|
2738
|
+
billing_cycle_anchor?: Settings.BillingCycleAnchor;
|
|
2739
|
+
/**
|
|
2740
|
+
* Controls whether Stripe attempts payment on the resumption invoice and how payment affects the subscription's status. The default is `resume_on_payment_success`.
|
|
2741
|
+
*/
|
|
2742
|
+
payment_behavior?: Settings.PaymentBehavior;
|
|
2743
|
+
/**
|
|
2744
|
+
* Determines how to handle prorations when the subscription resumes. The default is `create_prorations`.
|
|
2745
|
+
*/
|
|
2746
|
+
proration_behavior?: Settings.ProrationBehavior;
|
|
2747
|
+
}
|
|
2748
|
+
namespace ResumeAt {
|
|
2749
|
+
interface Duration {
|
|
2750
|
+
/**
|
|
2751
|
+
* The time unit for the resume duration. One of `day`, `week`, `month`, or `year`.
|
|
2752
|
+
*/
|
|
2753
|
+
interval: Duration.Interval;
|
|
2754
|
+
/**
|
|
2755
|
+
* The number of intervals after which the subscription resumes.
|
|
2756
|
+
*/
|
|
2757
|
+
interval_count?: number;
|
|
2758
|
+
}
|
|
2759
|
+
type Type = 'duration' | 'now' | 'timestamp' | OtherString;
|
|
2760
|
+
namespace Duration {
|
|
2761
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2762
|
+
}
|
|
2763
|
+
}
|
|
2764
|
+
namespace Settings {
|
|
2765
|
+
type BillingCycleAnchor = 'resume_at' | 'unchanged' | OtherString;
|
|
2766
|
+
type PaymentBehavior = 'resume_on_payment_attempt' | 'resume_on_payment_success' | OtherString;
|
|
2767
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
2768
|
+
}
|
|
2769
|
+
}
|
|
2770
|
+
}
|
|
2771
|
+
namespace Phase {
|
|
2772
|
+
interface AddInvoiceItem {
|
|
2773
|
+
/**
|
|
2774
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
2775
|
+
*/
|
|
2776
|
+
discountable?: boolean;
|
|
2777
|
+
/**
|
|
2778
|
+
* The coupons to redeem into discounts for the item.
|
|
2779
|
+
*/
|
|
2780
|
+
discounts?: Array<AddInvoiceItem.Discount>;
|
|
2781
|
+
/**
|
|
2782
|
+
* 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`.
|
|
2783
|
+
*/
|
|
2784
|
+
metadata?: MetadataParam;
|
|
2785
|
+
/**
|
|
2786
|
+
* The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
2787
|
+
*/
|
|
2788
|
+
period?: AddInvoiceItem.Period;
|
|
2789
|
+
/**
|
|
2790
|
+
* The ID of the price object. One of `price` or `price_data` is required.
|
|
2791
|
+
*/
|
|
2792
|
+
price?: string;
|
|
2793
|
+
/**
|
|
2794
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
2795
|
+
*/
|
|
2796
|
+
price_data?: AddInvoiceItem.PriceData;
|
|
2797
|
+
/**
|
|
2798
|
+
* Quantity for this item. Defaults to 1.
|
|
2799
|
+
*/
|
|
2800
|
+
quantity?: number;
|
|
2801
|
+
/**
|
|
2802
|
+
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
|
2803
|
+
*/
|
|
2804
|
+
tax_rates?: Emptyable<Array<string>>;
|
|
2805
|
+
}
|
|
2806
|
+
interface AutomaticTax {
|
|
2807
|
+
/**
|
|
2808
|
+
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
|
2809
|
+
*/
|
|
2810
|
+
enabled: boolean;
|
|
2811
|
+
/**
|
|
2812
|
+
* The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
|
2813
|
+
*/
|
|
2814
|
+
liability?: AutomaticTax.Liability;
|
|
2815
|
+
}
|
|
2816
|
+
type BillingCycleAnchor = 'automatic' | 'phase_start' | OtherString;
|
|
2817
|
+
interface BillingThresholds {
|
|
2818
|
+
/**
|
|
2819
|
+
* Monetary threshold that triggers the subscription to advance to a new billing period
|
|
2820
|
+
*/
|
|
2821
|
+
amount_gte?: number;
|
|
2822
|
+
/**
|
|
2823
|
+
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
|
2824
|
+
*/
|
|
2825
|
+
reset_billing_cycle_anchor?: boolean;
|
|
2826
|
+
}
|
|
2827
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice' | OtherString;
|
|
2828
|
+
interface Discount {
|
|
2829
|
+
/**
|
|
1570
2830
|
* ID of the coupon to create a new discount for.
|
|
1571
2831
|
*/
|
|
1572
2832
|
coupon?: string;
|
|
@@ -1574,10 +2834,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1574
2834
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1575
2835
|
*/
|
|
1576
2836
|
discount?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* Details to determine how long the discount should be applied for.
|
|
2839
|
+
*/
|
|
2840
|
+
discount_end?: Discount.DiscountEnd;
|
|
1577
2841
|
/**
|
|
1578
2842
|
* ID of the promotion code to create a new discount for.
|
|
1579
2843
|
*/
|
|
1580
2844
|
promotion_code?: string;
|
|
2845
|
+
/**
|
|
2846
|
+
* Settings for discount application including service period anchoring.
|
|
2847
|
+
*/
|
|
2848
|
+
settings?: Discount.Settings;
|
|
1581
2849
|
}
|
|
1582
2850
|
interface Duration {
|
|
1583
2851
|
/**
|
|
@@ -1589,6 +2857,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1589
2857
|
*/
|
|
1590
2858
|
interval_count?: number;
|
|
1591
2859
|
}
|
|
2860
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
1592
2861
|
interface InvoiceSettings {
|
|
1593
2862
|
/**
|
|
1594
2863
|
* 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.
|
|
@@ -1648,6 +2917,20 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1648
2917
|
* 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.
|
|
1649
2918
|
*/
|
|
1650
2919
|
tax_rates?: Emptyable<Array<string>>;
|
|
2920
|
+
/**
|
|
2921
|
+
* Options that configure the trial on the subscription item.
|
|
2922
|
+
*/
|
|
2923
|
+
trial?: Item.Trial;
|
|
2924
|
+
/**
|
|
2925
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
2926
|
+
*/
|
|
2927
|
+
trial_offer?: string;
|
|
2928
|
+
}
|
|
2929
|
+
interface PauseCollection {
|
|
2930
|
+
/**
|
|
2931
|
+
* The payment collection behavior for this subscription while paused.
|
|
2932
|
+
*/
|
|
2933
|
+
behavior: PauseCollection.Behavior;
|
|
1651
2934
|
}
|
|
1652
2935
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
1653
2936
|
interface TransferData {
|
|
@@ -1660,6 +2943,13 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1660
2943
|
*/
|
|
1661
2944
|
destination: string;
|
|
1662
2945
|
}
|
|
2946
|
+
type TrialContinuation = 'continue' | 'none' | OtherString;
|
|
2947
|
+
interface TrialSettings {
|
|
2948
|
+
/**
|
|
2949
|
+
* Defines how the subscription should behave when a trial ends.
|
|
2950
|
+
*/
|
|
2951
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
2952
|
+
}
|
|
1663
2953
|
namespace AddInvoiceItem {
|
|
1664
2954
|
interface Discount {
|
|
1665
2955
|
/**
|
|
@@ -1670,6 +2960,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1670
2960
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1671
2961
|
*/
|
|
1672
2962
|
discount?: string;
|
|
2963
|
+
/**
|
|
2964
|
+
* Details to determine how long the discount should be applied for.
|
|
2965
|
+
*/
|
|
2966
|
+
discount_end?: Discount.DiscountEnd;
|
|
1673
2967
|
/**
|
|
1674
2968
|
* ID of the promotion code to create a new discount for.
|
|
1675
2969
|
*/
|
|
@@ -1707,6 +3001,38 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1707
3001
|
*/
|
|
1708
3002
|
unit_amount_decimal?: Decimal;
|
|
1709
3003
|
}
|
|
3004
|
+
namespace Discount {
|
|
3005
|
+
interface DiscountEnd {
|
|
3006
|
+
/**
|
|
3007
|
+
* Time span for the redeemed discount.
|
|
3008
|
+
*/
|
|
3009
|
+
duration?: DiscountEnd.Duration;
|
|
3010
|
+
/**
|
|
3011
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3012
|
+
*/
|
|
3013
|
+
timestamp?: number;
|
|
3014
|
+
/**
|
|
3015
|
+
* The type of calculation made to determine when the discount ends.
|
|
3016
|
+
*/
|
|
3017
|
+
type: DiscountEnd.Type;
|
|
3018
|
+
}
|
|
3019
|
+
namespace DiscountEnd {
|
|
3020
|
+
interface Duration {
|
|
3021
|
+
/**
|
|
3022
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3023
|
+
*/
|
|
3024
|
+
interval: Duration.Interval;
|
|
3025
|
+
/**
|
|
3026
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3027
|
+
*/
|
|
3028
|
+
interval_count: number;
|
|
3029
|
+
}
|
|
3030
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3031
|
+
namespace Duration {
|
|
3032
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3033
|
+
}
|
|
3034
|
+
}
|
|
3035
|
+
}
|
|
1710
3036
|
namespace Period {
|
|
1711
3037
|
interface End {
|
|
1712
3038
|
/**
|
|
@@ -1736,7 +3062,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1736
3062
|
}
|
|
1737
3063
|
}
|
|
1738
3064
|
namespace PriceData {
|
|
1739
|
-
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3065
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
|
|
1740
3066
|
}
|
|
1741
3067
|
}
|
|
1742
3068
|
namespace AutomaticTax {
|
|
@@ -1751,11 +3077,91 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1751
3077
|
type: Liability.Type;
|
|
1752
3078
|
}
|
|
1753
3079
|
namespace Liability {
|
|
1754
|
-
type Type = 'account' | 'self' | OtherString;
|
|
3080
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
3081
|
+
}
|
|
3082
|
+
}
|
|
3083
|
+
namespace Discount {
|
|
3084
|
+
interface DiscountEnd {
|
|
3085
|
+
/**
|
|
3086
|
+
* Time span for the redeemed discount.
|
|
3087
|
+
*/
|
|
3088
|
+
duration?: DiscountEnd.Duration;
|
|
3089
|
+
/**
|
|
3090
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3091
|
+
*/
|
|
3092
|
+
timestamp?: number;
|
|
3093
|
+
/**
|
|
3094
|
+
* The type of calculation made to determine when the discount ends.
|
|
3095
|
+
*/
|
|
3096
|
+
type: DiscountEnd.Type;
|
|
3097
|
+
}
|
|
3098
|
+
interface Settings {
|
|
3099
|
+
/**
|
|
3100
|
+
* Configures service period cycle anchoring.
|
|
3101
|
+
*/
|
|
3102
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3103
|
+
/**
|
|
3104
|
+
* 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.
|
|
3105
|
+
*/
|
|
3106
|
+
start_date?: Settings.StartDate;
|
|
3107
|
+
}
|
|
3108
|
+
namespace DiscountEnd {
|
|
3109
|
+
interface Duration {
|
|
3110
|
+
/**
|
|
3111
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3112
|
+
*/
|
|
3113
|
+
interval: Duration.Interval;
|
|
3114
|
+
/**
|
|
3115
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3116
|
+
*/
|
|
3117
|
+
interval_count: number;
|
|
3118
|
+
}
|
|
3119
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3120
|
+
namespace Duration {
|
|
3121
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3122
|
+
}
|
|
3123
|
+
}
|
|
3124
|
+
namespace Settings {
|
|
3125
|
+
interface ServicePeriodAnchorConfig {
|
|
3126
|
+
/**
|
|
3127
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3128
|
+
*/
|
|
3129
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3130
|
+
/**
|
|
3131
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3132
|
+
*/
|
|
3133
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3134
|
+
}
|
|
3135
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
3136
|
+
namespace ServicePeriodAnchorConfig {
|
|
3137
|
+
interface Custom {
|
|
3138
|
+
/**
|
|
3139
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3140
|
+
*/
|
|
3141
|
+
day_of_month: number;
|
|
3142
|
+
/**
|
|
3143
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3144
|
+
*/
|
|
3145
|
+
hour?: number;
|
|
3146
|
+
/**
|
|
3147
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3148
|
+
*/
|
|
3149
|
+
minute?: number;
|
|
3150
|
+
/**
|
|
3151
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3152
|
+
*/
|
|
3153
|
+
month?: number;
|
|
3154
|
+
/**
|
|
3155
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3156
|
+
*/
|
|
3157
|
+
second?: number;
|
|
3158
|
+
}
|
|
3159
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3160
|
+
}
|
|
1755
3161
|
}
|
|
1756
3162
|
}
|
|
1757
3163
|
namespace Duration {
|
|
1758
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3164
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1759
3165
|
}
|
|
1760
3166
|
namespace InvoiceSettings {
|
|
1761
3167
|
interface CustomField {
|
|
@@ -1779,7 +3185,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1779
3185
|
type: Issuer.Type;
|
|
1780
3186
|
}
|
|
1781
3187
|
namespace Issuer {
|
|
1782
|
-
type Type = 'account' | 'self' | OtherString;
|
|
3188
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1783
3189
|
}
|
|
1784
3190
|
}
|
|
1785
3191
|
namespace Item {
|
|
@@ -1798,10 +3204,18 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1798
3204
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1799
3205
|
*/
|
|
1800
3206
|
discount?: string;
|
|
3207
|
+
/**
|
|
3208
|
+
* Details to determine how long the discount should be applied for.
|
|
3209
|
+
*/
|
|
3210
|
+
discount_end?: Discount.DiscountEnd;
|
|
1801
3211
|
/**
|
|
1802
3212
|
* ID of the promotion code to create a new discount for.
|
|
1803
3213
|
*/
|
|
1804
3214
|
promotion_code?: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* Settings for discount application including service period anchoring.
|
|
3217
|
+
*/
|
|
3218
|
+
settings?: Discount.Settings;
|
|
1805
3219
|
}
|
|
1806
3220
|
interface PriceData {
|
|
1807
3221
|
/**
|
|
@@ -1829,6 +3243,96 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1829
3243
|
*/
|
|
1830
3244
|
unit_amount_decimal?: Decimal;
|
|
1831
3245
|
}
|
|
3246
|
+
interface Trial {
|
|
3247
|
+
/**
|
|
3248
|
+
* 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.
|
|
3249
|
+
*/
|
|
3250
|
+
converts_to?: Array<string>;
|
|
3251
|
+
/**
|
|
3252
|
+
* Determines the type of trial for this item.
|
|
3253
|
+
*/
|
|
3254
|
+
type: Trial.Type;
|
|
3255
|
+
}
|
|
3256
|
+
namespace Discount {
|
|
3257
|
+
interface DiscountEnd {
|
|
3258
|
+
/**
|
|
3259
|
+
* Time span for the redeemed discount.
|
|
3260
|
+
*/
|
|
3261
|
+
duration?: DiscountEnd.Duration;
|
|
3262
|
+
/**
|
|
3263
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3264
|
+
*/
|
|
3265
|
+
timestamp?: number;
|
|
3266
|
+
/**
|
|
3267
|
+
* The type of calculation made to determine when the discount ends.
|
|
3268
|
+
*/
|
|
3269
|
+
type: DiscountEnd.Type;
|
|
3270
|
+
}
|
|
3271
|
+
interface Settings {
|
|
3272
|
+
/**
|
|
3273
|
+
* Configures service period cycle anchoring.
|
|
3274
|
+
*/
|
|
3275
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3276
|
+
/**
|
|
3277
|
+
* 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.
|
|
3278
|
+
*/
|
|
3279
|
+
start_date?: Settings.StartDate;
|
|
3280
|
+
}
|
|
3281
|
+
namespace DiscountEnd {
|
|
3282
|
+
interface Duration {
|
|
3283
|
+
/**
|
|
3284
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3285
|
+
*/
|
|
3286
|
+
interval: Duration.Interval;
|
|
3287
|
+
/**
|
|
3288
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3289
|
+
*/
|
|
3290
|
+
interval_count: number;
|
|
3291
|
+
}
|
|
3292
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3293
|
+
namespace Duration {
|
|
3294
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3295
|
+
}
|
|
3296
|
+
}
|
|
3297
|
+
namespace Settings {
|
|
3298
|
+
interface ServicePeriodAnchorConfig {
|
|
3299
|
+
/**
|
|
3300
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3301
|
+
*/
|
|
3302
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3303
|
+
/**
|
|
3304
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3305
|
+
*/
|
|
3306
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3307
|
+
}
|
|
3308
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
3309
|
+
namespace ServicePeriodAnchorConfig {
|
|
3310
|
+
interface Custom {
|
|
3311
|
+
/**
|
|
3312
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3313
|
+
*/
|
|
3314
|
+
day_of_month: number;
|
|
3315
|
+
/**
|
|
3316
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3317
|
+
*/
|
|
3318
|
+
hour?: number;
|
|
3319
|
+
/**
|
|
3320
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3321
|
+
*/
|
|
3322
|
+
minute?: number;
|
|
3323
|
+
/**
|
|
3324
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3325
|
+
*/
|
|
3326
|
+
month?: number;
|
|
3327
|
+
/**
|
|
3328
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3329
|
+
*/
|
|
3330
|
+
second?: number;
|
|
3331
|
+
}
|
|
3332
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3333
|
+
}
|
|
3334
|
+
}
|
|
3335
|
+
}
|
|
1832
3336
|
namespace PriceData {
|
|
1833
3337
|
interface Recurring {
|
|
1834
3338
|
/**
|
|
@@ -1840,12 +3344,32 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1840
3344
|
*/
|
|
1841
3345
|
interval_count?: number;
|
|
1842
3346
|
}
|
|
1843
|
-
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3347
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified' | OtherString;
|
|
1844
3348
|
namespace Recurring {
|
|
1845
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3349
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1846
3350
|
}
|
|
1847
3351
|
}
|
|
3352
|
+
namespace Trial {
|
|
3353
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
3354
|
+
}
|
|
1848
3355
|
}
|
|
3356
|
+
namespace PauseCollection {
|
|
3357
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
3358
|
+
}
|
|
3359
|
+
namespace TrialSettings {
|
|
3360
|
+
interface EndBehavior {
|
|
3361
|
+
/**
|
|
3362
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3363
|
+
*/
|
|
3364
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3365
|
+
}
|
|
3366
|
+
namespace EndBehavior {
|
|
3367
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
3368
|
+
}
|
|
3369
|
+
}
|
|
3370
|
+
}
|
|
3371
|
+
namespace Prebilling {
|
|
3372
|
+
type UpdateBehavior = 'prebill' | 'reset' | OtherString;
|
|
1849
3373
|
}
|
|
1850
3374
|
}
|
|
1851
3375
|
export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
@@ -1882,6 +3406,847 @@ export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
|
1882
3406
|
*/
|
|
1883
3407
|
scheduled?: boolean;
|
|
1884
3408
|
}
|
|
3409
|
+
export interface SubscriptionScheduleAmendParams {
|
|
3410
|
+
/**
|
|
3411
|
+
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
3412
|
+
*/
|
|
3413
|
+
amendments?: Array<SubscriptionScheduleAmendParams.Amendment>;
|
|
3414
|
+
/**
|
|
3415
|
+
* Specifies which fields in the response should be expanded.
|
|
3416
|
+
*/
|
|
3417
|
+
expand?: Array<string>;
|
|
3418
|
+
/**
|
|
3419
|
+
* Provide any time periods to bill in advance.
|
|
3420
|
+
*/
|
|
3421
|
+
prebilling?: Emptyable<Array<SubscriptionScheduleAmendParams.Prebilling>>;
|
|
3422
|
+
/**
|
|
3423
|
+
* In cases where the amendment changes the currently active phase,
|
|
3424
|
+
* specifies if and how to prorate at the time of the request.
|
|
3425
|
+
*/
|
|
3426
|
+
proration_behavior?: SubscriptionScheduleAmendParams.ProrationBehavior;
|
|
3427
|
+
/**
|
|
3428
|
+
* Changes to apply to the subscription schedule.
|
|
3429
|
+
*/
|
|
3430
|
+
schedule_settings?: SubscriptionScheduleAmendParams.ScheduleSettings;
|
|
3431
|
+
}
|
|
3432
|
+
export declare namespace SubscriptionScheduleAmendParams {
|
|
3433
|
+
interface Amendment {
|
|
3434
|
+
/**
|
|
3435
|
+
* 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.
|
|
3436
|
+
*/
|
|
3437
|
+
amendment_end?: Amendment.AmendmentEnd;
|
|
3438
|
+
/**
|
|
3439
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
3440
|
+
*/
|
|
3441
|
+
amendment_start: Amendment.AmendmentStart;
|
|
3442
|
+
/**
|
|
3443
|
+
* 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.
|
|
3444
|
+
*/
|
|
3445
|
+
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
3446
|
+
/**
|
|
3447
|
+
* Actions to apply to the billing schedules.
|
|
3448
|
+
*/
|
|
3449
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
3450
|
+
/**
|
|
3451
|
+
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
3452
|
+
*/
|
|
3453
|
+
discount_actions?: Array<Amendment.DiscountAction>;
|
|
3454
|
+
/**
|
|
3455
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3456
|
+
*/
|
|
3457
|
+
effective_at?: Amendment.EffectiveAt;
|
|
3458
|
+
/**
|
|
3459
|
+
* Changes to the subscription items during the amendment time span.
|
|
3460
|
+
*/
|
|
3461
|
+
item_actions?: Array<Amendment.ItemAction>;
|
|
3462
|
+
/**
|
|
3463
|
+
* Instructions for how to modify phase metadata
|
|
3464
|
+
*/
|
|
3465
|
+
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
3466
|
+
/**
|
|
3467
|
+
* 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`.
|
|
3468
|
+
*/
|
|
3469
|
+
proration_behavior?: Amendment.ProrationBehavior;
|
|
3470
|
+
/**
|
|
3471
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3472
|
+
*/
|
|
3473
|
+
set_pause_collection?: Amendment.SetPauseCollection;
|
|
3474
|
+
/**
|
|
3475
|
+
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
3476
|
+
*/
|
|
3477
|
+
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
3478
|
+
/**
|
|
3479
|
+
* Settings related to subscription trials.
|
|
3480
|
+
*/
|
|
3481
|
+
trial_settings?: Amendment.TrialSettings;
|
|
3482
|
+
}
|
|
3483
|
+
interface Prebilling {
|
|
3484
|
+
/**
|
|
3485
|
+
* The beginning of the prebilled time period. The default value is `now`.
|
|
3486
|
+
*/
|
|
3487
|
+
bill_from?: Prebilling.BillFrom;
|
|
3488
|
+
/**
|
|
3489
|
+
* The end of the prebilled time period.
|
|
3490
|
+
*/
|
|
3491
|
+
bill_until?: Prebilling.BillUntil;
|
|
3492
|
+
/**
|
|
3493
|
+
* When the prebilling invoice should be created. The default value is `now`.
|
|
3494
|
+
*/
|
|
3495
|
+
invoice_at?: 'now';
|
|
3496
|
+
/**
|
|
3497
|
+
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
3498
|
+
*/
|
|
3499
|
+
update_behavior?: Prebilling.UpdateBehavior;
|
|
3500
|
+
}
|
|
3501
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3502
|
+
interface ScheduleSettings {
|
|
3503
|
+
/**
|
|
3504
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
3505
|
+
*/
|
|
3506
|
+
end_behavior?: ScheduleSettings.EndBehavior;
|
|
3507
|
+
}
|
|
3508
|
+
namespace Amendment {
|
|
3509
|
+
interface AmendmentEnd {
|
|
3510
|
+
/**
|
|
3511
|
+
* Use the `end` time of a given discount.
|
|
3512
|
+
*/
|
|
3513
|
+
discount_end?: AmendmentEnd.DiscountEnd;
|
|
3514
|
+
/**
|
|
3515
|
+
* Time span for the amendment starting from the `amendment_start`.
|
|
3516
|
+
*/
|
|
3517
|
+
duration?: AmendmentEnd.Duration;
|
|
3518
|
+
/**
|
|
3519
|
+
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
3520
|
+
*/
|
|
3521
|
+
timestamp?: number;
|
|
3522
|
+
/**
|
|
3523
|
+
* Select one of three ways to pass the `amendment_end`.
|
|
3524
|
+
*/
|
|
3525
|
+
type: AmendmentEnd.Type;
|
|
3526
|
+
}
|
|
3527
|
+
interface AmendmentStart {
|
|
3528
|
+
/**
|
|
3529
|
+
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
3530
|
+
*/
|
|
3531
|
+
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
3532
|
+
/**
|
|
3533
|
+
* Use the `end` time of a given discount.
|
|
3534
|
+
*/
|
|
3535
|
+
discount_end?: AmendmentStart.DiscountEnd;
|
|
3536
|
+
/**
|
|
3537
|
+
* A precise Unix timestamp for the amendment to start.
|
|
3538
|
+
*/
|
|
3539
|
+
timestamp?: number;
|
|
3540
|
+
/**
|
|
3541
|
+
* Select one of three ways to pass the `amendment_start`.
|
|
3542
|
+
*/
|
|
3543
|
+
type: AmendmentStart.Type;
|
|
3544
|
+
}
|
|
3545
|
+
type BillingCycleAnchor = 'amendment_start' | 'automatic' | OtherString;
|
|
3546
|
+
interface BillingSchedulesAction {
|
|
3547
|
+
/**
|
|
3548
|
+
* Specify which subscription items the billing schedule applies to.
|
|
3549
|
+
*/
|
|
3550
|
+
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
3551
|
+
/**
|
|
3552
|
+
* Select the action.
|
|
3553
|
+
*/
|
|
3554
|
+
type: BillingSchedulesAction.Type;
|
|
3555
|
+
}
|
|
3556
|
+
interface DiscountAction {
|
|
3557
|
+
/**
|
|
3558
|
+
* Details of the discount to add.
|
|
3559
|
+
*/
|
|
3560
|
+
add?: DiscountAction.Add;
|
|
3561
|
+
/**
|
|
3562
|
+
* Details of the discount to remove.
|
|
3563
|
+
*/
|
|
3564
|
+
remove?: DiscountAction.Remove;
|
|
3565
|
+
/**
|
|
3566
|
+
* Details of the discount to replace the existing discounts with.
|
|
3567
|
+
*/
|
|
3568
|
+
set?: DiscountAction.Set;
|
|
3569
|
+
/**
|
|
3570
|
+
* Determines the type of discount action.
|
|
3571
|
+
*/
|
|
3572
|
+
type: DiscountAction.Type;
|
|
3573
|
+
}
|
|
3574
|
+
type EffectiveAt = 'amendment_start' | 'billing_period_start' | OtherString;
|
|
3575
|
+
interface ItemAction {
|
|
3576
|
+
/**
|
|
3577
|
+
* 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.
|
|
3578
|
+
*/
|
|
3579
|
+
add?: ItemAction.Add;
|
|
3580
|
+
/**
|
|
3581
|
+
* Details of the subscription item to remove.
|
|
3582
|
+
*/
|
|
3583
|
+
remove?: ItemAction.Remove;
|
|
3584
|
+
/**
|
|
3585
|
+
* 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.
|
|
3586
|
+
*/
|
|
3587
|
+
set?: ItemAction.Set;
|
|
3588
|
+
/**
|
|
3589
|
+
* Determines the type of item action.
|
|
3590
|
+
*/
|
|
3591
|
+
type: ItemAction.Type;
|
|
3592
|
+
}
|
|
3593
|
+
interface MetadataAction {
|
|
3594
|
+
/**
|
|
3595
|
+
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3596
|
+
*/
|
|
3597
|
+
add?: {
|
|
3598
|
+
[key: string]: string;
|
|
3599
|
+
};
|
|
3600
|
+
/**
|
|
3601
|
+
* Keys to remove from schedule phase metadata.
|
|
3602
|
+
*/
|
|
3603
|
+
remove?: Array<string>;
|
|
3604
|
+
/**
|
|
3605
|
+
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3606
|
+
*/
|
|
3607
|
+
set?: Emptyable<{
|
|
3608
|
+
[key: string]: string;
|
|
3609
|
+
}>;
|
|
3610
|
+
/**
|
|
3611
|
+
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3612
|
+
*/
|
|
3613
|
+
type: MetadataAction.Type;
|
|
3614
|
+
}
|
|
3615
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3616
|
+
interface SetPauseCollection {
|
|
3617
|
+
/**
|
|
3618
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
3619
|
+
*/
|
|
3620
|
+
set?: SetPauseCollection.Set;
|
|
3621
|
+
/**
|
|
3622
|
+
* Determines the type of the pause_collection amendment.
|
|
3623
|
+
*/
|
|
3624
|
+
type: SetPauseCollection.Type;
|
|
3625
|
+
}
|
|
3626
|
+
type SetScheduleEnd = 'amendment_end' | 'amendment_start' | OtherString;
|
|
3627
|
+
interface TrialSettings {
|
|
3628
|
+
/**
|
|
3629
|
+
* Defines how the subscription should behave when a trial ends.
|
|
3630
|
+
*/
|
|
3631
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
3632
|
+
}
|
|
3633
|
+
namespace AmendmentEnd {
|
|
3634
|
+
interface DiscountEnd {
|
|
3635
|
+
/**
|
|
3636
|
+
* The ID of a specific discount.
|
|
3637
|
+
*/
|
|
3638
|
+
discount: string;
|
|
3639
|
+
}
|
|
3640
|
+
interface Duration {
|
|
3641
|
+
/**
|
|
3642
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3643
|
+
*/
|
|
3644
|
+
interval: Duration.Interval;
|
|
3645
|
+
/**
|
|
3646
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3647
|
+
*/
|
|
3648
|
+
interval_count: number;
|
|
3649
|
+
}
|
|
3650
|
+
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
|
|
3651
|
+
namespace Duration {
|
|
3652
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3653
|
+
}
|
|
3654
|
+
}
|
|
3655
|
+
namespace AmendmentStart {
|
|
3656
|
+
interface AmendmentEnd {
|
|
3657
|
+
/**
|
|
3658
|
+
* 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.
|
|
3659
|
+
*/
|
|
3660
|
+
index: number;
|
|
3661
|
+
}
|
|
3662
|
+
interface DiscountEnd {
|
|
3663
|
+
/**
|
|
3664
|
+
* The ID of a specific discount.
|
|
3665
|
+
*/
|
|
3666
|
+
discount: string;
|
|
3667
|
+
}
|
|
3668
|
+
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
|
|
3669
|
+
}
|
|
3670
|
+
namespace BillingSchedulesAction {
|
|
3671
|
+
interface AppliesTo {
|
|
3672
|
+
/**
|
|
3673
|
+
* The ID of the price object.
|
|
3674
|
+
*/
|
|
3675
|
+
price?: string;
|
|
3676
|
+
/**
|
|
3677
|
+
* Controls which subscription items the billing schedule applies to.
|
|
3678
|
+
*/
|
|
3679
|
+
type: 'price';
|
|
3680
|
+
}
|
|
3681
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
3682
|
+
}
|
|
3683
|
+
namespace DiscountAction {
|
|
3684
|
+
interface Add {
|
|
3685
|
+
/**
|
|
3686
|
+
* The coupon code to redeem.
|
|
3687
|
+
*/
|
|
3688
|
+
coupon?: string;
|
|
3689
|
+
/**
|
|
3690
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3691
|
+
*/
|
|
3692
|
+
discount?: string;
|
|
3693
|
+
/**
|
|
3694
|
+
* Details to determine how long the discount should be applied for.
|
|
3695
|
+
*/
|
|
3696
|
+
discount_end?: Add.DiscountEnd;
|
|
3697
|
+
/**
|
|
3698
|
+
* 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.
|
|
3699
|
+
*/
|
|
3700
|
+
index?: number;
|
|
3701
|
+
/**
|
|
3702
|
+
* The promotion code to redeem.
|
|
3703
|
+
*/
|
|
3704
|
+
promotion_code?: string;
|
|
3705
|
+
/**
|
|
3706
|
+
* Settings for discount application including service period anchoring.
|
|
3707
|
+
*/
|
|
3708
|
+
settings?: Add.Settings;
|
|
3709
|
+
}
|
|
3710
|
+
interface Remove {
|
|
3711
|
+
/**
|
|
3712
|
+
* The coupon code to remove from the `discounts` array.
|
|
3713
|
+
*/
|
|
3714
|
+
coupon?: string;
|
|
3715
|
+
/**
|
|
3716
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
3717
|
+
*/
|
|
3718
|
+
discount?: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
3721
|
+
*/
|
|
3722
|
+
promotion_code?: string;
|
|
3723
|
+
}
|
|
3724
|
+
interface Set {
|
|
3725
|
+
/**
|
|
3726
|
+
* The coupon code to replace the `discounts` array with.
|
|
3727
|
+
*/
|
|
3728
|
+
coupon?: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
3731
|
+
*/
|
|
3732
|
+
discount?: string;
|
|
3733
|
+
/**
|
|
3734
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3735
|
+
*/
|
|
3736
|
+
promotion_code?: string;
|
|
3737
|
+
/**
|
|
3738
|
+
* Settings for discount application including service period anchoring.
|
|
3739
|
+
*/
|
|
3740
|
+
settings?: Set.Settings;
|
|
3741
|
+
}
|
|
3742
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
3743
|
+
namespace Add {
|
|
3744
|
+
interface DiscountEnd {
|
|
3745
|
+
/**
|
|
3746
|
+
* The type of calculation made to determine when the discount ends.
|
|
3747
|
+
*/
|
|
3748
|
+
type: 'amendment_end';
|
|
3749
|
+
}
|
|
3750
|
+
interface Settings {
|
|
3751
|
+
/**
|
|
3752
|
+
* Configures service period cycle anchoring.
|
|
3753
|
+
*/
|
|
3754
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3755
|
+
/**
|
|
3756
|
+
* 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.
|
|
3757
|
+
*/
|
|
3758
|
+
start_date?: Settings.StartDate;
|
|
3759
|
+
}
|
|
3760
|
+
namespace Settings {
|
|
3761
|
+
interface ServicePeriodAnchorConfig {
|
|
3762
|
+
/**
|
|
3763
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3764
|
+
*/
|
|
3765
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3766
|
+
/**
|
|
3767
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3768
|
+
*/
|
|
3769
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3770
|
+
}
|
|
3771
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
3772
|
+
namespace ServicePeriodAnchorConfig {
|
|
3773
|
+
interface Custom {
|
|
3774
|
+
/**
|
|
3775
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3776
|
+
*/
|
|
3777
|
+
day_of_month: number;
|
|
3778
|
+
/**
|
|
3779
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3780
|
+
*/
|
|
3781
|
+
hour?: number;
|
|
3782
|
+
/**
|
|
3783
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3784
|
+
*/
|
|
3785
|
+
minute?: number;
|
|
3786
|
+
/**
|
|
3787
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3788
|
+
*/
|
|
3789
|
+
month?: number;
|
|
3790
|
+
/**
|
|
3791
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3792
|
+
*/
|
|
3793
|
+
second?: number;
|
|
3794
|
+
}
|
|
3795
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3796
|
+
}
|
|
3797
|
+
}
|
|
3798
|
+
}
|
|
3799
|
+
namespace Set {
|
|
3800
|
+
interface Settings {
|
|
3801
|
+
/**
|
|
3802
|
+
* Configures service period cycle anchoring.
|
|
3803
|
+
*/
|
|
3804
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3805
|
+
/**
|
|
3806
|
+
* 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.
|
|
3807
|
+
*/
|
|
3808
|
+
start_date?: Settings.StartDate;
|
|
3809
|
+
}
|
|
3810
|
+
namespace Settings {
|
|
3811
|
+
interface ServicePeriodAnchorConfig {
|
|
3812
|
+
/**
|
|
3813
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3814
|
+
*/
|
|
3815
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3816
|
+
/**
|
|
3817
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3818
|
+
*/
|
|
3819
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3820
|
+
}
|
|
3821
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
3822
|
+
namespace ServicePeriodAnchorConfig {
|
|
3823
|
+
interface Custom {
|
|
3824
|
+
/**
|
|
3825
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3826
|
+
*/
|
|
3827
|
+
day_of_month: number;
|
|
3828
|
+
/**
|
|
3829
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3830
|
+
*/
|
|
3831
|
+
hour?: number;
|
|
3832
|
+
/**
|
|
3833
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3834
|
+
*/
|
|
3835
|
+
minute?: number;
|
|
3836
|
+
/**
|
|
3837
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3838
|
+
*/
|
|
3839
|
+
month?: number;
|
|
3840
|
+
/**
|
|
3841
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3842
|
+
*/
|
|
3843
|
+
second?: number;
|
|
3844
|
+
}
|
|
3845
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3846
|
+
}
|
|
3847
|
+
}
|
|
3848
|
+
}
|
|
3849
|
+
}
|
|
3850
|
+
namespace ItemAction {
|
|
3851
|
+
interface Add {
|
|
3852
|
+
/**
|
|
3853
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3854
|
+
*/
|
|
3855
|
+
discounts?: Array<Add.Discount>;
|
|
3856
|
+
/**
|
|
3857
|
+
* 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`.
|
|
3858
|
+
*/
|
|
3859
|
+
metadata?: MetadataParam;
|
|
3860
|
+
/**
|
|
3861
|
+
* The ID of the price object.
|
|
3862
|
+
*/
|
|
3863
|
+
price: string;
|
|
3864
|
+
/**
|
|
3865
|
+
* Quantity for this item.
|
|
3866
|
+
*/
|
|
3867
|
+
quantity?: number;
|
|
3868
|
+
/**
|
|
3869
|
+
* 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`.
|
|
3870
|
+
*/
|
|
3871
|
+
tax_rates?: Array<string>;
|
|
3872
|
+
/**
|
|
3873
|
+
* Options that configure the trial on the subscription item.
|
|
3874
|
+
*/
|
|
3875
|
+
trial?: Add.Trial;
|
|
3876
|
+
/**
|
|
3877
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3878
|
+
*/
|
|
3879
|
+
trial_offer?: string;
|
|
3880
|
+
}
|
|
3881
|
+
interface Remove {
|
|
3882
|
+
/**
|
|
3883
|
+
* ID of a price to remove.
|
|
3884
|
+
*/
|
|
3885
|
+
price: string;
|
|
3886
|
+
}
|
|
3887
|
+
interface Set {
|
|
3888
|
+
/**
|
|
3889
|
+
* 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`.
|
|
3890
|
+
*/
|
|
3891
|
+
discounts?: Array<Set.Discount>;
|
|
3892
|
+
/**
|
|
3893
|
+
* 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`.
|
|
3894
|
+
*/
|
|
3895
|
+
metadata?: MetadataParam;
|
|
3896
|
+
/**
|
|
3897
|
+
* The ID of the price object.
|
|
3898
|
+
*/
|
|
3899
|
+
price: string;
|
|
3900
|
+
/**
|
|
3901
|
+
* 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`.
|
|
3902
|
+
*/
|
|
3903
|
+
quantity?: number;
|
|
3904
|
+
/**
|
|
3905
|
+
* 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`.
|
|
3906
|
+
*/
|
|
3907
|
+
tax_rates?: Array<string>;
|
|
3908
|
+
/**
|
|
3909
|
+
* 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`.
|
|
3910
|
+
*/
|
|
3911
|
+
trial?: Set.Trial;
|
|
3912
|
+
/**
|
|
3913
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3914
|
+
*/
|
|
3915
|
+
trial_offer?: string;
|
|
3916
|
+
}
|
|
3917
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
3918
|
+
namespace Add {
|
|
3919
|
+
interface Discount {
|
|
3920
|
+
/**
|
|
3921
|
+
* ID of the coupon to create a new discount for.
|
|
3922
|
+
*/
|
|
3923
|
+
coupon?: string;
|
|
3924
|
+
/**
|
|
3925
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3926
|
+
*/
|
|
3927
|
+
discount?: string;
|
|
3928
|
+
/**
|
|
3929
|
+
* Details to determine how long the discount should be applied for.
|
|
3930
|
+
*/
|
|
3931
|
+
discount_end?: Discount.DiscountEnd;
|
|
3932
|
+
/**
|
|
3933
|
+
* ID of the promotion code to create a new discount for.
|
|
3934
|
+
*/
|
|
3935
|
+
promotion_code?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* Settings for discount application including service period anchoring.
|
|
3938
|
+
*/
|
|
3939
|
+
settings?: Discount.Settings;
|
|
3940
|
+
}
|
|
3941
|
+
interface Trial {
|
|
3942
|
+
/**
|
|
3943
|
+
* 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.
|
|
3944
|
+
*/
|
|
3945
|
+
converts_to?: Array<string>;
|
|
3946
|
+
/**
|
|
3947
|
+
* Determines the type of trial for this item.
|
|
3948
|
+
*/
|
|
3949
|
+
type: Trial.Type;
|
|
3950
|
+
}
|
|
3951
|
+
namespace Discount {
|
|
3952
|
+
interface DiscountEnd {
|
|
3953
|
+
/**
|
|
3954
|
+
* Time span for the redeemed discount.
|
|
3955
|
+
*/
|
|
3956
|
+
duration?: DiscountEnd.Duration;
|
|
3957
|
+
/**
|
|
3958
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3959
|
+
*/
|
|
3960
|
+
timestamp?: number;
|
|
3961
|
+
/**
|
|
3962
|
+
* The type of calculation made to determine when the discount ends.
|
|
3963
|
+
*/
|
|
3964
|
+
type: DiscountEnd.Type;
|
|
3965
|
+
}
|
|
3966
|
+
interface Settings {
|
|
3967
|
+
/**
|
|
3968
|
+
* Configures service period cycle anchoring.
|
|
3969
|
+
*/
|
|
3970
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3971
|
+
/**
|
|
3972
|
+
* 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.
|
|
3973
|
+
*/
|
|
3974
|
+
start_date?: Settings.StartDate;
|
|
3975
|
+
}
|
|
3976
|
+
namespace DiscountEnd {
|
|
3977
|
+
interface Duration {
|
|
3978
|
+
/**
|
|
3979
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3980
|
+
*/
|
|
3981
|
+
interval: Duration.Interval;
|
|
3982
|
+
/**
|
|
3983
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3984
|
+
*/
|
|
3985
|
+
interval_count: number;
|
|
3986
|
+
}
|
|
3987
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3988
|
+
namespace Duration {
|
|
3989
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3990
|
+
}
|
|
3991
|
+
}
|
|
3992
|
+
namespace Settings {
|
|
3993
|
+
interface ServicePeriodAnchorConfig {
|
|
3994
|
+
/**
|
|
3995
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3996
|
+
*/
|
|
3997
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3998
|
+
/**
|
|
3999
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4000
|
+
*/
|
|
4001
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4002
|
+
}
|
|
4003
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4004
|
+
namespace ServicePeriodAnchorConfig {
|
|
4005
|
+
interface Custom {
|
|
4006
|
+
/**
|
|
4007
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4008
|
+
*/
|
|
4009
|
+
day_of_month: number;
|
|
4010
|
+
/**
|
|
4011
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4012
|
+
*/
|
|
4013
|
+
hour?: number;
|
|
4014
|
+
/**
|
|
4015
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4016
|
+
*/
|
|
4017
|
+
minute?: number;
|
|
4018
|
+
/**
|
|
4019
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4020
|
+
*/
|
|
4021
|
+
month?: number;
|
|
4022
|
+
/**
|
|
4023
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4024
|
+
*/
|
|
4025
|
+
second?: number;
|
|
4026
|
+
}
|
|
4027
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4028
|
+
}
|
|
4029
|
+
}
|
|
4030
|
+
}
|
|
4031
|
+
namespace Trial {
|
|
4032
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
4033
|
+
}
|
|
4034
|
+
}
|
|
4035
|
+
namespace Set {
|
|
4036
|
+
interface Discount {
|
|
4037
|
+
/**
|
|
4038
|
+
* ID of the coupon to create a new discount for.
|
|
4039
|
+
*/
|
|
4040
|
+
coupon?: string;
|
|
4041
|
+
/**
|
|
4042
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4043
|
+
*/
|
|
4044
|
+
discount?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* Details to determine how long the discount should be applied for.
|
|
4047
|
+
*/
|
|
4048
|
+
discount_end?: Discount.DiscountEnd;
|
|
4049
|
+
/**
|
|
4050
|
+
* ID of the promotion code to create a new discount for.
|
|
4051
|
+
*/
|
|
4052
|
+
promotion_code?: string;
|
|
4053
|
+
/**
|
|
4054
|
+
* Settings for discount application including service period anchoring.
|
|
4055
|
+
*/
|
|
4056
|
+
settings?: Discount.Settings;
|
|
4057
|
+
}
|
|
4058
|
+
interface Trial {
|
|
4059
|
+
/**
|
|
4060
|
+
* 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.
|
|
4061
|
+
*/
|
|
4062
|
+
converts_to?: Array<string>;
|
|
4063
|
+
/**
|
|
4064
|
+
* Determines the type of trial for this item.
|
|
4065
|
+
*/
|
|
4066
|
+
type: Trial.Type;
|
|
4067
|
+
}
|
|
4068
|
+
namespace Discount {
|
|
4069
|
+
interface DiscountEnd {
|
|
4070
|
+
/**
|
|
4071
|
+
* Time span for the redeemed discount.
|
|
4072
|
+
*/
|
|
4073
|
+
duration?: DiscountEnd.Duration;
|
|
4074
|
+
/**
|
|
4075
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4076
|
+
*/
|
|
4077
|
+
timestamp?: number;
|
|
4078
|
+
/**
|
|
4079
|
+
* The type of calculation made to determine when the discount ends.
|
|
4080
|
+
*/
|
|
4081
|
+
type: DiscountEnd.Type;
|
|
4082
|
+
}
|
|
4083
|
+
interface Settings {
|
|
4084
|
+
/**
|
|
4085
|
+
* Configures service period cycle anchoring.
|
|
4086
|
+
*/
|
|
4087
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4088
|
+
/**
|
|
4089
|
+
* 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.
|
|
4090
|
+
*/
|
|
4091
|
+
start_date?: Settings.StartDate;
|
|
4092
|
+
}
|
|
4093
|
+
namespace DiscountEnd {
|
|
4094
|
+
interface Duration {
|
|
4095
|
+
/**
|
|
4096
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4097
|
+
*/
|
|
4098
|
+
interval: Duration.Interval;
|
|
4099
|
+
/**
|
|
4100
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4101
|
+
*/
|
|
4102
|
+
interval_count: number;
|
|
4103
|
+
}
|
|
4104
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4105
|
+
namespace Duration {
|
|
4106
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4107
|
+
}
|
|
4108
|
+
}
|
|
4109
|
+
namespace Settings {
|
|
4110
|
+
interface ServicePeriodAnchorConfig {
|
|
4111
|
+
/**
|
|
4112
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4113
|
+
*/
|
|
4114
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4115
|
+
/**
|
|
4116
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4117
|
+
*/
|
|
4118
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4119
|
+
}
|
|
4120
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4121
|
+
namespace ServicePeriodAnchorConfig {
|
|
4122
|
+
interface Custom {
|
|
4123
|
+
/**
|
|
4124
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4125
|
+
*/
|
|
4126
|
+
day_of_month: number;
|
|
4127
|
+
/**
|
|
4128
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4129
|
+
*/
|
|
4130
|
+
hour?: number;
|
|
4131
|
+
/**
|
|
4132
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4133
|
+
*/
|
|
4134
|
+
minute?: number;
|
|
4135
|
+
/**
|
|
4136
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4137
|
+
*/
|
|
4138
|
+
month?: number;
|
|
4139
|
+
/**
|
|
4140
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4141
|
+
*/
|
|
4142
|
+
second?: number;
|
|
4143
|
+
}
|
|
4144
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4145
|
+
}
|
|
4146
|
+
}
|
|
4147
|
+
}
|
|
4148
|
+
namespace Trial {
|
|
4149
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
4150
|
+
}
|
|
4151
|
+
}
|
|
4152
|
+
}
|
|
4153
|
+
namespace MetadataAction {
|
|
4154
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
4155
|
+
}
|
|
4156
|
+
namespace SetPauseCollection {
|
|
4157
|
+
interface Set {
|
|
4158
|
+
/**
|
|
4159
|
+
* The payment collection behavior for this subscription while paused.
|
|
4160
|
+
*/
|
|
4161
|
+
behavior: Set.Behavior;
|
|
4162
|
+
}
|
|
4163
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
4164
|
+
namespace Set {
|
|
4165
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
4166
|
+
}
|
|
4167
|
+
}
|
|
4168
|
+
namespace TrialSettings {
|
|
4169
|
+
interface EndBehavior {
|
|
4170
|
+
/**
|
|
4171
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4172
|
+
*/
|
|
4173
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4174
|
+
}
|
|
4175
|
+
namespace EndBehavior {
|
|
4176
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
4177
|
+
}
|
|
4178
|
+
}
|
|
4179
|
+
}
|
|
4180
|
+
namespace Prebilling {
|
|
4181
|
+
interface BillFrom {
|
|
4182
|
+
/**
|
|
4183
|
+
* Start the prebilled period when a specified amendment begins.
|
|
4184
|
+
*/
|
|
4185
|
+
amendment_start?: BillFrom.AmendmentStart;
|
|
4186
|
+
/**
|
|
4187
|
+
* Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
4188
|
+
*/
|
|
4189
|
+
timestamp?: number;
|
|
4190
|
+
/**
|
|
4191
|
+
* Select one of several ways to pass the `bill_from` value.
|
|
4192
|
+
*/
|
|
4193
|
+
type: BillFrom.Type;
|
|
4194
|
+
}
|
|
4195
|
+
interface BillUntil {
|
|
4196
|
+
/**
|
|
4197
|
+
* End the prebilled period when a specified amendment ends.
|
|
4198
|
+
*/
|
|
4199
|
+
amendment_end?: BillUntil.AmendmentEnd;
|
|
4200
|
+
/**
|
|
4201
|
+
* Time span for prebilling, starting from `bill_from`.
|
|
4202
|
+
*/
|
|
4203
|
+
duration?: BillUntil.Duration;
|
|
4204
|
+
/**
|
|
4205
|
+
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
4206
|
+
*/
|
|
4207
|
+
timestamp?: number;
|
|
4208
|
+
/**
|
|
4209
|
+
* Select one of several ways to pass the `bill_until` value.
|
|
4210
|
+
*/
|
|
4211
|
+
type: BillUntil.Type;
|
|
4212
|
+
}
|
|
4213
|
+
type UpdateBehavior = 'prebill' | 'reset' | OtherString;
|
|
4214
|
+
namespace BillFrom {
|
|
4215
|
+
interface AmendmentStart {
|
|
4216
|
+
/**
|
|
4217
|
+
* 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.
|
|
4218
|
+
*/
|
|
4219
|
+
index: number;
|
|
4220
|
+
}
|
|
4221
|
+
type Type = 'amendment_start' | 'now' | 'timestamp' | OtherString;
|
|
4222
|
+
}
|
|
4223
|
+
namespace BillUntil {
|
|
4224
|
+
interface AmendmentEnd {
|
|
4225
|
+
/**
|
|
4226
|
+
* 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.
|
|
4227
|
+
*/
|
|
4228
|
+
index: number;
|
|
4229
|
+
}
|
|
4230
|
+
interface Duration {
|
|
4231
|
+
/**
|
|
4232
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4233
|
+
*/
|
|
4234
|
+
interval: Duration.Interval;
|
|
4235
|
+
/**
|
|
4236
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4237
|
+
*/
|
|
4238
|
+
interval_count: number;
|
|
4239
|
+
}
|
|
4240
|
+
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp' | OtherString;
|
|
4241
|
+
namespace Duration {
|
|
4242
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4243
|
+
}
|
|
4244
|
+
}
|
|
4245
|
+
}
|
|
4246
|
+
namespace ScheduleSettings {
|
|
4247
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
4248
|
+
}
|
|
4249
|
+
}
|
|
1885
4250
|
export interface SubscriptionScheduleCancelParams {
|
|
1886
4251
|
/**
|
|
1887
4252
|
* Specifies which fields in the response should be expanded.
|
|
@@ -1906,3 +4271,11 @@ export interface SubscriptionScheduleReleaseParams {
|
|
|
1906
4271
|
*/
|
|
1907
4272
|
preserve_cancel_date?: boolean;
|
|
1908
4273
|
}
|
|
4274
|
+
export interface SubscriptionScheduleSerializeBatchCancelParams {
|
|
4275
|
+
}
|
|
4276
|
+
export interface SubscriptionScheduleSerializeBatchCreateParams {
|
|
4277
|
+
}
|
|
4278
|
+
export interface SubscriptionScheduleSerializeBatchReleaseParams {
|
|
4279
|
+
}
|
|
4280
|
+
export interface SubscriptionScheduleSerializeBatchUpdateParams {
|
|
4281
|
+
}
|