stripe 22.4.0 → 22.5.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 +3171 -13
- package/OPENAPI_VERSION +1 -1
- package/README.md +44 -60
- package/VERSION +1 -1
- package/cjs/Error.d.ts +58 -0
- package/cjs/Error.js +135 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +491 -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 +5 -1
- package/cjs/resources/AccountNotices.d.ts +140 -0
- package/cjs/resources/AccountNotices.js +29 -0
- package/cjs/resources/AccountNotices.js.map +1 -0
- package/cjs/resources/AccountSessions.d.ts +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 +1037 -6
- package/cjs/resources/Accounts.js +47 -0
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplicationFees.d.ts +28 -1
- package/cjs/resources/Balance.d.ts +134 -0
- package/cjs/resources/BalanceSettings.d.ts +18 -0
- package/cjs/resources/BalanceTransactions.d.ts +1 -1
- package/cjs/resources/BalanceTransfers.d.ts +160 -0
- package/cjs/resources/BalanceTransfers.js +15 -0
- package/cjs/resources/BalanceTransfers.js.map +1 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/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 +88 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
- package/cjs/resources/Billing/Analytics/index.js +13 -0
- package/cjs/resources/Billing/Analytics/index.js.map +1 -0
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +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 +5 -0
- package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
- package/cjs/resources/Capabilities.d.ts +25 -2
- package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
- package/cjs/resources/Capital/FinancingOffers.js +30 -0
- package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/Capital/FinancingSummary.d.ts +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 +28 -0
- package/cjs/resources/Charges.d.ts +3367 -70
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1193 -12
- package/cjs/resources/Checkout/Sessions.js +115 -0
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -0
- package/cjs/resources/ConfirmationTokens.d.ts +146 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +128 -2
- package/cjs/resources/Coupons.js +41 -0
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +7 -1
- package/cjs/resources/CreditNotes.js +13 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/Crypto/CustomerConsumerWallets.d.ts +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 +421 -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 +74 -0
- package/cjs/resources/CustomerSessions.js +13 -0
- package/cjs/resources/CustomerSessions.js.map +1 -1
- package/cjs/resources/Customers.d.ts +98 -1
- package/cjs/resources/Customers.js +195 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +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 +1420 -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 +574 -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/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/cjs/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/cjs/resources/FinancialConnections/Accounts.js +8 -0
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +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 +124 -9
- 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 +204 -3
- package/cjs/resources/InvoiceItems.js +41 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +174 -4
- package/cjs/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +2125 -21
- package/cjs/resources/Invoices.js +221 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +524 -1
- package/cjs/resources/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +22 -4
- package/cjs/resources/Issuing/Cards.d.ts +82 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +53 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/cjs/resources/Issuing/Disputes.d.ts +246 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/cjs/resources/Issuing/Programs.d.ts +95 -0
- package/cjs/resources/Issuing/Programs.js +35 -0
- package/cjs/resources/Issuing/Programs.js.map +1 -0
- package/cjs/resources/Issuing/Settlements.d.ts +83 -0
- package/cjs/resources/Issuing/Settlements.js +4 -0
- package/cjs/resources/Issuing/Settlements.js.map +1 -0
- package/cjs/resources/Issuing/Tokens.d.ts +26 -0
- package/cjs/resources/Issuing/Transactions.d.ts +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 +47 -2
- 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 +679 -2
- 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 +16109 -2361
- package/cjs/resources/PaymentIntents.js +46 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +77 -15
- 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 +300 -3
- package/cjs/resources/PaymentMethods.js +20 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +737 -20
- package/cjs/resources/PaymentRecords.js +18 -0
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Persons.d.ts +25 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +77 -1
- 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 +199 -1
- 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 +1179 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +1045 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +3548 -254
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/cjs/resources/Radar/AccountEvaluations.js +27 -0
- package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
- package/cjs/resources/Radar/CustomerEvaluations.d.ts +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 +115 -1
- 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/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 +39 -0
- package/cjs/resources/Refunds.js +27 -0
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reserve/Holds.d.ts +53 -1
- package/cjs/resources/Reserve/Holds.js +19 -0
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +16 -0
- package/cjs/resources/Reserve/Plans.js +11 -0
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +41 -1
- package/cjs/resources/Reserve/Releases.js +19 -0
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +17 -6
- package/cjs/resources/Reserve/index.js +9 -0
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/RiskSignals.d.ts +10 -0
- package/cjs/resources/RiskSignals.js +4 -0
- package/cjs/resources/RiskSignals.js.map +1 -0
- package/cjs/resources/SetupAttempts.d.ts +35 -1
- package/cjs/resources/SetupAttempts.js.map +1 -1
- package/cjs/resources/SetupIntents.d.ts +627 -11
- 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/Sources.d.ts +29 -1
- package/cjs/resources/SubscriptionItems.d.ts +266 -1
- package/cjs/resources/SubscriptionItems.js +41 -0
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +2398 -67
- package/cjs/resources/SubscriptionSchedules.js +61 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +971 -13
- 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 +46 -4
- 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 +171 -2
- package/cjs/resources/Tax/Registrations.js +27 -0
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +8 -0
- package/cjs/resources/Tax/Settings.js +13 -0
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/Transactions.d.ts +10 -2
- package/cjs/resources/Tax/Transactions.js +13 -0
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- package/cjs/resources/Tax/index.d.ts +31 -13
- package/cjs/resources/Tax/index.js +4 -0
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +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 +6 -0
- package/cjs/resources/TaxIds.js +13 -0
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +12 -0
- package/cjs/resources/TaxRates.js +27 -0
- package/cjs/resources/TaxRates.js.map +1 -1
- package/cjs/resources/Terminal/Configurations.d.ts +27 -0
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/cjs/resources/Terminal/Readers.d.ts +207 -2
- 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 +81 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/Capital/index.js +13 -0
- package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +100 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +102 -0
- 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 +110 -0
- package/cjs/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/cjs/resources/TestHelpers/PaymentIntents.d.ts +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 +82 -0
- package/cjs/resources/Transfers.d.ts +12 -0
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/TransitBalances.d.ts +25 -0
- package/cjs/resources/TransitBalances.js +4 -0
- package/cjs/resources/TransitBalances.js.map +1 -0
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +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 +1484 -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 +16128 -1981
- 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 +7881 -232
- 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 +416 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js +4 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js +101 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/cjs/resources/V2/Core/Health/Alerts.js +182 -0
- package/cjs/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/cjs/resources/V2/Core/Health/index.d.ts +16 -0
- package/cjs/resources/V2/Core/Health/index.js +13 -0
- package/cjs/resources/V2/Core/Health/index.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +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 +219 -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 +525 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +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 +297 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +150 -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/index.d.ts +16 -0
- package/cjs/resources/V2/Tax/index.js +13 -0
- package/cjs/resources/V2/Tax/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +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 +2 -2
- package/cjs/resources.d.ts +19 -0
- package/cjs/resources.js +290 -18
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +15353 -1281
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +158 -54
- package/cjs/stripe.core.js +72 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +58 -0
- package/esm/Error.js +118 -0
- package/esm/Error.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +487 -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 +5 -1
- package/esm/resources/AccountNotices.d.ts +140 -0
- package/esm/resources/AccountNotices.js +25 -0
- package/esm/resources/AccountNotices.js.map +1 -0
- package/esm/resources/AccountSessions.d.ts +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 +1037 -6
- package/esm/resources/Accounts.js +47 -0
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplicationFees.d.ts +28 -1
- package/esm/resources/Balance.d.ts +134 -0
- package/esm/resources/BalanceSettings.d.ts +18 -0
- package/esm/resources/BalanceTransactions.d.ts +1 -1
- package/esm/resources/BalanceTransfers.d.ts +160 -0
- package/esm/resources/BalanceTransfers.js +11 -0
- package/esm/resources/BalanceTransfers.js.map +1 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/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 +88 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/esm/resources/Billing/Analytics/index.d.ts +15 -0
- package/esm/resources/Billing/Analytics/index.js +9 -0
- package/esm/resources/Billing/Analytics/index.js.map +1 -0
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +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 +5 -0
- package/esm/resources/BillingPortal/Configurations.js.map +1 -1
- package/esm/resources/Capabilities.d.ts +25 -2
- package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
- package/esm/resources/Capital/FinancingOffers.js +26 -0
- package/esm/resources/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/Capital/FinancingSummary.d.ts +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 +28 -0
- package/esm/resources/Charges.d.ts +3367 -70
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1193 -12
- package/esm/resources/Checkout/Sessions.js +115 -0
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -0
- package/esm/resources/ConfirmationTokens.d.ts +146 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/Coupons.d.ts +128 -2
- package/esm/resources/Coupons.js +41 -0
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +7 -1
- package/esm/resources/CreditNotes.js +13 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/Crypto/CustomerConsumerWallets.d.ts +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 +421 -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 +74 -0
- package/esm/resources/CustomerSessions.js +13 -0
- package/esm/resources/CustomerSessions.js.map +1 -1
- package/esm/resources/Customers.d.ts +98 -1
- package/esm/resources/Customers.js +195 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +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 +1420 -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 +574 -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/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/esm/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/esm/resources/FinancialConnections/Accounts.js +8 -0
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +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 +124 -9
- 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 +204 -3
- package/esm/resources/InvoiceItems.js +41 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +174 -4
- package/esm/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/esm/resources/InvoiceRenderingTemplates.js +28 -0
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +2125 -21
- package/esm/resources/Invoices.js +221 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +524 -1
- package/esm/resources/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +22 -4
- package/esm/resources/Issuing/Cards.d.ts +82 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +49 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/esm/resources/Issuing/Disputes.d.ts +246 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/esm/resources/Issuing/Programs.d.ts +95 -0
- package/esm/resources/Issuing/Programs.js +31 -0
- package/esm/resources/Issuing/Programs.js.map +1 -0
- package/esm/resources/Issuing/Settlements.d.ts +83 -0
- package/esm/resources/Issuing/Settlements.js +3 -0
- package/esm/resources/Issuing/Settlements.js.map +1 -0
- package/esm/resources/Issuing/Tokens.d.ts +26 -0
- package/esm/resources/Issuing/Transactions.d.ts +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 +47 -2
- 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 +679 -2
- 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 +16109 -2361
- package/esm/resources/PaymentIntents.js +46 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +77 -15
- 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 +300 -3
- package/esm/resources/PaymentMethods.js +20 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +737 -20
- package/esm/resources/PaymentRecords.js +18 -0
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Persons.d.ts +25 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +77 -1
- 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 +199 -1
- 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 +1179 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +1045 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +3548 -254
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/esm/resources/Radar/AccountEvaluations.js +23 -0
- package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
- package/esm/resources/Radar/CustomerEvaluations.d.ts +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 +115 -1
- 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/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 +39 -0
- package/esm/resources/Refunds.js +27 -0
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reserve/Holds.d.ts +53 -1
- package/esm/resources/Reserve/Holds.js +17 -1
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +16 -0
- package/esm/resources/Reserve/Plans.js +9 -1
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +41 -1
- package/esm/resources/Reserve/Releases.js +17 -1
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +17 -6
- package/esm/resources/Reserve/index.js +9 -0
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/RiskSignals.d.ts +10 -0
- package/esm/resources/RiskSignals.js +3 -0
- package/esm/resources/RiskSignals.js.map +1 -0
- package/esm/resources/SetupAttempts.d.ts +35 -1
- package/esm/resources/SetupAttempts.js.map +1 -1
- package/esm/resources/SetupIntents.d.ts +627 -11
- 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/Sources.d.ts +29 -1
- package/esm/resources/SubscriptionItems.d.ts +266 -1
- package/esm/resources/SubscriptionItems.js +41 -0
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +2398 -67
- package/esm/resources/SubscriptionSchedules.js +61 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +971 -13
- 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 +46 -4
- 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 +171 -2
- package/esm/resources/Tax/Registrations.js +27 -0
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +8 -0
- package/esm/resources/Tax/Settings.js +13 -0
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/Transactions.d.ts +10 -2
- package/esm/resources/Tax/Transactions.js +13 -0
- package/esm/resources/Tax/Transactions.js.map +1 -1
- package/esm/resources/Tax/index.d.ts +31 -13
- package/esm/resources/Tax/index.js +4 -0
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +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 +6 -0
- package/esm/resources/TaxIds.js +13 -0
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +12 -0
- package/esm/resources/TaxRates.js +27 -0
- package/esm/resources/TaxRates.js.map +1 -1
- package/esm/resources/Terminal/Configurations.d.ts +27 -0
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
- package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/esm/resources/Terminal/Readers.d.ts +207 -2
- 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 +81 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/esm/resources/TestHelpers/Capital/index.js +9 -0
- package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +100 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +102 -0
- 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 +110 -0
- package/esm/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/esm/resources/TestHelpers/PaymentIntents.d.ts +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 +82 -0
- package/esm/resources/Transfers.d.ts +12 -0
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/TransitBalances.d.ts +25 -0
- package/esm/resources/TransitBalances.js +3 -0
- package/esm/resources/TransitBalances.js.map +1 -0
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +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 +1484 -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 +16128 -1981
- 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 +7881 -232
- 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 +416 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js +3 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js +97 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/esm/resources/V2/Core/Health/Alerts.js +178 -0
- package/esm/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/esm/resources/V2/Core/Health/index.d.ts +16 -0
- package/esm/resources/V2/Core/Health/index.js +9 -0
- package/esm/resources/V2/Core/Health/index.js.map +1 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +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 +219 -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 +525 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +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 +297 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +150 -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/index.d.ts +16 -0
- package/esm/resources/V2/Tax/index.js +9 -0
- package/esm/resources/V2/Tax/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +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 +2 -2
- package/esm/resources.d.ts +19 -0
- package/esm/resources.js +261 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +158 -54
- package/esm/stripe.core.js +43 -2
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +158 -54
- package/esm/stripe.esm.node.js +43 -2
- package/esm/stripe.esm.node.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import { StripeResource } from '../StripeResource.js';
|
|
2
|
+
import { InvoiceLineItem } from './InvoiceLineItems.js';
|
|
2
3
|
import { LineItem } from './LineItems.js';
|
|
4
|
+
import { QuoteLine } from './QuoteLines.js';
|
|
5
|
+
import { QuotePreviewInvoice } from './QuotePreviewInvoices.js';
|
|
6
|
+
import { QuotePreviewSubscriptionSchedule } from './QuotePreviewSubscriptionSchedules.js';
|
|
3
7
|
import { Discount as _Discount } from './Discounts.js';
|
|
4
8
|
import { Application, DeletedApplication } from './Applications.js';
|
|
5
9
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
@@ -8,6 +12,7 @@ import { Invoice, DeletedInvoice } from './Invoices.js';
|
|
|
8
12
|
import { Account } from './Accounts.js';
|
|
9
13
|
import { Subscription } from './Subscriptions.js';
|
|
10
14
|
import { SubscriptionSchedule } from './SubscriptionSchedules.js';
|
|
15
|
+
import { Price } from './Prices.js';
|
|
11
16
|
import * as TestHelpers from './TestHelpers/index.js';
|
|
12
17
|
import { Emptyable, MetadataParam, OtherString, Decimal, PaginationParams, Metadata } from '../shared.js';
|
|
13
18
|
import { RequestOptions, ApiListPromise, Response, ApiList, StripeStreamResponse } from '../lib.js';
|
|
@@ -40,18 +45,46 @@ export declare class QuoteResource extends StripeResource {
|
|
|
40
45
|
* Finalizes the quote.
|
|
41
46
|
*/
|
|
42
47
|
finalizeQuote(id: string, params?: QuoteFinalizeQuoteParams, options?: RequestOptions): Promise<Response<Quote>>;
|
|
48
|
+
/**
|
|
49
|
+
* Converts a stale quote to draft.
|
|
50
|
+
*/
|
|
51
|
+
markDraft(id: string, params?: QuoteMarkDraftParams, options?: RequestOptions): Promise<Response<Quote>>;
|
|
52
|
+
/**
|
|
53
|
+
* Converts a draft or open quote to stale.
|
|
54
|
+
*/
|
|
55
|
+
markStale(id: string, params?: QuoteMarkStaleParams, options?: RequestOptions): Promise<Response<Quote>>;
|
|
56
|
+
/**
|
|
57
|
+
* Recompute the upcoming invoice estimate for the quote.
|
|
58
|
+
*/
|
|
59
|
+
reestimate(id: string, params?: QuoteReestimateParams, options?: RequestOptions): Promise<Response<Quote>>;
|
|
43
60
|
/**
|
|
44
61
|
* Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
|
|
45
62
|
*/
|
|
46
63
|
pdf(id: string, params?: QuotePdfParams, options?: RequestOptions): Promise<StripeStreamResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* Preview the invoice line items that would be generated by accepting the quote.
|
|
66
|
+
*/
|
|
67
|
+
listPreviewInvoiceLines(quoteId: string, id: string, params?: QuoteListPreviewInvoiceLinesParams, options?: RequestOptions): ApiListPromise<InvoiceLineItem>;
|
|
47
68
|
/**
|
|
48
69
|
* When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
|
|
49
70
|
*/
|
|
50
71
|
listComputedUpfrontLineItems(id: string, params?: QuoteListComputedUpfrontLineItemsParams, options?: RequestOptions): ApiListPromise<LineItem>;
|
|
72
|
+
/**
|
|
73
|
+
* Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
|
74
|
+
*/
|
|
75
|
+
listLines(id: string, params?: QuoteListLinesParams, options?: RequestOptions): ApiListPromise<QuoteLine>;
|
|
51
76
|
/**
|
|
52
77
|
* When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
|
53
78
|
*/
|
|
54
79
|
listLineItems(id: string, params?: QuoteListLineItemsParams, options?: RequestOptions): ApiListPromise<LineItem>;
|
|
80
|
+
/**
|
|
81
|
+
* Preview the invoices that would be generated by accepting the quote.
|
|
82
|
+
*/
|
|
83
|
+
listPreviewInvoices(id: string, params?: QuoteListPreviewInvoicesParams, options?: RequestOptions): ApiListPromise<QuotePreviewInvoice>;
|
|
84
|
+
/**
|
|
85
|
+
* Preview the schedules that would be generated by accepting the quote
|
|
86
|
+
*/
|
|
87
|
+
listPreviewSubscriptionSchedules(id: string, params?: QuoteListPreviewSubscriptionSchedulesParams, options?: RequestOptions): ApiListPromise<QuotePreviewSubscriptionSchedule>;
|
|
55
88
|
}
|
|
56
89
|
export interface Quote {
|
|
57
90
|
/**
|
|
@@ -62,6 +95,10 @@ export interface Quote {
|
|
|
62
95
|
* String representing the object's type. Objects of the same type share the same value.
|
|
63
96
|
*/
|
|
64
97
|
object: 'quote';
|
|
98
|
+
/**
|
|
99
|
+
* Allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
|
|
100
|
+
*/
|
|
101
|
+
allow_backdated_lines?: boolean | null;
|
|
65
102
|
/**
|
|
66
103
|
* Total before any discounts or taxes are applied.
|
|
67
104
|
*/
|
|
@@ -141,6 +178,10 @@ export interface Quote {
|
|
|
141
178
|
* A list of items the customer is being quoted for.
|
|
142
179
|
*/
|
|
143
180
|
line_items?: ApiList<LineItem>;
|
|
181
|
+
/**
|
|
182
|
+
* A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
|
183
|
+
*/
|
|
184
|
+
lines?: Array<string> | null;
|
|
144
185
|
/**
|
|
145
186
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
146
187
|
*/
|
|
@@ -161,16 +202,28 @@ export interface Quote {
|
|
|
161
202
|
* The status of the quote.
|
|
162
203
|
*/
|
|
163
204
|
status: Quote.Status;
|
|
205
|
+
/**
|
|
206
|
+
* Details on when and why a quote has been marked as stale or canceled.
|
|
207
|
+
*/
|
|
208
|
+
status_details?: Quote.StatusDetails | null;
|
|
164
209
|
status_transitions: Quote.StatusTransitions;
|
|
165
210
|
/**
|
|
166
211
|
* The subscription that was created or updated from this quote.
|
|
167
212
|
*/
|
|
168
213
|
subscription: string | Subscription | null;
|
|
169
214
|
subscription_data: Quote.SubscriptionData;
|
|
215
|
+
/**
|
|
216
|
+
* List representing overrides for `subscription_data` configurations for specific subscription schedules.
|
|
217
|
+
*/
|
|
218
|
+
subscription_data_overrides?: Array<Quote.SubscriptionDataOverride> | null;
|
|
170
219
|
/**
|
|
171
220
|
* The subscription schedule that was created or updated from this quote.
|
|
172
221
|
*/
|
|
173
222
|
subscription_schedule: string | SubscriptionSchedule | null;
|
|
223
|
+
/**
|
|
224
|
+
* The subscription schedules that were created or updated from this quote.
|
|
225
|
+
*/
|
|
226
|
+
subscription_schedules?: Array<Quote.SubscriptionSchedule> | null;
|
|
174
227
|
/**
|
|
175
228
|
* ID of the test clock this quote belongs to.
|
|
176
229
|
*/
|
|
@@ -202,10 +255,18 @@ export declare namespace Quote {
|
|
|
202
255
|
}
|
|
203
256
|
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
204
257
|
interface Computed {
|
|
258
|
+
/**
|
|
259
|
+
* Details of the most recent reestimate of the quote's preview schedules and upcoming invoices, including the status of Stripe's calculation.
|
|
260
|
+
*/
|
|
261
|
+
last_reestimation_details?: Computed.LastReestimationDetails | null;
|
|
205
262
|
/**
|
|
206
263
|
* The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
|
|
207
264
|
*/
|
|
208
265
|
recurring: Computed.Recurring | null;
|
|
266
|
+
/**
|
|
267
|
+
* The time at which the quote's estimated schedules and upcoming invoices were generated.
|
|
268
|
+
*/
|
|
269
|
+
updated_at?: number | null;
|
|
209
270
|
upfront: Computed.Upfront;
|
|
210
271
|
}
|
|
211
272
|
interface FromQuote {
|
|
@@ -237,7 +298,11 @@ export declare namespace Quote {
|
|
|
237
298
|
footer: string | null;
|
|
238
299
|
issuer: InvoiceSettings.Issuer;
|
|
239
300
|
}
|
|
240
|
-
type Status = 'accepted' | 'canceled' | 'draft' | 'open' | OtherString;
|
|
301
|
+
type Status = 'accepted' | 'accepting' | 'canceled' | 'draft' | 'open' | 'stale' | OtherString;
|
|
302
|
+
interface StatusDetails {
|
|
303
|
+
canceled?: StatusDetails.Canceled;
|
|
304
|
+
stale?: StatusDetails.Stale;
|
|
305
|
+
}
|
|
241
306
|
interface StatusTransitions {
|
|
242
307
|
/**
|
|
243
308
|
* The time that the quote was accepted. Measured in seconds since Unix epoch.
|
|
@@ -253,10 +318,26 @@ export declare namespace Quote {
|
|
|
253
318
|
finalized_at: number | null;
|
|
254
319
|
}
|
|
255
320
|
interface SubscriptionData {
|
|
321
|
+
/**
|
|
322
|
+
* Describes the period to bill for upon accepting the quote.
|
|
323
|
+
*/
|
|
324
|
+
bill_on_acceptance?: SubscriptionData.BillOnAcceptance | null;
|
|
325
|
+
/**
|
|
326
|
+
* 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.
|
|
327
|
+
*/
|
|
328
|
+
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
329
|
+
/**
|
|
330
|
+
* Whether the subscription will always start a new billing period when the quote is accepted.
|
|
331
|
+
*/
|
|
332
|
+
billing_cycle_anchor?: 'reset' | null;
|
|
256
333
|
/**
|
|
257
334
|
* The billing mode of the quote.
|
|
258
335
|
*/
|
|
259
336
|
billing_mode: SubscriptionData.BillingMode;
|
|
337
|
+
/**
|
|
338
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
|
|
339
|
+
*/
|
|
340
|
+
billing_schedules?: Array<SubscriptionData.BillingSchedule>;
|
|
260
341
|
/**
|
|
261
342
|
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
262
343
|
*/
|
|
@@ -265,15 +346,77 @@ export declare namespace Quote {
|
|
|
265
346
|
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
|
|
266
347
|
*/
|
|
267
348
|
effective_date: number | null;
|
|
349
|
+
/**
|
|
350
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
351
|
+
*/
|
|
352
|
+
end_behavior?: SubscriptionData.EndBehavior | null;
|
|
353
|
+
/**
|
|
354
|
+
* The id of the subscription that will be updated when the quote is accepted.
|
|
355
|
+
*/
|
|
356
|
+
from_subscription?: string | Subscription | null;
|
|
268
357
|
/**
|
|
269
358
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
270
359
|
*/
|
|
271
360
|
metadata: Metadata | null;
|
|
361
|
+
/**
|
|
362
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
363
|
+
*/
|
|
364
|
+
phase_effective_at?: SubscriptionData.PhaseEffectiveAt | null;
|
|
365
|
+
/**
|
|
366
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
367
|
+
*/
|
|
368
|
+
prebilling?: SubscriptionData.Prebilling | null;
|
|
369
|
+
/**
|
|
370
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
371
|
+
*/
|
|
372
|
+
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
272
373
|
/**
|
|
273
374
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
274
375
|
*/
|
|
275
376
|
trial_period_days: number | null;
|
|
276
377
|
}
|
|
378
|
+
interface SubscriptionDataOverride {
|
|
379
|
+
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
380
|
+
/**
|
|
381
|
+
* Describes the period to bill for upon accepting the quote.
|
|
382
|
+
*/
|
|
383
|
+
bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance | null;
|
|
384
|
+
/**
|
|
385
|
+
* 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.
|
|
386
|
+
*/
|
|
387
|
+
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
388
|
+
/**
|
|
389
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
|
|
390
|
+
*/
|
|
391
|
+
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
392
|
+
/**
|
|
393
|
+
* The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
|
|
394
|
+
*/
|
|
395
|
+
customer: string | null;
|
|
396
|
+
/**
|
|
397
|
+
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
398
|
+
*/
|
|
399
|
+
description: string | null;
|
|
400
|
+
/**
|
|
401
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
402
|
+
*/
|
|
403
|
+
end_behavior?: SubscriptionDataOverride.EndBehavior | null;
|
|
404
|
+
/**
|
|
405
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
406
|
+
*/
|
|
407
|
+
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt | null;
|
|
408
|
+
/**
|
|
409
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
410
|
+
*/
|
|
411
|
+
proration_behavior?: SubscriptionDataOverride.ProrationBehavior | null;
|
|
412
|
+
}
|
|
413
|
+
interface SubscriptionSchedule {
|
|
414
|
+
applies_to: SubscriptionSchedule.AppliesTo;
|
|
415
|
+
/**
|
|
416
|
+
* The subscription schedule that was created or updated from this quote.
|
|
417
|
+
*/
|
|
418
|
+
subscription_schedule: string;
|
|
419
|
+
}
|
|
277
420
|
interface TotalDetails {
|
|
278
421
|
/**
|
|
279
422
|
* This is the sum of all the discounts.
|
|
@@ -316,10 +459,20 @@ export declare namespace Quote {
|
|
|
316
459
|
}
|
|
317
460
|
type Status = 'complete' | 'failed' | 'requires_location_inputs' | OtherString;
|
|
318
461
|
namespace Liability {
|
|
319
|
-
type Type = 'account' | 'self' | OtherString;
|
|
462
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
320
463
|
}
|
|
321
464
|
}
|
|
322
465
|
namespace Computed {
|
|
466
|
+
interface LastReestimationDetails {
|
|
467
|
+
/**
|
|
468
|
+
* When `status` is `failed`, provides details about the quote reestimation failure.
|
|
469
|
+
*/
|
|
470
|
+
failed: LastReestimationDetails.Failed | null;
|
|
471
|
+
/**
|
|
472
|
+
* Latest status of the reestimation.
|
|
473
|
+
*/
|
|
474
|
+
status: LastReestimationDetails.Status;
|
|
475
|
+
}
|
|
323
476
|
interface Recurring {
|
|
324
477
|
/**
|
|
325
478
|
* Total before any discounts or taxes are applied.
|
|
@@ -354,6 +507,26 @@ export declare namespace Quote {
|
|
|
354
507
|
line_items?: ApiList<LineItem>;
|
|
355
508
|
total_details: Upfront.TotalDetails;
|
|
356
509
|
}
|
|
510
|
+
namespace LastReestimationDetails {
|
|
511
|
+
interface Failed {
|
|
512
|
+
/**
|
|
513
|
+
* The failure `code` is more granular than the `reason` provided and may correspond to a Stripe error code. For automation errors, this field is one of: `reverse_api_failure`, `reverse_api_deadline_exceeeded`, or `reverse_api_response_validation_error`, which are Stripe error codes and map to the error `message` field.
|
|
514
|
+
*/
|
|
515
|
+
failure_code: string | null;
|
|
516
|
+
/**
|
|
517
|
+
* Information derived from the `failure_code` or a freeform message that explains the error as a human-readable English string. For example, "margin ID is not a valid ID".
|
|
518
|
+
*/
|
|
519
|
+
message: string | null;
|
|
520
|
+
/**
|
|
521
|
+
* The reason the reestimation failed.
|
|
522
|
+
*/
|
|
523
|
+
reason: Failed.Reason;
|
|
524
|
+
}
|
|
525
|
+
type Status = 'failed' | 'in_progress' | 'succeeded' | OtherString;
|
|
526
|
+
namespace Failed {
|
|
527
|
+
type Reason = 'automation_failure' | 'internal_error' | OtherString;
|
|
528
|
+
}
|
|
529
|
+
}
|
|
357
530
|
namespace Recurring {
|
|
358
531
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
359
532
|
interface TotalDetails {
|
|
@@ -512,10 +685,117 @@ export declare namespace Quote {
|
|
|
512
685
|
type: Issuer.Type;
|
|
513
686
|
}
|
|
514
687
|
namespace Issuer {
|
|
515
|
-
type Type = 'account' | 'self' | OtherString;
|
|
688
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
689
|
+
}
|
|
690
|
+
}
|
|
691
|
+
namespace StatusDetails {
|
|
692
|
+
interface Canceled {
|
|
693
|
+
/**
|
|
694
|
+
* The reason this quote was marked as canceled.
|
|
695
|
+
*/
|
|
696
|
+
reason: Canceled.Reason | null;
|
|
697
|
+
/**
|
|
698
|
+
* Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.
|
|
699
|
+
*/
|
|
700
|
+
transitioned_at: number | null;
|
|
701
|
+
}
|
|
702
|
+
interface Stale {
|
|
703
|
+
/**
|
|
704
|
+
* Time at which the quote expires. Measured in seconds since the Unix epoch.
|
|
705
|
+
*/
|
|
706
|
+
expires_at: number | null;
|
|
707
|
+
/**
|
|
708
|
+
* The most recent reason this quote was marked as stale.
|
|
709
|
+
*/
|
|
710
|
+
last_reason: Stale.LastReason | null;
|
|
711
|
+
/**
|
|
712
|
+
* Time at which the stale reason was updated. Measured in seconds since the Unix epoch.
|
|
713
|
+
*/
|
|
714
|
+
last_updated_at: number | null;
|
|
715
|
+
/**
|
|
716
|
+
* Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.
|
|
717
|
+
*/
|
|
718
|
+
transitioned_at: number | null;
|
|
719
|
+
}
|
|
720
|
+
namespace Canceled {
|
|
721
|
+
type Reason = 'canceled' | 'quote_accepted' | 'quote_expired' | 'quote_superseded' | 'subscription_canceled' | OtherString;
|
|
722
|
+
}
|
|
723
|
+
namespace Stale {
|
|
724
|
+
interface LastReason {
|
|
725
|
+
/**
|
|
726
|
+
* The ID of the line that is invalid if the stale reason type is `line_invalid`.
|
|
727
|
+
*/
|
|
728
|
+
line_invalid?: string;
|
|
729
|
+
/**
|
|
730
|
+
* The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.
|
|
731
|
+
*/
|
|
732
|
+
lines_invalid?: Array<LastReason.LinesInvalid>;
|
|
733
|
+
/**
|
|
734
|
+
* The user supplied mark stale reason.
|
|
735
|
+
*/
|
|
736
|
+
marked_stale?: string | null;
|
|
737
|
+
/**
|
|
738
|
+
* The ID of the subscription that was canceled.
|
|
739
|
+
*/
|
|
740
|
+
subscription_canceled?: string;
|
|
741
|
+
subscription_changed?: LastReason.SubscriptionChanged;
|
|
742
|
+
/**
|
|
743
|
+
* The ID of the subscription that was expired.
|
|
744
|
+
*/
|
|
745
|
+
subscription_expired?: string;
|
|
746
|
+
/**
|
|
747
|
+
* The ID of the subscription schedule that was canceled.
|
|
748
|
+
*/
|
|
749
|
+
subscription_schedule_canceled?: string;
|
|
750
|
+
subscription_schedule_changed?: LastReason.SubscriptionScheduleChanged;
|
|
751
|
+
/**
|
|
752
|
+
* The ID of the subscription schedule that was released.
|
|
753
|
+
*/
|
|
754
|
+
subscription_schedule_released?: string;
|
|
755
|
+
/**
|
|
756
|
+
* The reason the quote was marked as stale.
|
|
757
|
+
*/
|
|
758
|
+
type: LastReason.Type | null;
|
|
759
|
+
}
|
|
760
|
+
namespace LastReason {
|
|
761
|
+
interface LinesInvalid {
|
|
762
|
+
/**
|
|
763
|
+
* The timestamp at which the lines were marked as invalid.
|
|
764
|
+
*/
|
|
765
|
+
invalid_at: number;
|
|
766
|
+
/**
|
|
767
|
+
* The list of lines that became invalid at the given timestamp.
|
|
768
|
+
*/
|
|
769
|
+
lines: Array<string>;
|
|
770
|
+
}
|
|
771
|
+
interface SubscriptionChanged {
|
|
772
|
+
/**
|
|
773
|
+
* The subscription's state before the quote was marked as stale.
|
|
774
|
+
*/
|
|
775
|
+
previous_subscription: Subscription | null;
|
|
776
|
+
}
|
|
777
|
+
interface SubscriptionScheduleChanged {
|
|
778
|
+
/**
|
|
779
|
+
* The subscription schedule's state before the quote was marked as stale.
|
|
780
|
+
*/
|
|
781
|
+
previous_subscription_schedule: SubscriptionSchedule | null;
|
|
782
|
+
}
|
|
783
|
+
type Type = 'accept_failed_validations' | 'bill_on_acceptance_invalid' | 'billing_schedules_invalid' | 'line_invalid' | 'lines_invalid' | 'marked_stale' | 'subscription_canceled' | 'subscription_changed' | 'subscription_expired' | 'subscription_schedule_canceled' | 'subscription_schedule_changed' | 'subscription_schedule_released';
|
|
784
|
+
}
|
|
516
785
|
}
|
|
517
786
|
}
|
|
518
787
|
namespace SubscriptionData {
|
|
788
|
+
interface BillOnAcceptance {
|
|
789
|
+
/**
|
|
790
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
791
|
+
*/
|
|
792
|
+
bill_from: BillOnAcceptance.BillFrom | null;
|
|
793
|
+
/**
|
|
794
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
795
|
+
*/
|
|
796
|
+
bill_until: BillOnAcceptance.BillUntil | null;
|
|
797
|
+
}
|
|
798
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
519
799
|
interface BillingMode {
|
|
520
800
|
flexible?: BillingMode.Flexible;
|
|
521
801
|
/**
|
|
@@ -523,6 +803,27 @@ export declare namespace Quote {
|
|
|
523
803
|
*/
|
|
524
804
|
type: BillingMode.Type;
|
|
525
805
|
}
|
|
806
|
+
interface BillingSchedule {
|
|
807
|
+
/**
|
|
808
|
+
* Specifies which subscription items the billing schedule applies to.
|
|
809
|
+
*/
|
|
810
|
+
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
811
|
+
/**
|
|
812
|
+
* Specifies the start of the billing period.
|
|
813
|
+
*/
|
|
814
|
+
bill_from?: BillingSchedule.BillFrom | null;
|
|
815
|
+
bill_until: BillingSchedule.BillUntil;
|
|
816
|
+
/**
|
|
817
|
+
* Unique identifier for the billing schedule.
|
|
818
|
+
*/
|
|
819
|
+
key: string;
|
|
820
|
+
}
|
|
821
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
822
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
823
|
+
interface Prebilling {
|
|
824
|
+
iterations: number;
|
|
825
|
+
}
|
|
826
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
526
827
|
namespace BillingMode {
|
|
527
828
|
interface Flexible {
|
|
528
829
|
/**
|
|
@@ -535,80 +836,463 @@ export declare namespace Quote {
|
|
|
535
836
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
536
837
|
}
|
|
537
838
|
}
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
839
|
+
namespace BillingSchedule {
|
|
840
|
+
interface AppliesTo {
|
|
841
|
+
/**
|
|
842
|
+
* The billing schedule will apply to the subscription item with the given price ID.
|
|
843
|
+
*/
|
|
844
|
+
price: string | Price | null;
|
|
845
|
+
/**
|
|
846
|
+
* Controls which subscription items the billing schedule applies to.
|
|
847
|
+
*/
|
|
848
|
+
type: 'price';
|
|
849
|
+
}
|
|
850
|
+
interface BillFrom {
|
|
851
|
+
/**
|
|
852
|
+
* The time the billing schedule applies from.
|
|
853
|
+
*/
|
|
854
|
+
computed_timestamp: number | null;
|
|
855
|
+
/**
|
|
856
|
+
* Lets you bill the period starting from a particular Quote line.
|
|
857
|
+
*/
|
|
858
|
+
line_starts_at: BillFrom.LineStartsAt | null;
|
|
859
|
+
/**
|
|
860
|
+
* Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
|
|
861
|
+
*/
|
|
862
|
+
timestamp: number | null;
|
|
863
|
+
/**
|
|
864
|
+
* Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
|
|
865
|
+
*/
|
|
866
|
+
type: BillFrom.Type;
|
|
867
|
+
}
|
|
868
|
+
interface BillUntil {
|
|
869
|
+
/**
|
|
870
|
+
* The timestamp the billing schedule will apply until.
|
|
871
|
+
*/
|
|
872
|
+
computed_timestamp: number | null;
|
|
873
|
+
/**
|
|
874
|
+
* Specifies the billing period.
|
|
875
|
+
*/
|
|
876
|
+
duration: BillUntil.Duration | null;
|
|
877
|
+
/**
|
|
878
|
+
* Lets you bill the period ending at a particular Quote line.
|
|
879
|
+
*/
|
|
880
|
+
line_ends_at?: BillUntil.LineEndsAt | null;
|
|
881
|
+
/**
|
|
882
|
+
* If specified, the billing schedule will apply until the specified timestamp.
|
|
883
|
+
*/
|
|
884
|
+
timestamp: number | null;
|
|
885
|
+
/**
|
|
886
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
887
|
+
*/
|
|
888
|
+
type: BillUntil.Type;
|
|
889
|
+
}
|
|
890
|
+
namespace BillFrom {
|
|
891
|
+
interface LineStartsAt {
|
|
892
|
+
/**
|
|
893
|
+
* Unique identifier for the object.
|
|
894
|
+
*/
|
|
895
|
+
id: string;
|
|
896
|
+
}
|
|
897
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
898
|
+
}
|
|
899
|
+
namespace BillUntil {
|
|
900
|
+
interface Duration {
|
|
901
|
+
/**
|
|
902
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
903
|
+
*/
|
|
904
|
+
interval: Duration.Interval;
|
|
905
|
+
/**
|
|
906
|
+
* The multiplier applied to the interval.
|
|
907
|
+
*/
|
|
908
|
+
interval_count: number | null;
|
|
909
|
+
}
|
|
910
|
+
interface LineEndsAt {
|
|
911
|
+
/**
|
|
912
|
+
* Unique identifier for the object.
|
|
913
|
+
*/
|
|
914
|
+
id: string;
|
|
915
|
+
}
|
|
916
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
917
|
+
namespace Duration {
|
|
918
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
919
|
+
}
|
|
920
|
+
}
|
|
549
921
|
}
|
|
550
|
-
namespace
|
|
551
|
-
interface
|
|
922
|
+
namespace BillOnAcceptance {
|
|
923
|
+
interface BillFrom {
|
|
552
924
|
/**
|
|
553
|
-
* The
|
|
925
|
+
* The materialized time.
|
|
554
926
|
*/
|
|
555
|
-
|
|
927
|
+
computed: number | null;
|
|
556
928
|
/**
|
|
557
|
-
*
|
|
558
|
-
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
559
|
-
*
|
|
560
|
-
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
929
|
+
* The timestamp the given line starts at.
|
|
561
930
|
*/
|
|
562
|
-
|
|
931
|
+
line_starts_at: BillFrom.LineStartsAt | null;
|
|
932
|
+
/**
|
|
933
|
+
* A precise Unix timestamp.
|
|
934
|
+
*/
|
|
935
|
+
timestamp: number | null;
|
|
936
|
+
/**
|
|
937
|
+
* The type of method to specify the `bill_from` time.
|
|
938
|
+
*/
|
|
939
|
+
type: BillFrom.Type;
|
|
563
940
|
}
|
|
564
|
-
interface
|
|
941
|
+
interface BillUntil {
|
|
565
942
|
/**
|
|
566
|
-
*
|
|
943
|
+
* The materialized time.
|
|
567
944
|
*/
|
|
568
|
-
|
|
945
|
+
computed: number | null;
|
|
569
946
|
/**
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
947
|
+
* Time span for the quote line starting from the `starts_at` date.
|
|
573
948
|
*/
|
|
574
|
-
|
|
949
|
+
duration: BillUntil.Duration | null;
|
|
575
950
|
/**
|
|
576
|
-
* The
|
|
951
|
+
* The timestamp the given line ends at.
|
|
577
952
|
*/
|
|
578
|
-
|
|
953
|
+
line_ends_at: BillUntil.LineEndsAt | null;
|
|
579
954
|
/**
|
|
580
|
-
*
|
|
955
|
+
* A precise Unix timestamp.
|
|
581
956
|
*/
|
|
582
|
-
|
|
957
|
+
timestamp: number | null;
|
|
958
|
+
/**
|
|
959
|
+
* The type of method to specify the `bill_until` time.
|
|
960
|
+
*/
|
|
961
|
+
type: BillUntil.Type;
|
|
583
962
|
}
|
|
584
|
-
namespace
|
|
585
|
-
|
|
963
|
+
namespace BillFrom {
|
|
964
|
+
interface LineStartsAt {
|
|
965
|
+
/**
|
|
966
|
+
* Unique identifier for the object.
|
|
967
|
+
*/
|
|
968
|
+
id: string;
|
|
969
|
+
}
|
|
970
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
971
|
+
}
|
|
972
|
+
namespace BillUntil {
|
|
973
|
+
interface Duration {
|
|
974
|
+
/**
|
|
975
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
976
|
+
*/
|
|
977
|
+
interval: Duration.Interval;
|
|
978
|
+
/**
|
|
979
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
980
|
+
*/
|
|
981
|
+
interval_count: number;
|
|
982
|
+
}
|
|
983
|
+
interface LineEndsAt {
|
|
984
|
+
/**
|
|
985
|
+
* Unique identifier for the object.
|
|
986
|
+
*/
|
|
987
|
+
id: string;
|
|
988
|
+
}
|
|
989
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
990
|
+
namespace Duration {
|
|
991
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
992
|
+
}
|
|
586
993
|
}
|
|
587
994
|
}
|
|
588
995
|
}
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
996
|
+
namespace SubscriptionDataOverride {
|
|
997
|
+
interface AppliesTo {
|
|
998
|
+
/**
|
|
999
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
1000
|
+
*/
|
|
1001
|
+
new_reference: string | null;
|
|
1002
|
+
/**
|
|
1003
|
+
* The ID of the schedule the line applies to.
|
|
1004
|
+
*/
|
|
1005
|
+
subscription_schedule: string | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
1008
|
+
*/
|
|
1009
|
+
type: AppliesTo.Type;
|
|
1010
|
+
}
|
|
1011
|
+
interface BillOnAcceptance {
|
|
1012
|
+
/**
|
|
1013
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
1014
|
+
*/
|
|
1015
|
+
bill_from: BillOnAcceptance.BillFrom | null;
|
|
1016
|
+
/**
|
|
1017
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
1018
|
+
*/
|
|
1019
|
+
bill_until: BillOnAcceptance.BillUntil | null;
|
|
1020
|
+
}
|
|
1021
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1022
|
+
interface BillingSchedule {
|
|
1023
|
+
/**
|
|
1024
|
+
* Specifies which subscription items the billing schedule applies to.
|
|
1025
|
+
*/
|
|
1026
|
+
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
1027
|
+
/**
|
|
1028
|
+
* Specifies the start of the billing period.
|
|
1029
|
+
*/
|
|
1030
|
+
bill_from?: BillingSchedule.BillFrom | null;
|
|
1031
|
+
bill_until: BillingSchedule.BillUntil;
|
|
1032
|
+
/**
|
|
1033
|
+
* Unique identifier for the billing schedule.
|
|
1034
|
+
*/
|
|
1035
|
+
key: string;
|
|
1036
|
+
}
|
|
1037
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
1038
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
1039
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1040
|
+
namespace AppliesTo {
|
|
1041
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
1042
|
+
}
|
|
1043
|
+
namespace BillingSchedule {
|
|
1044
|
+
interface AppliesTo {
|
|
1045
|
+
/**
|
|
1046
|
+
* The billing schedule will apply to the subscription item with the given price ID.
|
|
1047
|
+
*/
|
|
1048
|
+
price: string | Price | null;
|
|
1049
|
+
/**
|
|
1050
|
+
* Controls which subscription items the billing schedule applies to.
|
|
1051
|
+
*/
|
|
1052
|
+
type: 'price';
|
|
1053
|
+
}
|
|
1054
|
+
interface BillFrom {
|
|
1055
|
+
/**
|
|
1056
|
+
* The time the billing schedule applies from.
|
|
1057
|
+
*/
|
|
1058
|
+
computed_timestamp: number | null;
|
|
1059
|
+
/**
|
|
1060
|
+
* Lets you bill the period starting from a particular Quote line.
|
|
1061
|
+
*/
|
|
1062
|
+
line_starts_at: BillFrom.LineStartsAt | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
|
|
1065
|
+
*/
|
|
1066
|
+
timestamp: number | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
|
|
1069
|
+
*/
|
|
1070
|
+
type: BillFrom.Type;
|
|
1071
|
+
}
|
|
1072
|
+
interface BillUntil {
|
|
1073
|
+
/**
|
|
1074
|
+
* The timestamp the billing schedule will apply until.
|
|
1075
|
+
*/
|
|
1076
|
+
computed_timestamp: number | null;
|
|
1077
|
+
/**
|
|
1078
|
+
* Specifies the billing period.
|
|
1079
|
+
*/
|
|
1080
|
+
duration: BillUntil.Duration | null;
|
|
1081
|
+
/**
|
|
1082
|
+
* Lets you bill the period ending at a particular Quote line.
|
|
1083
|
+
*/
|
|
1084
|
+
line_ends_at?: BillUntil.LineEndsAt | null;
|
|
1085
|
+
/**
|
|
1086
|
+
* If specified, the billing schedule will apply until the specified timestamp.
|
|
1087
|
+
*/
|
|
1088
|
+
timestamp: number | null;
|
|
1089
|
+
/**
|
|
1090
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1091
|
+
*/
|
|
1092
|
+
type: BillUntil.Type;
|
|
1093
|
+
}
|
|
1094
|
+
namespace BillFrom {
|
|
1095
|
+
interface LineStartsAt {
|
|
1096
|
+
/**
|
|
1097
|
+
* Unique identifier for the object.
|
|
1098
|
+
*/
|
|
1099
|
+
id: string;
|
|
1100
|
+
}
|
|
1101
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
1102
|
+
}
|
|
1103
|
+
namespace BillUntil {
|
|
1104
|
+
interface Duration {
|
|
1105
|
+
/**
|
|
1106
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1107
|
+
*/
|
|
1108
|
+
interval: Duration.Interval;
|
|
1109
|
+
/**
|
|
1110
|
+
* The multiplier applied to the interval.
|
|
1111
|
+
*/
|
|
1112
|
+
interval_count: number | null;
|
|
1113
|
+
}
|
|
1114
|
+
interface LineEndsAt {
|
|
1115
|
+
/**
|
|
1116
|
+
* Unique identifier for the object.
|
|
1117
|
+
*/
|
|
1118
|
+
id: string;
|
|
1119
|
+
}
|
|
1120
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
1121
|
+
namespace Duration {
|
|
1122
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1123
|
+
}
|
|
1124
|
+
}
|
|
1125
|
+
}
|
|
1126
|
+
namespace BillOnAcceptance {
|
|
1127
|
+
interface BillFrom {
|
|
1128
|
+
/**
|
|
1129
|
+
* The materialized time.
|
|
1130
|
+
*/
|
|
1131
|
+
computed: number | null;
|
|
1132
|
+
/**
|
|
1133
|
+
* The timestamp the given line starts at.
|
|
1134
|
+
*/
|
|
1135
|
+
line_starts_at: BillFrom.LineStartsAt | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* A precise Unix timestamp.
|
|
1138
|
+
*/
|
|
1139
|
+
timestamp: number | null;
|
|
1140
|
+
/**
|
|
1141
|
+
* The type of method to specify the `bill_from` time.
|
|
1142
|
+
*/
|
|
1143
|
+
type: BillFrom.Type;
|
|
1144
|
+
}
|
|
1145
|
+
interface BillUntil {
|
|
1146
|
+
/**
|
|
1147
|
+
* The materialized time.
|
|
1148
|
+
*/
|
|
1149
|
+
computed: number | null;
|
|
1150
|
+
/**
|
|
1151
|
+
* Time span for the quote line starting from the `starts_at` date.
|
|
1152
|
+
*/
|
|
1153
|
+
duration: BillUntil.Duration | null;
|
|
1154
|
+
/**
|
|
1155
|
+
* The timestamp the given line ends at.
|
|
1156
|
+
*/
|
|
1157
|
+
line_ends_at: BillUntil.LineEndsAt | null;
|
|
1158
|
+
/**
|
|
1159
|
+
* A precise Unix timestamp.
|
|
1160
|
+
*/
|
|
1161
|
+
timestamp: number | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* The type of method to specify the `bill_until` time.
|
|
1164
|
+
*/
|
|
1165
|
+
type: BillUntil.Type;
|
|
1166
|
+
}
|
|
1167
|
+
namespace BillFrom {
|
|
1168
|
+
interface LineStartsAt {
|
|
1169
|
+
/**
|
|
1170
|
+
* Unique identifier for the object.
|
|
1171
|
+
*/
|
|
1172
|
+
id: string;
|
|
1173
|
+
}
|
|
1174
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
1175
|
+
}
|
|
1176
|
+
namespace BillUntil {
|
|
1177
|
+
interface Duration {
|
|
1178
|
+
/**
|
|
1179
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1180
|
+
*/
|
|
1181
|
+
interval: Duration.Interval;
|
|
1182
|
+
/**
|
|
1183
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1184
|
+
*/
|
|
1185
|
+
interval_count: number;
|
|
1186
|
+
}
|
|
1187
|
+
interface LineEndsAt {
|
|
1188
|
+
/**
|
|
1189
|
+
* Unique identifier for the object.
|
|
1190
|
+
*/
|
|
1191
|
+
id: string;
|
|
1192
|
+
}
|
|
1193
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
1194
|
+
namespace Duration {
|
|
1195
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1196
|
+
}
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
namespace SubscriptionSchedule {
|
|
1201
|
+
interface AppliesTo {
|
|
1202
|
+
/**
|
|
1203
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
1204
|
+
*/
|
|
1205
|
+
new_reference: string | null;
|
|
1206
|
+
/**
|
|
1207
|
+
* The ID of the schedule the line applies to.
|
|
1208
|
+
*/
|
|
1209
|
+
subscription_schedule: string | null;
|
|
1210
|
+
/**
|
|
1211
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
1212
|
+
*/
|
|
1213
|
+
type: AppliesTo.Type;
|
|
1214
|
+
}
|
|
1215
|
+
namespace AppliesTo {
|
|
1216
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
1217
|
+
}
|
|
1218
|
+
}
|
|
1219
|
+
namespace TotalDetails {
|
|
1220
|
+
interface Breakdown {
|
|
1221
|
+
/**
|
|
1222
|
+
* The aggregated discounts.
|
|
1223
|
+
*/
|
|
1224
|
+
discounts: Array<Breakdown.Discount>;
|
|
1225
|
+
/**
|
|
1226
|
+
* The aggregated tax amounts by rate.
|
|
1227
|
+
*/
|
|
1228
|
+
taxes: Array<Breakdown.Tax>;
|
|
1229
|
+
}
|
|
1230
|
+
namespace Breakdown {
|
|
1231
|
+
interface Discount {
|
|
1232
|
+
/**
|
|
1233
|
+
* The amount discounted.
|
|
1234
|
+
*/
|
|
1235
|
+
amount: number;
|
|
1236
|
+
/**
|
|
1237
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
1238
|
+
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
1239
|
+
*
|
|
1240
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
1241
|
+
*/
|
|
1242
|
+
discount: _Discount;
|
|
1243
|
+
}
|
|
1244
|
+
interface Tax {
|
|
1245
|
+
/**
|
|
1246
|
+
* Amount of tax applied for this rate.
|
|
1247
|
+
*/
|
|
1248
|
+
amount: number;
|
|
1249
|
+
/**
|
|
1250
|
+
* Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
|
|
1251
|
+
*
|
|
1252
|
+
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
1253
|
+
*/
|
|
1254
|
+
rate: TaxRate;
|
|
1255
|
+
/**
|
|
1256
|
+
* The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
|
1257
|
+
*/
|
|
1258
|
+
taxability_reason: Tax.TaxabilityReason | null;
|
|
1259
|
+
/**
|
|
1260
|
+
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
1261
|
+
*/
|
|
1262
|
+
taxable_amount: number | null;
|
|
1263
|
+
}
|
|
1264
|
+
namespace Tax {
|
|
1265
|
+
type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated' | OtherString;
|
|
1266
|
+
}
|
|
1267
|
+
}
|
|
1268
|
+
}
|
|
1269
|
+
}
|
|
1270
|
+
export interface QuoteCreateParams {
|
|
1271
|
+
/**
|
|
1272
|
+
* Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
|
|
1273
|
+
*/
|
|
1274
|
+
allow_backdated_lines?: boolean;
|
|
1275
|
+
/**
|
|
1276
|
+
* The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
|
|
1277
|
+
*/
|
|
1278
|
+
application_fee_amount?: Emptyable<number>;
|
|
1279
|
+
/**
|
|
1280
|
+
* 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. There must be at least 1 line item with a recurring price to use this field.
|
|
1281
|
+
*/
|
|
1282
|
+
application_fee_percent?: Emptyable<number>;
|
|
1283
|
+
/**
|
|
1284
|
+
* Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
|
|
1285
|
+
*/
|
|
1286
|
+
automatic_tax?: QuoteCreateParams.AutomaticTax;
|
|
1287
|
+
/**
|
|
1288
|
+
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
|
|
1289
|
+
*/
|
|
1290
|
+
collection_method?: QuoteCreateParams.CollectionMethod;
|
|
1291
|
+
/**
|
|
1292
|
+
* The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
|
|
1293
|
+
*/
|
|
1294
|
+
customer?: string;
|
|
1295
|
+
/**
|
|
612
1296
|
* The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
|
|
613
1297
|
*/
|
|
614
1298
|
customer_account?: string;
|
|
@@ -652,6 +1336,10 @@ export interface QuoteCreateParams {
|
|
|
652
1336
|
* A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
|
|
653
1337
|
*/
|
|
654
1338
|
line_items?: Array<QuoteCreateParams.LineItem>;
|
|
1339
|
+
/**
|
|
1340
|
+
* A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
|
1341
|
+
*/
|
|
1342
|
+
lines?: Array<QuoteCreateParams.Line>;
|
|
655
1343
|
/**
|
|
656
1344
|
* 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`.
|
|
657
1345
|
*/
|
|
@@ -664,6 +1352,10 @@ export interface QuoteCreateParams {
|
|
|
664
1352
|
* When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
|
|
665
1353
|
*/
|
|
666
1354
|
subscription_data?: QuoteCreateParams.SubscriptionData;
|
|
1355
|
+
/**
|
|
1356
|
+
* List representing overrides for `subscription_data` configurations for specific subscription schedules.
|
|
1357
|
+
*/
|
|
1358
|
+
subscription_data_overrides?: Array<QuoteCreateParams.SubscriptionDataOverride>;
|
|
667
1359
|
/**
|
|
668
1360
|
* ID of the test clock to attach to the quote.
|
|
669
1361
|
*/
|
|
@@ -694,6 +1386,10 @@ export declare namespace QuoteCreateParams {
|
|
|
694
1386
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
695
1387
|
*/
|
|
696
1388
|
discount?: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* Details to determine how long the discount should be applied for.
|
|
1391
|
+
*/
|
|
1392
|
+
discount_end?: Discount.DiscountEnd;
|
|
697
1393
|
/**
|
|
698
1394
|
* ID of the promotion code to create a new discount for.
|
|
699
1395
|
*/
|
|
@@ -753,28 +1449,160 @@ export declare namespace QuoteCreateParams {
|
|
|
753
1449
|
*/
|
|
754
1450
|
tax_rates?: Emptyable<Array<string>>;
|
|
755
1451
|
}
|
|
1452
|
+
interface Line {
|
|
1453
|
+
/**
|
|
1454
|
+
* An array of operations the quote line performs.
|
|
1455
|
+
*/
|
|
1456
|
+
actions?: Array<Line.Action>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Details to identify the subscription schedule the quote line applies to.
|
|
1459
|
+
*/
|
|
1460
|
+
applies_to?: Line.AppliesTo;
|
|
1461
|
+
/**
|
|
1462
|
+
* For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp. For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
|
|
1463
|
+
*/
|
|
1464
|
+
billing_cycle_anchor?: Line.BillingCycleAnchor;
|
|
1465
|
+
/**
|
|
1466
|
+
* A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
|
|
1467
|
+
*/
|
|
1468
|
+
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
1469
|
+
/**
|
|
1470
|
+
* Configures how the quote handles billing for line transitions.
|
|
1471
|
+
*/
|
|
1472
|
+
effective_at?: Line.EffectiveAt;
|
|
1473
|
+
/**
|
|
1474
|
+
* Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
|
1475
|
+
*/
|
|
1476
|
+
ends_at?: Line.EndsAt;
|
|
1477
|
+
/**
|
|
1478
|
+
* Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
|
|
1479
|
+
*/
|
|
1480
|
+
proration_behavior?: Line.ProrationBehavior;
|
|
1481
|
+
/**
|
|
1482
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
1483
|
+
*/
|
|
1484
|
+
set_pause_collection?: Line.SetPauseCollection;
|
|
1485
|
+
/**
|
|
1486
|
+
* Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
|
|
1487
|
+
*/
|
|
1488
|
+
set_schedule_end?: Line.SetScheduleEnd;
|
|
1489
|
+
/**
|
|
1490
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
1491
|
+
*/
|
|
1492
|
+
starts_at?: Line.StartsAt;
|
|
1493
|
+
/**
|
|
1494
|
+
* Settings related to subscription trials.
|
|
1495
|
+
*/
|
|
1496
|
+
trial_settings?: Line.TrialSettings;
|
|
1497
|
+
}
|
|
756
1498
|
interface SubscriptionData {
|
|
1499
|
+
/**
|
|
1500
|
+
* Describes the period to bill for upon accepting the quote.
|
|
1501
|
+
*/
|
|
1502
|
+
bill_on_acceptance?: SubscriptionData.BillOnAcceptance;
|
|
1503
|
+
/**
|
|
1504
|
+
* 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.
|
|
1505
|
+
*/
|
|
1506
|
+
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
1507
|
+
/**
|
|
1508
|
+
* When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
|
1509
|
+
*/
|
|
1510
|
+
billing_cycle_anchor?: Emptyable<'reset'>;
|
|
757
1511
|
/**
|
|
758
1512
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
759
1513
|
*/
|
|
760
1514
|
billing_mode?: SubscriptionData.BillingMode;
|
|
1515
|
+
/**
|
|
1516
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1517
|
+
*/
|
|
1518
|
+
billing_schedules?: Array<SubscriptionData.BillingSchedule>;
|
|
761
1519
|
/**
|
|
762
1520
|
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
763
1521
|
*/
|
|
764
1522
|
description?: string;
|
|
765
1523
|
/**
|
|
766
|
-
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
1524
|
+
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
767
1525
|
*/
|
|
768
1526
|
effective_date?: Emptyable<'current_period_end' | number>;
|
|
1527
|
+
/**
|
|
1528
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1529
|
+
*/
|
|
1530
|
+
end_behavior?: SubscriptionData.EndBehavior;
|
|
1531
|
+
/**
|
|
1532
|
+
* The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
|
|
1533
|
+
*/
|
|
1534
|
+
from_subscription?: string;
|
|
769
1535
|
/**
|
|
770
1536
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
771
1537
|
*/
|
|
772
1538
|
metadata?: MetadataParam;
|
|
1539
|
+
/**
|
|
1540
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
1541
|
+
*/
|
|
1542
|
+
phase_effective_at?: SubscriptionData.PhaseEffectiveAt;
|
|
1543
|
+
/**
|
|
1544
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
1545
|
+
*/
|
|
1546
|
+
prebilling?: Emptyable<SubscriptionData.Prebilling>;
|
|
1547
|
+
/**
|
|
1548
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1549
|
+
*
|
|
1550
|
+
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1551
|
+
*
|
|
1552
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
1553
|
+
*
|
|
1554
|
+
* Prorations can be disabled by passing `none`.
|
|
1555
|
+
*/
|
|
1556
|
+
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
773
1557
|
/**
|
|
774
1558
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
775
1559
|
*/
|
|
776
1560
|
trial_period_days?: Emptyable<number>;
|
|
777
1561
|
}
|
|
1562
|
+
interface SubscriptionDataOverride {
|
|
1563
|
+
/**
|
|
1564
|
+
* Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
|
|
1565
|
+
*/
|
|
1566
|
+
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
1567
|
+
/**
|
|
1568
|
+
* Describes the period to bill for upon accepting the quote.
|
|
1569
|
+
*/
|
|
1570
|
+
bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance;
|
|
1571
|
+
/**
|
|
1572
|
+
* 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.
|
|
1573
|
+
*/
|
|
1574
|
+
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
1575
|
+
/**
|
|
1576
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1577
|
+
*/
|
|
1578
|
+
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
1579
|
+
/**
|
|
1580
|
+
* The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
|
|
1581
|
+
*/
|
|
1582
|
+
customer?: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
1585
|
+
*/
|
|
1586
|
+
description?: string;
|
|
1587
|
+
/**
|
|
1588
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1589
|
+
*/
|
|
1590
|
+
end_behavior?: SubscriptionDataOverride.EndBehavior;
|
|
1591
|
+
/**
|
|
1592
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
1593
|
+
*/
|
|
1594
|
+
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
1595
|
+
/**
|
|
1596
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1597
|
+
*
|
|
1598
|
+
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1599
|
+
*
|
|
1600
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
1601
|
+
*
|
|
1602
|
+
* Prorations can be disabled by passing `none`.
|
|
1603
|
+
*/
|
|
1604
|
+
proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
|
|
1605
|
+
}
|
|
778
1606
|
interface TransferData {
|
|
779
1607
|
/**
|
|
780
1608
|
* The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
|
|
@@ -801,21 +1629,53 @@ export declare namespace QuoteCreateParams {
|
|
|
801
1629
|
type: Liability.Type;
|
|
802
1630
|
}
|
|
803
1631
|
namespace Liability {
|
|
804
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1632
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
805
1633
|
}
|
|
806
1634
|
}
|
|
807
|
-
namespace
|
|
808
|
-
interface
|
|
1635
|
+
namespace Discount {
|
|
1636
|
+
interface DiscountEnd {
|
|
809
1637
|
/**
|
|
810
|
-
*
|
|
1638
|
+
* Time span for the redeemed discount.
|
|
811
1639
|
*/
|
|
812
|
-
|
|
1640
|
+
duration?: DiscountEnd.Duration;
|
|
813
1641
|
/**
|
|
814
|
-
*
|
|
1642
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
815
1643
|
*/
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
1644
|
+
timestamp?: number;
|
|
1645
|
+
/**
|
|
1646
|
+
* The type of calculation made to determine when the discount ends.
|
|
1647
|
+
*/
|
|
1648
|
+
type: DiscountEnd.Type;
|
|
1649
|
+
}
|
|
1650
|
+
namespace DiscountEnd {
|
|
1651
|
+
interface Duration {
|
|
1652
|
+
/**
|
|
1653
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1654
|
+
*/
|
|
1655
|
+
interval: Duration.Interval;
|
|
1656
|
+
/**
|
|
1657
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1658
|
+
*/
|
|
1659
|
+
interval_count: number;
|
|
1660
|
+
}
|
|
1661
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
1662
|
+
namespace Duration {
|
|
1663
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1664
|
+
}
|
|
1665
|
+
}
|
|
1666
|
+
}
|
|
1667
|
+
namespace InvoiceSettings {
|
|
1668
|
+
interface CustomField {
|
|
1669
|
+
/**
|
|
1670
|
+
* The name of the custom field. This may be up to 40 characters.
|
|
1671
|
+
*/
|
|
1672
|
+
name: string;
|
|
1673
|
+
/**
|
|
1674
|
+
* The value of the custom field. This may be up to 140 characters.
|
|
1675
|
+
*/
|
|
1676
|
+
value: string;
|
|
1677
|
+
}
|
|
1678
|
+
interface Issuer {
|
|
819
1679
|
/**
|
|
820
1680
|
* The connected account being referenced when `type` is `account`.
|
|
821
1681
|
*/
|
|
@@ -826,213 +1686,1328 @@ export declare namespace QuoteCreateParams {
|
|
|
826
1686
|
type: Issuer.Type;
|
|
827
1687
|
}
|
|
828
1688
|
namespace Issuer {
|
|
829
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1689
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
830
1690
|
}
|
|
831
1691
|
}
|
|
832
|
-
namespace
|
|
833
|
-
interface
|
|
1692
|
+
namespace Line {
|
|
1693
|
+
interface Action {
|
|
834
1694
|
/**
|
|
835
|
-
*
|
|
1695
|
+
* Details for the `add_discount` type.
|
|
836
1696
|
*/
|
|
837
|
-
|
|
1697
|
+
add_discount?: Action.AddDiscount;
|
|
838
1698
|
/**
|
|
839
|
-
*
|
|
1699
|
+
* Details for the `add_item` type.
|
|
840
1700
|
*/
|
|
841
|
-
|
|
1701
|
+
add_item?: Action.AddItem;
|
|
842
1702
|
/**
|
|
843
|
-
*
|
|
1703
|
+
* Details for the `add_metadata` type: specify a hash of key-value pairs.
|
|
844
1704
|
*/
|
|
845
|
-
|
|
1705
|
+
add_metadata?: {
|
|
1706
|
+
[key: string]: string;
|
|
1707
|
+
};
|
|
1708
|
+
/**
|
|
1709
|
+
* Details for the `remove_discount` type.
|
|
1710
|
+
*/
|
|
1711
|
+
remove_discount?: Action.RemoveDiscount;
|
|
1712
|
+
/**
|
|
1713
|
+
* Details for the `remove_item` type.
|
|
1714
|
+
*/
|
|
1715
|
+
remove_item?: Action.RemoveItem;
|
|
1716
|
+
/**
|
|
1717
|
+
* Details for the `remove_metadata` type: specify an array of metadata keys.
|
|
1718
|
+
*/
|
|
1719
|
+
remove_metadata?: Array<string>;
|
|
1720
|
+
/**
|
|
1721
|
+
* Details for the `set_discounts` type.
|
|
1722
|
+
*/
|
|
1723
|
+
set_discounts?: Array<Action.SetDiscount>;
|
|
1724
|
+
/**
|
|
1725
|
+
* Details for the `set_items` type.
|
|
1726
|
+
*/
|
|
1727
|
+
set_items?: Array<Action.SetItem>;
|
|
1728
|
+
/**
|
|
1729
|
+
* Details for the `set_metadata` type: specify an array of key-value pairs.
|
|
1730
|
+
*/
|
|
1731
|
+
set_metadata?: Emptyable<{
|
|
1732
|
+
[key: string]: string;
|
|
1733
|
+
}>;
|
|
1734
|
+
/**
|
|
1735
|
+
* The type of action the quote line performs.
|
|
1736
|
+
*/
|
|
1737
|
+
type: Action.Type;
|
|
846
1738
|
}
|
|
847
|
-
interface
|
|
1739
|
+
interface AppliesTo {
|
|
848
1740
|
/**
|
|
849
|
-
*
|
|
1741
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
850
1742
|
*/
|
|
851
|
-
|
|
1743
|
+
new_reference?: string;
|
|
852
1744
|
/**
|
|
853
|
-
* The ID of the
|
|
1745
|
+
* The ID of the schedule the line applies to.
|
|
854
1746
|
*/
|
|
855
|
-
|
|
1747
|
+
subscription_schedule?: string;
|
|
856
1748
|
/**
|
|
857
|
-
*
|
|
1749
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
858
1750
|
*/
|
|
859
|
-
|
|
1751
|
+
type: AppliesTo.Type;
|
|
1752
|
+
}
|
|
1753
|
+
type BillingCycleAnchor = 'automatic' | 'line_starts_at' | OtherString;
|
|
1754
|
+
interface CancelSubscriptionSchedule {
|
|
860
1755
|
/**
|
|
861
|
-
*
|
|
1756
|
+
* Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
|
|
862
1757
|
*/
|
|
863
|
-
|
|
1758
|
+
cancel_at: 'line_starts_at';
|
|
864
1759
|
/**
|
|
865
|
-
*
|
|
1760
|
+
* If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
|
|
866
1761
|
*/
|
|
867
|
-
|
|
1762
|
+
invoice_now?: boolean;
|
|
868
1763
|
/**
|
|
869
|
-
*
|
|
1764
|
+
* If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
|
|
870
1765
|
*/
|
|
871
|
-
|
|
1766
|
+
prorate?: boolean;
|
|
872
1767
|
}
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
1768
|
+
type EffectiveAt = 'billing_period_start' | 'line_start' | OtherString;
|
|
1769
|
+
interface EndsAt {
|
|
1770
|
+
/**
|
|
1771
|
+
* Use the `end` time of a given discount.
|
|
1772
|
+
*/
|
|
1773
|
+
discount_end?: EndsAt.DiscountEnd;
|
|
1774
|
+
/**
|
|
1775
|
+
* Time span for the quote line starting from the `starts_at` date.
|
|
1776
|
+
*/
|
|
1777
|
+
duration?: EndsAt.Duration;
|
|
1778
|
+
/**
|
|
1779
|
+
* A precise Unix timestamp.
|
|
1780
|
+
*/
|
|
1781
|
+
timestamp?: number;
|
|
1782
|
+
/**
|
|
1783
|
+
* Select a way to pass in `ends_at`.
|
|
1784
|
+
*/
|
|
1785
|
+
type: EndsAt.Type;
|
|
888
1786
|
}
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
interface BillingMode {
|
|
1787
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
1788
|
+
interface SetPauseCollection {
|
|
892
1789
|
/**
|
|
893
|
-
*
|
|
1790
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
894
1791
|
*/
|
|
895
|
-
|
|
1792
|
+
set?: SetPauseCollection.Set;
|
|
896
1793
|
/**
|
|
897
|
-
*
|
|
1794
|
+
* Determines the type of the pause_collection amendment.
|
|
898
1795
|
*/
|
|
899
|
-
type:
|
|
1796
|
+
type: SetPauseCollection.Type;
|
|
900
1797
|
}
|
|
901
|
-
|
|
902
|
-
|
|
1798
|
+
type SetScheduleEnd = 'line_ends_at' | 'line_starts_at' | OtherString;
|
|
1799
|
+
interface StartsAt {
|
|
1800
|
+
/**
|
|
1801
|
+
* Use the `end` time of a given discount.
|
|
1802
|
+
*/
|
|
1803
|
+
discount_end?: StartsAt.DiscountEnd;
|
|
1804
|
+
/**
|
|
1805
|
+
* The timestamp the given line ends at.
|
|
1806
|
+
*/
|
|
1807
|
+
line_ends_at?: StartsAt.LineEndsAt;
|
|
1808
|
+
/**
|
|
1809
|
+
* A precise Unix timestamp.
|
|
1810
|
+
*/
|
|
1811
|
+
timestamp?: number;
|
|
1812
|
+
/**
|
|
1813
|
+
* Select a way to pass in `starts_at`.
|
|
1814
|
+
*/
|
|
1815
|
+
type: StartsAt.Type;
|
|
1816
|
+
}
|
|
1817
|
+
interface TrialSettings {
|
|
1818
|
+
/**
|
|
1819
|
+
* Defines how the subscription should behave when a trial ends.
|
|
1820
|
+
*/
|
|
1821
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
1822
|
+
}
|
|
1823
|
+
namespace Action {
|
|
1824
|
+
interface AddDiscount {
|
|
903
1825
|
/**
|
|
904
|
-
*
|
|
1826
|
+
* The coupon code to redeem.
|
|
905
1827
|
*/
|
|
906
|
-
|
|
1828
|
+
coupon?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
1831
|
+
*/
|
|
1832
|
+
discount?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* Details to determine how long the discount should be applied for.
|
|
1835
|
+
*/
|
|
1836
|
+
discount_end?: AddDiscount.DiscountEnd;
|
|
1837
|
+
/**
|
|
1838
|
+
* 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.
|
|
1839
|
+
*/
|
|
1840
|
+
index?: number;
|
|
1841
|
+
/**
|
|
1842
|
+
* The promotion code to redeem.
|
|
1843
|
+
*/
|
|
1844
|
+
promotion_code?: string;
|
|
1845
|
+
/**
|
|
1846
|
+
* Settings for discount application including service period anchoring.
|
|
1847
|
+
*/
|
|
1848
|
+
settings?: AddDiscount.Settings;
|
|
907
1849
|
}
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
1850
|
+
interface AddItem {
|
|
1851
|
+
/**
|
|
1852
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
1853
|
+
*/
|
|
1854
|
+
discounts?: Array<AddItem.Discount>;
|
|
1855
|
+
/**
|
|
1856
|
+
* 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`.
|
|
1857
|
+
*/
|
|
1858
|
+
metadata?: MetadataParam;
|
|
1859
|
+
/**
|
|
1860
|
+
* The ID of the price object.
|
|
1861
|
+
*/
|
|
1862
|
+
price: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* Quantity for this item.
|
|
1865
|
+
*/
|
|
1866
|
+
quantity?: number;
|
|
1867
|
+
/**
|
|
1868
|
+
* 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`.
|
|
1869
|
+
*/
|
|
1870
|
+
tax_rates?: Array<string>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Options that configure the trial on the subscription item.
|
|
1873
|
+
*/
|
|
1874
|
+
trial?: AddItem.Trial;
|
|
1875
|
+
/**
|
|
1876
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
1877
|
+
*/
|
|
1878
|
+
trial_offer?: string;
|
|
911
1879
|
}
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1880
|
+
interface RemoveDiscount {
|
|
1881
|
+
/**
|
|
1882
|
+
* The coupon code to remove from the `discounts` array.
|
|
1883
|
+
*/
|
|
1884
|
+
coupon?: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
1887
|
+
*/
|
|
1888
|
+
discount?: string;
|
|
1889
|
+
/**
|
|
1890
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
1891
|
+
*/
|
|
1892
|
+
promotion_code?: string;
|
|
1893
|
+
}
|
|
1894
|
+
interface RemoveItem {
|
|
1895
|
+
/**
|
|
1896
|
+
* ID of a price to remove.
|
|
1897
|
+
*/
|
|
1898
|
+
price: string;
|
|
1899
|
+
}
|
|
1900
|
+
interface SetDiscount {
|
|
1901
|
+
/**
|
|
1902
|
+
* The coupon code to replace the `discounts` array with.
|
|
1903
|
+
*/
|
|
1904
|
+
coupon?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
1907
|
+
*/
|
|
1908
|
+
discount?: string;
|
|
1909
|
+
/**
|
|
1910
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
1911
|
+
*/
|
|
1912
|
+
promotion_code?: string;
|
|
1913
|
+
/**
|
|
1914
|
+
* Settings for discount application including service period anchoring.
|
|
1915
|
+
*/
|
|
1916
|
+
settings?: SetDiscount.Settings;
|
|
1917
|
+
}
|
|
1918
|
+
interface SetItem {
|
|
1919
|
+
/**
|
|
1920
|
+
* 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`.
|
|
1921
|
+
*/
|
|
1922
|
+
discounts?: Array<SetItem.Discount>;
|
|
1923
|
+
/**
|
|
1924
|
+
* 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`.
|
|
1925
|
+
*/
|
|
1926
|
+
metadata?: MetadataParam;
|
|
1927
|
+
/**
|
|
1928
|
+
* The ID of the price object.
|
|
1929
|
+
*/
|
|
1930
|
+
price: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* 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`.
|
|
1933
|
+
*/
|
|
1934
|
+
quantity?: number;
|
|
1935
|
+
/**
|
|
1936
|
+
* 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`.
|
|
1937
|
+
*/
|
|
1938
|
+
tax_rates?: Array<string>;
|
|
1939
|
+
/**
|
|
1940
|
+
* 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`.
|
|
1941
|
+
*/
|
|
1942
|
+
trial?: SetItem.Trial;
|
|
1943
|
+
/**
|
|
1944
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
1945
|
+
*/
|
|
1946
|
+
trial_offer?: string;
|
|
1947
|
+
}
|
|
1948
|
+
type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata' | OtherString;
|
|
1949
|
+
namespace AddDiscount {
|
|
1950
|
+
interface DiscountEnd {
|
|
1951
|
+
/**
|
|
1952
|
+
* The type of calculation made to determine when the discount ends.
|
|
1953
|
+
*/
|
|
1954
|
+
type: 'line_ends_at';
|
|
1955
|
+
}
|
|
1956
|
+
interface Settings {
|
|
1957
|
+
/**
|
|
1958
|
+
* Configures service period cycle anchoring.
|
|
1959
|
+
*/
|
|
1960
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1961
|
+
/**
|
|
1962
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
1963
|
+
*/
|
|
1964
|
+
start_date?: Settings.StartDate;
|
|
1965
|
+
}
|
|
1966
|
+
namespace Settings {
|
|
1967
|
+
interface ServicePeriodAnchorConfig {
|
|
1968
|
+
/**
|
|
1969
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1970
|
+
*/
|
|
1971
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1972
|
+
/**
|
|
1973
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1974
|
+
*/
|
|
1975
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
1976
|
+
}
|
|
1977
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
1978
|
+
namespace ServicePeriodAnchorConfig {
|
|
1979
|
+
interface Custom {
|
|
1980
|
+
/**
|
|
1981
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1982
|
+
*/
|
|
1983
|
+
day_of_month: number;
|
|
1984
|
+
/**
|
|
1985
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1986
|
+
*/
|
|
1987
|
+
hour?: number;
|
|
1988
|
+
/**
|
|
1989
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1990
|
+
*/
|
|
1991
|
+
minute?: number;
|
|
1992
|
+
/**
|
|
1993
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1994
|
+
*/
|
|
1995
|
+
month?: number;
|
|
1996
|
+
/**
|
|
1997
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1998
|
+
*/
|
|
1999
|
+
second?: number;
|
|
2000
|
+
}
|
|
2001
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2002
|
+
}
|
|
2003
|
+
}
|
|
2004
|
+
}
|
|
2005
|
+
namespace AddItem {
|
|
2006
|
+
interface Discount {
|
|
2007
|
+
/**
|
|
2008
|
+
* ID of the coupon to create a new discount for.
|
|
2009
|
+
*/
|
|
2010
|
+
coupon?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2013
|
+
*/
|
|
2014
|
+
discount?: string;
|
|
2015
|
+
/**
|
|
2016
|
+
* Details to determine how long the discount should be applied for.
|
|
2017
|
+
*/
|
|
2018
|
+
discount_end?: Discount.DiscountEnd;
|
|
2019
|
+
/**
|
|
2020
|
+
* ID of the promotion code to create a new discount for.
|
|
2021
|
+
*/
|
|
2022
|
+
promotion_code?: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* Settings for discount application including service period anchoring.
|
|
2025
|
+
*/
|
|
2026
|
+
settings?: Discount.Settings;
|
|
2027
|
+
}
|
|
2028
|
+
interface Trial {
|
|
2029
|
+
/**
|
|
2030
|
+
* 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.
|
|
2031
|
+
*/
|
|
2032
|
+
converts_to?: Array<string>;
|
|
2033
|
+
/**
|
|
2034
|
+
* Determines the type of trial for this item.
|
|
2035
|
+
*/
|
|
2036
|
+
type: Trial.Type;
|
|
2037
|
+
}
|
|
2038
|
+
namespace Discount {
|
|
2039
|
+
interface DiscountEnd {
|
|
2040
|
+
/**
|
|
2041
|
+
* Time span for the redeemed discount.
|
|
2042
|
+
*/
|
|
2043
|
+
duration?: DiscountEnd.Duration;
|
|
2044
|
+
/**
|
|
2045
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2046
|
+
*/
|
|
2047
|
+
timestamp?: number;
|
|
2048
|
+
/**
|
|
2049
|
+
* The type of calculation made to determine when the discount ends.
|
|
2050
|
+
*/
|
|
2051
|
+
type: DiscountEnd.Type;
|
|
2052
|
+
}
|
|
2053
|
+
interface Settings {
|
|
2054
|
+
/**
|
|
2055
|
+
* Configures service period cycle anchoring.
|
|
2056
|
+
*/
|
|
2057
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2058
|
+
/**
|
|
2059
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
2060
|
+
*/
|
|
2061
|
+
start_date?: Settings.StartDate;
|
|
2062
|
+
}
|
|
2063
|
+
namespace DiscountEnd {
|
|
2064
|
+
interface Duration {
|
|
2065
|
+
/**
|
|
2066
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2067
|
+
*/
|
|
2068
|
+
interval: Duration.Interval;
|
|
2069
|
+
/**
|
|
2070
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2071
|
+
*/
|
|
2072
|
+
interval_count: number;
|
|
2073
|
+
}
|
|
2074
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2075
|
+
namespace Duration {
|
|
2076
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2077
|
+
}
|
|
2078
|
+
}
|
|
2079
|
+
namespace Settings {
|
|
2080
|
+
interface ServicePeriodAnchorConfig {
|
|
2081
|
+
/**
|
|
2082
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2083
|
+
*/
|
|
2084
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2085
|
+
/**
|
|
2086
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2087
|
+
*/
|
|
2088
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2089
|
+
}
|
|
2090
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
2091
|
+
namespace ServicePeriodAnchorConfig {
|
|
2092
|
+
interface Custom {
|
|
2093
|
+
/**
|
|
2094
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2095
|
+
*/
|
|
2096
|
+
day_of_month: number;
|
|
2097
|
+
/**
|
|
2098
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2099
|
+
*/
|
|
2100
|
+
hour?: number;
|
|
2101
|
+
/**
|
|
2102
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2103
|
+
*/
|
|
2104
|
+
minute?: number;
|
|
2105
|
+
/**
|
|
2106
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2107
|
+
*/
|
|
2108
|
+
month?: number;
|
|
2109
|
+
/**
|
|
2110
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2111
|
+
*/
|
|
2112
|
+
second?: number;
|
|
2113
|
+
}
|
|
2114
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2115
|
+
}
|
|
2116
|
+
}
|
|
2117
|
+
}
|
|
2118
|
+
namespace Trial {
|
|
2119
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
2120
|
+
}
|
|
2121
|
+
}
|
|
2122
|
+
namespace SetDiscount {
|
|
2123
|
+
interface Settings {
|
|
2124
|
+
/**
|
|
2125
|
+
* Configures service period cycle anchoring.
|
|
2126
|
+
*/
|
|
2127
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2128
|
+
/**
|
|
2129
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
2130
|
+
*/
|
|
2131
|
+
start_date?: Settings.StartDate;
|
|
2132
|
+
}
|
|
2133
|
+
namespace Settings {
|
|
2134
|
+
interface ServicePeriodAnchorConfig {
|
|
2135
|
+
/**
|
|
2136
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2137
|
+
*/
|
|
2138
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2139
|
+
/**
|
|
2140
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2141
|
+
*/
|
|
2142
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2143
|
+
}
|
|
2144
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
2145
|
+
namespace ServicePeriodAnchorConfig {
|
|
2146
|
+
interface Custom {
|
|
2147
|
+
/**
|
|
2148
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2149
|
+
*/
|
|
2150
|
+
day_of_month: number;
|
|
2151
|
+
/**
|
|
2152
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2153
|
+
*/
|
|
2154
|
+
hour?: number;
|
|
2155
|
+
/**
|
|
2156
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2157
|
+
*/
|
|
2158
|
+
minute?: number;
|
|
2159
|
+
/**
|
|
2160
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2161
|
+
*/
|
|
2162
|
+
month?: number;
|
|
2163
|
+
/**
|
|
2164
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2165
|
+
*/
|
|
2166
|
+
second?: number;
|
|
2167
|
+
}
|
|
2168
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2169
|
+
}
|
|
2170
|
+
}
|
|
2171
|
+
}
|
|
2172
|
+
namespace SetItem {
|
|
2173
|
+
interface Discount {
|
|
2174
|
+
/**
|
|
2175
|
+
* ID of the coupon to create a new discount for.
|
|
2176
|
+
*/
|
|
2177
|
+
coupon?: string;
|
|
2178
|
+
/**
|
|
2179
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2180
|
+
*/
|
|
2181
|
+
discount?: string;
|
|
2182
|
+
/**
|
|
2183
|
+
* Details to determine how long the discount should be applied for.
|
|
2184
|
+
*/
|
|
2185
|
+
discount_end?: Discount.DiscountEnd;
|
|
2186
|
+
/**
|
|
2187
|
+
* ID of the promotion code to create a new discount for.
|
|
2188
|
+
*/
|
|
2189
|
+
promotion_code?: string;
|
|
2190
|
+
/**
|
|
2191
|
+
* Settings for discount application including service period anchoring.
|
|
2192
|
+
*/
|
|
2193
|
+
settings?: Discount.Settings;
|
|
2194
|
+
}
|
|
2195
|
+
interface Trial {
|
|
2196
|
+
/**
|
|
2197
|
+
* 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.
|
|
2198
|
+
*/
|
|
2199
|
+
converts_to?: Array<string>;
|
|
2200
|
+
/**
|
|
2201
|
+
* Determines the type of trial for this item.
|
|
2202
|
+
*/
|
|
2203
|
+
type: Trial.Type;
|
|
2204
|
+
}
|
|
2205
|
+
namespace Discount {
|
|
2206
|
+
interface DiscountEnd {
|
|
2207
|
+
/**
|
|
2208
|
+
* Time span for the redeemed discount.
|
|
2209
|
+
*/
|
|
2210
|
+
duration?: DiscountEnd.Duration;
|
|
2211
|
+
/**
|
|
2212
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2213
|
+
*/
|
|
2214
|
+
timestamp?: number;
|
|
2215
|
+
/**
|
|
2216
|
+
* The type of calculation made to determine when the discount ends.
|
|
2217
|
+
*/
|
|
2218
|
+
type: DiscountEnd.Type;
|
|
2219
|
+
}
|
|
2220
|
+
interface Settings {
|
|
2221
|
+
/**
|
|
2222
|
+
* Configures service period cycle anchoring.
|
|
2223
|
+
*/
|
|
2224
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2225
|
+
/**
|
|
2226
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
2227
|
+
*/
|
|
2228
|
+
start_date?: Settings.StartDate;
|
|
2229
|
+
}
|
|
2230
|
+
namespace DiscountEnd {
|
|
2231
|
+
interface Duration {
|
|
2232
|
+
/**
|
|
2233
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2234
|
+
*/
|
|
2235
|
+
interval: Duration.Interval;
|
|
2236
|
+
/**
|
|
2237
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2238
|
+
*/
|
|
2239
|
+
interval_count: number;
|
|
2240
|
+
}
|
|
2241
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2242
|
+
namespace Duration {
|
|
2243
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2244
|
+
}
|
|
2245
|
+
}
|
|
2246
|
+
namespace Settings {
|
|
2247
|
+
interface ServicePeriodAnchorConfig {
|
|
2248
|
+
/**
|
|
2249
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2250
|
+
*/
|
|
2251
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2252
|
+
/**
|
|
2253
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2254
|
+
*/
|
|
2255
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
2256
|
+
}
|
|
2257
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
2258
|
+
namespace ServicePeriodAnchorConfig {
|
|
2259
|
+
interface Custom {
|
|
2260
|
+
/**
|
|
2261
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2262
|
+
*/
|
|
2263
|
+
day_of_month: number;
|
|
2264
|
+
/**
|
|
2265
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2266
|
+
*/
|
|
2267
|
+
hour?: number;
|
|
2268
|
+
/**
|
|
2269
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2270
|
+
*/
|
|
2271
|
+
minute?: number;
|
|
2272
|
+
/**
|
|
2273
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2274
|
+
*/
|
|
2275
|
+
month?: number;
|
|
2276
|
+
/**
|
|
2277
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2278
|
+
*/
|
|
2279
|
+
second?: number;
|
|
2280
|
+
}
|
|
2281
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
2282
|
+
}
|
|
2283
|
+
}
|
|
2284
|
+
}
|
|
2285
|
+
namespace Trial {
|
|
2286
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
2287
|
+
}
|
|
2288
|
+
}
|
|
2289
|
+
}
|
|
2290
|
+
namespace AppliesTo {
|
|
2291
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
2292
|
+
}
|
|
2293
|
+
namespace EndsAt {
|
|
2294
|
+
interface DiscountEnd {
|
|
2295
|
+
/**
|
|
2296
|
+
* The ID of a specific discount.
|
|
2297
|
+
*/
|
|
2298
|
+
discount: string;
|
|
2299
|
+
}
|
|
2300
|
+
interface Duration {
|
|
2301
|
+
/**
|
|
2302
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2303
|
+
*/
|
|
2304
|
+
interval: Duration.Interval;
|
|
2305
|
+
/**
|
|
2306
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2307
|
+
*/
|
|
2308
|
+
interval_count: number;
|
|
2309
|
+
}
|
|
2310
|
+
type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2311
|
+
namespace Duration {
|
|
2312
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2313
|
+
}
|
|
2314
|
+
}
|
|
2315
|
+
namespace SetPauseCollection {
|
|
2316
|
+
interface Set {
|
|
2317
|
+
/**
|
|
2318
|
+
* The payment collection behavior for this subscription while paused.
|
|
2319
|
+
*/
|
|
2320
|
+
behavior: Set.Behavior;
|
|
2321
|
+
}
|
|
2322
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
2323
|
+
namespace Set {
|
|
2324
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
2325
|
+
}
|
|
2326
|
+
}
|
|
2327
|
+
namespace StartsAt {
|
|
2328
|
+
interface DiscountEnd {
|
|
2329
|
+
/**
|
|
2330
|
+
* The ID of a specific discount.
|
|
2331
|
+
*/
|
|
2332
|
+
discount: string;
|
|
2333
|
+
}
|
|
2334
|
+
interface LineEndsAt {
|
|
2335
|
+
/**
|
|
2336
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2337
|
+
*/
|
|
2338
|
+
index?: number;
|
|
2339
|
+
}
|
|
2340
|
+
type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2341
|
+
}
|
|
2342
|
+
namespace TrialSettings {
|
|
2343
|
+
interface EndBehavior {
|
|
2344
|
+
/**
|
|
2345
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2346
|
+
*/
|
|
2347
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2348
|
+
}
|
|
2349
|
+
namespace EndBehavior {
|
|
2350
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
2351
|
+
}
|
|
2352
|
+
}
|
|
2353
|
+
}
|
|
2354
|
+
namespace LineItem {
|
|
2355
|
+
interface Discount {
|
|
2356
|
+
/**
|
|
2357
|
+
* ID of the coupon to create a new discount for.
|
|
2358
|
+
*/
|
|
2359
|
+
coupon?: string;
|
|
2360
|
+
/**
|
|
2361
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2362
|
+
*/
|
|
2363
|
+
discount?: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* Details to determine how long the discount should be applied for.
|
|
2366
|
+
*/
|
|
2367
|
+
discount_end?: Discount.DiscountEnd;
|
|
2368
|
+
/**
|
|
2369
|
+
* ID of the promotion code to create a new discount for.
|
|
2370
|
+
*/
|
|
2371
|
+
promotion_code?: string;
|
|
2372
|
+
}
|
|
2373
|
+
interface PriceData {
|
|
2374
|
+
/**
|
|
2375
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
2376
|
+
*/
|
|
2377
|
+
currency: string;
|
|
2378
|
+
/**
|
|
2379
|
+
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
2380
|
+
*/
|
|
2381
|
+
product: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* The recurring components of a price such as `interval` and `interval_count`.
|
|
2384
|
+
*/
|
|
2385
|
+
recurring?: PriceData.Recurring;
|
|
2386
|
+
/**
|
|
2387
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
2388
|
+
*/
|
|
2389
|
+
tax_behavior?: PriceData.TaxBehavior;
|
|
2390
|
+
/**
|
|
2391
|
+
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
2392
|
+
*/
|
|
2393
|
+
unit_amount?: number;
|
|
2394
|
+
/**
|
|
2395
|
+
* Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
|
2396
|
+
*/
|
|
2397
|
+
unit_amount_decimal?: Decimal;
|
|
2398
|
+
}
|
|
2399
|
+
namespace Discount {
|
|
2400
|
+
interface DiscountEnd {
|
|
2401
|
+
/**
|
|
2402
|
+
* Time span for the redeemed discount.
|
|
2403
|
+
*/
|
|
2404
|
+
duration?: DiscountEnd.Duration;
|
|
2405
|
+
/**
|
|
2406
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2407
|
+
*/
|
|
2408
|
+
timestamp?: number;
|
|
2409
|
+
/**
|
|
2410
|
+
* The type of calculation made to determine when the discount ends.
|
|
2411
|
+
*/
|
|
2412
|
+
type: DiscountEnd.Type;
|
|
2413
|
+
}
|
|
2414
|
+
namespace DiscountEnd {
|
|
2415
|
+
interface Duration {
|
|
2416
|
+
/**
|
|
2417
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2418
|
+
*/
|
|
2419
|
+
interval: Duration.Interval;
|
|
2420
|
+
/**
|
|
2421
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2422
|
+
*/
|
|
2423
|
+
interval_count: number;
|
|
2424
|
+
}
|
|
2425
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2426
|
+
namespace Duration {
|
|
2427
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2428
|
+
}
|
|
2429
|
+
}
|
|
2430
|
+
}
|
|
2431
|
+
namespace PriceData {
|
|
2432
|
+
interface Recurring {
|
|
2433
|
+
/**
|
|
2434
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
2435
|
+
*/
|
|
2436
|
+
interval: Recurring.Interval;
|
|
2437
|
+
/**
|
|
2438
|
+
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
2439
|
+
*/
|
|
2440
|
+
interval_count?: number;
|
|
2441
|
+
}
|
|
2442
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
2443
|
+
namespace Recurring {
|
|
2444
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2445
|
+
}
|
|
2446
|
+
}
|
|
2447
|
+
}
|
|
2448
|
+
namespace SubscriptionData {
|
|
2449
|
+
interface BillOnAcceptance {
|
|
2450
|
+
/**
|
|
2451
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
2452
|
+
*/
|
|
2453
|
+
bill_from?: BillOnAcceptance.BillFrom;
|
|
2454
|
+
/**
|
|
2455
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
2456
|
+
*/
|
|
2457
|
+
bill_until?: BillOnAcceptance.BillUntil;
|
|
2458
|
+
}
|
|
2459
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
2460
|
+
interface BillingMode {
|
|
2461
|
+
/**
|
|
2462
|
+
* Configure behavior for flexible billing mode.
|
|
2463
|
+
*/
|
|
2464
|
+
flexible?: BillingMode.Flexible;
|
|
2465
|
+
/**
|
|
2466
|
+
* Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
|
|
2467
|
+
*/
|
|
2468
|
+
type: BillingMode.Type;
|
|
2469
|
+
}
|
|
2470
|
+
interface BillingSchedule {
|
|
2471
|
+
/**
|
|
2472
|
+
* Configure billing schedule differently for individual subscription items.
|
|
2473
|
+
*/
|
|
2474
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
2475
|
+
/**
|
|
2476
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
2477
|
+
*/
|
|
2478
|
+
bill_from: BillingSchedule.BillFrom;
|
|
2479
|
+
/**
|
|
2480
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
2481
|
+
*/
|
|
2482
|
+
bill_until: BillingSchedule.BillUntil;
|
|
2483
|
+
/**
|
|
2484
|
+
* 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.
|
|
2485
|
+
*/
|
|
2486
|
+
key?: string;
|
|
2487
|
+
}
|
|
2488
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
2489
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
2490
|
+
interface Prebilling {
|
|
2491
|
+
/**
|
|
2492
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
2493
|
+
*/
|
|
2494
|
+
iterations: number;
|
|
2495
|
+
}
|
|
2496
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2497
|
+
namespace BillingMode {
|
|
2498
|
+
interface Flexible {
|
|
2499
|
+
/**
|
|
2500
|
+
* Controls how invoices and invoice items display proration amounts and discount amounts.
|
|
2501
|
+
*/
|
|
2502
|
+
proration_discounts?: Flexible.ProrationDiscounts;
|
|
2503
|
+
}
|
|
2504
|
+
type Type = 'classic' | 'flexible' | OtherString;
|
|
2505
|
+
namespace Flexible {
|
|
2506
|
+
type ProrationDiscounts = 'included' | 'itemized';
|
|
2507
|
+
}
|
|
2508
|
+
}
|
|
2509
|
+
namespace BillingSchedule {
|
|
2510
|
+
interface AppliesTo {
|
|
2511
|
+
/**
|
|
2512
|
+
* The ID of the price object.
|
|
2513
|
+
*/
|
|
2514
|
+
price?: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* Controls which subscription items the billing schedule applies to.
|
|
2517
|
+
*/
|
|
2518
|
+
type: 'price';
|
|
2519
|
+
}
|
|
2520
|
+
interface BillFrom {
|
|
2521
|
+
/**
|
|
2522
|
+
* Details of a Quote line to start the bill period from.
|
|
2523
|
+
*/
|
|
2524
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
2525
|
+
/**
|
|
2526
|
+
* A precise Unix timestamp.
|
|
2527
|
+
*/
|
|
2528
|
+
timestamp?: number;
|
|
2529
|
+
/**
|
|
2530
|
+
* The type of method to specify the `bill_from` time.
|
|
2531
|
+
*/
|
|
2532
|
+
type: BillFrom.Type;
|
|
2533
|
+
}
|
|
2534
|
+
interface BillUntil {
|
|
2535
|
+
/**
|
|
2536
|
+
* Details of the duration over which to bill.
|
|
2537
|
+
*/
|
|
2538
|
+
duration?: BillUntil.Duration;
|
|
2539
|
+
/**
|
|
2540
|
+
* Details of a Quote line item from which to bill until.
|
|
2541
|
+
*/
|
|
2542
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
2543
|
+
/**
|
|
2544
|
+
* A precise Unix timestamp.
|
|
2545
|
+
*/
|
|
2546
|
+
timestamp?: number;
|
|
2547
|
+
/**
|
|
2548
|
+
* The type of method to specify the `bill_until` time.
|
|
2549
|
+
*/
|
|
2550
|
+
type: BillUntil.Type;
|
|
2551
|
+
}
|
|
2552
|
+
namespace BillFrom {
|
|
2553
|
+
interface LineStartsAt {
|
|
2554
|
+
/**
|
|
2555
|
+
* The ID of a quote line.
|
|
2556
|
+
*/
|
|
2557
|
+
id?: string;
|
|
2558
|
+
/**
|
|
2559
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2560
|
+
*/
|
|
2561
|
+
index?: number;
|
|
2562
|
+
}
|
|
2563
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
2564
|
+
}
|
|
2565
|
+
namespace BillUntil {
|
|
2566
|
+
interface Duration {
|
|
2567
|
+
/**
|
|
2568
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2569
|
+
*/
|
|
2570
|
+
interval: Duration.Interval;
|
|
2571
|
+
/**
|
|
2572
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2573
|
+
*/
|
|
2574
|
+
interval_count: number;
|
|
2575
|
+
}
|
|
2576
|
+
interface LineEndsAt {
|
|
2577
|
+
/**
|
|
2578
|
+
* The ID of a quote line.
|
|
2579
|
+
*/
|
|
2580
|
+
id?: string;
|
|
2581
|
+
/**
|
|
2582
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2583
|
+
*/
|
|
2584
|
+
index?: number;
|
|
2585
|
+
}
|
|
2586
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2587
|
+
namespace Duration {
|
|
2588
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2589
|
+
}
|
|
2590
|
+
}
|
|
2591
|
+
}
|
|
2592
|
+
namespace BillOnAcceptance {
|
|
2593
|
+
interface BillFrom {
|
|
2594
|
+
/**
|
|
2595
|
+
* Details of a Quote line to start the bill period from.
|
|
2596
|
+
*/
|
|
2597
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
2598
|
+
/**
|
|
2599
|
+
* A precise Unix timestamp.
|
|
2600
|
+
*/
|
|
2601
|
+
timestamp?: number;
|
|
2602
|
+
/**
|
|
2603
|
+
* The type of method to specify the `bill_from` time.
|
|
2604
|
+
*/
|
|
2605
|
+
type: BillFrom.Type;
|
|
2606
|
+
}
|
|
2607
|
+
interface BillUntil {
|
|
2608
|
+
/**
|
|
2609
|
+
* Details of the duration over which to bill.
|
|
2610
|
+
*/
|
|
2611
|
+
duration?: BillUntil.Duration;
|
|
2612
|
+
/**
|
|
2613
|
+
* Details of a Quote line item from which to bill until.
|
|
2614
|
+
*/
|
|
2615
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
2616
|
+
/**
|
|
2617
|
+
* A precise Unix timestamp.
|
|
2618
|
+
*/
|
|
2619
|
+
timestamp?: number;
|
|
2620
|
+
/**
|
|
2621
|
+
* The type of method to specify the `bill_until` time.
|
|
2622
|
+
*/
|
|
2623
|
+
type: BillUntil.Type;
|
|
2624
|
+
}
|
|
2625
|
+
namespace BillFrom {
|
|
2626
|
+
interface LineStartsAt {
|
|
2627
|
+
/**
|
|
2628
|
+
* The ID of a quote line.
|
|
2629
|
+
*/
|
|
2630
|
+
id?: string;
|
|
2631
|
+
/**
|
|
2632
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2633
|
+
*/
|
|
2634
|
+
index?: number;
|
|
2635
|
+
}
|
|
2636
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
2637
|
+
}
|
|
2638
|
+
namespace BillUntil {
|
|
2639
|
+
interface Duration {
|
|
2640
|
+
/**
|
|
2641
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2642
|
+
*/
|
|
2643
|
+
interval: Duration.Interval;
|
|
2644
|
+
/**
|
|
2645
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2646
|
+
*/
|
|
2647
|
+
interval_count: number;
|
|
2648
|
+
}
|
|
2649
|
+
interface LineEndsAt {
|
|
2650
|
+
/**
|
|
2651
|
+
* The ID of a quote line.
|
|
2652
|
+
*/
|
|
2653
|
+
id?: string;
|
|
2654
|
+
/**
|
|
2655
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2656
|
+
*/
|
|
2657
|
+
index?: number;
|
|
2658
|
+
}
|
|
2659
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2660
|
+
namespace Duration {
|
|
2661
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2662
|
+
}
|
|
2663
|
+
}
|
|
2664
|
+
}
|
|
2665
|
+
}
|
|
2666
|
+
namespace SubscriptionDataOverride {
|
|
2667
|
+
interface AppliesTo {
|
|
2668
|
+
/**
|
|
2669
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
2670
|
+
*/
|
|
2671
|
+
new_reference?: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* The ID of the schedule the line applies to.
|
|
2674
|
+
*/
|
|
2675
|
+
subscription_schedule?: string;
|
|
2676
|
+
/**
|
|
2677
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
2678
|
+
*/
|
|
2679
|
+
type: AppliesTo.Type;
|
|
2680
|
+
}
|
|
2681
|
+
interface BillOnAcceptance {
|
|
2682
|
+
/**
|
|
2683
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
2684
|
+
*/
|
|
2685
|
+
bill_from?: BillOnAcceptance.BillFrom;
|
|
2686
|
+
/**
|
|
2687
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
2688
|
+
*/
|
|
2689
|
+
bill_until?: BillOnAcceptance.BillUntil;
|
|
2690
|
+
}
|
|
2691
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
2692
|
+
interface BillingSchedule {
|
|
2693
|
+
/**
|
|
2694
|
+
* Configure billing schedule differently for individual subscription items.
|
|
2695
|
+
*/
|
|
2696
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
2697
|
+
/**
|
|
2698
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
2699
|
+
*/
|
|
2700
|
+
bill_from: BillingSchedule.BillFrom;
|
|
2701
|
+
/**
|
|
2702
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
2703
|
+
*/
|
|
2704
|
+
bill_until: BillingSchedule.BillUntil;
|
|
2705
|
+
/**
|
|
2706
|
+
* 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.
|
|
2707
|
+
*/
|
|
2708
|
+
key?: string;
|
|
2709
|
+
}
|
|
2710
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
2711
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
2712
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2713
|
+
namespace AppliesTo {
|
|
2714
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
2715
|
+
}
|
|
2716
|
+
namespace BillingSchedule {
|
|
2717
|
+
interface AppliesTo {
|
|
2718
|
+
/**
|
|
2719
|
+
* The ID of the price object.
|
|
2720
|
+
*/
|
|
2721
|
+
price?: string;
|
|
2722
|
+
/**
|
|
2723
|
+
* Controls which subscription items the billing schedule applies to.
|
|
2724
|
+
*/
|
|
2725
|
+
type: 'price';
|
|
2726
|
+
}
|
|
2727
|
+
interface BillFrom {
|
|
2728
|
+
/**
|
|
2729
|
+
* Details of a Quote line to start the bill period from.
|
|
2730
|
+
*/
|
|
2731
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
2732
|
+
/**
|
|
2733
|
+
* A precise Unix timestamp.
|
|
2734
|
+
*/
|
|
2735
|
+
timestamp?: number;
|
|
2736
|
+
/**
|
|
2737
|
+
* The type of method to specify the `bill_from` time.
|
|
2738
|
+
*/
|
|
2739
|
+
type: BillFrom.Type;
|
|
2740
|
+
}
|
|
2741
|
+
interface BillUntil {
|
|
2742
|
+
/**
|
|
2743
|
+
* Details of the duration over which to bill.
|
|
2744
|
+
*/
|
|
2745
|
+
duration?: BillUntil.Duration;
|
|
2746
|
+
/**
|
|
2747
|
+
* Details of a Quote line item from which to bill until.
|
|
2748
|
+
*/
|
|
2749
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
2750
|
+
/**
|
|
2751
|
+
* A precise Unix timestamp.
|
|
2752
|
+
*/
|
|
2753
|
+
timestamp?: number;
|
|
2754
|
+
/**
|
|
2755
|
+
* The type of method to specify the `bill_until` time.
|
|
2756
|
+
*/
|
|
2757
|
+
type: BillUntil.Type;
|
|
2758
|
+
}
|
|
2759
|
+
namespace BillFrom {
|
|
2760
|
+
interface LineStartsAt {
|
|
2761
|
+
/**
|
|
2762
|
+
* The ID of a quote line.
|
|
2763
|
+
*/
|
|
2764
|
+
id?: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2767
|
+
*/
|
|
2768
|
+
index?: number;
|
|
2769
|
+
}
|
|
2770
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
2771
|
+
}
|
|
2772
|
+
namespace BillUntil {
|
|
2773
|
+
interface Duration {
|
|
2774
|
+
/**
|
|
2775
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2776
|
+
*/
|
|
2777
|
+
interval: Duration.Interval;
|
|
2778
|
+
/**
|
|
2779
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2780
|
+
*/
|
|
2781
|
+
interval_count: number;
|
|
2782
|
+
}
|
|
2783
|
+
interface LineEndsAt {
|
|
2784
|
+
/**
|
|
2785
|
+
* The ID of a quote line.
|
|
2786
|
+
*/
|
|
2787
|
+
id?: string;
|
|
2788
|
+
/**
|
|
2789
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2790
|
+
*/
|
|
2791
|
+
index?: number;
|
|
2792
|
+
}
|
|
2793
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2794
|
+
namespace Duration {
|
|
2795
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2796
|
+
}
|
|
2797
|
+
}
|
|
2798
|
+
}
|
|
2799
|
+
namespace BillOnAcceptance {
|
|
2800
|
+
interface BillFrom {
|
|
2801
|
+
/**
|
|
2802
|
+
* Details of a Quote line to start the bill period from.
|
|
2803
|
+
*/
|
|
2804
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
2805
|
+
/**
|
|
2806
|
+
* A precise Unix timestamp.
|
|
2807
|
+
*/
|
|
2808
|
+
timestamp?: number;
|
|
2809
|
+
/**
|
|
2810
|
+
* The type of method to specify the `bill_from` time.
|
|
2811
|
+
*/
|
|
2812
|
+
type: BillFrom.Type;
|
|
2813
|
+
}
|
|
2814
|
+
interface BillUntil {
|
|
2815
|
+
/**
|
|
2816
|
+
* Details of the duration over which to bill.
|
|
2817
|
+
*/
|
|
2818
|
+
duration?: BillUntil.Duration;
|
|
2819
|
+
/**
|
|
2820
|
+
* Details of a Quote line item from which to bill until.
|
|
2821
|
+
*/
|
|
2822
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
2823
|
+
/**
|
|
2824
|
+
* A precise Unix timestamp.
|
|
2825
|
+
*/
|
|
2826
|
+
timestamp?: number;
|
|
2827
|
+
/**
|
|
2828
|
+
* The type of method to specify the `bill_until` time.
|
|
2829
|
+
*/
|
|
2830
|
+
type: BillUntil.Type;
|
|
2831
|
+
}
|
|
2832
|
+
namespace BillFrom {
|
|
2833
|
+
interface LineStartsAt {
|
|
2834
|
+
/**
|
|
2835
|
+
* The ID of a quote line.
|
|
2836
|
+
*/
|
|
2837
|
+
id?: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2840
|
+
*/
|
|
2841
|
+
index?: number;
|
|
2842
|
+
}
|
|
2843
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
2844
|
+
}
|
|
2845
|
+
namespace BillUntil {
|
|
2846
|
+
interface Duration {
|
|
2847
|
+
/**
|
|
2848
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2849
|
+
*/
|
|
2850
|
+
interval: Duration.Interval;
|
|
2851
|
+
/**
|
|
2852
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2853
|
+
*/
|
|
2854
|
+
interval_count: number;
|
|
2855
|
+
}
|
|
2856
|
+
interface LineEndsAt {
|
|
2857
|
+
/**
|
|
2858
|
+
* The ID of a quote line.
|
|
2859
|
+
*/
|
|
2860
|
+
id?: string;
|
|
2861
|
+
/**
|
|
2862
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
2863
|
+
*/
|
|
2864
|
+
index?: number;
|
|
2865
|
+
}
|
|
2866
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
2867
|
+
namespace Duration {
|
|
2868
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2869
|
+
}
|
|
2870
|
+
}
|
|
2871
|
+
}
|
|
2872
|
+
}
|
|
2873
|
+
}
|
|
2874
|
+
export interface QuoteRetrieveParams {
|
|
2875
|
+
/**
|
|
2876
|
+
* Specifies which fields in the response should be expanded.
|
|
2877
|
+
*/
|
|
2878
|
+
expand?: Array<string>;
|
|
2879
|
+
}
|
|
2880
|
+
export interface QuoteUpdateParams {
|
|
2881
|
+
/**
|
|
2882
|
+
* Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
|
|
2883
|
+
*/
|
|
2884
|
+
allow_backdated_lines?: boolean;
|
|
2885
|
+
/**
|
|
2886
|
+
* The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
|
|
2887
|
+
*/
|
|
2888
|
+
application_fee_amount?: Emptyable<number>;
|
|
2889
|
+
/**
|
|
2890
|
+
* 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. There must be at least 1 line item with a recurring price to use this field.
|
|
2891
|
+
*/
|
|
2892
|
+
application_fee_percent?: Emptyable<number>;
|
|
2893
|
+
/**
|
|
2894
|
+
* Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
|
|
2895
|
+
*/
|
|
2896
|
+
automatic_tax?: QuoteUpdateParams.AutomaticTax;
|
|
2897
|
+
/**
|
|
2898
|
+
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
|
|
2899
|
+
*/
|
|
2900
|
+
collection_method?: QuoteUpdateParams.CollectionMethod;
|
|
2901
|
+
/**
|
|
2902
|
+
* The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
|
|
2903
|
+
*/
|
|
2904
|
+
customer?: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.
|
|
2907
|
+
*/
|
|
2908
|
+
customer_account?: string;
|
|
2909
|
+
/**
|
|
2910
|
+
* The tax rates that will apply to any line item that does not have `tax_rates` set.
|
|
2911
|
+
*/
|
|
2912
|
+
default_tax_rates?: Emptyable<Array<string>>;
|
|
2913
|
+
/**
|
|
2914
|
+
* A description that will be displayed on the quote PDF.
|
|
2915
|
+
*/
|
|
2916
|
+
description?: Emptyable<string>;
|
|
2917
|
+
/**
|
|
2918
|
+
* The discounts applied to the quote.
|
|
2919
|
+
*/
|
|
2920
|
+
discounts?: Emptyable<Array<QuoteUpdateParams.Discount>>;
|
|
2921
|
+
/**
|
|
2922
|
+
* Specifies which fields in the response should be expanded.
|
|
2923
|
+
*/
|
|
2924
|
+
expand?: Array<string>;
|
|
2925
|
+
/**
|
|
2926
|
+
* A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
|
|
2927
|
+
*/
|
|
2928
|
+
expires_at?: number;
|
|
2929
|
+
/**
|
|
2930
|
+
* A footer that will be displayed on the quote PDF.
|
|
2931
|
+
*/
|
|
2932
|
+
footer?: Emptyable<string>;
|
|
2933
|
+
/**
|
|
2934
|
+
* A header that will be displayed on the quote PDF.
|
|
2935
|
+
*/
|
|
2936
|
+
header?: Emptyable<string>;
|
|
2937
|
+
/**
|
|
2938
|
+
* All invoices will be billed using the specified settings.
|
|
2939
|
+
*/
|
|
2940
|
+
invoice_settings?: QuoteUpdateParams.InvoiceSettings;
|
|
2941
|
+
/**
|
|
2942
|
+
* A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
|
|
2943
|
+
*/
|
|
2944
|
+
line_items?: Array<QuoteUpdateParams.LineItem>;
|
|
2945
|
+
/**
|
|
2946
|
+
* A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
|
2947
|
+
*/
|
|
2948
|
+
lines?: Array<QuoteUpdateParams.Line>;
|
|
2949
|
+
/**
|
|
2950
|
+
* 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`.
|
|
2951
|
+
*/
|
|
2952
|
+
metadata?: MetadataParam;
|
|
2953
|
+
/**
|
|
2954
|
+
* The account on behalf of which to charge.
|
|
2955
|
+
*/
|
|
2956
|
+
on_behalf_of?: Emptyable<string>;
|
|
2957
|
+
/**
|
|
2958
|
+
* When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
|
|
2959
|
+
*/
|
|
2960
|
+
subscription_data?: QuoteUpdateParams.SubscriptionData;
|
|
2961
|
+
/**
|
|
2962
|
+
* List representing overrides for `subscription_data` configurations for specific subscription schedules.
|
|
2963
|
+
*/
|
|
2964
|
+
subscription_data_overrides?: Emptyable<Array<QuoteUpdateParams.SubscriptionDataOverride>>;
|
|
2965
|
+
/**
|
|
2966
|
+
* The data with which to automatically create a Transfer for each of the invoices.
|
|
2967
|
+
*/
|
|
2968
|
+
transfer_data?: Emptyable<QuoteUpdateParams.TransferData>;
|
|
2969
|
+
}
|
|
2970
|
+
export declare namespace QuoteUpdateParams {
|
|
2971
|
+
interface AutomaticTax {
|
|
2972
|
+
/**
|
|
2973
|
+
* Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.
|
|
2974
|
+
*/
|
|
2975
|
+
enabled: boolean;
|
|
2976
|
+
/**
|
|
2977
|
+
* 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.
|
|
2978
|
+
*/
|
|
2979
|
+
liability?: AutomaticTax.Liability;
|
|
2980
|
+
}
|
|
2981
|
+
type CollectionMethod = 'charge_automatically' | 'send_invoice';
|
|
2982
|
+
interface Discount {
|
|
2983
|
+
/**
|
|
2984
|
+
* ID of the coupon to create a new discount for.
|
|
2985
|
+
*/
|
|
2986
|
+
coupon?: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2989
|
+
*/
|
|
2990
|
+
discount?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* Details to determine how long the discount should be applied for.
|
|
2993
|
+
*/
|
|
2994
|
+
discount_end?: Discount.DiscountEnd;
|
|
2995
|
+
/**
|
|
2996
|
+
* ID of the promotion code to create a new discount for.
|
|
2997
|
+
*/
|
|
2998
|
+
promotion_code?: string;
|
|
2999
|
+
}
|
|
3000
|
+
interface InvoiceSettings {
|
|
3001
|
+
/**
|
|
3002
|
+
* A list of up to 4 custom fields to be displayed on the invoice.
|
|
3003
|
+
*/
|
|
3004
|
+
custom_fields?: Emptyable<Array<InvoiceSettings.CustomField>>;
|
|
3005
|
+
/**
|
|
3006
|
+
* Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
|
|
3007
|
+
*/
|
|
3008
|
+
days_until_due?: number;
|
|
3009
|
+
/**
|
|
3010
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1036
3011
|
*/
|
|
1037
3012
|
description?: Emptyable<string>;
|
|
1038
3013
|
/**
|
|
@@ -1070,24 +3045,156 @@ export declare namespace QuoteUpdateParams {
|
|
|
1070
3045
|
*/
|
|
1071
3046
|
tax_rates?: Emptyable<Array<string>>;
|
|
1072
3047
|
}
|
|
3048
|
+
interface Line {
|
|
3049
|
+
/**
|
|
3050
|
+
* An array of operations the quote line performs.
|
|
3051
|
+
*/
|
|
3052
|
+
actions?: Array<Line.Action>;
|
|
3053
|
+
/**
|
|
3054
|
+
* Details to identify the subscription schedule the quote line applies to.
|
|
3055
|
+
*/
|
|
3056
|
+
applies_to?: Line.AppliesTo;
|
|
3057
|
+
/**
|
|
3058
|
+
* For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp. For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
|
|
3059
|
+
*/
|
|
3060
|
+
billing_cycle_anchor?: Line.BillingCycleAnchor;
|
|
3061
|
+
/**
|
|
3062
|
+
* A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
|
|
3063
|
+
*/
|
|
3064
|
+
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
3065
|
+
/**
|
|
3066
|
+
* Configures how the quote handles billing for line transitions.
|
|
3067
|
+
*/
|
|
3068
|
+
effective_at?: Line.EffectiveAt;
|
|
3069
|
+
/**
|
|
3070
|
+
* Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
|
3071
|
+
*/
|
|
3072
|
+
ends_at?: Line.EndsAt;
|
|
3073
|
+
/**
|
|
3074
|
+
* The ID of an existing line on the quote.
|
|
3075
|
+
*/
|
|
3076
|
+
id?: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
|
|
3079
|
+
*/
|
|
3080
|
+
proration_behavior?: Line.ProrationBehavior;
|
|
3081
|
+
/**
|
|
3082
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3083
|
+
*/
|
|
3084
|
+
set_pause_collection?: Line.SetPauseCollection;
|
|
3085
|
+
/**
|
|
3086
|
+
* Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
|
|
3087
|
+
*/
|
|
3088
|
+
set_schedule_end?: Line.SetScheduleEnd;
|
|
3089
|
+
/**
|
|
3090
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
3091
|
+
*/
|
|
3092
|
+
starts_at?: Line.StartsAt;
|
|
3093
|
+
/**
|
|
3094
|
+
* Settings related to subscription trials.
|
|
3095
|
+
*/
|
|
3096
|
+
trial_settings?: Line.TrialSettings;
|
|
3097
|
+
}
|
|
1073
3098
|
interface SubscriptionData {
|
|
3099
|
+
/**
|
|
3100
|
+
* Describes the period to bill for upon accepting the quote.
|
|
3101
|
+
*/
|
|
3102
|
+
bill_on_acceptance?: Emptyable<SubscriptionData.BillOnAcceptance>;
|
|
3103
|
+
/**
|
|
3104
|
+
* 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.
|
|
3105
|
+
*/
|
|
3106
|
+
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
3107
|
+
/**
|
|
3108
|
+
* When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
|
3109
|
+
*/
|
|
3110
|
+
billing_cycle_anchor?: Emptyable<'reset'>;
|
|
3111
|
+
/**
|
|
3112
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
3113
|
+
*/
|
|
3114
|
+
billing_schedules?: Emptyable<Array<SubscriptionData.BillingSchedule>>;
|
|
1074
3115
|
/**
|
|
1075
3116
|
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
1076
3117
|
*/
|
|
1077
3118
|
description?: Emptyable<string>;
|
|
1078
3119
|
/**
|
|
1079
|
-
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
3120
|
+
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
1080
3121
|
*/
|
|
1081
3122
|
effective_date?: Emptyable<'current_period_end' | number>;
|
|
3123
|
+
/**
|
|
3124
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
3125
|
+
*/
|
|
3126
|
+
end_behavior?: SubscriptionData.EndBehavior;
|
|
1082
3127
|
/**
|
|
1083
3128
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
1084
3129
|
*/
|
|
1085
3130
|
metadata?: MetadataParam;
|
|
3131
|
+
/**
|
|
3132
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
3133
|
+
*/
|
|
3134
|
+
phase_effective_at?: SubscriptionData.PhaseEffectiveAt;
|
|
3135
|
+
/**
|
|
3136
|
+
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
3137
|
+
*/
|
|
3138
|
+
prebilling?: Emptyable<SubscriptionData.Prebilling>;
|
|
3139
|
+
/**
|
|
3140
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
3141
|
+
*
|
|
3142
|
+
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
3143
|
+
*
|
|
3144
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
3145
|
+
*
|
|
3146
|
+
* Prorations can be disabled by passing `none`.
|
|
3147
|
+
*/
|
|
3148
|
+
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
1086
3149
|
/**
|
|
1087
3150
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
1088
3151
|
*/
|
|
1089
3152
|
trial_period_days?: Emptyable<number>;
|
|
1090
3153
|
}
|
|
3154
|
+
interface SubscriptionDataOverride {
|
|
3155
|
+
/**
|
|
3156
|
+
* Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
|
|
3157
|
+
*/
|
|
3158
|
+
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
3159
|
+
/**
|
|
3160
|
+
* Describes the period to bill for upon accepting the quote.
|
|
3161
|
+
*/
|
|
3162
|
+
bill_on_acceptance?: Emptyable<SubscriptionDataOverride.BillOnAcceptance>;
|
|
3163
|
+
/**
|
|
3164
|
+
* 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.
|
|
3165
|
+
*/
|
|
3166
|
+
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
3167
|
+
/**
|
|
3168
|
+
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
3169
|
+
*/
|
|
3170
|
+
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
3171
|
+
/**
|
|
3172
|
+
* The customer the Subscription Data override applies to.
|
|
3173
|
+
*/
|
|
3174
|
+
customer?: string;
|
|
3175
|
+
/**
|
|
3176
|
+
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
3177
|
+
*/
|
|
3178
|
+
description?: Emptyable<string>;
|
|
3179
|
+
/**
|
|
3180
|
+
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
3181
|
+
*/
|
|
3182
|
+
end_behavior?: SubscriptionDataOverride.EndBehavior;
|
|
3183
|
+
/**
|
|
3184
|
+
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
3185
|
+
*/
|
|
3186
|
+
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
3187
|
+
/**
|
|
3188
|
+
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
3189
|
+
*
|
|
3190
|
+
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
3191
|
+
*
|
|
3192
|
+
* Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
3193
|
+
*
|
|
3194
|
+
* Prorations can be disabled by passing `none`.
|
|
3195
|
+
*/
|
|
3196
|
+
proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
|
|
3197
|
+
}
|
|
1091
3198
|
interface TransferData {
|
|
1092
3199
|
/**
|
|
1093
3200
|
* The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
|
|
@@ -1105,16 +3212,48 @@ export declare namespace QuoteUpdateParams {
|
|
|
1105
3212
|
namespace AutomaticTax {
|
|
1106
3213
|
interface Liability {
|
|
1107
3214
|
/**
|
|
1108
|
-
* The connected account being referenced when `type` is `account`.
|
|
3215
|
+
* The connected account being referenced when `type` is `account`.
|
|
3216
|
+
*/
|
|
3217
|
+
account?: string;
|
|
3218
|
+
/**
|
|
3219
|
+
* Type of the account referenced in the request.
|
|
3220
|
+
*/
|
|
3221
|
+
type: Liability.Type;
|
|
3222
|
+
}
|
|
3223
|
+
namespace Liability {
|
|
3224
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
3225
|
+
}
|
|
3226
|
+
}
|
|
3227
|
+
namespace Discount {
|
|
3228
|
+
interface DiscountEnd {
|
|
3229
|
+
/**
|
|
3230
|
+
* Time span for the redeemed discount.
|
|
3231
|
+
*/
|
|
3232
|
+
duration?: DiscountEnd.Duration;
|
|
3233
|
+
/**
|
|
3234
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1109
3235
|
*/
|
|
1110
|
-
|
|
3236
|
+
timestamp?: number;
|
|
1111
3237
|
/**
|
|
1112
|
-
*
|
|
3238
|
+
* The type of calculation made to determine when the discount ends.
|
|
1113
3239
|
*/
|
|
1114
|
-
type:
|
|
3240
|
+
type: DiscountEnd.Type;
|
|
1115
3241
|
}
|
|
1116
|
-
namespace
|
|
1117
|
-
|
|
3242
|
+
namespace DiscountEnd {
|
|
3243
|
+
interface Duration {
|
|
3244
|
+
/**
|
|
3245
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3246
|
+
*/
|
|
3247
|
+
interval: Duration.Interval;
|
|
3248
|
+
/**
|
|
3249
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3250
|
+
*/
|
|
3251
|
+
interval_count: number;
|
|
3252
|
+
}
|
|
3253
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3254
|
+
namespace Duration {
|
|
3255
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3256
|
+
}
|
|
1118
3257
|
}
|
|
1119
3258
|
}
|
|
1120
3259
|
namespace InvoiceSettings {
|
|
@@ -1138,8 +3277,674 @@ export declare namespace QuoteUpdateParams {
|
|
|
1138
3277
|
*/
|
|
1139
3278
|
type: Issuer.Type;
|
|
1140
3279
|
}
|
|
1141
|
-
namespace Issuer {
|
|
1142
|
-
type Type = 'account' | 'self' | OtherString;
|
|
3280
|
+
namespace Issuer {
|
|
3281
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
3282
|
+
}
|
|
3283
|
+
}
|
|
3284
|
+
namespace Line {
|
|
3285
|
+
interface Action {
|
|
3286
|
+
/**
|
|
3287
|
+
* Details for the `add_discount` type.
|
|
3288
|
+
*/
|
|
3289
|
+
add_discount?: Action.AddDiscount;
|
|
3290
|
+
/**
|
|
3291
|
+
* Details for the `add_item` type.
|
|
3292
|
+
*/
|
|
3293
|
+
add_item?: Action.AddItem;
|
|
3294
|
+
/**
|
|
3295
|
+
* Details for the `add_metadata` type: specify a hash of key-value pairs.
|
|
3296
|
+
*/
|
|
3297
|
+
add_metadata?: {
|
|
3298
|
+
[key: string]: string;
|
|
3299
|
+
};
|
|
3300
|
+
/**
|
|
3301
|
+
* Details for the `remove_discount` type.
|
|
3302
|
+
*/
|
|
3303
|
+
remove_discount?: Action.RemoveDiscount;
|
|
3304
|
+
/**
|
|
3305
|
+
* Details for the `remove_item` type.
|
|
3306
|
+
*/
|
|
3307
|
+
remove_item?: Action.RemoveItem;
|
|
3308
|
+
/**
|
|
3309
|
+
* Details for the `remove_metadata` type: specify an array of metadata keys.
|
|
3310
|
+
*/
|
|
3311
|
+
remove_metadata?: Array<string>;
|
|
3312
|
+
/**
|
|
3313
|
+
* Details for the `set_discounts` type.
|
|
3314
|
+
*/
|
|
3315
|
+
set_discounts?: Array<Action.SetDiscount>;
|
|
3316
|
+
/**
|
|
3317
|
+
* Details for the `set_items` type.
|
|
3318
|
+
*/
|
|
3319
|
+
set_items?: Array<Action.SetItem>;
|
|
3320
|
+
/**
|
|
3321
|
+
* Details for the `set_metadata` type: specify an array of key-value pairs.
|
|
3322
|
+
*/
|
|
3323
|
+
set_metadata?: Emptyable<{
|
|
3324
|
+
[key: string]: string;
|
|
3325
|
+
}>;
|
|
3326
|
+
/**
|
|
3327
|
+
* The type of action the quote line performs.
|
|
3328
|
+
*/
|
|
3329
|
+
type: Action.Type;
|
|
3330
|
+
}
|
|
3331
|
+
interface AppliesTo {
|
|
3332
|
+
/**
|
|
3333
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
3334
|
+
*/
|
|
3335
|
+
new_reference?: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* The ID of the schedule the line applies to.
|
|
3338
|
+
*/
|
|
3339
|
+
subscription_schedule?: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
3342
|
+
*/
|
|
3343
|
+
type: AppliesTo.Type;
|
|
3344
|
+
}
|
|
3345
|
+
type BillingCycleAnchor = 'automatic' | 'line_starts_at' | OtherString;
|
|
3346
|
+
interface CancelSubscriptionSchedule {
|
|
3347
|
+
/**
|
|
3348
|
+
* Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
|
|
3349
|
+
*/
|
|
3350
|
+
cancel_at: 'line_starts_at';
|
|
3351
|
+
/**
|
|
3352
|
+
* If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
|
|
3353
|
+
*/
|
|
3354
|
+
invoice_now?: boolean;
|
|
3355
|
+
/**
|
|
3356
|
+
* If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
|
|
3357
|
+
*/
|
|
3358
|
+
prorate?: boolean;
|
|
3359
|
+
}
|
|
3360
|
+
type EffectiveAt = 'billing_period_start' | 'line_start' | OtherString;
|
|
3361
|
+
interface EndsAt {
|
|
3362
|
+
/**
|
|
3363
|
+
* Use the `end` time of a given discount.
|
|
3364
|
+
*/
|
|
3365
|
+
discount_end?: EndsAt.DiscountEnd;
|
|
3366
|
+
/**
|
|
3367
|
+
* Time span for the quote line starting from the `starts_at` date.
|
|
3368
|
+
*/
|
|
3369
|
+
duration?: EndsAt.Duration;
|
|
3370
|
+
/**
|
|
3371
|
+
* A precise Unix timestamp.
|
|
3372
|
+
*/
|
|
3373
|
+
timestamp?: number;
|
|
3374
|
+
/**
|
|
3375
|
+
* Select a way to pass in `ends_at`.
|
|
3376
|
+
*/
|
|
3377
|
+
type: EndsAt.Type;
|
|
3378
|
+
}
|
|
3379
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3380
|
+
interface SetPauseCollection {
|
|
3381
|
+
/**
|
|
3382
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
3383
|
+
*/
|
|
3384
|
+
set?: SetPauseCollection.Set;
|
|
3385
|
+
/**
|
|
3386
|
+
* Determines the type of the pause_collection amendment.
|
|
3387
|
+
*/
|
|
3388
|
+
type: SetPauseCollection.Type;
|
|
3389
|
+
}
|
|
3390
|
+
type SetScheduleEnd = 'line_ends_at' | 'line_starts_at' | OtherString;
|
|
3391
|
+
interface StartsAt {
|
|
3392
|
+
/**
|
|
3393
|
+
* Use the `end` time of a given discount.
|
|
3394
|
+
*/
|
|
3395
|
+
discount_end?: StartsAt.DiscountEnd;
|
|
3396
|
+
/**
|
|
3397
|
+
* The timestamp the given line ends at.
|
|
3398
|
+
*/
|
|
3399
|
+
line_ends_at?: StartsAt.LineEndsAt;
|
|
3400
|
+
/**
|
|
3401
|
+
* A precise Unix timestamp.
|
|
3402
|
+
*/
|
|
3403
|
+
timestamp?: number;
|
|
3404
|
+
/**
|
|
3405
|
+
* Select a way to pass in `starts_at`.
|
|
3406
|
+
*/
|
|
3407
|
+
type: StartsAt.Type;
|
|
3408
|
+
}
|
|
3409
|
+
interface TrialSettings {
|
|
3410
|
+
/**
|
|
3411
|
+
* Defines how the subscription should behave when a trial ends.
|
|
3412
|
+
*/
|
|
3413
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
3414
|
+
}
|
|
3415
|
+
namespace Action {
|
|
3416
|
+
interface AddDiscount {
|
|
3417
|
+
/**
|
|
3418
|
+
* The coupon code to redeem.
|
|
3419
|
+
*/
|
|
3420
|
+
coupon?: string;
|
|
3421
|
+
/**
|
|
3422
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3423
|
+
*/
|
|
3424
|
+
discount?: string;
|
|
3425
|
+
/**
|
|
3426
|
+
* Details to determine how long the discount should be applied for.
|
|
3427
|
+
*/
|
|
3428
|
+
discount_end?: AddDiscount.DiscountEnd;
|
|
3429
|
+
/**
|
|
3430
|
+
* 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.
|
|
3431
|
+
*/
|
|
3432
|
+
index?: number;
|
|
3433
|
+
/**
|
|
3434
|
+
* The promotion code to redeem.
|
|
3435
|
+
*/
|
|
3436
|
+
promotion_code?: string;
|
|
3437
|
+
/**
|
|
3438
|
+
* Settings for discount application including service period anchoring.
|
|
3439
|
+
*/
|
|
3440
|
+
settings?: AddDiscount.Settings;
|
|
3441
|
+
}
|
|
3442
|
+
interface AddItem {
|
|
3443
|
+
/**
|
|
3444
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3445
|
+
*/
|
|
3446
|
+
discounts?: Array<AddItem.Discount>;
|
|
3447
|
+
/**
|
|
3448
|
+
* 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`.
|
|
3449
|
+
*/
|
|
3450
|
+
metadata?: MetadataParam;
|
|
3451
|
+
/**
|
|
3452
|
+
* The ID of the price object.
|
|
3453
|
+
*/
|
|
3454
|
+
price: string;
|
|
3455
|
+
/**
|
|
3456
|
+
* Quantity for this item.
|
|
3457
|
+
*/
|
|
3458
|
+
quantity?: number;
|
|
3459
|
+
/**
|
|
3460
|
+
* 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`.
|
|
3461
|
+
*/
|
|
3462
|
+
tax_rates?: Array<string>;
|
|
3463
|
+
/**
|
|
3464
|
+
* Options that configure the trial on the subscription item.
|
|
3465
|
+
*/
|
|
3466
|
+
trial?: AddItem.Trial;
|
|
3467
|
+
/**
|
|
3468
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3469
|
+
*/
|
|
3470
|
+
trial_offer?: string;
|
|
3471
|
+
}
|
|
3472
|
+
interface RemoveDiscount {
|
|
3473
|
+
/**
|
|
3474
|
+
* The coupon code to remove from the `discounts` array.
|
|
3475
|
+
*/
|
|
3476
|
+
coupon?: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
3479
|
+
*/
|
|
3480
|
+
discount?: string;
|
|
3481
|
+
/**
|
|
3482
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
3483
|
+
*/
|
|
3484
|
+
promotion_code?: string;
|
|
3485
|
+
}
|
|
3486
|
+
interface RemoveItem {
|
|
3487
|
+
/**
|
|
3488
|
+
* ID of a price to remove.
|
|
3489
|
+
*/
|
|
3490
|
+
price: string;
|
|
3491
|
+
}
|
|
3492
|
+
interface SetDiscount {
|
|
3493
|
+
/**
|
|
3494
|
+
* The coupon code to replace the `discounts` array with.
|
|
3495
|
+
*/
|
|
3496
|
+
coupon?: string;
|
|
3497
|
+
/**
|
|
3498
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
3499
|
+
*/
|
|
3500
|
+
discount?: string;
|
|
3501
|
+
/**
|
|
3502
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3503
|
+
*/
|
|
3504
|
+
promotion_code?: string;
|
|
3505
|
+
/**
|
|
3506
|
+
* Settings for discount application including service period anchoring.
|
|
3507
|
+
*/
|
|
3508
|
+
settings?: SetDiscount.Settings;
|
|
3509
|
+
}
|
|
3510
|
+
interface SetItem {
|
|
3511
|
+
/**
|
|
3512
|
+
* 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`.
|
|
3513
|
+
*/
|
|
3514
|
+
discounts?: Array<SetItem.Discount>;
|
|
3515
|
+
/**
|
|
3516
|
+
* 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`.
|
|
3517
|
+
*/
|
|
3518
|
+
metadata?: MetadataParam;
|
|
3519
|
+
/**
|
|
3520
|
+
* The ID of the price object.
|
|
3521
|
+
*/
|
|
3522
|
+
price: string;
|
|
3523
|
+
/**
|
|
3524
|
+
* 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`.
|
|
3525
|
+
*/
|
|
3526
|
+
quantity?: number;
|
|
3527
|
+
/**
|
|
3528
|
+
* 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`.
|
|
3529
|
+
*/
|
|
3530
|
+
tax_rates?: Array<string>;
|
|
3531
|
+
/**
|
|
3532
|
+
* 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`.
|
|
3533
|
+
*/
|
|
3534
|
+
trial?: SetItem.Trial;
|
|
3535
|
+
/**
|
|
3536
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
3537
|
+
*/
|
|
3538
|
+
trial_offer?: string;
|
|
3539
|
+
}
|
|
3540
|
+
type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata' | OtherString;
|
|
3541
|
+
namespace AddDiscount {
|
|
3542
|
+
interface DiscountEnd {
|
|
3543
|
+
/**
|
|
3544
|
+
* The type of calculation made to determine when the discount ends.
|
|
3545
|
+
*/
|
|
3546
|
+
type: 'line_ends_at';
|
|
3547
|
+
}
|
|
3548
|
+
interface Settings {
|
|
3549
|
+
/**
|
|
3550
|
+
* Configures service period cycle anchoring.
|
|
3551
|
+
*/
|
|
3552
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3553
|
+
/**
|
|
3554
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
3555
|
+
*/
|
|
3556
|
+
start_date?: Settings.StartDate;
|
|
3557
|
+
}
|
|
3558
|
+
namespace Settings {
|
|
3559
|
+
interface ServicePeriodAnchorConfig {
|
|
3560
|
+
/**
|
|
3561
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3562
|
+
*/
|
|
3563
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3564
|
+
/**
|
|
3565
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3566
|
+
*/
|
|
3567
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3568
|
+
}
|
|
3569
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
3570
|
+
namespace ServicePeriodAnchorConfig {
|
|
3571
|
+
interface Custom {
|
|
3572
|
+
/**
|
|
3573
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3574
|
+
*/
|
|
3575
|
+
day_of_month: number;
|
|
3576
|
+
/**
|
|
3577
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3578
|
+
*/
|
|
3579
|
+
hour?: number;
|
|
3580
|
+
/**
|
|
3581
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3582
|
+
*/
|
|
3583
|
+
minute?: number;
|
|
3584
|
+
/**
|
|
3585
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3586
|
+
*/
|
|
3587
|
+
month?: number;
|
|
3588
|
+
/**
|
|
3589
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3590
|
+
*/
|
|
3591
|
+
second?: number;
|
|
3592
|
+
}
|
|
3593
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3594
|
+
}
|
|
3595
|
+
}
|
|
3596
|
+
}
|
|
3597
|
+
namespace AddItem {
|
|
3598
|
+
interface Discount {
|
|
3599
|
+
/**
|
|
3600
|
+
* ID of the coupon to create a new discount for.
|
|
3601
|
+
*/
|
|
3602
|
+
coupon?: string;
|
|
3603
|
+
/**
|
|
3604
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3605
|
+
*/
|
|
3606
|
+
discount?: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* Details to determine how long the discount should be applied for.
|
|
3609
|
+
*/
|
|
3610
|
+
discount_end?: Discount.DiscountEnd;
|
|
3611
|
+
/**
|
|
3612
|
+
* ID of the promotion code to create a new discount for.
|
|
3613
|
+
*/
|
|
3614
|
+
promotion_code?: string;
|
|
3615
|
+
/**
|
|
3616
|
+
* Settings for discount application including service period anchoring.
|
|
3617
|
+
*/
|
|
3618
|
+
settings?: Discount.Settings;
|
|
3619
|
+
}
|
|
3620
|
+
interface Trial {
|
|
3621
|
+
/**
|
|
3622
|
+
* 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.
|
|
3623
|
+
*/
|
|
3624
|
+
converts_to?: Array<string>;
|
|
3625
|
+
/**
|
|
3626
|
+
* Determines the type of trial for this item.
|
|
3627
|
+
*/
|
|
3628
|
+
type: Trial.Type;
|
|
3629
|
+
}
|
|
3630
|
+
namespace Discount {
|
|
3631
|
+
interface DiscountEnd {
|
|
3632
|
+
/**
|
|
3633
|
+
* Time span for the redeemed discount.
|
|
3634
|
+
*/
|
|
3635
|
+
duration?: DiscountEnd.Duration;
|
|
3636
|
+
/**
|
|
3637
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3638
|
+
*/
|
|
3639
|
+
timestamp?: number;
|
|
3640
|
+
/**
|
|
3641
|
+
* The type of calculation made to determine when the discount ends.
|
|
3642
|
+
*/
|
|
3643
|
+
type: DiscountEnd.Type;
|
|
3644
|
+
}
|
|
3645
|
+
interface Settings {
|
|
3646
|
+
/**
|
|
3647
|
+
* Configures service period cycle anchoring.
|
|
3648
|
+
*/
|
|
3649
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3650
|
+
/**
|
|
3651
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
3652
|
+
*/
|
|
3653
|
+
start_date?: Settings.StartDate;
|
|
3654
|
+
}
|
|
3655
|
+
namespace DiscountEnd {
|
|
3656
|
+
interface Duration {
|
|
3657
|
+
/**
|
|
3658
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3659
|
+
*/
|
|
3660
|
+
interval: Duration.Interval;
|
|
3661
|
+
/**
|
|
3662
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3663
|
+
*/
|
|
3664
|
+
interval_count: number;
|
|
3665
|
+
}
|
|
3666
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3667
|
+
namespace Duration {
|
|
3668
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3669
|
+
}
|
|
3670
|
+
}
|
|
3671
|
+
namespace Settings {
|
|
3672
|
+
interface ServicePeriodAnchorConfig {
|
|
3673
|
+
/**
|
|
3674
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3675
|
+
*/
|
|
3676
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3677
|
+
/**
|
|
3678
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3679
|
+
*/
|
|
3680
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3681
|
+
}
|
|
3682
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
3683
|
+
namespace ServicePeriodAnchorConfig {
|
|
3684
|
+
interface Custom {
|
|
3685
|
+
/**
|
|
3686
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3687
|
+
*/
|
|
3688
|
+
day_of_month: number;
|
|
3689
|
+
/**
|
|
3690
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3691
|
+
*/
|
|
3692
|
+
hour?: number;
|
|
3693
|
+
/**
|
|
3694
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3695
|
+
*/
|
|
3696
|
+
minute?: number;
|
|
3697
|
+
/**
|
|
3698
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3699
|
+
*/
|
|
3700
|
+
month?: number;
|
|
3701
|
+
/**
|
|
3702
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3703
|
+
*/
|
|
3704
|
+
second?: number;
|
|
3705
|
+
}
|
|
3706
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3707
|
+
}
|
|
3708
|
+
}
|
|
3709
|
+
}
|
|
3710
|
+
namespace Trial {
|
|
3711
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
3712
|
+
}
|
|
3713
|
+
}
|
|
3714
|
+
namespace SetDiscount {
|
|
3715
|
+
interface Settings {
|
|
3716
|
+
/**
|
|
3717
|
+
* Configures service period cycle anchoring.
|
|
3718
|
+
*/
|
|
3719
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3720
|
+
/**
|
|
3721
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
3722
|
+
*/
|
|
3723
|
+
start_date?: Settings.StartDate;
|
|
3724
|
+
}
|
|
3725
|
+
namespace Settings {
|
|
3726
|
+
interface ServicePeriodAnchorConfig {
|
|
3727
|
+
/**
|
|
3728
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3729
|
+
*/
|
|
3730
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3731
|
+
/**
|
|
3732
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3733
|
+
*/
|
|
3734
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3735
|
+
}
|
|
3736
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
3737
|
+
namespace ServicePeriodAnchorConfig {
|
|
3738
|
+
interface Custom {
|
|
3739
|
+
/**
|
|
3740
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3741
|
+
*/
|
|
3742
|
+
day_of_month: number;
|
|
3743
|
+
/**
|
|
3744
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3745
|
+
*/
|
|
3746
|
+
hour?: number;
|
|
3747
|
+
/**
|
|
3748
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3749
|
+
*/
|
|
3750
|
+
minute?: number;
|
|
3751
|
+
/**
|
|
3752
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3753
|
+
*/
|
|
3754
|
+
month?: number;
|
|
3755
|
+
/**
|
|
3756
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3757
|
+
*/
|
|
3758
|
+
second?: number;
|
|
3759
|
+
}
|
|
3760
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3761
|
+
}
|
|
3762
|
+
}
|
|
3763
|
+
}
|
|
3764
|
+
namespace SetItem {
|
|
3765
|
+
interface Discount {
|
|
3766
|
+
/**
|
|
3767
|
+
* ID of the coupon to create a new discount for.
|
|
3768
|
+
*/
|
|
3769
|
+
coupon?: string;
|
|
3770
|
+
/**
|
|
3771
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3772
|
+
*/
|
|
3773
|
+
discount?: string;
|
|
3774
|
+
/**
|
|
3775
|
+
* Details to determine how long the discount should be applied for.
|
|
3776
|
+
*/
|
|
3777
|
+
discount_end?: Discount.DiscountEnd;
|
|
3778
|
+
/**
|
|
3779
|
+
* ID of the promotion code to create a new discount for.
|
|
3780
|
+
*/
|
|
3781
|
+
promotion_code?: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* Settings for discount application including service period anchoring.
|
|
3784
|
+
*/
|
|
3785
|
+
settings?: Discount.Settings;
|
|
3786
|
+
}
|
|
3787
|
+
interface Trial {
|
|
3788
|
+
/**
|
|
3789
|
+
* 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.
|
|
3790
|
+
*/
|
|
3791
|
+
converts_to?: Array<string>;
|
|
3792
|
+
/**
|
|
3793
|
+
* Determines the type of trial for this item.
|
|
3794
|
+
*/
|
|
3795
|
+
type: Trial.Type;
|
|
3796
|
+
}
|
|
3797
|
+
namespace Discount {
|
|
3798
|
+
interface DiscountEnd {
|
|
3799
|
+
/**
|
|
3800
|
+
* Time span for the redeemed discount.
|
|
3801
|
+
*/
|
|
3802
|
+
duration?: DiscountEnd.Duration;
|
|
3803
|
+
/**
|
|
3804
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3805
|
+
*/
|
|
3806
|
+
timestamp?: number;
|
|
3807
|
+
/**
|
|
3808
|
+
* The type of calculation made to determine when the discount ends.
|
|
3809
|
+
*/
|
|
3810
|
+
type: DiscountEnd.Type;
|
|
3811
|
+
}
|
|
3812
|
+
interface Settings {
|
|
3813
|
+
/**
|
|
3814
|
+
* Configures service period cycle anchoring.
|
|
3815
|
+
*/
|
|
3816
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3817
|
+
/**
|
|
3818
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `line_start` if omitted.
|
|
3819
|
+
*/
|
|
3820
|
+
start_date?: Settings.StartDate;
|
|
3821
|
+
}
|
|
3822
|
+
namespace DiscountEnd {
|
|
3823
|
+
interface Duration {
|
|
3824
|
+
/**
|
|
3825
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3826
|
+
*/
|
|
3827
|
+
interval: Duration.Interval;
|
|
3828
|
+
/**
|
|
3829
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3830
|
+
*/
|
|
3831
|
+
interval_count: number;
|
|
3832
|
+
}
|
|
3833
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3834
|
+
namespace Duration {
|
|
3835
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3836
|
+
}
|
|
3837
|
+
}
|
|
3838
|
+
namespace Settings {
|
|
3839
|
+
interface ServicePeriodAnchorConfig {
|
|
3840
|
+
/**
|
|
3841
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3842
|
+
*/
|
|
3843
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3844
|
+
/**
|
|
3845
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3846
|
+
*/
|
|
3847
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3848
|
+
}
|
|
3849
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start' | OtherString;
|
|
3850
|
+
namespace ServicePeriodAnchorConfig {
|
|
3851
|
+
interface Custom {
|
|
3852
|
+
/**
|
|
3853
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3854
|
+
*/
|
|
3855
|
+
day_of_month: number;
|
|
3856
|
+
/**
|
|
3857
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3858
|
+
*/
|
|
3859
|
+
hour?: number;
|
|
3860
|
+
/**
|
|
3861
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3862
|
+
*/
|
|
3863
|
+
minute?: number;
|
|
3864
|
+
/**
|
|
3865
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3866
|
+
*/
|
|
3867
|
+
month?: number;
|
|
3868
|
+
/**
|
|
3869
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3870
|
+
*/
|
|
3871
|
+
second?: number;
|
|
3872
|
+
}
|
|
3873
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
3874
|
+
}
|
|
3875
|
+
}
|
|
3876
|
+
}
|
|
3877
|
+
namespace Trial {
|
|
3878
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
3879
|
+
}
|
|
3880
|
+
}
|
|
3881
|
+
}
|
|
3882
|
+
namespace AppliesTo {
|
|
3883
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
3884
|
+
}
|
|
3885
|
+
namespace EndsAt {
|
|
3886
|
+
interface DiscountEnd {
|
|
3887
|
+
/**
|
|
3888
|
+
* The ID of a specific discount.
|
|
3889
|
+
*/
|
|
3890
|
+
discount: string;
|
|
3891
|
+
}
|
|
3892
|
+
interface Duration {
|
|
3893
|
+
/**
|
|
3894
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3895
|
+
*/
|
|
3896
|
+
interval: Duration.Interval;
|
|
3897
|
+
/**
|
|
3898
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3899
|
+
*/
|
|
3900
|
+
interval_count: number;
|
|
3901
|
+
}
|
|
3902
|
+
type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
3903
|
+
namespace Duration {
|
|
3904
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3905
|
+
}
|
|
3906
|
+
}
|
|
3907
|
+
namespace SetPauseCollection {
|
|
3908
|
+
interface Set {
|
|
3909
|
+
/**
|
|
3910
|
+
* The payment collection behavior for this subscription while paused.
|
|
3911
|
+
*/
|
|
3912
|
+
behavior: Set.Behavior;
|
|
3913
|
+
}
|
|
3914
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
3915
|
+
namespace Set {
|
|
3916
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
3917
|
+
}
|
|
3918
|
+
}
|
|
3919
|
+
namespace StartsAt {
|
|
3920
|
+
interface DiscountEnd {
|
|
3921
|
+
/**
|
|
3922
|
+
* The ID of a specific discount.
|
|
3923
|
+
*/
|
|
3924
|
+
discount: string;
|
|
3925
|
+
}
|
|
3926
|
+
interface LineEndsAt {
|
|
3927
|
+
/**
|
|
3928
|
+
* The ID of a quote line.
|
|
3929
|
+
*/
|
|
3930
|
+
id?: string;
|
|
3931
|
+
/**
|
|
3932
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
3933
|
+
*/
|
|
3934
|
+
index?: number;
|
|
3935
|
+
}
|
|
3936
|
+
type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
3937
|
+
}
|
|
3938
|
+
namespace TrialSettings {
|
|
3939
|
+
interface EndBehavior {
|
|
3940
|
+
/**
|
|
3941
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3942
|
+
*/
|
|
3943
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3944
|
+
}
|
|
3945
|
+
namespace EndBehavior {
|
|
3946
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
3947
|
+
}
|
|
1143
3948
|
}
|
|
1144
3949
|
}
|
|
1145
3950
|
namespace LineItem {
|
|
@@ -1152,6 +3957,10 @@ export declare namespace QuoteUpdateParams {
|
|
|
1152
3957
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1153
3958
|
*/
|
|
1154
3959
|
discount?: string;
|
|
3960
|
+
/**
|
|
3961
|
+
* Details to determine how long the discount should be applied for.
|
|
3962
|
+
*/
|
|
3963
|
+
discount_end?: Discount.DiscountEnd;
|
|
1155
3964
|
/**
|
|
1156
3965
|
* ID of the promotion code to create a new discount for.
|
|
1157
3966
|
*/
|
|
@@ -1183,6 +3992,38 @@ export declare namespace QuoteUpdateParams {
|
|
|
1183
3992
|
*/
|
|
1184
3993
|
unit_amount_decimal?: Decimal;
|
|
1185
3994
|
}
|
|
3995
|
+
namespace Discount {
|
|
3996
|
+
interface DiscountEnd {
|
|
3997
|
+
/**
|
|
3998
|
+
* Time span for the redeemed discount.
|
|
3999
|
+
*/
|
|
4000
|
+
duration?: DiscountEnd.Duration;
|
|
4001
|
+
/**
|
|
4002
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4003
|
+
*/
|
|
4004
|
+
timestamp?: number;
|
|
4005
|
+
/**
|
|
4006
|
+
* The type of calculation made to determine when the discount ends.
|
|
4007
|
+
*/
|
|
4008
|
+
type: DiscountEnd.Type;
|
|
4009
|
+
}
|
|
4010
|
+
namespace DiscountEnd {
|
|
4011
|
+
interface Duration {
|
|
4012
|
+
/**
|
|
4013
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4014
|
+
*/
|
|
4015
|
+
interval: Duration.Interval;
|
|
4016
|
+
/**
|
|
4017
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4018
|
+
*/
|
|
4019
|
+
interval_count: number;
|
|
4020
|
+
}
|
|
4021
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4022
|
+
namespace Duration {
|
|
4023
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4024
|
+
}
|
|
4025
|
+
}
|
|
4026
|
+
}
|
|
1186
4027
|
namespace PriceData {
|
|
1187
4028
|
interface Recurring {
|
|
1188
4029
|
/**
|
|
@@ -1200,6 +4041,409 @@ export declare namespace QuoteUpdateParams {
|
|
|
1200
4041
|
}
|
|
1201
4042
|
}
|
|
1202
4043
|
}
|
|
4044
|
+
namespace SubscriptionData {
|
|
4045
|
+
interface BillOnAcceptance {
|
|
4046
|
+
/**
|
|
4047
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
4048
|
+
*/
|
|
4049
|
+
bill_from?: BillOnAcceptance.BillFrom;
|
|
4050
|
+
/**
|
|
4051
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
4052
|
+
*/
|
|
4053
|
+
bill_until?: BillOnAcceptance.BillUntil;
|
|
4054
|
+
}
|
|
4055
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
4056
|
+
interface BillingSchedule {
|
|
4057
|
+
/**
|
|
4058
|
+
* Configure billing schedule differently for individual subscription items.
|
|
4059
|
+
*/
|
|
4060
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
4061
|
+
/**
|
|
4062
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
4063
|
+
*/
|
|
4064
|
+
bill_from?: BillingSchedule.BillFrom;
|
|
4065
|
+
/**
|
|
4066
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
4067
|
+
*/
|
|
4068
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
4069
|
+
/**
|
|
4070
|
+
* 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.
|
|
4071
|
+
*/
|
|
4072
|
+
key?: string;
|
|
4073
|
+
}
|
|
4074
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
4075
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
4076
|
+
interface Prebilling {
|
|
4077
|
+
/**
|
|
4078
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
4079
|
+
*/
|
|
4080
|
+
iterations: number;
|
|
4081
|
+
}
|
|
4082
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4083
|
+
namespace BillingSchedule {
|
|
4084
|
+
interface AppliesTo {
|
|
4085
|
+
/**
|
|
4086
|
+
* The ID of the price object.
|
|
4087
|
+
*/
|
|
4088
|
+
price?: string;
|
|
4089
|
+
/**
|
|
4090
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4091
|
+
*/
|
|
4092
|
+
type: 'price';
|
|
4093
|
+
}
|
|
4094
|
+
interface BillFrom {
|
|
4095
|
+
/**
|
|
4096
|
+
* Details of a Quote line to start the bill period from.
|
|
4097
|
+
*/
|
|
4098
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
4099
|
+
/**
|
|
4100
|
+
* A precise Unix timestamp.
|
|
4101
|
+
*/
|
|
4102
|
+
timestamp?: number;
|
|
4103
|
+
/**
|
|
4104
|
+
* The type of method to specify the `bill_from` time.
|
|
4105
|
+
*/
|
|
4106
|
+
type: BillFrom.Type;
|
|
4107
|
+
}
|
|
4108
|
+
interface BillUntil {
|
|
4109
|
+
/**
|
|
4110
|
+
* Details of the duration over which to bill.
|
|
4111
|
+
*/
|
|
4112
|
+
duration?: BillUntil.Duration;
|
|
4113
|
+
/**
|
|
4114
|
+
* Details of a Quote line item from which to bill until.
|
|
4115
|
+
*/
|
|
4116
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
4117
|
+
/**
|
|
4118
|
+
* A precise Unix timestamp.
|
|
4119
|
+
*/
|
|
4120
|
+
timestamp?: number;
|
|
4121
|
+
/**
|
|
4122
|
+
* The type of method to specify the `bill_until` time.
|
|
4123
|
+
*/
|
|
4124
|
+
type: BillUntil.Type;
|
|
4125
|
+
}
|
|
4126
|
+
namespace BillFrom {
|
|
4127
|
+
interface LineStartsAt {
|
|
4128
|
+
/**
|
|
4129
|
+
* The ID of a quote line.
|
|
4130
|
+
*/
|
|
4131
|
+
id?: string;
|
|
4132
|
+
/**
|
|
4133
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4134
|
+
*/
|
|
4135
|
+
index?: number;
|
|
4136
|
+
}
|
|
4137
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4138
|
+
}
|
|
4139
|
+
namespace BillUntil {
|
|
4140
|
+
interface Duration {
|
|
4141
|
+
/**
|
|
4142
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4143
|
+
*/
|
|
4144
|
+
interval: Duration.Interval;
|
|
4145
|
+
/**
|
|
4146
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4147
|
+
*/
|
|
4148
|
+
interval_count: number;
|
|
4149
|
+
}
|
|
4150
|
+
interface LineEndsAt {
|
|
4151
|
+
/**
|
|
4152
|
+
* The ID of a quote line.
|
|
4153
|
+
*/
|
|
4154
|
+
id?: string;
|
|
4155
|
+
/**
|
|
4156
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4157
|
+
*/
|
|
4158
|
+
index?: number;
|
|
4159
|
+
}
|
|
4160
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
4161
|
+
namespace Duration {
|
|
4162
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4163
|
+
}
|
|
4164
|
+
}
|
|
4165
|
+
}
|
|
4166
|
+
namespace BillOnAcceptance {
|
|
4167
|
+
interface BillFrom {
|
|
4168
|
+
/**
|
|
4169
|
+
* Details of a Quote line to start the bill period from.
|
|
4170
|
+
*/
|
|
4171
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
4172
|
+
/**
|
|
4173
|
+
* A precise Unix timestamp.
|
|
4174
|
+
*/
|
|
4175
|
+
timestamp?: number;
|
|
4176
|
+
/**
|
|
4177
|
+
* The type of method to specify the `bill_from` time.
|
|
4178
|
+
*/
|
|
4179
|
+
type: BillFrom.Type;
|
|
4180
|
+
}
|
|
4181
|
+
interface BillUntil {
|
|
4182
|
+
/**
|
|
4183
|
+
* Details of the duration over which to bill.
|
|
4184
|
+
*/
|
|
4185
|
+
duration?: BillUntil.Duration;
|
|
4186
|
+
/**
|
|
4187
|
+
* Details of a Quote line item from which to bill until.
|
|
4188
|
+
*/
|
|
4189
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
4190
|
+
/**
|
|
4191
|
+
* A precise Unix timestamp.
|
|
4192
|
+
*/
|
|
4193
|
+
timestamp?: number;
|
|
4194
|
+
/**
|
|
4195
|
+
* The type of method to specify the `bill_until` time.
|
|
4196
|
+
*/
|
|
4197
|
+
type: BillUntil.Type;
|
|
4198
|
+
}
|
|
4199
|
+
namespace BillFrom {
|
|
4200
|
+
interface LineStartsAt {
|
|
4201
|
+
/**
|
|
4202
|
+
* The ID of a quote line.
|
|
4203
|
+
*/
|
|
4204
|
+
id?: string;
|
|
4205
|
+
/**
|
|
4206
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4207
|
+
*/
|
|
4208
|
+
index?: number;
|
|
4209
|
+
}
|
|
4210
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
4211
|
+
}
|
|
4212
|
+
namespace BillUntil {
|
|
4213
|
+
interface Duration {
|
|
4214
|
+
/**
|
|
4215
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4216
|
+
*/
|
|
4217
|
+
interval: Duration.Interval;
|
|
4218
|
+
/**
|
|
4219
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4220
|
+
*/
|
|
4221
|
+
interval_count: number;
|
|
4222
|
+
}
|
|
4223
|
+
interface LineEndsAt {
|
|
4224
|
+
/**
|
|
4225
|
+
* The ID of a quote line.
|
|
4226
|
+
*/
|
|
4227
|
+
id?: string;
|
|
4228
|
+
/**
|
|
4229
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4230
|
+
*/
|
|
4231
|
+
index?: number;
|
|
4232
|
+
}
|
|
4233
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
4234
|
+
namespace Duration {
|
|
4235
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4236
|
+
}
|
|
4237
|
+
}
|
|
4238
|
+
}
|
|
4239
|
+
}
|
|
4240
|
+
namespace SubscriptionDataOverride {
|
|
4241
|
+
interface AppliesTo {
|
|
4242
|
+
/**
|
|
4243
|
+
* A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
|
|
4244
|
+
*/
|
|
4245
|
+
new_reference?: string;
|
|
4246
|
+
/**
|
|
4247
|
+
* The ID of the schedule the line applies to.
|
|
4248
|
+
*/
|
|
4249
|
+
subscription_schedule?: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
4252
|
+
*/
|
|
4253
|
+
type: AppliesTo.Type;
|
|
4254
|
+
}
|
|
4255
|
+
interface BillOnAcceptance {
|
|
4256
|
+
/**
|
|
4257
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
4258
|
+
*/
|
|
4259
|
+
bill_from?: BillOnAcceptance.BillFrom;
|
|
4260
|
+
/**
|
|
4261
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
4262
|
+
*/
|
|
4263
|
+
bill_until?: BillOnAcceptance.BillUntil;
|
|
4264
|
+
}
|
|
4265
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
4266
|
+
interface BillingSchedule {
|
|
4267
|
+
/**
|
|
4268
|
+
* Configure billing schedule differently for individual subscription items.
|
|
4269
|
+
*/
|
|
4270
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
4271
|
+
/**
|
|
4272
|
+
* The start of the period to bill from when the Quote is accepted.
|
|
4273
|
+
*/
|
|
4274
|
+
bill_from?: BillingSchedule.BillFrom;
|
|
4275
|
+
/**
|
|
4276
|
+
* The end of the period to bill until when the Quote is accepted.
|
|
4277
|
+
*/
|
|
4278
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
4279
|
+
/**
|
|
4280
|
+
* 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.
|
|
4281
|
+
*/
|
|
4282
|
+
key?: string;
|
|
4283
|
+
}
|
|
4284
|
+
type EndBehavior = 'cancel' | 'release' | OtherString;
|
|
4285
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start' | OtherString;
|
|
4286
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4287
|
+
namespace AppliesTo {
|
|
4288
|
+
type Type = 'new_reference' | 'subscription_schedule' | OtherString;
|
|
4289
|
+
}
|
|
4290
|
+
namespace BillingSchedule {
|
|
4291
|
+
interface AppliesTo {
|
|
4292
|
+
/**
|
|
4293
|
+
* The ID of the price object.
|
|
4294
|
+
*/
|
|
4295
|
+
price?: string;
|
|
4296
|
+
/**
|
|
4297
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4298
|
+
*/
|
|
4299
|
+
type: 'price';
|
|
4300
|
+
}
|
|
4301
|
+
interface BillFrom {
|
|
4302
|
+
/**
|
|
4303
|
+
* Details of a Quote line to start the bill period from.
|
|
4304
|
+
*/
|
|
4305
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
4306
|
+
/**
|
|
4307
|
+
* A precise Unix timestamp.
|
|
4308
|
+
*/
|
|
4309
|
+
timestamp?: number;
|
|
4310
|
+
/**
|
|
4311
|
+
* The type of method to specify the `bill_from` time.
|
|
4312
|
+
*/
|
|
4313
|
+
type: BillFrom.Type;
|
|
4314
|
+
}
|
|
4315
|
+
interface BillUntil {
|
|
4316
|
+
/**
|
|
4317
|
+
* Details of the duration over which to bill.
|
|
4318
|
+
*/
|
|
4319
|
+
duration?: BillUntil.Duration;
|
|
4320
|
+
/**
|
|
4321
|
+
* Details of a Quote line item from which to bill until.
|
|
4322
|
+
*/
|
|
4323
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
4324
|
+
/**
|
|
4325
|
+
* A precise Unix timestamp.
|
|
4326
|
+
*/
|
|
4327
|
+
timestamp?: number;
|
|
4328
|
+
/**
|
|
4329
|
+
* The type of method to specify the `bill_until` time.
|
|
4330
|
+
*/
|
|
4331
|
+
type: BillUntil.Type;
|
|
4332
|
+
}
|
|
4333
|
+
namespace BillFrom {
|
|
4334
|
+
interface LineStartsAt {
|
|
4335
|
+
/**
|
|
4336
|
+
* The ID of a quote line.
|
|
4337
|
+
*/
|
|
4338
|
+
id?: string;
|
|
4339
|
+
/**
|
|
4340
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4341
|
+
*/
|
|
4342
|
+
index?: number;
|
|
4343
|
+
}
|
|
4344
|
+
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4345
|
+
}
|
|
4346
|
+
namespace BillUntil {
|
|
4347
|
+
interface Duration {
|
|
4348
|
+
/**
|
|
4349
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4350
|
+
*/
|
|
4351
|
+
interval: Duration.Interval;
|
|
4352
|
+
/**
|
|
4353
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4354
|
+
*/
|
|
4355
|
+
interval_count: number;
|
|
4356
|
+
}
|
|
4357
|
+
interface LineEndsAt {
|
|
4358
|
+
/**
|
|
4359
|
+
* The ID of a quote line.
|
|
4360
|
+
*/
|
|
4361
|
+
id?: string;
|
|
4362
|
+
/**
|
|
4363
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4364
|
+
*/
|
|
4365
|
+
index?: number;
|
|
4366
|
+
}
|
|
4367
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
4368
|
+
namespace Duration {
|
|
4369
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4370
|
+
}
|
|
4371
|
+
}
|
|
4372
|
+
}
|
|
4373
|
+
namespace BillOnAcceptance {
|
|
4374
|
+
interface BillFrom {
|
|
4375
|
+
/**
|
|
4376
|
+
* Details of a Quote line to start the bill period from.
|
|
4377
|
+
*/
|
|
4378
|
+
line_starts_at?: BillFrom.LineStartsAt;
|
|
4379
|
+
/**
|
|
4380
|
+
* A precise Unix timestamp.
|
|
4381
|
+
*/
|
|
4382
|
+
timestamp?: number;
|
|
4383
|
+
/**
|
|
4384
|
+
* The type of method to specify the `bill_from` time.
|
|
4385
|
+
*/
|
|
4386
|
+
type: BillFrom.Type;
|
|
4387
|
+
}
|
|
4388
|
+
interface BillUntil {
|
|
4389
|
+
/**
|
|
4390
|
+
* Details of the duration over which to bill.
|
|
4391
|
+
*/
|
|
4392
|
+
duration?: BillUntil.Duration;
|
|
4393
|
+
/**
|
|
4394
|
+
* Details of a Quote line item from which to bill until.
|
|
4395
|
+
*/
|
|
4396
|
+
line_ends_at?: BillUntil.LineEndsAt;
|
|
4397
|
+
/**
|
|
4398
|
+
* A precise Unix timestamp.
|
|
4399
|
+
*/
|
|
4400
|
+
timestamp?: number;
|
|
4401
|
+
/**
|
|
4402
|
+
* The type of method to specify the `bill_until` time.
|
|
4403
|
+
*/
|
|
4404
|
+
type: BillUntil.Type;
|
|
4405
|
+
}
|
|
4406
|
+
namespace BillFrom {
|
|
4407
|
+
interface LineStartsAt {
|
|
4408
|
+
/**
|
|
4409
|
+
* The ID of a quote line.
|
|
4410
|
+
*/
|
|
4411
|
+
id?: string;
|
|
4412
|
+
/**
|
|
4413
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4414
|
+
*/
|
|
4415
|
+
index?: number;
|
|
4416
|
+
}
|
|
4417
|
+
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp' | OtherString;
|
|
4418
|
+
}
|
|
4419
|
+
namespace BillUntil {
|
|
4420
|
+
interface Duration {
|
|
4421
|
+
/**
|
|
4422
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4423
|
+
*/
|
|
4424
|
+
interval: Duration.Interval;
|
|
4425
|
+
/**
|
|
4426
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4427
|
+
*/
|
|
4428
|
+
interval_count: number;
|
|
4429
|
+
}
|
|
4430
|
+
interface LineEndsAt {
|
|
4431
|
+
/**
|
|
4432
|
+
* The ID of a quote line.
|
|
4433
|
+
*/
|
|
4434
|
+
id?: string;
|
|
4435
|
+
/**
|
|
4436
|
+
* The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
|
|
4437
|
+
*/
|
|
4438
|
+
index?: number;
|
|
4439
|
+
}
|
|
4440
|
+
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice' | OtherString;
|
|
4441
|
+
namespace Duration {
|
|
4442
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4443
|
+
}
|
|
4444
|
+
}
|
|
4445
|
+
}
|
|
4446
|
+
}
|
|
1203
4447
|
}
|
|
1204
4448
|
export interface QuoteListParams extends PaginationParams {
|
|
1205
4449
|
/**
|
|
@@ -1214,6 +4458,10 @@ export interface QuoteListParams extends PaginationParams {
|
|
|
1214
4458
|
* Specifies which fields in the response should be expanded.
|
|
1215
4459
|
*/
|
|
1216
4460
|
expand?: Array<string>;
|
|
4461
|
+
/**
|
|
4462
|
+
* The subscription which the quote updates.
|
|
4463
|
+
*/
|
|
4464
|
+
from_subscription?: string;
|
|
1217
4465
|
/**
|
|
1218
4466
|
* The status of the quote.
|
|
1219
4467
|
*/
|
|
@@ -1224,7 +4472,7 @@ export interface QuoteListParams extends PaginationParams {
|
|
|
1224
4472
|
test_clock?: string;
|
|
1225
4473
|
}
|
|
1226
4474
|
export declare namespace QuoteListParams {
|
|
1227
|
-
type Status = 'accepted' | 'canceled' | 'draft' | 'open' | OtherString;
|
|
4475
|
+
type Status = 'accepted' | 'accepting' | 'canceled' | 'draft' | 'open' | 'stale' | OtherString;
|
|
1228
4476
|
}
|
|
1229
4477
|
export interface QuoteAcceptParams {
|
|
1230
4478
|
/**
|
|
@@ -1248,6 +4496,12 @@ export interface QuoteFinalizeQuoteParams {
|
|
|
1248
4496
|
*/
|
|
1249
4497
|
expires_at?: number;
|
|
1250
4498
|
}
|
|
4499
|
+
export interface QuoteListPreviewInvoiceLinesParams extends PaginationParams {
|
|
4500
|
+
/**
|
|
4501
|
+
* Specifies which fields in the response should be expanded.
|
|
4502
|
+
*/
|
|
4503
|
+
expand?: Array<string>;
|
|
4504
|
+
}
|
|
1251
4505
|
export interface QuoteListComputedUpfrontLineItemsParams extends PaginationParams {
|
|
1252
4506
|
/**
|
|
1253
4507
|
* Specifies which fields in the response should be expanded.
|
|
@@ -1260,9 +4514,49 @@ export interface QuoteListLineItemsParams extends PaginationParams {
|
|
|
1260
4514
|
*/
|
|
1261
4515
|
expand?: Array<string>;
|
|
1262
4516
|
}
|
|
4517
|
+
export interface QuoteListLinesParams extends PaginationParams {
|
|
4518
|
+
/**
|
|
4519
|
+
* Specifies which fields in the response should be expanded.
|
|
4520
|
+
*/
|
|
4521
|
+
expand?: Array<string>;
|
|
4522
|
+
}
|
|
4523
|
+
export interface QuoteListPreviewInvoicesParams extends PaginationParams {
|
|
4524
|
+
/**
|
|
4525
|
+
* Specifies which fields in the response should be expanded.
|
|
4526
|
+
*/
|
|
4527
|
+
expand?: Array<string>;
|
|
4528
|
+
}
|
|
4529
|
+
export interface QuoteListPreviewSubscriptionSchedulesParams extends PaginationParams {
|
|
4530
|
+
/**
|
|
4531
|
+
* Specifies which fields in the response should be expanded.
|
|
4532
|
+
*/
|
|
4533
|
+
expand?: Array<string>;
|
|
4534
|
+
}
|
|
4535
|
+
export interface QuoteMarkDraftParams {
|
|
4536
|
+
/**
|
|
4537
|
+
* Specifies which fields in the response should be expanded.
|
|
4538
|
+
*/
|
|
4539
|
+
expand?: Array<string>;
|
|
4540
|
+
}
|
|
4541
|
+
export interface QuoteMarkStaleParams {
|
|
4542
|
+
/**
|
|
4543
|
+
* Specifies which fields in the response should be expanded.
|
|
4544
|
+
*/
|
|
4545
|
+
expand?: Array<string>;
|
|
4546
|
+
/**
|
|
4547
|
+
* Reason the Quote is being marked stale.
|
|
4548
|
+
*/
|
|
4549
|
+
reason?: string;
|
|
4550
|
+
}
|
|
1263
4551
|
export interface QuotePdfParams {
|
|
1264
4552
|
/**
|
|
1265
4553
|
* Specifies which fields in the response should be expanded.
|
|
1266
4554
|
*/
|
|
1267
4555
|
expand?: Array<string>;
|
|
1268
4556
|
}
|
|
4557
|
+
export interface QuoteReestimateParams {
|
|
4558
|
+
/**
|
|
4559
|
+
* Specifies which fields in the response should be expanded.
|
|
4560
|
+
*/
|
|
4561
|
+
expand?: Array<string>;
|
|
4562
|
+
}
|