stripe 22.3.0 → 22.4.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2984 -12
- package/OPENAPI_VERSION +1 -1
- package/README.md +44 -60
- package/VERSION +1 -1
- package/cjs/Error.d.ts +53 -0
- package/cjs/Error.js +134 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +476 -0
- package/cjs/StripeEventNotificationHandler.js.map +1 -0
- package/cjs/Types.d.ts +4 -2
- package/cjs/apiVersion.d.ts +1 -2
- package/cjs/apiVersion.js +2 -3
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +5 -1
- package/cjs/resources/AccountNotices.d.ts +140 -0
- package/cjs/resources/AccountNotices.js +29 -0
- package/cjs/resources/AccountNotices.js.map +1 -0
- package/cjs/resources/AccountSessions.d.ts +597 -0
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/AccountSignals.d.ts +110 -0
- package/cjs/resources/AccountSignals.js +4 -0
- package/cjs/resources/AccountSignals.js.map +1 -0
- package/cjs/resources/Accounts.d.ts +1020 -6
- package/cjs/resources/Accounts.js +47 -0
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplicationFees.d.ts +28 -1
- package/cjs/resources/Balance.d.ts +134 -0
- package/cjs/resources/BalanceSettings.d.ts +18 -0
- package/cjs/resources/BalanceTransactions.d.ts +1 -1
- package/cjs/resources/BalanceTransfers.d.ts +160 -0
- package/cjs/resources/BalanceTransfers.js +15 -0
- package/cjs/resources/BalanceTransfers.js.map +1 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertRecovereds.d.ts +40 -0
- package/cjs/resources/Billing/AlertRecovereds.js +4 -0
- package/cjs/resources/Billing/AlertRecovereds.js.map +1 -0
- package/cjs/resources/Billing/AlertTriggereds.d.ts +55 -1
- package/cjs/resources/Billing/Alerts.d.ts +408 -5
- package/cjs/resources/Billing/Alerts.js +321 -5
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
- package/cjs/resources/Billing/Analytics/index.js +13 -0
- package/cjs/resources/Billing/Analytics/index.js.map +1 -0
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +126 -2
- package/cjs/resources/Billing/CreditBalanceSummary.js +39 -1
- package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/cjs/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/cjs/resources/Billing/CreditGrants.d.ts +85 -3
- package/cjs/resources/Billing/CreditGrants.js +134 -5
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/cjs/resources/Billing/Meters.d.ts +31 -0
- package/cjs/resources/Billing/index.d.ts +6 -0
- package/cjs/resources/Billing/index.js +2 -0
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/Capabilities.d.ts +25 -2
- package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
- package/cjs/resources/Capital/FinancingOffers.js +30 -0
- package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/Capital/FinancingSummary.d.ts +101 -0
- package/cjs/resources/Capital/FinancingSummary.js +15 -0
- package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
- package/cjs/resources/Capital/FinancingTransactions.d.ts +141 -0
- package/cjs/resources/Capital/FinancingTransactions.js +24 -0
- package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
- package/cjs/resources/Capital/index.d.ts +25 -0
- package/cjs/resources/Capital/index.js +17 -0
- package/cjs/resources/Capital/index.js.map +1 -0
- package/cjs/resources/Cards.d.ts +28 -0
- package/cjs/resources/Charges.d.ts +3352 -70
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1174 -22
- package/cjs/resources/Checkout/Sessions.js +115 -0
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -0
- package/cjs/resources/ConfirmationTokens.d.ts +139 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +128 -2
- package/cjs/resources/Coupons.js +41 -0
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +7 -1
- package/cjs/resources/CreditNotes.js +13 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/Crypto/CustomerConsumerWallets.d.ts +29 -0
- package/cjs/resources/Crypto/CustomerConsumerWallets.js +4 -0
- package/cjs/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.d.ts +79 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.js +4 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
- package/cjs/resources/Crypto/Customers.d.ts +111 -0
- package/cjs/resources/Crypto/Customers.js +31 -0
- package/cjs/resources/Crypto/Customers.js.map +1 -0
- package/cjs/resources/Crypto/OnrampSessions.d.ts +413 -0
- package/cjs/resources/Crypto/OnrampSessions.js +47 -0
- package/cjs/resources/Crypto/OnrampSessions.js.map +1 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.d.ts +60 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.js +15 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
- package/cjs/resources/Crypto/index.d.ts +34 -0
- package/cjs/resources/Crypto/index.js +17 -0
- package/cjs/resources/Crypto/index.js.map +1 -0
- package/cjs/resources/CustomerSessions.d.ts +74 -0
- package/cjs/resources/CustomerSessions.js +13 -0
- package/cjs/resources/CustomerSessions.js.map +1 -1
- package/cjs/resources/Customers.d.ts +98 -1
- package/cjs/resources/Customers.js +195 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +128 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js +4 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/Orders.d.ts +159 -0
- package/cjs/resources/DelegatedCheckout/Orders.js +15 -0
- package/cjs/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1416 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +47 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/index.d.ts +25 -0
- package/cjs/resources/DelegatedCheckout/index.js +15 -0
- package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
- package/cjs/resources/Discounts.d.ts +19 -0
- package/cjs/resources/Disputes.d.ts +43 -0
- package/cjs/resources/Disputes.js +14 -0
- package/cjs/resources/Disputes.js.map +1 -1
- package/cjs/resources/Events.d.ts +573 -2
- package/cjs/resources/ExternalAccounts.d.ts +212 -1
- package/cjs/resources/ExternalAccounts.js +44 -0
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/cjs/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/cjs/resources/FinancialConnections/Accounts.js +8 -0
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +99 -0
- package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
- package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/cjs/resources/FinancialConnections/Institutions.d.ts +99 -0
- package/cjs/resources/FinancialConnections/Institutions.js +23 -0
- package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
- package/cjs/resources/FinancialConnections/Sessions.d.ts +156 -7
- package/cjs/resources/FinancialConnections/Sessions.js.map +1 -1
- package/cjs/resources/FinancialConnections/index.d.ts +21 -6
- package/cjs/resources/FinancialConnections/index.js +4 -0
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/FrMealVouchersOnboardings.d.ts +173 -0
- package/cjs/resources/FrMealVouchersOnboardings.js +42 -0
- package/cjs/resources/FrMealVouchersOnboardings.js.map +1 -0
- package/cjs/resources/FxQuotes.d.ts +212 -0
- package/cjs/resources/FxQuotes.js +29 -0
- package/cjs/resources/FxQuotes.js.map +1 -0
- package/cjs/resources/GiftCardOperations.d.ts +248 -0
- package/cjs/resources/GiftCardOperations.js +15 -0
- package/cjs/resources/GiftCardOperations.js.map +1 -0
- package/cjs/resources/GiftCards.d.ts +187 -0
- package/cjs/resources/GiftCards.js +51 -0
- package/cjs/resources/GiftCards.js.map +1 -0
- package/cjs/resources/Identity/BlocklistEntries.d.ts +155 -0
- package/cjs/resources/Identity/BlocklistEntries.js +54 -0
- package/cjs/resources/Identity/BlocklistEntries.js.map +1 -0
- package/cjs/resources/Identity/VerificationReports.d.ts +33 -2
- package/cjs/resources/Identity/VerificationReports.js.map +1 -1
- package/cjs/resources/Identity/VerificationSessions.d.ts +11 -3
- package/cjs/resources/Identity/index.d.ts +18 -10
- package/cjs/resources/Identity/index.js +2 -0
- package/cjs/resources/Identity/index.js.map +1 -1
- package/cjs/resources/InvoiceItems.d.ts +203 -2
- package/cjs/resources/InvoiceItems.js +41 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +174 -4
- package/cjs/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +2120 -22
- package/cjs/resources/Invoices.js +221 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +435 -1
- package/cjs/resources/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +18 -4
- package/cjs/resources/Issuing/Cards.d.ts +53 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +53 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/cjs/resources/Issuing/Disputes.d.ts +246 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/cjs/resources/Issuing/Programs.d.ts +95 -0
- package/cjs/resources/Issuing/Programs.js +35 -0
- package/cjs/resources/Issuing/Programs.js.map +1 -0
- package/cjs/resources/Issuing/Settlements.d.ts +83 -0
- package/cjs/resources/Issuing/Settlements.js +4 -0
- package/cjs/resources/Issuing/Settlements.js.map +1 -0
- package/cjs/resources/Issuing/Tokens.d.ts +26 -0
- package/cjs/resources/Issuing/Transactions.d.ts +178 -0
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +56 -22
- package/cjs/resources/Issuing/index.js +8 -0
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +29 -2
- package/cjs/resources/Mandates.d.ts +47 -1
- package/cjs/resources/Mandates.js +8 -0
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/Margins.d.ts +115 -0
- package/cjs/resources/Margins.js +35 -0
- package/cjs/resources/Margins.js.map +1 -0
- package/cjs/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js +15 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/cjs/resources/Orchestration/index.d.ts +12 -0
- package/cjs/resources/Orchestration/index.js +13 -0
- package/cjs/resources/Orchestration/index.js.map +1 -0
- package/cjs/resources/Orders.d.ts +4773 -0
- package/cjs/resources/Orders.js +457 -0
- package/cjs/resources/Orders.js.map +1 -0
- package/cjs/resources/PaymentAttemptRecords.d.ts +664 -2
- package/cjs/resources/PaymentAttemptRecords.js +48 -0
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
- package/cjs/resources/PaymentIntents.d.ts +16756 -3555
- package/cjs/resources/PaymentIntents.js +46 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +74 -12
- package/cjs/resources/PaymentLocationCapabilities.d.ts +122 -0
- package/cjs/resources/PaymentLocationCapabilities.js +29 -0
- package/cjs/resources/PaymentLocationCapabilities.js.map +1 -0
- package/cjs/resources/PaymentLocations.d.ts +178 -0
- package/cjs/resources/PaymentLocations.js +41 -0
- package/cjs/resources/PaymentLocations.js.map +1 -0
- package/cjs/resources/PaymentMethodBalances.d.ts +46 -0
- package/cjs/resources/PaymentMethodBalances.js +4 -0
- package/cjs/resources/PaymentMethodBalances.js.map +1 -0
- package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/cjs/resources/PaymentMethods.d.ts +290 -3
- package/cjs/resources/PaymentMethods.js +20 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +623 -19
- package/cjs/resources/PaymentRecords.js +11 -0
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Persons.d.ts +25 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +76 -0
- package/cjs/resources/Prices.js +27 -0
- package/cjs/resources/Prices.js.map +1 -1
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/cjs/resources/Privacy/RedactionJobs.d.ts +227 -0
- package/cjs/resources/Privacy/RedactionJobs.js +73 -0
- package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
- package/cjs/resources/Privacy/index.d.ts +22 -0
- package/cjs/resources/Privacy/index.js +13 -0
- package/cjs/resources/Privacy/index.js.map +1 -0
- package/cjs/resources/ProductCatalog/TrialOffers.d.ts +125 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/cjs/resources/ProductCatalog/index.d.ts +12 -0
- package/cjs/resources/ProductCatalog/index.js +13 -0
- package/cjs/resources/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/Products.d.ts +198 -0
- package/cjs/resources/Products.js +69 -0
- package/cjs/resources/Products.js.map +1 -1
- package/cjs/resources/Profiles.d.ts +26 -0
- package/cjs/resources/Profiles.js +4 -0
- package/cjs/resources/Profiles.js.map +1 -0
- package/cjs/resources/PromotionCodes.d.ts +12 -0
- package/cjs/resources/PromotionCodes.js +27 -0
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/QuoteLines.d.ts +684 -0
- package/cjs/resources/QuoteLines.js +4 -0
- package/cjs/resources/QuoteLines.js.map +1 -0
- package/cjs/resources/QuotePreviewInvoices.d.ts +1173 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +902 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +3548 -254
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/cjs/resources/Radar/AccountEvaluations.js +27 -0
- package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
- package/cjs/resources/Radar/CustomerEvaluations.d.ts +244 -0
- package/cjs/resources/Radar/CustomerEvaluations.js +27 -0
- package/cjs/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js +15 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +63 -1
- package/cjs/resources/Radar/ValueListItems.d.ts +38 -0
- package/cjs/resources/Radar/ValueListItems.js +13 -0
- package/cjs/resources/Radar/ValueListItems.js.map +1 -1
- package/cjs/resources/Radar/index.d.ts +36 -16
- package/cjs/resources/Radar/index.js +6 -0
- package/cjs/resources/Radar/index.js.map +1 -1
- package/cjs/resources/Refunds.d.ts +35 -0
- package/cjs/resources/Refunds.js +27 -0
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reserve/Holds.d.ts +53 -1
- package/cjs/resources/Reserve/Holds.js +19 -0
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +16 -0
- package/cjs/resources/Reserve/Plans.js +11 -0
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +41 -1
- package/cjs/resources/Reserve/Releases.js +19 -0
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +17 -6
- package/cjs/resources/Reserve/index.js +9 -0
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/RiskSignals.d.ts +10 -0
- package/cjs/resources/RiskSignals.js +4 -0
- package/cjs/resources/RiskSignals.js.map +1 -0
- package/cjs/resources/SetupAttempts.d.ts +26 -1
- package/cjs/resources/SetupIntents.d.ts +603 -11
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1146 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/IssuedTokens.d.ts +320 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/index.d.ts +19 -0
- package/cjs/resources/SharedPayment/index.js +15 -0
- package/cjs/resources/SharedPayment/index.js.map +1 -0
- package/cjs/resources/Sources.d.ts +29 -1
- package/cjs/resources/SubscriptionItems.d.ts +265 -0
- package/cjs/resources/SubscriptionItems.js +41 -0
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +1949 -19
- package/cjs/resources/SubscriptionSchedules.js +61 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +965 -12
- package/cjs/resources/Subscriptions.js +289 -0
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/cjs/resources/Tax/Calculations.d.ts +45 -3
- package/cjs/resources/Tax/Forms.d.ts +228 -0
- package/cjs/resources/Tax/Forms.js +32 -0
- package/cjs/resources/Tax/Forms.js.map +1 -0
- package/cjs/resources/Tax/Locations.d.ts +108 -0
- package/cjs/resources/Tax/Locations.js +33 -0
- package/cjs/resources/Tax/Locations.js.map +1 -0
- package/cjs/resources/Tax/Registrations.d.ts +171 -2
- package/cjs/resources/Tax/Registrations.js +27 -0
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +8 -0
- package/cjs/resources/Tax/Settings.js +13 -0
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/Transactions.d.ts +10 -2
- package/cjs/resources/Tax/Transactions.js +13 -0
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- package/cjs/resources/Tax/index.d.ts +31 -13
- package/cjs/resources/Tax/index.js +4 -0
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +15 -0
- package/cjs/resources/TaxFunds.d.ts +174 -0
- package/cjs/resources/TaxFunds.js +23 -0
- package/cjs/resources/TaxFunds.js.map +1 -0
- package/cjs/resources/TaxIds.d.ts +6 -0
- package/cjs/resources/TaxIds.js +13 -0
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +12 -0
- package/cjs/resources/TaxRates.js +27 -0
- package/cjs/resources/TaxRates.js.map +1 -1
- package/cjs/resources/Terminal/Configurations.d.ts +27 -0
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/cjs/resources/Terminal/Readers.d.ts +17 -1
- package/cjs/resources/Terminal/index.d.ts +5 -0
- package/cjs/resources/Terminal/index.js +2 -0
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/Capital/index.js +13 -0
- package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +94 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +18 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.d.ts +126 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js +39 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +26 -0
- package/cjs/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/cjs/resources/TestHelpers/PaymentIntents.d.ts +37 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js +15 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/cjs/resources/TestHelpers/index.d.ts +14 -6
- package/cjs/resources/TestHelpers/index.js +12 -6
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Tokens.d.ts +76 -0
- package/cjs/resources/Transfers.d.ts +12 -0
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/TransitBalances.d.ts +25 -0
- package/cjs/resources/TransitBalances.js +4 -0
- package/cjs/resources/TransitBalances.js.map +1 -0
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings.d.ts +280 -0
- package/cjs/resources/V2/Billing/BillSettings.js +41 -0
- package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js +4 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js +23 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences.d.ts +1011 -0
- package/cjs/resources/V2/Billing/Cadences.js +264 -0
- package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings.d.ts +775 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js +4 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +29 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.js +15 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts.d.ts +1775 -0
- package/cjs/resources/V2/Billing/Contracts.js +607 -0
- package/cjs/resources/V2/Billing/Contracts.js.map +1 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +35 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/cjs/resources/V2/Billing/IntentActions.d.ts +603 -0
- package/cjs/resources/V2/Billing/IntentActions.js +4 -0
- package/cjs/resources/V2/Billing/IntentActions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +70 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents.d.ts +1253 -0
- package/cjs/resources/V2/Billing/Intents.js +87 -0
- package/cjs/resources/V2/Billing/Intents.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js +4 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +64 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees.d.ts +360 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +148 -0
- package/cjs/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/cjs/resources/V2/Billing/LicensedItems.d.ts +170 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +35 -0
- package/cjs/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/cjs/resources/V2/Billing/MeteredItems.d.ts +218 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +35 -0
- package/cjs/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/cjs/resources/V2/Billing/OneTimeItems.d.ts +170 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js +35 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +296 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +41 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +23 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans.d.ts +169 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +43 -0
- package/cjs/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/cjs/resources/V2/Billing/Profiles.d.ts +162 -0
- package/cjs/resources/V2/Billing/Profiles.js +35 -0
- package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardRates.d.ts +111 -0
- package/cjs/resources/V2/Billing/RateCardRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +41 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js +4 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +35 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +110 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +23 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards.d.ts +336 -0
- package/cjs/resources/V2/Billing/RateCards.js +76 -0
- package/cjs/resources/V2/Billing/RateCards.js.map +1 -0
- package/cjs/resources/V2/Billing/ServiceActions.d.ts +510 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +162 -0
- package/cjs/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/cjs/resources/V2/Billing/index.d.ts +175 -6
- package/cjs/resources/V2/Billing/index.js +32 -0
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Core/AccountEvaluations.d.ts +156 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js +15 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/cjs/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/cjs/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/cjs/resources/V2/Core/AccountTokens.d.ts +220 -2
- package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts.d.ts +15174 -1219
- package/cjs/resources/V2/Core/Accounts.js +10284 -53
- package/cjs/resources/V2/Core/Accounts.js.map +1 -1
- package/cjs/resources/V2/Core/ApprovalRequests.d.ts +330 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js +46 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/cjs/resources/V2/Core/BatchJobs.d.ts +360 -0
- package/cjs/resources/V2/Core/BatchJobs.js +225 -0
- package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +31 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/cjs/resources/V2/Core/ConnectionSessions.d.ts +86 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js +21 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/cjs/resources/V2/Core/Events.d.ts +7671 -232
- package/cjs/resources/V2/Core/FeeBatches.d.ts +233 -0
- package/cjs/resources/V2/Core/FeeBatches.js +23 -0
- package/cjs/resources/V2/Core/FeeBatches.js.map +1 -0
- package/cjs/resources/V2/Core/FeeEntries.d.ts +199 -0
- package/cjs/resources/V2/Core/FeeEntries.js +23 -0
- package/cjs/resources/V2/Core/FeeEntries.js.map +1 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.d.ts +416 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js +4 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js +101 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/cjs/resources/V2/Core/Health/Alerts.js +182 -0
- package/cjs/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/cjs/resources/V2/Core/Health/index.d.ts +16 -0
- package/cjs/resources/V2/Core/Health/index.js +13 -0
- package/cjs/resources/V2/Core/Health/index.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +251 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +65 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
- package/cjs/resources/V2/Core/Vault/index.js +15 -0
- package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
- package/cjs/resources/V2/Core/index.d.ts +66 -14
- package/cjs/resources/V2/Core/index.js +18 -0
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js +36 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js +4 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/cjs/resources/V2/Data/Analytics/index.js +13 -0
- package/cjs/resources/V2/Data/Analytics/index.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +171 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Data/index.d.ts +13 -0
- package/cjs/resources/V2/Data/index.js +15 -0
- package/cjs/resources/V2/Data/index.js.map +1 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/cjs/resources/V2/Extend/Workflows.d.ts +119 -0
- package/cjs/resources/V2/Extend/Workflows.js +30 -0
- package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
- package/cjs/resources/V2/Extend/index.d.ts +20 -0
- package/cjs/resources/V2/Extend/index.js +15 -0
- package/cjs/resources/V2/Extend/index.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/cjs/resources/V2/Iam/ActivityLogs.d.ts +210 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/cjs/resources/V2/Iam/ApiKeys.d.ts +304 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +47 -0
- package/cjs/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/cjs/resources/V2/Iam/index.d.ts +23 -0
- package/cjs/resources/V2/Iam/index.js +15 -0
- package/cjs/resources/V2/Iam/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +31 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.d.ts +167 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js +29 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js +4 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +44 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +53 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +449 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +50 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +4 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +218 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +317 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.d.ts +525 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +266 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +458 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +263 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +27 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +30 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +15 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js +13 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +265 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +296 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +143 -0
- package/cjs/resources/V2/MoneyManagement/index.js +49 -0
- package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +92 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/cjs/resources/V2/Network/index.d.ts +13 -0
- package/cjs/resources/V2/Network/index.js +13 -0
- package/cjs/resources/V2/Network/index.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.d.ts +823 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +53 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js +4 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +35 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +53 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/cjs/resources/V2/Payments/index.d.ts +31 -0
- package/cjs/resources/V2/Payments/index.js +15 -0
- package/cjs/resources/V2/Payments/index.js.map +1 -0
- package/cjs/resources/V2/Reporting/ReportRuns.d.ts +190 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js +50 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/cjs/resources/V2/Reporting/Reports.d.ts +106 -0
- package/cjs/resources/V2/Reporting/Reports.js +17 -0
- package/cjs/resources/V2/Reporting/Reports.js.map +1 -0
- package/cjs/resources/V2/Reporting/index.d.ts +18 -0
- package/cjs/resources/V2/Reporting/index.js +15 -0
- package/cjs/resources/V2/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountSignals.d.ts +172 -0
- package/cjs/resources/V2/Signals/AccountSignals.js +58 -0
- package/cjs/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/cjs/resources/V2/Signals/index.d.ts +13 -0
- package/cjs/resources/V2/Signals/index.js +13 -0
- package/cjs/resources/V2/Signals/index.js.map +1 -0
- package/cjs/resources/V2/Tax/ManualRules.d.ts +331 -0
- package/cjs/resources/V2/Tax/ManualRules.js +193 -0
- package/cjs/resources/V2/Tax/ManualRules.js.map +1 -0
- package/cjs/resources/V2/Tax/index.d.ts +16 -0
- package/cjs/resources/V2/Tax/index.js +13 -0
- package/cjs/resources/V2/Tax/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +15 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/index.d.ts +10 -0
- package/cjs/resources/V2/TestHelpers/index.js +15 -0
- package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/index.d.ts +39 -0
- package/cjs/resources/V2/index.js +22 -0
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +2 -2
- package/cjs/resources.d.ts +20 -0
- package/cjs/resources.js +282 -18
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +14156 -490
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +161 -54
- package/cjs/stripe.core.js +74 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +53 -0
- package/esm/Error.js +117 -0
- package/esm/Error.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +472 -0
- package/esm/StripeEventNotificationHandler.js.map +1 -0
- package/esm/Types.d.ts +4 -2
- package/esm/apiVersion.d.ts +1 -2
- package/esm/apiVersion.js +1 -2
- package/esm/apiVersion.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +5 -1
- package/esm/resources/AccountNotices.d.ts +140 -0
- package/esm/resources/AccountNotices.js +25 -0
- package/esm/resources/AccountNotices.js.map +1 -0
- package/esm/resources/AccountSessions.d.ts +597 -0
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/AccountSignals.d.ts +110 -0
- package/esm/resources/AccountSignals.js +3 -0
- package/esm/resources/AccountSignals.js.map +1 -0
- package/esm/resources/Accounts.d.ts +1020 -6
- package/esm/resources/Accounts.js +47 -0
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplicationFees.d.ts +28 -1
- package/esm/resources/Balance.d.ts +134 -0
- package/esm/resources/BalanceSettings.d.ts +18 -0
- package/esm/resources/BalanceTransactions.d.ts +1 -1
- package/esm/resources/BalanceTransfers.d.ts +160 -0
- package/esm/resources/BalanceTransfers.js +11 -0
- package/esm/resources/BalanceTransfers.js.map +1 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertRecovereds.d.ts +40 -0
- package/esm/resources/Billing/AlertRecovereds.js +3 -0
- package/esm/resources/Billing/AlertRecovereds.js.map +1 -0
- package/esm/resources/Billing/AlertTriggereds.d.ts +55 -1
- package/esm/resources/Billing/Alerts.d.ts +408 -5
- package/esm/resources/Billing/Alerts.js +321 -5
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/esm/resources/Billing/Analytics/index.d.ts +15 -0
- package/esm/resources/Billing/Analytics/index.js +9 -0
- package/esm/resources/Billing/Analytics/index.js.map +1 -0
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +126 -2
- package/esm/resources/Billing/CreditBalanceSummary.js +39 -1
- package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/esm/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/esm/resources/Billing/CreditGrants.d.ts +85 -3
- package/esm/resources/Billing/CreditGrants.js +134 -5
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/esm/resources/Billing/Meters.d.ts +31 -0
- package/esm/resources/Billing/index.d.ts +6 -0
- package/esm/resources/Billing/index.js +2 -0
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/Capabilities.d.ts +25 -2
- package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
- package/esm/resources/Capital/FinancingOffers.js +26 -0
- package/esm/resources/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/Capital/FinancingSummary.d.ts +101 -0
- package/esm/resources/Capital/FinancingSummary.js +11 -0
- package/esm/resources/Capital/FinancingSummary.js.map +1 -0
- package/esm/resources/Capital/FinancingTransactions.d.ts +141 -0
- package/esm/resources/Capital/FinancingTransactions.js +20 -0
- package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
- package/esm/resources/Capital/index.d.ts +25 -0
- package/esm/resources/Capital/index.js +13 -0
- package/esm/resources/Capital/index.js.map +1 -0
- package/esm/resources/Cards.d.ts +28 -0
- package/esm/resources/Charges.d.ts +3352 -70
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1174 -22
- package/esm/resources/Checkout/Sessions.js +115 -0
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -0
- package/esm/resources/ConfirmationTokens.d.ts +139 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/Coupons.d.ts +128 -2
- package/esm/resources/Coupons.js +41 -0
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +7 -1
- package/esm/resources/CreditNotes.js +13 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/Crypto/CustomerConsumerWallets.d.ts +29 -0
- package/esm/resources/Crypto/CustomerConsumerWallets.js +3 -0
- package/esm/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.d.ts +79 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.js +3 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
- package/esm/resources/Crypto/Customers.d.ts +111 -0
- package/esm/resources/Crypto/Customers.js +27 -0
- package/esm/resources/Crypto/Customers.js.map +1 -0
- package/esm/resources/Crypto/OnrampSessions.d.ts +413 -0
- package/esm/resources/Crypto/OnrampSessions.js +43 -0
- package/esm/resources/Crypto/OnrampSessions.js.map +1 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.d.ts +60 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.js +11 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
- package/esm/resources/Crypto/index.d.ts +34 -0
- package/esm/resources/Crypto/index.js +13 -0
- package/esm/resources/Crypto/index.js.map +1 -0
- package/esm/resources/CustomerSessions.d.ts +74 -0
- package/esm/resources/CustomerSessions.js +13 -0
- package/esm/resources/CustomerSessions.js.map +1 -1
- package/esm/resources/Customers.d.ts +98 -1
- package/esm/resources/Customers.js +195 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +128 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js +3 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/esm/resources/DelegatedCheckout/Orders.d.ts +159 -0
- package/esm/resources/DelegatedCheckout/Orders.js +11 -0
- package/esm/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1416 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +43 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/esm/resources/DelegatedCheckout/index.d.ts +25 -0
- package/esm/resources/DelegatedCheckout/index.js +11 -0
- package/esm/resources/DelegatedCheckout/index.js.map +1 -0
- package/esm/resources/Discounts.d.ts +19 -0
- package/esm/resources/Disputes.d.ts +43 -0
- package/esm/resources/Disputes.js +14 -0
- package/esm/resources/Disputes.js.map +1 -1
- package/esm/resources/Events.d.ts +573 -2
- package/esm/resources/ExternalAccounts.d.ts +212 -1
- package/esm/resources/ExternalAccounts.js +42 -1
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/esm/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/esm/resources/FinancialConnections/Accounts.js +8 -0
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +99 -0
- package/esm/resources/FinancialConnections/Authorizations.js +11 -0
- package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
- package/esm/resources/FinancialConnections/Institutions.d.ts +99 -0
- package/esm/resources/FinancialConnections/Institutions.js +19 -0
- package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
- package/esm/resources/FinancialConnections/Sessions.d.ts +156 -7
- package/esm/resources/FinancialConnections/Sessions.js.map +1 -1
- package/esm/resources/FinancialConnections/index.d.ts +21 -6
- package/esm/resources/FinancialConnections/index.js +4 -0
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/FrMealVouchersOnboardings.d.ts +173 -0
- package/esm/resources/FrMealVouchersOnboardings.js +38 -0
- package/esm/resources/FrMealVouchersOnboardings.js.map +1 -0
- package/esm/resources/FxQuotes.d.ts +212 -0
- package/esm/resources/FxQuotes.js +25 -0
- package/esm/resources/FxQuotes.js.map +1 -0
- package/esm/resources/GiftCardOperations.d.ts +248 -0
- package/esm/resources/GiftCardOperations.js +11 -0
- package/esm/resources/GiftCardOperations.js.map +1 -0
- package/esm/resources/GiftCards.d.ts +187 -0
- package/esm/resources/GiftCards.js +47 -0
- package/esm/resources/GiftCards.js.map +1 -0
- package/esm/resources/Identity/BlocklistEntries.d.ts +155 -0
- package/esm/resources/Identity/BlocklistEntries.js +50 -0
- package/esm/resources/Identity/BlocklistEntries.js.map +1 -0
- package/esm/resources/Identity/VerificationReports.d.ts +33 -2
- package/esm/resources/Identity/VerificationReports.js.map +1 -1
- package/esm/resources/Identity/VerificationSessions.d.ts +11 -3
- package/esm/resources/Identity/index.d.ts +18 -10
- package/esm/resources/Identity/index.js +2 -0
- package/esm/resources/Identity/index.js.map +1 -1
- package/esm/resources/InvoiceItems.d.ts +203 -2
- package/esm/resources/InvoiceItems.js +41 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +174 -4
- package/esm/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/esm/resources/InvoiceRenderingTemplates.js +28 -0
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +2120 -22
- package/esm/resources/Invoices.js +221 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +435 -1
- package/esm/resources/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +18 -4
- package/esm/resources/Issuing/Cards.d.ts +53 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +49 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/esm/resources/Issuing/Disputes.d.ts +246 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/esm/resources/Issuing/Programs.d.ts +95 -0
- package/esm/resources/Issuing/Programs.js +31 -0
- package/esm/resources/Issuing/Programs.js.map +1 -0
- package/esm/resources/Issuing/Settlements.d.ts +83 -0
- package/esm/resources/Issuing/Settlements.js +3 -0
- package/esm/resources/Issuing/Settlements.js.map +1 -0
- package/esm/resources/Issuing/Tokens.d.ts +26 -0
- package/esm/resources/Issuing/Transactions.d.ts +178 -0
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +56 -22
- package/esm/resources/Issuing/index.js +8 -0
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +29 -2
- package/esm/resources/Mandates.d.ts +47 -1
- package/esm/resources/Mandates.js +8 -0
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/Margins.d.ts +115 -0
- package/esm/resources/Margins.js +31 -0
- package/esm/resources/Margins.js.map +1 -0
- package/esm/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/esm/resources/Orchestration/PaymentAttempts.js +11 -0
- package/esm/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/esm/resources/Orchestration/index.d.ts +12 -0
- package/esm/resources/Orchestration/index.js +9 -0
- package/esm/resources/Orchestration/index.js.map +1 -0
- package/esm/resources/Orders.d.ts +4773 -0
- package/esm/resources/Orders.js +453 -0
- package/esm/resources/Orders.js.map +1 -0
- package/esm/resources/PaymentAttemptRecords.d.ts +664 -2
- package/esm/resources/PaymentAttemptRecords.js +48 -0
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +17 -0
- package/esm/resources/PaymentIntents.d.ts +16756 -3555
- package/esm/resources/PaymentIntents.js +46 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +74 -12
- package/esm/resources/PaymentLocationCapabilities.d.ts +122 -0
- package/esm/resources/PaymentLocationCapabilities.js +25 -0
- package/esm/resources/PaymentLocationCapabilities.js.map +1 -0
- package/esm/resources/PaymentLocations.d.ts +178 -0
- package/esm/resources/PaymentLocations.js +37 -0
- package/esm/resources/PaymentLocations.js.map +1 -0
- package/esm/resources/PaymentMethodBalances.d.ts +46 -0
- package/esm/resources/PaymentMethodBalances.js +3 -0
- package/esm/resources/PaymentMethodBalances.js.map +1 -0
- package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
- package/esm/resources/PaymentMethods.d.ts +290 -3
- package/esm/resources/PaymentMethods.js +20 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +623 -19
- package/esm/resources/PaymentRecords.js +11 -0
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Persons.d.ts +25 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +76 -0
- package/esm/resources/Prices.js +27 -0
- package/esm/resources/Prices.js.map +1 -1
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/esm/resources/Privacy/RedactionJobs.d.ts +227 -0
- package/esm/resources/Privacy/RedactionJobs.js +69 -0
- package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
- package/esm/resources/Privacy/index.d.ts +22 -0
- package/esm/resources/Privacy/index.js +9 -0
- package/esm/resources/Privacy/index.js.map +1 -0
- package/esm/resources/ProductCatalog/TrialOffers.d.ts +125 -0
- package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
- package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/esm/resources/ProductCatalog/index.d.ts +12 -0
- package/esm/resources/ProductCatalog/index.js +9 -0
- package/esm/resources/ProductCatalog/index.js.map +1 -0
- package/esm/resources/Products.d.ts +198 -0
- package/esm/resources/Products.js +69 -0
- package/esm/resources/Products.js.map +1 -1
- package/esm/resources/Profiles.d.ts +26 -0
- package/esm/resources/Profiles.js +3 -0
- package/esm/resources/Profiles.js.map +1 -0
- package/esm/resources/PromotionCodes.d.ts +12 -0
- package/esm/resources/PromotionCodes.js +27 -0
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/QuoteLines.d.ts +684 -0
- package/esm/resources/QuoteLines.js +3 -0
- package/esm/resources/QuoteLines.js.map +1 -0
- package/esm/resources/QuotePreviewInvoices.d.ts +1173 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +902 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +3548 -254
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/esm/resources/Radar/AccountEvaluations.js +23 -0
- package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
- package/esm/resources/Radar/CustomerEvaluations.d.ts +244 -0
- package/esm/resources/Radar/CustomerEvaluations.js +23 -0
- package/esm/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js +11 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/esm/resources/Radar/PaymentEvaluations.d.ts +63 -1
- package/esm/resources/Radar/ValueListItems.d.ts +38 -0
- package/esm/resources/Radar/ValueListItems.js +13 -0
- package/esm/resources/Radar/ValueListItems.js.map +1 -1
- package/esm/resources/Radar/index.d.ts +36 -16
- package/esm/resources/Radar/index.js +6 -0
- package/esm/resources/Radar/index.js.map +1 -1
- package/esm/resources/Refunds.d.ts +35 -0
- package/esm/resources/Refunds.js +27 -0
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reserve/Holds.d.ts +53 -1
- package/esm/resources/Reserve/Holds.js +17 -1
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +16 -0
- package/esm/resources/Reserve/Plans.js +9 -1
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +41 -1
- package/esm/resources/Reserve/Releases.js +17 -1
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +17 -6
- package/esm/resources/Reserve/index.js +9 -0
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/RiskSignals.d.ts +10 -0
- package/esm/resources/RiskSignals.js +3 -0
- package/esm/resources/RiskSignals.js.map +1 -0
- package/esm/resources/SetupAttempts.d.ts +26 -1
- package/esm/resources/SetupIntents.d.ts +603 -11
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +1146 -0
- package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
- package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/IssuedTokens.d.ts +320 -0
- package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
- package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/index.d.ts +19 -0
- package/esm/resources/SharedPayment/index.js +11 -0
- package/esm/resources/SharedPayment/index.js.map +1 -0
- package/esm/resources/Sources.d.ts +29 -1
- package/esm/resources/SubscriptionItems.d.ts +265 -0
- package/esm/resources/SubscriptionItems.js +41 -0
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +1949 -19
- package/esm/resources/SubscriptionSchedules.js +61 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +965 -12
- package/esm/resources/Subscriptions.js +289 -0
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/esm/resources/Tax/Calculations.d.ts +45 -3
- package/esm/resources/Tax/Forms.d.ts +228 -0
- package/esm/resources/Tax/Forms.js +28 -0
- package/esm/resources/Tax/Forms.js.map +1 -0
- package/esm/resources/Tax/Locations.d.ts +108 -0
- package/esm/resources/Tax/Locations.js +29 -0
- package/esm/resources/Tax/Locations.js.map +1 -0
- package/esm/resources/Tax/Registrations.d.ts +171 -2
- package/esm/resources/Tax/Registrations.js +27 -0
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +8 -0
- package/esm/resources/Tax/Settings.js +13 -0
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/Transactions.d.ts +10 -2
- package/esm/resources/Tax/Transactions.js +13 -0
- package/esm/resources/Tax/Transactions.js.map +1 -1
- package/esm/resources/Tax/index.d.ts +31 -13
- package/esm/resources/Tax/index.js +4 -0
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +15 -0
- package/esm/resources/TaxFunds.d.ts +174 -0
- package/esm/resources/TaxFunds.js +19 -0
- package/esm/resources/TaxFunds.js.map +1 -0
- package/esm/resources/TaxIds.d.ts +6 -0
- package/esm/resources/TaxIds.js +13 -0
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +12 -0
- package/esm/resources/TaxRates.js +27 -0
- package/esm/resources/TaxRates.js.map +1 -1
- package/esm/resources/Terminal/Configurations.d.ts +27 -0
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
- package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/esm/resources/Terminal/Readers.d.ts +17 -1
- package/esm/resources/Terminal/index.d.ts +5 -0
- package/esm/resources/Terminal/index.js +2 -0
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/esm/resources/TestHelpers/Capital/index.js +9 -0
- package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +94 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +18 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.d.ts +126 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js +35 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +26 -0
- package/esm/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/esm/resources/TestHelpers/PaymentIntents.d.ts +37 -0
- package/esm/resources/TestHelpers/PaymentIntents.js +11 -0
- package/esm/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/esm/resources/TestHelpers/index.d.ts +14 -6
- package/esm/resources/TestHelpers/index.js +6 -0
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Tokens.d.ts +76 -0
- package/esm/resources/Transfers.d.ts +12 -0
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/TransitBalances.d.ts +25 -0
- package/esm/resources/TransitBalances.js +3 -0
- package/esm/resources/TransitBalances.js.map +1 -0
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings.d.ts +280 -0
- package/esm/resources/V2/Billing/BillSettings.js +37 -0
- package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js +3 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js +19 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences.d.ts +1011 -0
- package/esm/resources/V2/Billing/Cadences.js +260 -0
- package/esm/resources/V2/Billing/Cadences.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings.d.ts +775 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
- package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js +3 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +25 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.js +11 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts.d.ts +1775 -0
- package/esm/resources/V2/Billing/Contracts.js +603 -0
- package/esm/resources/V2/Billing/Contracts.js.map +1 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +31 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/esm/resources/V2/Billing/IntentActions.d.ts +603 -0
- package/esm/resources/V2/Billing/IntentActions.js +3 -0
- package/esm/resources/V2/Billing/IntentActions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +66 -0
- package/esm/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents.d.ts +1253 -0
- package/esm/resources/V2/Billing/Intents.js +83 -0
- package/esm/resources/V2/Billing/Intents.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js +3 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +60 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees.d.ts +360 -0
- package/esm/resources/V2/Billing/LicenseFees.js +144 -0
- package/esm/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/esm/resources/V2/Billing/LicensedItems.d.ts +170 -0
- package/esm/resources/V2/Billing/LicensedItems.js +31 -0
- package/esm/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/esm/resources/V2/Billing/MeteredItems.d.ts +218 -0
- package/esm/resources/V2/Billing/MeteredItems.js +31 -0
- package/esm/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/esm/resources/V2/Billing/OneTimeItems.d.ts +170 -0
- package/esm/resources/V2/Billing/OneTimeItems.js +31 -0
- package/esm/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +292 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +37 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +19 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans.d.ts +169 -0
- package/esm/resources/V2/Billing/PricingPlans.js +39 -0
- package/esm/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/esm/resources/V2/Billing/Profiles.d.ts +162 -0
- package/esm/resources/V2/Billing/Profiles.js +31 -0
- package/esm/resources/V2/Billing/Profiles.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardRates.d.ts +111 -0
- package/esm/resources/V2/Billing/RateCardRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +37 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/esm/resources/V2/Billing/RateCardVersions.js +3 -0
- package/esm/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +31 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +106 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +19 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards.d.ts +336 -0
- package/esm/resources/V2/Billing/RateCards.js +72 -0
- package/esm/resources/V2/Billing/RateCards.js.map +1 -0
- package/esm/resources/V2/Billing/ServiceActions.d.ts +510 -0
- package/esm/resources/V2/Billing/ServiceActions.js +158 -0
- package/esm/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/esm/resources/V2/Billing/index.d.ts +175 -6
- package/esm/resources/V2/Billing/index.js +32 -0
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Core/AccountEvaluations.d.ts +156 -0
- package/esm/resources/V2/Core/AccountEvaluations.js +11 -0
- package/esm/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/esm/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/esm/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/esm/resources/V2/Core/AccountTokens.d.ts +220 -2
- package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts.d.ts +15174 -1219
- package/esm/resources/V2/Core/Accounts.js +10284 -53
- package/esm/resources/V2/Core/Accounts.js.map +1 -1
- package/esm/resources/V2/Core/ApprovalRequests.d.ts +330 -0
- package/esm/resources/V2/Core/ApprovalRequests.js +42 -0
- package/esm/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/esm/resources/V2/Core/BatchJobs.d.ts +360 -0
- package/esm/resources/V2/Core/BatchJobs.js +221 -0
- package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +27 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/esm/resources/V2/Core/ConnectionSessions.d.ts +86 -0
- package/esm/resources/V2/Core/ConnectionSessions.js +17 -0
- package/esm/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/esm/resources/V2/Core/Events.d.ts +7671 -232
- package/esm/resources/V2/Core/FeeBatches.d.ts +233 -0
- package/esm/resources/V2/Core/FeeBatches.js +19 -0
- package/esm/resources/V2/Core/FeeBatches.js.map +1 -0
- package/esm/resources/V2/Core/FeeEntries.d.ts +199 -0
- package/esm/resources/V2/Core/FeeEntries.js +19 -0
- package/esm/resources/V2/Core/FeeEntries.js.map +1 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.d.ts +416 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js +3 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js +97 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/esm/resources/V2/Core/Health/Alerts.js +178 -0
- package/esm/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/esm/resources/V2/Core/Health/index.d.ts +16 -0
- package/esm/resources/V2/Core/Health/index.js +9 -0
- package/esm/resources/V2/Core/Health/index.js.map +1 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +251 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +61 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
- package/esm/resources/V2/Core/Vault/index.js +11 -0
- package/esm/resources/V2/Core/Vault/index.js.map +1 -0
- package/esm/resources/V2/Core/index.d.ts +66 -14
- package/esm/resources/V2/Core/index.js +18 -0
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +73 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js +32 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js +3 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/esm/resources/V2/Data/Analytics/index.js +9 -0
- package/esm/resources/V2/Data/Analytics/index.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +171 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/esm/resources/V2/Data/Reporting/index.js +9 -0
- package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Data/index.d.ts +13 -0
- package/esm/resources/V2/Data/index.js +11 -0
- package/esm/resources/V2/Data/index.js.map +1 -0
- package/esm/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/esm/resources/V2/Extend/Workflows.d.ts +119 -0
- package/esm/resources/V2/Extend/Workflows.js +26 -0
- package/esm/resources/V2/Extend/Workflows.js.map +1 -0
- package/esm/resources/V2/Extend/index.d.ts +20 -0
- package/esm/resources/V2/Extend/index.js +11 -0
- package/esm/resources/V2/Extend/index.js.map +1 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/esm/resources/V2/Iam/ActivityLogs.d.ts +210 -0
- package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
- package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/esm/resources/V2/Iam/ApiKeys.d.ts +304 -0
- package/esm/resources/V2/Iam/ApiKeys.js +43 -0
- package/esm/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/esm/resources/V2/Iam/index.d.ts +23 -0
- package/esm/resources/V2/Iam/index.js +11 -0
- package/esm/resources/V2/Iam/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +27 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.d.ts +167 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js +25 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js +3 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +44 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +49 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +449 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +46 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +3 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +218 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +317 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.d.ts +525 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +266 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +458 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +263 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +23 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +30 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +11 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.js +9 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +265 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Transactions.d.ts +296 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +143 -0
- package/esm/resources/V2/MoneyManagement/index.js +45 -0
- package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +92 -0
- package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
- package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/esm/resources/V2/Network/index.d.ts +13 -0
- package/esm/resources/V2/Network/index.js +9 -0
- package/esm/resources/V2/Network/index.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/esm/resources/V2/Payments/OffSessionPayments.d.ts +823 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +49 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js +3 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +31 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +49 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/esm/resources/V2/Payments/index.d.ts +31 -0
- package/esm/resources/V2/Payments/index.js +11 -0
- package/esm/resources/V2/Payments/index.js.map +1 -0
- package/esm/resources/V2/Reporting/ReportRuns.d.ts +190 -0
- package/esm/resources/V2/Reporting/ReportRuns.js +46 -0
- package/esm/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/esm/resources/V2/Reporting/Reports.d.ts +106 -0
- package/esm/resources/V2/Reporting/Reports.js +13 -0
- package/esm/resources/V2/Reporting/Reports.js.map +1 -0
- package/esm/resources/V2/Reporting/index.d.ts +18 -0
- package/esm/resources/V2/Reporting/index.js +11 -0
- package/esm/resources/V2/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Signals/AccountSignals.d.ts +172 -0
- package/esm/resources/V2/Signals/AccountSignals.js +54 -0
- package/esm/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/esm/resources/V2/Signals/index.d.ts +13 -0
- package/esm/resources/V2/Signals/index.js +9 -0
- package/esm/resources/V2/Signals/index.js.map +1 -0
- package/esm/resources/V2/Tax/ManualRules.d.ts +331 -0
- package/esm/resources/V2/Tax/ManualRules.js +189 -0
- package/esm/resources/V2/Tax/ManualRules.js.map +1 -0
- package/esm/resources/V2/Tax/index.d.ts +16 -0
- package/esm/resources/V2/Tax/index.js +9 -0
- package/esm/resources/V2/Tax/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +11 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/esm/resources/V2/TestHelpers/index.d.ts +10 -0
- package/esm/resources/V2/TestHelpers/index.js +11 -0
- package/esm/resources/V2/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/index.d.ts +39 -0
- package/esm/resources/V2/index.js +22 -0
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +2 -2
- package/esm/resources.d.ts +20 -0
- package/esm/resources.js +252 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +161 -54
- package/esm/stripe.core.js +45 -2
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +161 -54
- package/esm/stripe.esm.node.js +45 -2
- package/esm/stripe.esm.node.js.map +1 -1
- package/package.json +1 -1
|
@@ -4,6 +4,7 @@ import { Discount, DeletedDiscount } from './Discounts.js';
|
|
|
4
4
|
import { TaxId, DeletedTaxId } from './TaxIds.js';
|
|
5
5
|
import { Application, DeletedApplication } from './Applications.js';
|
|
6
6
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
7
|
+
import { Margin } from './Margins.js';
|
|
7
8
|
import { PaymentMethod } from './PaymentMethods.js';
|
|
8
9
|
import { CustomerSource } from './CustomerSources.js';
|
|
9
10
|
import { TaxRate } from './TaxRates.js';
|
|
@@ -67,6 +68,10 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
67
68
|
* See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
|
|
68
69
|
*/
|
|
69
70
|
attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
71
|
+
/**
|
|
72
|
+
* Detaches a payment from the invoice, removing it from the list of payments
|
|
73
|
+
*/
|
|
74
|
+
detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
70
75
|
/**
|
|
71
76
|
* Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
|
|
72
77
|
*/
|
|
@@ -111,6 +116,54 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
111
116
|
* Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
|
|
112
117
|
*/
|
|
113
118
|
createPreview(params?: InvoiceCreatePreviewParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
119
|
+
serializeBatchDelete(invoice: string, params?: Record<string, unknown>, options?: {
|
|
120
|
+
apiVersion?: string;
|
|
121
|
+
stripeContext?: string;
|
|
122
|
+
}): string;
|
|
123
|
+
serializeBatchUpdate(invoice: string, params?: Record<string, unknown>, options?: {
|
|
124
|
+
apiVersion?: string;
|
|
125
|
+
stripeContext?: string;
|
|
126
|
+
}): string;
|
|
127
|
+
serializeBatchCreate(params?: Record<string, unknown>, options?: {
|
|
128
|
+
apiVersion?: string;
|
|
129
|
+
stripeContext?: string;
|
|
130
|
+
}): string;
|
|
131
|
+
serializeBatchAddLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
132
|
+
apiVersion?: string;
|
|
133
|
+
stripeContext?: string;
|
|
134
|
+
}): string;
|
|
135
|
+
serializeBatchFinalizeInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
136
|
+
apiVersion?: string;
|
|
137
|
+
stripeContext?: string;
|
|
138
|
+
}): string;
|
|
139
|
+
serializeBatchMarkUncollectible(invoice: string, params?: Record<string, unknown>, options?: {
|
|
140
|
+
apiVersion?: string;
|
|
141
|
+
stripeContext?: string;
|
|
142
|
+
}): string;
|
|
143
|
+
serializeBatchPay(invoice: string, params?: Record<string, unknown>, options?: {
|
|
144
|
+
apiVersion?: string;
|
|
145
|
+
stripeContext?: string;
|
|
146
|
+
}): string;
|
|
147
|
+
serializeBatchRemoveLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
148
|
+
apiVersion?: string;
|
|
149
|
+
stripeContext?: string;
|
|
150
|
+
}): string;
|
|
151
|
+
serializeBatchSendInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
152
|
+
apiVersion?: string;
|
|
153
|
+
stripeContext?: string;
|
|
154
|
+
}): string;
|
|
155
|
+
serializeBatchUpdateLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
156
|
+
apiVersion?: string;
|
|
157
|
+
stripeContext?: string;
|
|
158
|
+
}): string;
|
|
159
|
+
serializeBatchVoidInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
160
|
+
apiVersion?: string;
|
|
161
|
+
stripeContext?: string;
|
|
162
|
+
}): string;
|
|
163
|
+
serializeBatchCreatePreview(params?: Record<string, unknown>, options?: {
|
|
164
|
+
apiVersion?: string;
|
|
165
|
+
stripeContext?: string;
|
|
166
|
+
}): string;
|
|
114
167
|
/**
|
|
115
168
|
* When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
|
116
169
|
*/
|
|
@@ -122,6 +175,10 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
122
175
|
* Updating an invoice's line item is only possible before the invoice is finalized.
|
|
123
176
|
*/
|
|
124
177
|
updateLineItem(invoiceId: string, id: string, params?: InvoiceUpdateLineItemParams, options?: RequestOptions): Promise<Response<InvoiceLineItem>>;
|
|
178
|
+
serializeBatchUpdateLineItem(invoice: string, lineItemId: string, params?: Record<string, unknown>, options?: {
|
|
179
|
+
apiVersion?: string;
|
|
180
|
+
stripeContext?: string;
|
|
181
|
+
}): string;
|
|
125
182
|
}
|
|
126
183
|
export interface Invoice {
|
|
127
184
|
/**
|
|
@@ -168,6 +225,10 @@ export interface Invoice {
|
|
|
168
225
|
* This is the sum of all the shipping amounts.
|
|
169
226
|
*/
|
|
170
227
|
amount_shipping: number;
|
|
228
|
+
/**
|
|
229
|
+
* List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
|
|
230
|
+
*/
|
|
231
|
+
amounts_due?: Array<Invoice.AmountsDue> | null;
|
|
171
232
|
/**
|
|
172
233
|
* ID of the Connect Application that created the invoice.
|
|
173
234
|
*/
|
|
@@ -257,6 +318,10 @@ export interface Invoice {
|
|
|
257
318
|
* The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
|
|
258
319
|
*/
|
|
259
320
|
customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
|
|
321
|
+
/**
|
|
322
|
+
* The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
|
|
323
|
+
*/
|
|
324
|
+
default_margins?: Array<string | Margin> | null;
|
|
260
325
|
/**
|
|
261
326
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
262
327
|
*/
|
|
@@ -421,6 +486,10 @@ export interface Invoice {
|
|
|
421
486
|
* The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
|
|
422
487
|
*/
|
|
423
488
|
total_excluding_tax: number | null;
|
|
489
|
+
/**
|
|
490
|
+
* The aggregate amounts calculated per margin across all line items.
|
|
491
|
+
*/
|
|
492
|
+
total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
|
|
424
493
|
/**
|
|
425
494
|
* Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
|
|
426
495
|
*/
|
|
@@ -449,6 +518,40 @@ export interface DeletedInvoice {
|
|
|
449
518
|
deleted: true;
|
|
450
519
|
}
|
|
451
520
|
export declare namespace Invoice {
|
|
521
|
+
interface AmountsDue {
|
|
522
|
+
/**
|
|
523
|
+
* Incremental amount due for this payment in cents (or local equivalent).
|
|
524
|
+
*/
|
|
525
|
+
amount: number;
|
|
526
|
+
/**
|
|
527
|
+
* The amount in cents (or local equivalent) that was paid for this payment.
|
|
528
|
+
*/
|
|
529
|
+
amount_paid: number;
|
|
530
|
+
/**
|
|
531
|
+
* The difference between the payment's amount and amount_paid, in cents (or local equivalent).
|
|
532
|
+
*/
|
|
533
|
+
amount_remaining: number;
|
|
534
|
+
/**
|
|
535
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
536
|
+
*/
|
|
537
|
+
days_until_due: number | null;
|
|
538
|
+
/**
|
|
539
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
540
|
+
*/
|
|
541
|
+
description: string | null;
|
|
542
|
+
/**
|
|
543
|
+
* Date on which a payment plan's payment is due.
|
|
544
|
+
*/
|
|
545
|
+
due_date: number | null;
|
|
546
|
+
/**
|
|
547
|
+
* Timestamp when the payment was paid.
|
|
548
|
+
*/
|
|
549
|
+
paid_at: number | null;
|
|
550
|
+
/**
|
|
551
|
+
* The status of the payment, one of `open`, `paid`, or `past_due`
|
|
552
|
+
*/
|
|
553
|
+
status: AmountsDue.Status;
|
|
554
|
+
}
|
|
452
555
|
interface AutomaticTax {
|
|
453
556
|
/**
|
|
454
557
|
* If Stripe disabled automatic tax, this enum describes why.
|
|
@@ -641,10 +744,18 @@ export declare namespace Invoice {
|
|
|
641
744
|
type: LastFinalizationError.Type;
|
|
642
745
|
}
|
|
643
746
|
interface Parent {
|
|
747
|
+
/**
|
|
748
|
+
* Details about the billing cadence that generated this invoice
|
|
749
|
+
*/
|
|
750
|
+
billing_cadence_details?: Parent.BillingCadenceDetails | null;
|
|
644
751
|
/**
|
|
645
752
|
* Details about the quote that generated this invoice
|
|
646
753
|
*/
|
|
647
754
|
quote_details: Parent.QuoteDetails | null;
|
|
755
|
+
/**
|
|
756
|
+
* Details about the schedule that generated this invoice
|
|
757
|
+
*/
|
|
758
|
+
schedule_details?: Parent.ScheduleDetails | null;
|
|
648
759
|
/**
|
|
649
760
|
* Details about the subscription that generated this invoice
|
|
650
761
|
*/
|
|
@@ -766,6 +877,16 @@ export declare namespace Invoice {
|
|
|
766
877
|
*/
|
|
767
878
|
discount: string | Discount | DeletedDiscount;
|
|
768
879
|
}
|
|
880
|
+
interface TotalMarginAmount {
|
|
881
|
+
/**
|
|
882
|
+
* The amount, in cents (or local equivalent), of the reduction in line item amount.
|
|
883
|
+
*/
|
|
884
|
+
amount: number;
|
|
885
|
+
/**
|
|
886
|
+
* The margin that was applied to get this margin amount.
|
|
887
|
+
*/
|
|
888
|
+
margin: string | Margin;
|
|
889
|
+
}
|
|
769
890
|
interface TotalPretaxCreditAmount {
|
|
770
891
|
/**
|
|
771
892
|
* The amount, in cents (or local equivalent), of the pretax credit amount.
|
|
@@ -779,6 +900,10 @@ export declare namespace Invoice {
|
|
|
779
900
|
* The discount that was applied to get this pretax credit amount.
|
|
780
901
|
*/
|
|
781
902
|
discount?: string | Discount | DeletedDiscount;
|
|
903
|
+
/**
|
|
904
|
+
* The margin that was applied to get this pretax credit amount.
|
|
905
|
+
*/
|
|
906
|
+
margin?: string | Margin;
|
|
782
907
|
/**
|
|
783
908
|
* Type of the pretax credit amount referenced.
|
|
784
909
|
*/
|
|
@@ -810,6 +935,9 @@ export declare namespace Invoice {
|
|
|
810
935
|
*/
|
|
811
936
|
type: 'tax_rate_details';
|
|
812
937
|
}
|
|
938
|
+
namespace AmountsDue {
|
|
939
|
+
type Status = 'open' | 'paid' | 'past_due';
|
|
940
|
+
}
|
|
813
941
|
namespace AutomaticTax {
|
|
814
942
|
type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error';
|
|
815
943
|
interface Liability {
|
|
@@ -824,32 +952,52 @@ export declare namespace Invoice {
|
|
|
824
952
|
}
|
|
825
953
|
type Status = 'complete' | 'failed' | 'requires_location_inputs';
|
|
826
954
|
namespace Liability {
|
|
827
|
-
type Type = 'account' | 'self';
|
|
955
|
+
type Type = 'account' | 'application' | 'self';
|
|
828
956
|
}
|
|
829
957
|
}
|
|
830
958
|
namespace CustomerTaxId {
|
|
831
959
|
type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
832
960
|
}
|
|
833
961
|
namespace Issuer {
|
|
834
|
-
type Type = 'account' | 'self';
|
|
962
|
+
type Type = 'account' | 'application' | 'self';
|
|
835
963
|
}
|
|
836
964
|
namespace LastFinalizationError {
|
|
837
|
-
type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'anomalous_money_movement_request' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'failed_tax_calculation' | 'financial_account_balance_does_not_support_currency' | 'financial_account_capability_not_enabled' | 'financial_account_capability_restricted' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | 'financial_connections_no_successful_transaction_refresh' | 'forwarding_api_inactive' | 'forwarding_api_invalid_parameter' | 'forwarding_api_retryable_upstream_error' | 'forwarding_api_upstream_connection_error' | 'forwarding_api_upstream_connection_timeout' | 'forwarding_api_upstream_error' | 'idempotency_key_in_use' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_zip' | 'india_recurring_payment_mandate_canceled' | 'instant_payouts_config_disabled' | 'instant_payouts_currency_disabled' | 'instant_payouts_limit_exceeded' | 'instant_payouts_unsupported' | 'insufficient_funds' | 'intent_invalid_state' | 'intent_verification_method_missing' | 'invalid_card_type' | 'invalid_characters' | 'invalid_charge_amount' | 'invalid_cvc' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_mandate_reference_prefix_format' | 'invalid_number' | 'invalid_source_usage' | 'invalid_tax_location' | 'invoice_no_customer_line_items' | 'invoice_no_payment_method_types' | 'invoice_no_subscription_line_items' | 'invoice_not_editable' | 'invoice_on_behalf_of_not_editable' | 'invoice_payment_intent_requires_action' | 'invoice_upcoming_none' | 'livemode_mismatch' | 'lock_timeout' | 'missing' | 'no_account' | 'not_allowed_on_standard_account' | 'out_of_inventory' | 'ownership_declaration_not_allowed' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_invalid_parameter' | 'payment_intent_konbini_rejected_confirmation_number' | 'payment_intent_mandate_invalid' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_rate_limit_exceeded' | 'payment_intent_unexpected_state' | 'payment_method_bank_account_already_verified' | 'payment_method_bank_account_blocked' | 'payment_method_billing_details_address_missing' | 'payment_method_configuration_failures' | 'payment_method_currency_mismatch' | 'payment_method_customer_decline' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_microdeposit_failed' | 'payment_method_microdeposit_processing_error' | 'payment_method_microdeposit_verification_amounts_invalid' | 'payment_method_microdeposit_verification_amounts_mismatch' | 'payment_method_microdeposit_verification_attempts_exceeded' | 'payment_method_microdeposit_verification_descriptor_code_mismatch' | 'payment_method_microdeposit_verification_timeout' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'payout_reconciliation_not_ready' | 'payouts_limit_exceeded' | 'payouts_not_allowed' | 'platform_account_required' | 'platform_api_key_expired' | 'postal_code_invalid' | 'processing_error' | 'product_inactive' | 'progressive_onboarding_limit_exceeded' | 'rate_limit' | 'refer_to_customer' | 'refund_disputed_payment' | 'request_blocked' | 'resource_already_exists' | 'resource_missing' | 'return_intent_already_processed' | 'routing_number_invalid' | 'secret_key_required' | 'sepa_unsupported_account' | 'service_period_coupon_with_metered_tiered_item_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_mandate_invalid' | 'setup_intent_mobile_wallet_unsupported' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state' | 'shipping_address_invalid' | 'shipping_calculation_failed' | 'siret_invalid' | 'sku_inactive' | 'state_unsupported' | 'status_transition_invalid' | 'storer_capability_missing' | 'storer_capability_not_active' | 'stripe_tax_inactive' | 'tax_id_invalid' | 'tax_id_prohibited' | 'taxes_calculation_failed' | 'terminal_location_country_unsupported' | 'terminal_reader_busy' | 'terminal_reader_hardware_fault' | 'terminal_reader_invalid_location_for_activation' | 'terminal_reader_invalid_location_for_payment' | 'terminal_reader_offline' | 'terminal_reader_timeout' | 'testmode_charges_only' | 'tls_version_unsupported' | 'token_already_used' | 'token_card_network_invalid' | 'token_in_use' | 'transfer_source_balance_parameters_mismatch' | 'transfers_not_allowed' | 'url_invalid';
|
|
965
|
+
type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'anomalous_money_movement_request' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'failed_tax_calculation' | 'financial_account_balance_does_not_support_currency' | 'financial_account_capability_not_enabled' | 'financial_account_capability_restricted' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | 'financial_connections_institution_unavailable' | 'financial_connections_no_successful_transaction_refresh' | 'forwarding_api_inactive' | 'forwarding_api_invalid_parameter' | 'forwarding_api_retryable_upstream_error' | 'forwarding_api_upstream_connection_error' | 'forwarding_api_upstream_connection_timeout' | 'forwarding_api_upstream_error' | 'idempotency_key_in_use' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_zip' | 'india_recurring_payment_mandate_canceled' | 'instant_payouts_config_disabled' | 'instant_payouts_currency_disabled' | 'instant_payouts_limit_exceeded' | 'instant_payouts_unsupported' | 'insufficient_funds' | 'intent_invalid_state' | 'intent_verification_method_missing' | 'invalid_card_type' | 'invalid_characters' | 'invalid_charge_amount' | 'invalid_cvc' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_mandate_reference_prefix_format' | 'invalid_number' | 'invalid_source_usage' | 'invalid_tax_location' | 'invoice_no_customer_line_items' | 'invoice_no_payment_method_types' | 'invoice_no_subscription_line_items' | 'invoice_not_editable' | 'invoice_on_behalf_of_not_editable' | 'invoice_payment_intent_requires_action' | 'invoice_upcoming_none' | 'livemode_mismatch' | 'lock_timeout' | 'missing' | 'no_account' | 'not_allowed_on_standard_account' | 'out_of_inventory' | 'ownership_declaration_not_allowed' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_invalid_parameter' | 'payment_intent_konbini_rejected_confirmation_number' | 'payment_intent_mandate_invalid' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_rate_limit_exceeded' | 'payment_intent_unexpected_state' | 'payment_method_bank_account_already_verified' | 'payment_method_bank_account_blocked' | 'payment_method_billing_details_address_missing' | 'payment_method_configuration_failures' | 'payment_method_currency_mismatch' | 'payment_method_customer_decline' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_microdeposit_failed' | 'payment_method_microdeposit_processing_error' | 'payment_method_microdeposit_verification_amounts_invalid' | 'payment_method_microdeposit_verification_amounts_mismatch' | 'payment_method_microdeposit_verification_attempts_exceeded' | 'payment_method_microdeposit_verification_descriptor_code_mismatch' | 'payment_method_microdeposit_verification_timeout' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'payout_reconciliation_not_ready' | 'payouts_limit_exceeded' | 'payouts_not_allowed' | 'platform_account_required' | 'platform_api_key_expired' | 'postal_code_invalid' | 'processing_error' | 'product_inactive' | 'progressive_onboarding_limit_exceeded' | 'rate_limit' | 'refer_to_customer' | 'refund_disputed_payment' | 'request_blocked' | 'resource_already_exists' | 'resource_missing' | 'return_intent_already_processed' | 'routing_number_invalid' | 'secret_key_required' | 'sensitive_data_access_expired' | 'sepa_unsupported_account' | 'service_period_coupon_with_metered_tiered_item_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_mandate_invalid' | 'setup_intent_mobile_wallet_unsupported' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state' | 'shipping_address_invalid' | 'shipping_calculation_failed' | 'siret_invalid' | 'sku_inactive' | 'state_unsupported' | 'status_transition_invalid' | 'storer_capability_missing' | 'storer_capability_not_active' | 'stripe_tax_inactive' | 'tax_id_invalid' | 'tax_id_prohibited' | 'taxes_calculation_failed' | 'terminal_location_country_unsupported' | 'terminal_reader_busy' | 'terminal_reader_collected_data_invalid' | 'terminal_reader_hardware_fault' | 'terminal_reader_invalid_location_for_activation' | 'terminal_reader_invalid_location_for_payment' | 'terminal_reader_offline' | 'terminal_reader_timeout' | 'testmode_charges_only' | 'tls_version_unsupported' | 'token_already_used' | 'token_card_network_invalid' | 'token_in_use' | 'transfer_source_balance_parameters_mismatch' | 'transfers_not_allowed' | 'url_invalid' | 'v2_account_disconnection_unsupported' | 'v2_account_missing_configuration';
|
|
838
966
|
type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
|
|
839
967
|
}
|
|
840
968
|
namespace Parent {
|
|
969
|
+
interface BillingCadenceDetails {
|
|
970
|
+
/**
|
|
971
|
+
* The billing cadence that generated this invoice
|
|
972
|
+
*/
|
|
973
|
+
billing_cadence: string;
|
|
974
|
+
}
|
|
841
975
|
interface QuoteDetails {
|
|
842
976
|
/**
|
|
843
977
|
* The quote that generated this invoice
|
|
844
978
|
*/
|
|
845
979
|
quote: string;
|
|
846
980
|
}
|
|
981
|
+
interface ScheduleDetails {
|
|
982
|
+
/**
|
|
983
|
+
* The schedule that generated this invoice
|
|
984
|
+
*/
|
|
985
|
+
schedule: string;
|
|
986
|
+
/**
|
|
987
|
+
* The subscription associated with this schedule
|
|
988
|
+
*/
|
|
989
|
+
subscription: string | Subscription | null;
|
|
990
|
+
}
|
|
847
991
|
interface SubscriptionDetails {
|
|
848
992
|
/**
|
|
849
993
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
|
|
850
994
|
* *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
|
|
851
995
|
*/
|
|
852
996
|
metadata: Metadata | null;
|
|
997
|
+
/**
|
|
998
|
+
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
999
|
+
*/
|
|
1000
|
+
pause_collection?: SubscriptionDetails.PauseCollection | null;
|
|
853
1001
|
/**
|
|
854
1002
|
* The subscription that generated this invoice
|
|
855
1003
|
*/
|
|
@@ -859,7 +1007,22 @@ export declare namespace Invoice {
|
|
|
859
1007
|
*/
|
|
860
1008
|
subscription_proration_date?: number;
|
|
861
1009
|
}
|
|
862
|
-
type Type = 'quote_details' | 'subscription_details';
|
|
1010
|
+
type Type = 'billing_cadence_details' | 'quote_details' | 'schedule_details' | 'subscription_details';
|
|
1011
|
+
namespace SubscriptionDetails {
|
|
1012
|
+
interface PauseCollection {
|
|
1013
|
+
/**
|
|
1014
|
+
* The payment collection behavior for this subscription while paused.
|
|
1015
|
+
*/
|
|
1016
|
+
behavior: PauseCollection.Behavior | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* The time after which the subscription will resume collecting payments.
|
|
1019
|
+
*/
|
|
1020
|
+
resumes_at: number | null;
|
|
1021
|
+
}
|
|
1022
|
+
namespace PauseCollection {
|
|
1023
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
863
1026
|
}
|
|
864
1027
|
namespace PaymentSettings {
|
|
865
1028
|
interface PaymentMethodOptions {
|
|
@@ -871,14 +1034,30 @@ export declare namespace Invoice {
|
|
|
871
1034
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
872
1035
|
*/
|
|
873
1036
|
bancontact: PaymentMethodOptions.Bancontact | null;
|
|
1037
|
+
/**
|
|
1038
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
1039
|
+
*/
|
|
1040
|
+
bizum?: PaymentMethodOptions.Bizum | null;
|
|
1041
|
+
/**
|
|
1042
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
1043
|
+
*/
|
|
1044
|
+
blik?: PaymentMethodOptions.Blik | null;
|
|
874
1045
|
/**
|
|
875
1046
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
876
1047
|
*/
|
|
877
1048
|
card: PaymentMethodOptions.Card | null;
|
|
1049
|
+
/**
|
|
1050
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
1051
|
+
*/
|
|
1052
|
+
check_scan?: PaymentMethodOptions.CheckScan | null;
|
|
878
1053
|
/**
|
|
879
1054
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
880
1055
|
*/
|
|
881
1056
|
customer_balance: PaymentMethodOptions.CustomerBalance | null;
|
|
1057
|
+
/**
|
|
1058
|
+
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1059
|
+
*/
|
|
1060
|
+
id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
|
|
882
1061
|
/**
|
|
883
1062
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
884
1063
|
*/
|
|
@@ -903,8 +1082,12 @@ export declare namespace Invoice {
|
|
|
903
1082
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
904
1083
|
*/
|
|
905
1084
|
us_bank_account: PaymentMethodOptions.UsBankAccount | null;
|
|
1085
|
+
/**
|
|
1086
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
1087
|
+
*/
|
|
1088
|
+
wechat_pay?: PaymentMethodOptions.WechatPay | null;
|
|
906
1089
|
}
|
|
907
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
1090
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
908
1091
|
namespace PaymentMethodOptions {
|
|
909
1092
|
interface AcssDebit {
|
|
910
1093
|
mandate_options?: AcssDebit.MandateOptions;
|
|
@@ -919,6 +1102,10 @@ export declare namespace Invoice {
|
|
|
919
1102
|
*/
|
|
920
1103
|
preferred_language: Bancontact.PreferredLanguage;
|
|
921
1104
|
}
|
|
1105
|
+
interface Bizum {
|
|
1106
|
+
}
|
|
1107
|
+
interface Blik {
|
|
1108
|
+
}
|
|
922
1109
|
interface Card {
|
|
923
1110
|
installments?: Card.Installments;
|
|
924
1111
|
/**
|
|
@@ -926,6 +1113,8 @@ export declare namespace Invoice {
|
|
|
926
1113
|
*/
|
|
927
1114
|
request_three_d_secure: Card.RequestThreeDSecure | null;
|
|
928
1115
|
}
|
|
1116
|
+
interface CheckScan {
|
|
1117
|
+
}
|
|
929
1118
|
interface CustomerBalance {
|
|
930
1119
|
bank_transfer?: CustomerBalance.BankTransfer;
|
|
931
1120
|
/**
|
|
@@ -933,6 +1122,8 @@ export declare namespace Invoice {
|
|
|
933
1122
|
*/
|
|
934
1123
|
funding_type: 'bank_transfer' | null;
|
|
935
1124
|
}
|
|
1125
|
+
interface IdBankTransfer {
|
|
1126
|
+
}
|
|
936
1127
|
interface Konbini {
|
|
937
1128
|
}
|
|
938
1129
|
interface Payto {
|
|
@@ -960,6 +1151,16 @@ export declare namespace Invoice {
|
|
|
960
1151
|
*/
|
|
961
1152
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
962
1153
|
}
|
|
1154
|
+
interface WechatPay {
|
|
1155
|
+
/**
|
|
1156
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
1157
|
+
*/
|
|
1158
|
+
app_id?: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* The client type that the end customer will pay from.
|
|
1161
|
+
*/
|
|
1162
|
+
client?: WechatPay.Client;
|
|
1163
|
+
}
|
|
963
1164
|
namespace AcssDebit {
|
|
964
1165
|
interface MandateOptions {
|
|
965
1166
|
/**
|
|
@@ -1069,14 +1270,21 @@ export declare namespace Invoice {
|
|
|
1069
1270
|
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
1070
1271
|
*/
|
|
1071
1272
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1273
|
+
/**
|
|
1274
|
+
* The institution to use to filter for possible accounts to link.
|
|
1275
|
+
*/
|
|
1276
|
+
institution?: string;
|
|
1072
1277
|
}
|
|
1073
1278
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1074
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1279
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
|
|
1075
1280
|
namespace Filters {
|
|
1076
1281
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1077
1282
|
}
|
|
1078
1283
|
}
|
|
1079
1284
|
}
|
|
1285
|
+
namespace WechatPay {
|
|
1286
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
1287
|
+
}
|
|
1080
1288
|
}
|
|
1081
1289
|
}
|
|
1082
1290
|
namespace Rendering {
|
|
@@ -1128,7 +1336,7 @@ export declare namespace Invoice {
|
|
|
1128
1336
|
}
|
|
1129
1337
|
}
|
|
1130
1338
|
namespace TotalPretaxCreditAmount {
|
|
1131
|
-
type Type = 'credit_balance_transaction' | 'discount';
|
|
1339
|
+
type Type = 'credit_balance_transaction' | 'discount' | 'margin';
|
|
1132
1340
|
}
|
|
1133
1341
|
namespace TotalTax {
|
|
1134
1342
|
type TaxBehavior = 'exclusive' | 'inclusive';
|
|
@@ -1136,7 +1344,7 @@ export declare namespace Invoice {
|
|
|
1136
1344
|
/**
|
|
1137
1345
|
* ID of the tax rate
|
|
1138
1346
|
*/
|
|
1139
|
-
tax_rate: string;
|
|
1347
|
+
tax_rate: string | TaxRate;
|
|
1140
1348
|
}
|
|
1141
1349
|
type TaxabilityReason = 'customer_exempt' | 'not_available' | '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';
|
|
1142
1350
|
}
|
|
@@ -1146,6 +1354,10 @@ export interface InvoiceCreateParams {
|
|
|
1146
1354
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1147
1355
|
*/
|
|
1148
1356
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
1357
|
+
/**
|
|
1358
|
+
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
1359
|
+
*/
|
|
1360
|
+
amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
1149
1361
|
/**
|
|
1150
1362
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
|
|
1151
1363
|
*/
|
|
@@ -1186,6 +1398,10 @@ export interface InvoiceCreateParams {
|
|
|
1186
1398
|
* The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
|
1187
1399
|
*/
|
|
1188
1400
|
days_until_due?: number;
|
|
1401
|
+
/**
|
|
1402
|
+
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
1403
|
+
*/
|
|
1404
|
+
default_margins?: Array<string>;
|
|
1189
1405
|
/**
|
|
1190
1406
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
1191
1407
|
*/
|
|
@@ -1276,6 +1492,24 @@ export interface InvoiceCreateParams {
|
|
|
1276
1492
|
transfer_data?: InvoiceCreateParams.TransferData;
|
|
1277
1493
|
}
|
|
1278
1494
|
export declare namespace InvoiceCreateParams {
|
|
1495
|
+
interface AmountsDue {
|
|
1496
|
+
/**
|
|
1497
|
+
* The amount in cents (or local equivalent).
|
|
1498
|
+
*/
|
|
1499
|
+
amount: number;
|
|
1500
|
+
/**
|
|
1501
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
1502
|
+
*/
|
|
1503
|
+
days_until_due?: number;
|
|
1504
|
+
/**
|
|
1505
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1506
|
+
*/
|
|
1507
|
+
description: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Date on which a payment plan's payment is due.
|
|
1510
|
+
*/
|
|
1511
|
+
due_date?: number;
|
|
1512
|
+
}
|
|
1279
1513
|
interface AutomaticTax {
|
|
1280
1514
|
/**
|
|
1281
1515
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -1306,6 +1540,10 @@ export declare namespace InvoiceCreateParams {
|
|
|
1306
1540
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1307
1541
|
*/
|
|
1308
1542
|
discount?: string;
|
|
1543
|
+
/**
|
|
1544
|
+
* Details to determine how long the discount should be applied for.
|
|
1545
|
+
*/
|
|
1546
|
+
discount_end?: Discount.DiscountEnd;
|
|
1309
1547
|
/**
|
|
1310
1548
|
* ID of the promotion code to create a new discount for.
|
|
1311
1549
|
*/
|
|
@@ -1410,11 +1648,43 @@ export declare namespace InvoiceCreateParams {
|
|
|
1410
1648
|
type: Liability.Type;
|
|
1411
1649
|
}
|
|
1412
1650
|
namespace Liability {
|
|
1413
|
-
type Type = 'account' | 'self';
|
|
1651
|
+
type Type = 'account' | 'application' | 'self';
|
|
1652
|
+
}
|
|
1653
|
+
}
|
|
1654
|
+
namespace Discount {
|
|
1655
|
+
interface DiscountEnd {
|
|
1656
|
+
/**
|
|
1657
|
+
* Time span for the redeemed discount.
|
|
1658
|
+
*/
|
|
1659
|
+
duration?: DiscountEnd.Duration;
|
|
1660
|
+
/**
|
|
1661
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1662
|
+
*/
|
|
1663
|
+
timestamp?: number;
|
|
1664
|
+
/**
|
|
1665
|
+
* The type of calculation made to determine when the discount ends.
|
|
1666
|
+
*/
|
|
1667
|
+
type: DiscountEnd.Type;
|
|
1668
|
+
}
|
|
1669
|
+
namespace DiscountEnd {
|
|
1670
|
+
interface Duration {
|
|
1671
|
+
/**
|
|
1672
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1673
|
+
*/
|
|
1674
|
+
interval: Duration.Interval;
|
|
1675
|
+
/**
|
|
1676
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1677
|
+
*/
|
|
1678
|
+
interval_count: number;
|
|
1679
|
+
}
|
|
1680
|
+
type Type = 'duration' | 'timestamp';
|
|
1681
|
+
namespace Duration {
|
|
1682
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1683
|
+
}
|
|
1414
1684
|
}
|
|
1415
1685
|
}
|
|
1416
1686
|
namespace Issuer {
|
|
1417
|
-
type Type = 'account' | 'self';
|
|
1687
|
+
type Type = 'account' | 'application' | 'self';
|
|
1418
1688
|
}
|
|
1419
1689
|
namespace PaymentSettings {
|
|
1420
1690
|
interface PaymentMethodOptions {
|
|
@@ -1426,14 +1696,30 @@ export declare namespace InvoiceCreateParams {
|
|
|
1426
1696
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
1427
1697
|
*/
|
|
1428
1698
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
1699
|
+
/**
|
|
1700
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
1701
|
+
*/
|
|
1702
|
+
bizum?: Emptyable<PaymentMethodOptions.Bizum>;
|
|
1703
|
+
/**
|
|
1704
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
1705
|
+
*/
|
|
1706
|
+
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
1429
1707
|
/**
|
|
1430
1708
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
1431
1709
|
*/
|
|
1432
1710
|
card?: Emptyable<PaymentMethodOptions.Card>;
|
|
1711
|
+
/**
|
|
1712
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
1713
|
+
*/
|
|
1714
|
+
check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
|
|
1433
1715
|
/**
|
|
1434
1716
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1435
1717
|
*/
|
|
1436
1718
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
1719
|
+
/**
|
|
1720
|
+
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1721
|
+
*/
|
|
1722
|
+
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
1437
1723
|
/**
|
|
1438
1724
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1439
1725
|
*/
|
|
@@ -1458,8 +1744,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
1458
1744
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
1459
1745
|
*/
|
|
1460
1746
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
1747
|
+
/**
|
|
1748
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
1749
|
+
*/
|
|
1750
|
+
wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
|
|
1461
1751
|
}
|
|
1462
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
1752
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
1463
1753
|
namespace PaymentMethodOptions {
|
|
1464
1754
|
interface AcssDebit {
|
|
1465
1755
|
/**
|
|
@@ -1477,6 +1767,10 @@ export declare namespace InvoiceCreateParams {
|
|
|
1477
1767
|
*/
|
|
1478
1768
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
1479
1769
|
}
|
|
1770
|
+
interface Bizum {
|
|
1771
|
+
}
|
|
1772
|
+
interface Blik {
|
|
1773
|
+
}
|
|
1480
1774
|
interface Card {
|
|
1481
1775
|
/**
|
|
1482
1776
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -1489,6 +1783,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
1489
1783
|
*/
|
|
1490
1784
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1491
1785
|
}
|
|
1786
|
+
interface CheckScan {
|
|
1787
|
+
}
|
|
1492
1788
|
interface CustomerBalance {
|
|
1493
1789
|
/**
|
|
1494
1790
|
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
|
@@ -1499,6 +1795,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
1499
1795
|
*/
|
|
1500
1796
|
funding_type?: string;
|
|
1501
1797
|
}
|
|
1798
|
+
interface IdBankTransfer {
|
|
1799
|
+
}
|
|
1502
1800
|
interface Konbini {
|
|
1503
1801
|
}
|
|
1504
1802
|
interface Payto {
|
|
@@ -1535,6 +1833,16 @@ export declare namespace InvoiceCreateParams {
|
|
|
1535
1833
|
*/
|
|
1536
1834
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
1537
1835
|
}
|
|
1836
|
+
interface WechatPay {
|
|
1837
|
+
/**
|
|
1838
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
1839
|
+
*/
|
|
1840
|
+
app_id?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* The client type that the end customer will pay from.
|
|
1843
|
+
*/
|
|
1844
|
+
client?: WechatPay.Client;
|
|
1845
|
+
}
|
|
1538
1846
|
namespace AcssDebit {
|
|
1539
1847
|
interface MandateOptions {
|
|
1540
1848
|
/**
|
|
@@ -1667,14 +1975,21 @@ export declare namespace InvoiceCreateParams {
|
|
|
1667
1975
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1668
1976
|
*/
|
|
1669
1977
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1978
|
+
/**
|
|
1979
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1980
|
+
*/
|
|
1981
|
+
institution?: string;
|
|
1670
1982
|
}
|
|
1671
1983
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1672
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1984
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
|
|
1673
1985
|
namespace Filters {
|
|
1674
1986
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1675
1987
|
}
|
|
1676
1988
|
}
|
|
1677
1989
|
}
|
|
1990
|
+
namespace WechatPay {
|
|
1991
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
1992
|
+
}
|
|
1678
1993
|
}
|
|
1679
1994
|
}
|
|
1680
1995
|
namespace Rendering {
|
|
@@ -1807,6 +2122,10 @@ export interface InvoiceUpdateParams {
|
|
|
1807
2122
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1808
2123
|
*/
|
|
1809
2124
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
2125
|
+
/**
|
|
2126
|
+
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
2127
|
+
*/
|
|
2128
|
+
amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
1810
2129
|
/**
|
|
1811
2130
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
|
|
1812
2131
|
*/
|
|
@@ -1835,6 +2154,10 @@ export interface InvoiceUpdateParams {
|
|
|
1835
2154
|
* The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
|
|
1836
2155
|
*/
|
|
1837
2156
|
days_until_due?: number;
|
|
2157
|
+
/**
|
|
2158
|
+
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
2159
|
+
*/
|
|
2160
|
+
default_margins?: Emptyable<Array<string>>;
|
|
1838
2161
|
/**
|
|
1839
2162
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
1840
2163
|
*/
|
|
@@ -1913,6 +2236,24 @@ export interface InvoiceUpdateParams {
|
|
|
1913
2236
|
transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
|
|
1914
2237
|
}
|
|
1915
2238
|
export declare namespace InvoiceUpdateParams {
|
|
2239
|
+
interface AmountsDue {
|
|
2240
|
+
/**
|
|
2241
|
+
* The amount in cents (or local equivalent).
|
|
2242
|
+
*/
|
|
2243
|
+
amount: number;
|
|
2244
|
+
/**
|
|
2245
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
2246
|
+
*/
|
|
2247
|
+
days_until_due?: number;
|
|
2248
|
+
/**
|
|
2249
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
2250
|
+
*/
|
|
2251
|
+
description: string;
|
|
2252
|
+
/**
|
|
2253
|
+
* Date on which a payment plan's payment is due.
|
|
2254
|
+
*/
|
|
2255
|
+
due_date?: number;
|
|
2256
|
+
}
|
|
1916
2257
|
interface AutomaticTax {
|
|
1917
2258
|
/**
|
|
1918
2259
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -1943,6 +2284,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
1943
2284
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1944
2285
|
*/
|
|
1945
2286
|
discount?: string;
|
|
2287
|
+
/**
|
|
2288
|
+
* Details to determine how long the discount should be applied for.
|
|
2289
|
+
*/
|
|
2290
|
+
discount_end?: Discount.DiscountEnd;
|
|
1946
2291
|
/**
|
|
1947
2292
|
* ID of the promotion code to create a new discount for.
|
|
1948
2293
|
*/
|
|
@@ -2036,11 +2381,43 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2036
2381
|
type: Liability.Type;
|
|
2037
2382
|
}
|
|
2038
2383
|
namespace Liability {
|
|
2039
|
-
type Type = 'account' | 'self';
|
|
2384
|
+
type Type = 'account' | 'application' | 'self';
|
|
2385
|
+
}
|
|
2386
|
+
}
|
|
2387
|
+
namespace Discount {
|
|
2388
|
+
interface DiscountEnd {
|
|
2389
|
+
/**
|
|
2390
|
+
* Time span for the redeemed discount.
|
|
2391
|
+
*/
|
|
2392
|
+
duration?: DiscountEnd.Duration;
|
|
2393
|
+
/**
|
|
2394
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2395
|
+
*/
|
|
2396
|
+
timestamp?: number;
|
|
2397
|
+
/**
|
|
2398
|
+
* The type of calculation made to determine when the discount ends.
|
|
2399
|
+
*/
|
|
2400
|
+
type: DiscountEnd.Type;
|
|
2401
|
+
}
|
|
2402
|
+
namespace DiscountEnd {
|
|
2403
|
+
interface Duration {
|
|
2404
|
+
/**
|
|
2405
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2406
|
+
*/
|
|
2407
|
+
interval: Duration.Interval;
|
|
2408
|
+
/**
|
|
2409
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2410
|
+
*/
|
|
2411
|
+
interval_count: number;
|
|
2412
|
+
}
|
|
2413
|
+
type Type = 'duration' | 'timestamp';
|
|
2414
|
+
namespace Duration {
|
|
2415
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2416
|
+
}
|
|
2040
2417
|
}
|
|
2041
2418
|
}
|
|
2042
2419
|
namespace Issuer {
|
|
2043
|
-
type Type = 'account' | 'self';
|
|
2420
|
+
type Type = 'account' | 'application' | 'self';
|
|
2044
2421
|
}
|
|
2045
2422
|
namespace PaymentSettings {
|
|
2046
2423
|
interface PaymentMethodOptions {
|
|
@@ -2052,14 +2429,30 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2052
2429
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
2053
2430
|
*/
|
|
2054
2431
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
2432
|
+
/**
|
|
2433
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
2434
|
+
*/
|
|
2435
|
+
bizum?: Emptyable<PaymentMethodOptions.Bizum>;
|
|
2436
|
+
/**
|
|
2437
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
2438
|
+
*/
|
|
2439
|
+
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
2055
2440
|
/**
|
|
2056
2441
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
2057
2442
|
*/
|
|
2058
2443
|
card?: Emptyable<PaymentMethodOptions.Card>;
|
|
2444
|
+
/**
|
|
2445
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
2446
|
+
*/
|
|
2447
|
+
check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
|
|
2059
2448
|
/**
|
|
2060
2449
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
2061
2450
|
*/
|
|
2062
2451
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
2452
|
+
/**
|
|
2453
|
+
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
2454
|
+
*/
|
|
2455
|
+
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
2063
2456
|
/**
|
|
2064
2457
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
2065
2458
|
*/
|
|
@@ -2084,8 +2477,12 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2084
2477
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
2085
2478
|
*/
|
|
2086
2479
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
2480
|
+
/**
|
|
2481
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
2482
|
+
*/
|
|
2483
|
+
wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
|
|
2087
2484
|
}
|
|
2088
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
2485
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'check_scan' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'momo' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
2089
2486
|
namespace PaymentMethodOptions {
|
|
2090
2487
|
interface AcssDebit {
|
|
2091
2488
|
/**
|
|
@@ -2103,6 +2500,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2103
2500
|
*/
|
|
2104
2501
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
2105
2502
|
}
|
|
2503
|
+
interface Bizum {
|
|
2504
|
+
}
|
|
2505
|
+
interface Blik {
|
|
2506
|
+
}
|
|
2106
2507
|
interface Card {
|
|
2107
2508
|
/**
|
|
2108
2509
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -2115,6 +2516,8 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2115
2516
|
*/
|
|
2116
2517
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
2117
2518
|
}
|
|
2519
|
+
interface CheckScan {
|
|
2520
|
+
}
|
|
2118
2521
|
interface CustomerBalance {
|
|
2119
2522
|
/**
|
|
2120
2523
|
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
|
@@ -2125,6 +2528,8 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2125
2528
|
*/
|
|
2126
2529
|
funding_type?: string;
|
|
2127
2530
|
}
|
|
2531
|
+
interface IdBankTransfer {
|
|
2532
|
+
}
|
|
2128
2533
|
interface Konbini {
|
|
2129
2534
|
}
|
|
2130
2535
|
interface Payto {
|
|
@@ -2161,6 +2566,16 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2161
2566
|
*/
|
|
2162
2567
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
2163
2568
|
}
|
|
2569
|
+
interface WechatPay {
|
|
2570
|
+
/**
|
|
2571
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
2572
|
+
*/
|
|
2573
|
+
app_id?: string;
|
|
2574
|
+
/**
|
|
2575
|
+
* The client type that the end customer will pay from.
|
|
2576
|
+
*/
|
|
2577
|
+
client?: WechatPay.Client;
|
|
2578
|
+
}
|
|
2164
2579
|
namespace AcssDebit {
|
|
2165
2580
|
interface MandateOptions {
|
|
2166
2581
|
/**
|
|
@@ -2293,14 +2708,21 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2293
2708
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2294
2709
|
*/
|
|
2295
2710
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2711
|
+
/**
|
|
2712
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
2713
|
+
*/
|
|
2714
|
+
institution?: string;
|
|
2296
2715
|
}
|
|
2297
2716
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
2298
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
2717
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
|
|
2299
2718
|
namespace Filters {
|
|
2300
2719
|
type AccountSubcategory = 'checking' | 'savings';
|
|
2301
2720
|
}
|
|
2302
2721
|
}
|
|
2303
2722
|
}
|
|
2723
|
+
namespace WechatPay {
|
|
2724
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
2725
|
+
}
|
|
2304
2726
|
}
|
|
2305
2727
|
}
|
|
2306
2728
|
namespace Rendering {
|
|
@@ -2423,6 +2845,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2423
2845
|
}
|
|
2424
2846
|
}
|
|
2425
2847
|
export interface InvoiceListParams extends PaginationParams {
|
|
2848
|
+
/**
|
|
2849
|
+
* Only return invoices for the cadence specified by this billing cadence ID.
|
|
2850
|
+
*/
|
|
2851
|
+
billing_cadence?: string;
|
|
2426
2852
|
/**
|
|
2427
2853
|
* The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
|
|
2428
2854
|
*/
|
|
@@ -2497,6 +2923,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2497
2923
|
* ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
|
2498
2924
|
*/
|
|
2499
2925
|
invoice_item?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
2928
|
+
*/
|
|
2929
|
+
margins?: Emptyable<Array<string>>;
|
|
2500
2930
|
/**
|
|
2501
2931
|
* 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`.
|
|
2502
2932
|
*/
|
|
@@ -2540,6 +2970,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2540
2970
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2541
2971
|
*/
|
|
2542
2972
|
discount?: string;
|
|
2973
|
+
/**
|
|
2974
|
+
* Details to determine how long the discount should be applied for.
|
|
2975
|
+
*/
|
|
2976
|
+
discount_end?: Discount.DiscountEnd;
|
|
2543
2977
|
/**
|
|
2544
2978
|
* ID of the promotion code to create a new discount for.
|
|
2545
2979
|
*/
|
|
@@ -2607,6 +3041,38 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2607
3041
|
*/
|
|
2608
3042
|
taxable_amount: number;
|
|
2609
3043
|
}
|
|
3044
|
+
namespace Discount {
|
|
3045
|
+
interface DiscountEnd {
|
|
3046
|
+
/**
|
|
3047
|
+
* Time span for the redeemed discount.
|
|
3048
|
+
*/
|
|
3049
|
+
duration?: DiscountEnd.Duration;
|
|
3050
|
+
/**
|
|
3051
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3052
|
+
*/
|
|
3053
|
+
timestamp?: number;
|
|
3054
|
+
/**
|
|
3055
|
+
* The type of calculation made to determine when the discount ends.
|
|
3056
|
+
*/
|
|
3057
|
+
type: DiscountEnd.Type;
|
|
3058
|
+
}
|
|
3059
|
+
namespace DiscountEnd {
|
|
3060
|
+
interface Duration {
|
|
3061
|
+
/**
|
|
3062
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3063
|
+
*/
|
|
3064
|
+
interval: Duration.Interval;
|
|
3065
|
+
/**
|
|
3066
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3067
|
+
*/
|
|
3068
|
+
interval_count: number;
|
|
3069
|
+
}
|
|
3070
|
+
type Type = 'duration' | 'timestamp';
|
|
3071
|
+
namespace Duration {
|
|
3072
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3073
|
+
}
|
|
3074
|
+
}
|
|
3075
|
+
}
|
|
2610
3076
|
namespace PriceData {
|
|
2611
3077
|
interface ProductData {
|
|
2612
3078
|
/**
|
|
@@ -2629,12 +3095,28 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2629
3095
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2630
3096
|
*/
|
|
2631
3097
|
tax_code?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
3100
|
+
*/
|
|
3101
|
+
tax_details?: ProductData.TaxDetails;
|
|
2632
3102
|
/**
|
|
2633
3103
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
2634
3104
|
*/
|
|
2635
3105
|
unit_label?: string;
|
|
2636
3106
|
}
|
|
2637
3107
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3108
|
+
namespace ProductData {
|
|
3109
|
+
interface TaxDetails {
|
|
3110
|
+
/**
|
|
3111
|
+
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
3112
|
+
*/
|
|
3113
|
+
performance_location?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3116
|
+
*/
|
|
3117
|
+
tax_code?: Emptyable<string>;
|
|
3118
|
+
}
|
|
3119
|
+
}
|
|
2638
3120
|
}
|
|
2639
3121
|
namespace TaxAmount {
|
|
2640
3122
|
interface TaxRateData {
|
|
@@ -2684,6 +3166,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2684
3166
|
}
|
|
2685
3167
|
}
|
|
2686
3168
|
export interface InvoiceAttachPaymentParams {
|
|
3169
|
+
/**
|
|
3170
|
+
* The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
|
3171
|
+
*/
|
|
3172
|
+
amount_requested?: number;
|
|
2687
3173
|
/**
|
|
2688
3174
|
* Specifies which fields in the response should be expanded.
|
|
2689
3175
|
*/
|
|
@@ -2696,12 +3182,48 @@ export interface InvoiceAttachPaymentParams {
|
|
|
2696
3182
|
* The ID of the PaymentRecord to attach to the invoice.
|
|
2697
3183
|
*/
|
|
2698
3184
|
payment_record?: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* The PaymentRecord data for attaching an out of band payment to the invoice.
|
|
3187
|
+
*/
|
|
3188
|
+
payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
|
|
3189
|
+
}
|
|
3190
|
+
export declare namespace InvoiceAttachPaymentParams {
|
|
3191
|
+
interface PaymentRecordData {
|
|
3192
|
+
/**
|
|
3193
|
+
* The amount that was paid out of band.
|
|
3194
|
+
*/
|
|
3195
|
+
amount: number;
|
|
3196
|
+
/**
|
|
3197
|
+
* The currency that was paid out of band.
|
|
3198
|
+
*/
|
|
3199
|
+
currency: string;
|
|
3200
|
+
/**
|
|
3201
|
+
* 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`.
|
|
3202
|
+
*/
|
|
3203
|
+
metadata?: Emptyable<MetadataParam>;
|
|
3204
|
+
/**
|
|
3205
|
+
* The type of money movement for this out of band payment record.
|
|
3206
|
+
*/
|
|
3207
|
+
money_movement_type: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* The timestamp when this out of band payment was paid.
|
|
3210
|
+
*/
|
|
3211
|
+
paid_at?: number;
|
|
3212
|
+
/**
|
|
3213
|
+
* The reference for this out of band payment record.
|
|
3214
|
+
*/
|
|
3215
|
+
payment_reference?: string;
|
|
3216
|
+
}
|
|
2699
3217
|
}
|
|
2700
3218
|
export interface InvoiceCreatePreviewParams {
|
|
2701
3219
|
/**
|
|
2702
3220
|
* Settings for automatic tax lookup for this invoice preview.
|
|
2703
3221
|
*/
|
|
2704
3222
|
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
|
|
3223
|
+
/**
|
|
3224
|
+
* The identifier of the billing cadence for which you'd like to retrieve the upcoming invoice. Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
|
|
3225
|
+
*/
|
|
3226
|
+
billing_cadence?: string;
|
|
2705
3227
|
/**
|
|
2706
3228
|
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
|
2707
3229
|
*/
|
|
@@ -2801,10 +3323,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2801
3323
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2802
3324
|
*/
|
|
2803
3325
|
discount?: string;
|
|
3326
|
+
/**
|
|
3327
|
+
* Details to determine how long the discount should be applied for.
|
|
3328
|
+
*/
|
|
3329
|
+
discount_end?: Discount.DiscountEnd;
|
|
2804
3330
|
/**
|
|
2805
3331
|
* ID of the promotion code to create a new discount for.
|
|
2806
3332
|
*/
|
|
2807
3333
|
promotion_code?: string;
|
|
3334
|
+
/**
|
|
3335
|
+
* Settings for discount application including service period anchoring.
|
|
3336
|
+
*/
|
|
3337
|
+
settings?: Discount.Settings;
|
|
2808
3338
|
}
|
|
2809
3339
|
interface InvoiceItem {
|
|
2810
3340
|
/**
|
|
@@ -2888,10 +3418,26 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2888
3418
|
}
|
|
2889
3419
|
type PreviewMode = 'next' | 'recurring';
|
|
2890
3420
|
interface ScheduleDetails {
|
|
3421
|
+
/**
|
|
3422
|
+
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
3423
|
+
*/
|
|
3424
|
+
amendments?: Array<ScheduleDetails.Amendment>;
|
|
3425
|
+
/**
|
|
3426
|
+
* 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.
|
|
3427
|
+
*/
|
|
3428
|
+
billing_behavior?: ScheduleDetails.BillingBehavior;
|
|
2891
3429
|
/**
|
|
2892
3430
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
2893
3431
|
*/
|
|
2894
3432
|
billing_mode?: ScheduleDetails.BillingMode;
|
|
3433
|
+
/**
|
|
3434
|
+
* Sets the billing schedules for the subscription schedule.
|
|
3435
|
+
*/
|
|
3436
|
+
billing_schedules?: Emptyable<Array<ScheduleDetails.BillingSchedule>>;
|
|
3437
|
+
/**
|
|
3438
|
+
* Object representing the subscription schedule's default settings.
|
|
3439
|
+
*/
|
|
3440
|
+
default_settings?: ScheduleDetails.DefaultSettings;
|
|
2895
3441
|
/**
|
|
2896
3442
|
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
|
2897
3443
|
*/
|
|
@@ -2900,6 +3446,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2900
3446
|
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
|
|
2901
3447
|
*/
|
|
2902
3448
|
phases?: Array<ScheduleDetails.Phase>;
|
|
3449
|
+
/**
|
|
3450
|
+
* Provide any time periods to bill in advance.
|
|
3451
|
+
*/
|
|
3452
|
+
prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
|
|
2903
3453
|
/**
|
|
2904
3454
|
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
2905
3455
|
*/
|
|
@@ -2938,6 +3488,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2938
3488
|
* A list of up to 20 subscription items, each with an attached price.
|
|
2939
3489
|
*/
|
|
2940
3490
|
items?: Array<SubscriptionDetails.Item>;
|
|
3491
|
+
/**
|
|
3492
|
+
* Previews the invoice that would be generated when pausing the subscription. Passing an empty hash won't preview pausing and instead returns the next invoice.
|
|
3493
|
+
*
|
|
3494
|
+
* To receive a preview invoice, set `invoicing_behavior` to `invoice`. A preview isn't available if the `bill_for` options produce no billable amounts.
|
|
3495
|
+
*
|
|
3496
|
+
* `pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.
|
|
3497
|
+
*/
|
|
3498
|
+
pause?: SubscriptionDetails.Pause;
|
|
3499
|
+
/**
|
|
3500
|
+
* The pre-billing to apply to the subscription as a preview.
|
|
3501
|
+
*/
|
|
3502
|
+
prebilling?: SubscriptionDetails.Prebilling;
|
|
2941
3503
|
/**
|
|
2942
3504
|
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
2943
3505
|
*/
|
|
@@ -2971,7 +3533,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2971
3533
|
type: Liability.Type;
|
|
2972
3534
|
}
|
|
2973
3535
|
namespace Liability {
|
|
2974
|
-
type Type = 'account' | 'self';
|
|
3536
|
+
type Type = 'account' | 'application' | 'self';
|
|
2975
3537
|
}
|
|
2976
3538
|
}
|
|
2977
3539
|
namespace CustomerDetails {
|
|
@@ -3010,6 +3572,86 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3010
3572
|
type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
3011
3573
|
}
|
|
3012
3574
|
}
|
|
3575
|
+
namespace Discount {
|
|
3576
|
+
interface DiscountEnd {
|
|
3577
|
+
/**
|
|
3578
|
+
* Time span for the redeemed discount.
|
|
3579
|
+
*/
|
|
3580
|
+
duration?: DiscountEnd.Duration;
|
|
3581
|
+
/**
|
|
3582
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3583
|
+
*/
|
|
3584
|
+
timestamp?: number;
|
|
3585
|
+
/**
|
|
3586
|
+
* The type of calculation made to determine when the discount ends.
|
|
3587
|
+
*/
|
|
3588
|
+
type: DiscountEnd.Type;
|
|
3589
|
+
}
|
|
3590
|
+
interface Settings {
|
|
3591
|
+
/**
|
|
3592
|
+
* Configures service period cycle anchoring.
|
|
3593
|
+
*/
|
|
3594
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3595
|
+
/**
|
|
3596
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
|
|
3597
|
+
*/
|
|
3598
|
+
start_date?: Settings.StartDate;
|
|
3599
|
+
}
|
|
3600
|
+
namespace DiscountEnd {
|
|
3601
|
+
interface Duration {
|
|
3602
|
+
/**
|
|
3603
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3604
|
+
*/
|
|
3605
|
+
interval: Duration.Interval;
|
|
3606
|
+
/**
|
|
3607
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3608
|
+
*/
|
|
3609
|
+
interval_count: number;
|
|
3610
|
+
}
|
|
3611
|
+
type Type = 'duration' | 'timestamp';
|
|
3612
|
+
namespace Duration {
|
|
3613
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3614
|
+
}
|
|
3615
|
+
}
|
|
3616
|
+
namespace Settings {
|
|
3617
|
+
interface ServicePeriodAnchorConfig {
|
|
3618
|
+
/**
|
|
3619
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3620
|
+
*/
|
|
3621
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3622
|
+
/**
|
|
3623
|
+
* The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
|
|
3624
|
+
*/
|
|
3625
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3626
|
+
}
|
|
3627
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'now';
|
|
3628
|
+
namespace ServicePeriodAnchorConfig {
|
|
3629
|
+
interface Custom {
|
|
3630
|
+
/**
|
|
3631
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3632
|
+
*/
|
|
3633
|
+
day_of_month: number;
|
|
3634
|
+
/**
|
|
3635
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3636
|
+
*/
|
|
3637
|
+
hour?: number;
|
|
3638
|
+
/**
|
|
3639
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3640
|
+
*/
|
|
3641
|
+
minute?: number;
|
|
3642
|
+
/**
|
|
3643
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3644
|
+
*/
|
|
3645
|
+
month?: number;
|
|
3646
|
+
/**
|
|
3647
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3648
|
+
*/
|
|
3649
|
+
second?: number;
|
|
3650
|
+
}
|
|
3651
|
+
type Type = 'custom' | 'subscription_service_cycle_anchor';
|
|
3652
|
+
}
|
|
3653
|
+
}
|
|
3654
|
+
}
|
|
3013
3655
|
namespace InvoiceItem {
|
|
3014
3656
|
interface Discount {
|
|
3015
3657
|
/**
|
|
@@ -3020,6 +3662,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3020
3662
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3021
3663
|
*/
|
|
3022
3664
|
discount?: string;
|
|
3665
|
+
/**
|
|
3666
|
+
* Details to determine how long the discount should be applied for.
|
|
3667
|
+
*/
|
|
3668
|
+
discount_end?: Discount.DiscountEnd;
|
|
3023
3669
|
/**
|
|
3024
3670
|
* ID of the promotion code to create a new discount for.
|
|
3025
3671
|
*/
|
|
@@ -3058,14 +3704,97 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3058
3704
|
unit_amount_decimal?: Decimal;
|
|
3059
3705
|
}
|
|
3060
3706
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3707
|
+
namespace Discount {
|
|
3708
|
+
interface DiscountEnd {
|
|
3709
|
+
/**
|
|
3710
|
+
* Time span for the redeemed discount.
|
|
3711
|
+
*/
|
|
3712
|
+
duration?: DiscountEnd.Duration;
|
|
3713
|
+
/**
|
|
3714
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3715
|
+
*/
|
|
3716
|
+
timestamp?: number;
|
|
3717
|
+
/**
|
|
3718
|
+
* The type of calculation made to determine when the discount ends.
|
|
3719
|
+
*/
|
|
3720
|
+
type: DiscountEnd.Type;
|
|
3721
|
+
}
|
|
3722
|
+
namespace DiscountEnd {
|
|
3723
|
+
interface Duration {
|
|
3724
|
+
/**
|
|
3725
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3726
|
+
*/
|
|
3727
|
+
interval: Duration.Interval;
|
|
3728
|
+
/**
|
|
3729
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3730
|
+
*/
|
|
3731
|
+
interval_count: number;
|
|
3732
|
+
}
|
|
3733
|
+
type Type = 'duration' | 'timestamp';
|
|
3734
|
+
namespace Duration {
|
|
3735
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3736
|
+
}
|
|
3737
|
+
}
|
|
3738
|
+
}
|
|
3061
3739
|
namespace PriceData {
|
|
3062
3740
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3063
3741
|
}
|
|
3064
3742
|
}
|
|
3065
3743
|
namespace Issuer {
|
|
3066
|
-
type Type = 'account' | 'self';
|
|
3744
|
+
type Type = 'account' | 'application' | 'self';
|
|
3067
3745
|
}
|
|
3068
3746
|
namespace ScheduleDetails {
|
|
3747
|
+
interface Amendment {
|
|
3748
|
+
/**
|
|
3749
|
+
* Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
|
3750
|
+
*/
|
|
3751
|
+
amendment_end?: Amendment.AmendmentEnd;
|
|
3752
|
+
/**
|
|
3753
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
3754
|
+
*/
|
|
3755
|
+
amendment_start: Amendment.AmendmentStart;
|
|
3756
|
+
/**
|
|
3757
|
+
* For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
|
3758
|
+
*/
|
|
3759
|
+
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
3760
|
+
/**
|
|
3761
|
+
* Actions to apply to the billing schedules.
|
|
3762
|
+
*/
|
|
3763
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
3764
|
+
/**
|
|
3765
|
+
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
3766
|
+
*/
|
|
3767
|
+
discount_actions?: Array<Amendment.DiscountAction>;
|
|
3768
|
+
/**
|
|
3769
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3770
|
+
*/
|
|
3771
|
+
effective_at?: Amendment.EffectiveAt;
|
|
3772
|
+
/**
|
|
3773
|
+
* Changes to the subscription items during the amendment time span.
|
|
3774
|
+
*/
|
|
3775
|
+
item_actions?: Array<Amendment.ItemAction>;
|
|
3776
|
+
/**
|
|
3777
|
+
* Instructions for how to modify phase metadata
|
|
3778
|
+
*/
|
|
3779
|
+
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
3780
|
+
/**
|
|
3781
|
+
* Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
|
3782
|
+
*/
|
|
3783
|
+
proration_behavior?: Amendment.ProrationBehavior;
|
|
3784
|
+
/**
|
|
3785
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3786
|
+
*/
|
|
3787
|
+
set_pause_collection?: Amendment.SetPauseCollection;
|
|
3788
|
+
/**
|
|
3789
|
+
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
3790
|
+
*/
|
|
3791
|
+
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
3792
|
+
/**
|
|
3793
|
+
* Settings related to subscription trials.
|
|
3794
|
+
*/
|
|
3795
|
+
trial_settings?: Amendment.TrialSettings;
|
|
3796
|
+
}
|
|
3797
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3069
3798
|
interface BillingMode {
|
|
3070
3799
|
/**
|
|
3071
3800
|
* Configure behavior for flexible billing mode.
|
|
@@ -3076,6 +3805,26 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3076
3805
|
*/
|
|
3077
3806
|
type: BillingMode.Type;
|
|
3078
3807
|
}
|
|
3808
|
+
interface BillingSchedule {
|
|
3809
|
+
/**
|
|
3810
|
+
* Configure billing schedule differently for individual subscription items.
|
|
3811
|
+
*/
|
|
3812
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
3813
|
+
/**
|
|
3814
|
+
* The end date for the billing schedule.
|
|
3815
|
+
*/
|
|
3816
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
3817
|
+
/**
|
|
3818
|
+
* 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.
|
|
3819
|
+
*/
|
|
3820
|
+
key?: string;
|
|
3821
|
+
}
|
|
3822
|
+
interface DefaultSettings {
|
|
3823
|
+
/**
|
|
3824
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3825
|
+
*/
|
|
3826
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
3827
|
+
}
|
|
3079
3828
|
type EndBehavior = 'cancel' | 'release';
|
|
3080
3829
|
interface Phase {
|
|
3081
3830
|
/**
|
|
@@ -3126,6 +3875,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3126
3875
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
3127
3876
|
*/
|
|
3128
3877
|
duration?: Phase.Duration;
|
|
3878
|
+
/**
|
|
3879
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3880
|
+
*/
|
|
3881
|
+
effective_at?: Phase.EffectiveAt;
|
|
3129
3882
|
/**
|
|
3130
3883
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
3131
3884
|
*/
|
|
@@ -3146,6 +3899,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3146
3899
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
3147
3900
|
*/
|
|
3148
3901
|
on_behalf_of?: string;
|
|
3902
|
+
/**
|
|
3903
|
+
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
3904
|
+
*/
|
|
3905
|
+
pause_collection?: Phase.PauseCollection;
|
|
3149
3906
|
/**
|
|
3150
3907
|
* Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
3151
3908
|
*/
|
|
@@ -3162,12 +3919,702 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3162
3919
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
3163
3920
|
*/
|
|
3164
3921
|
trial?: boolean;
|
|
3922
|
+
/**
|
|
3923
|
+
* Specify trial behavior when crossing phase boundaries
|
|
3924
|
+
*/
|
|
3925
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
3165
3926
|
/**
|
|
3166
3927
|
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
|
3167
3928
|
*/
|
|
3168
3929
|
trial_end?: number | 'now';
|
|
3930
|
+
/**
|
|
3931
|
+
* Settings related to subscription trials.
|
|
3932
|
+
*/
|
|
3933
|
+
trial_settings?: Phase.TrialSettings;
|
|
3934
|
+
}
|
|
3935
|
+
interface Prebilling {
|
|
3936
|
+
/**
|
|
3937
|
+
* The end of the prebilled time period.
|
|
3938
|
+
*/
|
|
3939
|
+
bill_until?: Prebilling.BillUntil;
|
|
3940
|
+
/**
|
|
3941
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
3942
|
+
*/
|
|
3943
|
+
iterations?: number;
|
|
3169
3944
|
}
|
|
3170
3945
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3946
|
+
namespace Amendment {
|
|
3947
|
+
interface AmendmentEnd {
|
|
3948
|
+
/**
|
|
3949
|
+
* Use the `end` time of a given discount.
|
|
3950
|
+
*/
|
|
3951
|
+
discount_end?: AmendmentEnd.DiscountEnd;
|
|
3952
|
+
/**
|
|
3953
|
+
* Time span for the amendment starting from the `amendment_start`.
|
|
3954
|
+
*/
|
|
3955
|
+
duration?: AmendmentEnd.Duration;
|
|
3956
|
+
/**
|
|
3957
|
+
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
3958
|
+
*/
|
|
3959
|
+
timestamp?: number;
|
|
3960
|
+
/**
|
|
3961
|
+
* Select one of three ways to pass the `amendment_end`.
|
|
3962
|
+
*/
|
|
3963
|
+
type: AmendmentEnd.Type;
|
|
3964
|
+
}
|
|
3965
|
+
interface AmendmentStart {
|
|
3966
|
+
/**
|
|
3967
|
+
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
3968
|
+
*/
|
|
3969
|
+
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
3970
|
+
/**
|
|
3971
|
+
* Use the `end` time of a given discount.
|
|
3972
|
+
*/
|
|
3973
|
+
discount_end?: AmendmentStart.DiscountEnd;
|
|
3974
|
+
/**
|
|
3975
|
+
* A precise Unix timestamp for the amendment to start.
|
|
3976
|
+
*/
|
|
3977
|
+
timestamp?: number;
|
|
3978
|
+
/**
|
|
3979
|
+
* Select one of three ways to pass the `amendment_start`.
|
|
3980
|
+
*/
|
|
3981
|
+
type: AmendmentStart.Type;
|
|
3982
|
+
}
|
|
3983
|
+
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
3984
|
+
interface BillingSchedulesAction {
|
|
3985
|
+
/**
|
|
3986
|
+
* Specify which subscription items the billing schedule applies to.
|
|
3987
|
+
*/
|
|
3988
|
+
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
3989
|
+
/**
|
|
3990
|
+
* Select the action.
|
|
3991
|
+
*/
|
|
3992
|
+
type: BillingSchedulesAction.Type;
|
|
3993
|
+
}
|
|
3994
|
+
interface DiscountAction {
|
|
3995
|
+
/**
|
|
3996
|
+
* Details of the discount to add.
|
|
3997
|
+
*/
|
|
3998
|
+
add?: DiscountAction.Add;
|
|
3999
|
+
/**
|
|
4000
|
+
* Details of the discount to remove.
|
|
4001
|
+
*/
|
|
4002
|
+
remove?: DiscountAction.Remove;
|
|
4003
|
+
/**
|
|
4004
|
+
* Details of the discount to replace the existing discounts with.
|
|
4005
|
+
*/
|
|
4006
|
+
set?: DiscountAction.Set;
|
|
4007
|
+
/**
|
|
4008
|
+
* Determines the type of discount action.
|
|
4009
|
+
*/
|
|
4010
|
+
type: DiscountAction.Type;
|
|
4011
|
+
}
|
|
4012
|
+
type EffectiveAt = 'amendment_start' | 'billing_period_start';
|
|
4013
|
+
interface ItemAction {
|
|
4014
|
+
/**
|
|
4015
|
+
* Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
|
4016
|
+
*/
|
|
4017
|
+
add?: ItemAction.Add;
|
|
4018
|
+
/**
|
|
4019
|
+
* Details of the subscription item to remove.
|
|
4020
|
+
*/
|
|
4021
|
+
remove?: ItemAction.Remove;
|
|
4022
|
+
/**
|
|
4023
|
+
* Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
|
4024
|
+
*/
|
|
4025
|
+
set?: ItemAction.Set;
|
|
4026
|
+
/**
|
|
4027
|
+
* Determines the type of item action.
|
|
4028
|
+
*/
|
|
4029
|
+
type: ItemAction.Type;
|
|
4030
|
+
}
|
|
4031
|
+
interface MetadataAction {
|
|
4032
|
+
/**
|
|
4033
|
+
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
4034
|
+
*/
|
|
4035
|
+
add?: {
|
|
4036
|
+
[key: string]: string;
|
|
4037
|
+
};
|
|
4038
|
+
/**
|
|
4039
|
+
* Keys to remove from schedule phase metadata.
|
|
4040
|
+
*/
|
|
4041
|
+
remove?: Array<string>;
|
|
4042
|
+
/**
|
|
4043
|
+
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
4044
|
+
*/
|
|
4045
|
+
set?: Emptyable<{
|
|
4046
|
+
[key: string]: string;
|
|
4047
|
+
}>;
|
|
4048
|
+
/**
|
|
4049
|
+
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
4050
|
+
*/
|
|
4051
|
+
type: MetadataAction.Type;
|
|
4052
|
+
}
|
|
4053
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4054
|
+
interface SetPauseCollection {
|
|
4055
|
+
/**
|
|
4056
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
4057
|
+
*/
|
|
4058
|
+
set?: SetPauseCollection.Set;
|
|
4059
|
+
/**
|
|
4060
|
+
* Determines the type of the pause_collection amendment.
|
|
4061
|
+
*/
|
|
4062
|
+
type: SetPauseCollection.Type;
|
|
4063
|
+
}
|
|
4064
|
+
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
4065
|
+
interface TrialSettings {
|
|
4066
|
+
/**
|
|
4067
|
+
* Defines how the subscription should behave when a trial ends.
|
|
4068
|
+
*/
|
|
4069
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
4070
|
+
}
|
|
4071
|
+
namespace AmendmentEnd {
|
|
4072
|
+
interface DiscountEnd {
|
|
4073
|
+
/**
|
|
4074
|
+
* The ID of a specific discount.
|
|
4075
|
+
*/
|
|
4076
|
+
discount: string;
|
|
4077
|
+
}
|
|
4078
|
+
interface Duration {
|
|
4079
|
+
/**
|
|
4080
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4081
|
+
*/
|
|
4082
|
+
interval: Duration.Interval;
|
|
4083
|
+
/**
|
|
4084
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4085
|
+
*/
|
|
4086
|
+
interval_count: number;
|
|
4087
|
+
}
|
|
4088
|
+
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
4089
|
+
namespace Duration {
|
|
4090
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4091
|
+
}
|
|
4092
|
+
}
|
|
4093
|
+
namespace AmendmentStart {
|
|
4094
|
+
interface AmendmentEnd {
|
|
4095
|
+
/**
|
|
4096
|
+
* The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
|
|
4097
|
+
*/
|
|
4098
|
+
index: number;
|
|
4099
|
+
}
|
|
4100
|
+
interface DiscountEnd {
|
|
4101
|
+
/**
|
|
4102
|
+
* The ID of a specific discount.
|
|
4103
|
+
*/
|
|
4104
|
+
discount: string;
|
|
4105
|
+
}
|
|
4106
|
+
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
4107
|
+
}
|
|
4108
|
+
namespace BillingSchedulesAction {
|
|
4109
|
+
interface AppliesTo {
|
|
4110
|
+
/**
|
|
4111
|
+
* The ID of the price object.
|
|
4112
|
+
*/
|
|
4113
|
+
price?: string;
|
|
4114
|
+
/**
|
|
4115
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4116
|
+
*/
|
|
4117
|
+
type: 'price';
|
|
4118
|
+
}
|
|
4119
|
+
type Type = 'remove' | 'set';
|
|
4120
|
+
}
|
|
4121
|
+
namespace DiscountAction {
|
|
4122
|
+
interface Add {
|
|
4123
|
+
/**
|
|
4124
|
+
* The coupon code to redeem.
|
|
4125
|
+
*/
|
|
4126
|
+
coupon?: string;
|
|
4127
|
+
/**
|
|
4128
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
4129
|
+
*/
|
|
4130
|
+
discount?: string;
|
|
4131
|
+
/**
|
|
4132
|
+
* Details to determine how long the discount should be applied for.
|
|
4133
|
+
*/
|
|
4134
|
+
discount_end?: Add.DiscountEnd;
|
|
4135
|
+
/**
|
|
4136
|
+
* 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.
|
|
4137
|
+
*/
|
|
4138
|
+
index?: number;
|
|
4139
|
+
/**
|
|
4140
|
+
* The promotion code to redeem.
|
|
4141
|
+
*/
|
|
4142
|
+
promotion_code?: string;
|
|
4143
|
+
/**
|
|
4144
|
+
* Settings for discount application including service period anchoring.
|
|
4145
|
+
*/
|
|
4146
|
+
settings?: Add.Settings;
|
|
4147
|
+
}
|
|
4148
|
+
interface Remove {
|
|
4149
|
+
/**
|
|
4150
|
+
* The coupon code to remove from the `discounts` array.
|
|
4151
|
+
*/
|
|
4152
|
+
coupon?: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
4155
|
+
*/
|
|
4156
|
+
discount?: string;
|
|
4157
|
+
/**
|
|
4158
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
4159
|
+
*/
|
|
4160
|
+
promotion_code?: string;
|
|
4161
|
+
}
|
|
4162
|
+
interface Set {
|
|
4163
|
+
/**
|
|
4164
|
+
* The coupon code to replace the `discounts` array with.
|
|
4165
|
+
*/
|
|
4166
|
+
coupon?: string;
|
|
4167
|
+
/**
|
|
4168
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
4169
|
+
*/
|
|
4170
|
+
discount?: string;
|
|
4171
|
+
/**
|
|
4172
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
4173
|
+
*/
|
|
4174
|
+
promotion_code?: string;
|
|
4175
|
+
/**
|
|
4176
|
+
* Settings for discount application including service period anchoring.
|
|
4177
|
+
*/
|
|
4178
|
+
settings?: Set.Settings;
|
|
4179
|
+
}
|
|
4180
|
+
type Type = 'add' | 'remove' | 'set';
|
|
4181
|
+
namespace Add {
|
|
4182
|
+
interface DiscountEnd {
|
|
4183
|
+
/**
|
|
4184
|
+
* The type of calculation made to determine when the discount ends.
|
|
4185
|
+
*/
|
|
4186
|
+
type: 'amendment_end';
|
|
4187
|
+
}
|
|
4188
|
+
interface Settings {
|
|
4189
|
+
/**
|
|
4190
|
+
* Configures service period cycle anchoring.
|
|
4191
|
+
*/
|
|
4192
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4193
|
+
/**
|
|
4194
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
4195
|
+
*/
|
|
4196
|
+
start_date?: Settings.StartDate;
|
|
4197
|
+
}
|
|
4198
|
+
namespace Settings {
|
|
4199
|
+
interface ServicePeriodAnchorConfig {
|
|
4200
|
+
/**
|
|
4201
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4202
|
+
*/
|
|
4203
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4204
|
+
/**
|
|
4205
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4206
|
+
*/
|
|
4207
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4208
|
+
}
|
|
4209
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
4210
|
+
namespace ServicePeriodAnchorConfig {
|
|
4211
|
+
interface Custom {
|
|
4212
|
+
/**
|
|
4213
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4214
|
+
*/
|
|
4215
|
+
day_of_month: number;
|
|
4216
|
+
/**
|
|
4217
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4218
|
+
*/
|
|
4219
|
+
hour?: number;
|
|
4220
|
+
/**
|
|
4221
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4222
|
+
*/
|
|
4223
|
+
minute?: number;
|
|
4224
|
+
/**
|
|
4225
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4226
|
+
*/
|
|
4227
|
+
month?: number;
|
|
4228
|
+
/**
|
|
4229
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4230
|
+
*/
|
|
4231
|
+
second?: number;
|
|
4232
|
+
}
|
|
4233
|
+
type Type = 'custom' | 'inherit';
|
|
4234
|
+
}
|
|
4235
|
+
}
|
|
4236
|
+
}
|
|
4237
|
+
namespace Set {
|
|
4238
|
+
interface Settings {
|
|
4239
|
+
/**
|
|
4240
|
+
* Configures service period cycle anchoring.
|
|
4241
|
+
*/
|
|
4242
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4243
|
+
/**
|
|
4244
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
4245
|
+
*/
|
|
4246
|
+
start_date?: Settings.StartDate;
|
|
4247
|
+
}
|
|
4248
|
+
namespace Settings {
|
|
4249
|
+
interface ServicePeriodAnchorConfig {
|
|
4250
|
+
/**
|
|
4251
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4252
|
+
*/
|
|
4253
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4254
|
+
/**
|
|
4255
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4256
|
+
*/
|
|
4257
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4258
|
+
}
|
|
4259
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
4260
|
+
namespace ServicePeriodAnchorConfig {
|
|
4261
|
+
interface Custom {
|
|
4262
|
+
/**
|
|
4263
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4264
|
+
*/
|
|
4265
|
+
day_of_month: number;
|
|
4266
|
+
/**
|
|
4267
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4268
|
+
*/
|
|
4269
|
+
hour?: number;
|
|
4270
|
+
/**
|
|
4271
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4272
|
+
*/
|
|
4273
|
+
minute?: number;
|
|
4274
|
+
/**
|
|
4275
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4276
|
+
*/
|
|
4277
|
+
month?: number;
|
|
4278
|
+
/**
|
|
4279
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4280
|
+
*/
|
|
4281
|
+
second?: number;
|
|
4282
|
+
}
|
|
4283
|
+
type Type = 'custom' | 'inherit';
|
|
4284
|
+
}
|
|
4285
|
+
}
|
|
4286
|
+
}
|
|
4287
|
+
}
|
|
4288
|
+
namespace ItemAction {
|
|
4289
|
+
interface Add {
|
|
4290
|
+
/**
|
|
4291
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
4292
|
+
*/
|
|
4293
|
+
discounts?: Array<Add.Discount>;
|
|
4294
|
+
/**
|
|
4295
|
+
* 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`.
|
|
4296
|
+
*/
|
|
4297
|
+
metadata?: MetadataParam;
|
|
4298
|
+
/**
|
|
4299
|
+
* The ID of the price object.
|
|
4300
|
+
*/
|
|
4301
|
+
price: string;
|
|
4302
|
+
/**
|
|
4303
|
+
* Quantity for this item.
|
|
4304
|
+
*/
|
|
4305
|
+
quantity?: number;
|
|
4306
|
+
/**
|
|
4307
|
+
* 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`.
|
|
4308
|
+
*/
|
|
4309
|
+
tax_rates?: Array<string>;
|
|
4310
|
+
/**
|
|
4311
|
+
* Options that configure the trial on the subscription item.
|
|
4312
|
+
*/
|
|
4313
|
+
trial?: Add.Trial;
|
|
4314
|
+
/**
|
|
4315
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4316
|
+
*/
|
|
4317
|
+
trial_offer?: string;
|
|
4318
|
+
}
|
|
4319
|
+
interface Remove {
|
|
4320
|
+
/**
|
|
4321
|
+
* ID of a price to remove.
|
|
4322
|
+
*/
|
|
4323
|
+
price: string;
|
|
4324
|
+
}
|
|
4325
|
+
interface Set {
|
|
4326
|
+
/**
|
|
4327
|
+
* 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`.
|
|
4328
|
+
*/
|
|
4329
|
+
discounts?: Array<Set.Discount>;
|
|
4330
|
+
/**
|
|
4331
|
+
* 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`.
|
|
4332
|
+
*/
|
|
4333
|
+
metadata?: MetadataParam;
|
|
4334
|
+
/**
|
|
4335
|
+
* The ID of the price object.
|
|
4336
|
+
*/
|
|
4337
|
+
price: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* 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`.
|
|
4340
|
+
*/
|
|
4341
|
+
quantity?: number;
|
|
4342
|
+
/**
|
|
4343
|
+
* 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`.
|
|
4344
|
+
*/
|
|
4345
|
+
tax_rates?: Array<string>;
|
|
4346
|
+
/**
|
|
4347
|
+
* 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`.
|
|
4348
|
+
*/
|
|
4349
|
+
trial?: Set.Trial;
|
|
4350
|
+
/**
|
|
4351
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4352
|
+
*/
|
|
4353
|
+
trial_offer?: string;
|
|
4354
|
+
}
|
|
4355
|
+
type Type = 'add' | 'remove' | 'set';
|
|
4356
|
+
namespace Add {
|
|
4357
|
+
interface Discount {
|
|
4358
|
+
/**
|
|
4359
|
+
* ID of the coupon to create a new discount for.
|
|
4360
|
+
*/
|
|
4361
|
+
coupon?: string;
|
|
4362
|
+
/**
|
|
4363
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4364
|
+
*/
|
|
4365
|
+
discount?: string;
|
|
4366
|
+
/**
|
|
4367
|
+
* Details to determine how long the discount should be applied for.
|
|
4368
|
+
*/
|
|
4369
|
+
discount_end?: Discount.DiscountEnd;
|
|
4370
|
+
/**
|
|
4371
|
+
* ID of the promotion code to create a new discount for.
|
|
4372
|
+
*/
|
|
4373
|
+
promotion_code?: string;
|
|
4374
|
+
/**
|
|
4375
|
+
* Settings for discount application including service period anchoring.
|
|
4376
|
+
*/
|
|
4377
|
+
settings?: Discount.Settings;
|
|
4378
|
+
}
|
|
4379
|
+
interface Trial {
|
|
4380
|
+
/**
|
|
4381
|
+
* 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.
|
|
4382
|
+
*/
|
|
4383
|
+
converts_to?: Array<string>;
|
|
4384
|
+
/**
|
|
4385
|
+
* Determines the type of trial for this item.
|
|
4386
|
+
*/
|
|
4387
|
+
type: Trial.Type;
|
|
4388
|
+
}
|
|
4389
|
+
namespace Discount {
|
|
4390
|
+
interface DiscountEnd {
|
|
4391
|
+
/**
|
|
4392
|
+
* Time span for the redeemed discount.
|
|
4393
|
+
*/
|
|
4394
|
+
duration?: DiscountEnd.Duration;
|
|
4395
|
+
/**
|
|
4396
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4397
|
+
*/
|
|
4398
|
+
timestamp?: number;
|
|
4399
|
+
/**
|
|
4400
|
+
* The type of calculation made to determine when the discount ends.
|
|
4401
|
+
*/
|
|
4402
|
+
type: DiscountEnd.Type;
|
|
4403
|
+
}
|
|
4404
|
+
interface Settings {
|
|
4405
|
+
/**
|
|
4406
|
+
* Configures service period cycle anchoring.
|
|
4407
|
+
*/
|
|
4408
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4409
|
+
/**
|
|
4410
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
4411
|
+
*/
|
|
4412
|
+
start_date?: Settings.StartDate;
|
|
4413
|
+
}
|
|
4414
|
+
namespace DiscountEnd {
|
|
4415
|
+
interface Duration {
|
|
4416
|
+
/**
|
|
4417
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4418
|
+
*/
|
|
4419
|
+
interval: Duration.Interval;
|
|
4420
|
+
/**
|
|
4421
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4422
|
+
*/
|
|
4423
|
+
interval_count: number;
|
|
4424
|
+
}
|
|
4425
|
+
type Type = 'duration' | 'timestamp';
|
|
4426
|
+
namespace Duration {
|
|
4427
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4428
|
+
}
|
|
4429
|
+
}
|
|
4430
|
+
namespace Settings {
|
|
4431
|
+
interface ServicePeriodAnchorConfig {
|
|
4432
|
+
/**
|
|
4433
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4434
|
+
*/
|
|
4435
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4436
|
+
/**
|
|
4437
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4438
|
+
*/
|
|
4439
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4440
|
+
}
|
|
4441
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
4442
|
+
namespace ServicePeriodAnchorConfig {
|
|
4443
|
+
interface Custom {
|
|
4444
|
+
/**
|
|
4445
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4446
|
+
*/
|
|
4447
|
+
day_of_month: number;
|
|
4448
|
+
/**
|
|
4449
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4450
|
+
*/
|
|
4451
|
+
hour?: number;
|
|
4452
|
+
/**
|
|
4453
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4454
|
+
*/
|
|
4455
|
+
minute?: number;
|
|
4456
|
+
/**
|
|
4457
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4458
|
+
*/
|
|
4459
|
+
month?: number;
|
|
4460
|
+
/**
|
|
4461
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4462
|
+
*/
|
|
4463
|
+
second?: number;
|
|
4464
|
+
}
|
|
4465
|
+
type Type = 'custom' | 'inherit';
|
|
4466
|
+
}
|
|
4467
|
+
}
|
|
4468
|
+
}
|
|
4469
|
+
namespace Trial {
|
|
4470
|
+
type Type = 'free' | 'paid';
|
|
4471
|
+
}
|
|
4472
|
+
}
|
|
4473
|
+
namespace Set {
|
|
4474
|
+
interface Discount {
|
|
4475
|
+
/**
|
|
4476
|
+
* ID of the coupon to create a new discount for.
|
|
4477
|
+
*/
|
|
4478
|
+
coupon?: string;
|
|
4479
|
+
/**
|
|
4480
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4481
|
+
*/
|
|
4482
|
+
discount?: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* Details to determine how long the discount should be applied for.
|
|
4485
|
+
*/
|
|
4486
|
+
discount_end?: Discount.DiscountEnd;
|
|
4487
|
+
/**
|
|
4488
|
+
* ID of the promotion code to create a new discount for.
|
|
4489
|
+
*/
|
|
4490
|
+
promotion_code?: string;
|
|
4491
|
+
/**
|
|
4492
|
+
* Settings for discount application including service period anchoring.
|
|
4493
|
+
*/
|
|
4494
|
+
settings?: Discount.Settings;
|
|
4495
|
+
}
|
|
4496
|
+
interface Trial {
|
|
4497
|
+
/**
|
|
4498
|
+
* 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.
|
|
4499
|
+
*/
|
|
4500
|
+
converts_to?: Array<string>;
|
|
4501
|
+
/**
|
|
4502
|
+
* Determines the type of trial for this item.
|
|
4503
|
+
*/
|
|
4504
|
+
type: Trial.Type;
|
|
4505
|
+
}
|
|
4506
|
+
namespace Discount {
|
|
4507
|
+
interface DiscountEnd {
|
|
4508
|
+
/**
|
|
4509
|
+
* Time span for the redeemed discount.
|
|
4510
|
+
*/
|
|
4511
|
+
duration?: DiscountEnd.Duration;
|
|
4512
|
+
/**
|
|
4513
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4514
|
+
*/
|
|
4515
|
+
timestamp?: number;
|
|
4516
|
+
/**
|
|
4517
|
+
* The type of calculation made to determine when the discount ends.
|
|
4518
|
+
*/
|
|
4519
|
+
type: DiscountEnd.Type;
|
|
4520
|
+
}
|
|
4521
|
+
interface Settings {
|
|
4522
|
+
/**
|
|
4523
|
+
* Configures service period cycle anchoring.
|
|
4524
|
+
*/
|
|
4525
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4526
|
+
/**
|
|
4527
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
4528
|
+
*/
|
|
4529
|
+
start_date?: Settings.StartDate;
|
|
4530
|
+
}
|
|
4531
|
+
namespace DiscountEnd {
|
|
4532
|
+
interface Duration {
|
|
4533
|
+
/**
|
|
4534
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4535
|
+
*/
|
|
4536
|
+
interval: Duration.Interval;
|
|
4537
|
+
/**
|
|
4538
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4539
|
+
*/
|
|
4540
|
+
interval_count: number;
|
|
4541
|
+
}
|
|
4542
|
+
type Type = 'duration' | 'timestamp';
|
|
4543
|
+
namespace Duration {
|
|
4544
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4545
|
+
}
|
|
4546
|
+
}
|
|
4547
|
+
namespace Settings {
|
|
4548
|
+
interface ServicePeriodAnchorConfig {
|
|
4549
|
+
/**
|
|
4550
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4551
|
+
*/
|
|
4552
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4553
|
+
/**
|
|
4554
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4555
|
+
*/
|
|
4556
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4557
|
+
}
|
|
4558
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
4559
|
+
namespace ServicePeriodAnchorConfig {
|
|
4560
|
+
interface Custom {
|
|
4561
|
+
/**
|
|
4562
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4563
|
+
*/
|
|
4564
|
+
day_of_month: number;
|
|
4565
|
+
/**
|
|
4566
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4567
|
+
*/
|
|
4568
|
+
hour?: number;
|
|
4569
|
+
/**
|
|
4570
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4571
|
+
*/
|
|
4572
|
+
minute?: number;
|
|
4573
|
+
/**
|
|
4574
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4575
|
+
*/
|
|
4576
|
+
month?: number;
|
|
4577
|
+
/**
|
|
4578
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4579
|
+
*/
|
|
4580
|
+
second?: number;
|
|
4581
|
+
}
|
|
4582
|
+
type Type = 'custom' | 'inherit';
|
|
4583
|
+
}
|
|
4584
|
+
}
|
|
4585
|
+
}
|
|
4586
|
+
namespace Trial {
|
|
4587
|
+
type Type = 'free' | 'paid';
|
|
4588
|
+
}
|
|
4589
|
+
}
|
|
4590
|
+
}
|
|
4591
|
+
namespace MetadataAction {
|
|
4592
|
+
type Type = 'add' | 'remove' | 'set';
|
|
4593
|
+
}
|
|
4594
|
+
namespace SetPauseCollection {
|
|
4595
|
+
interface Set {
|
|
4596
|
+
/**
|
|
4597
|
+
* The payment collection behavior for this subscription while paused.
|
|
4598
|
+
*/
|
|
4599
|
+
behavior: Set.Behavior;
|
|
4600
|
+
}
|
|
4601
|
+
type Type = 'remove' | 'set';
|
|
4602
|
+
namespace Set {
|
|
4603
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
4604
|
+
}
|
|
4605
|
+
}
|
|
4606
|
+
namespace TrialSettings {
|
|
4607
|
+
interface EndBehavior {
|
|
4608
|
+
/**
|
|
4609
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4610
|
+
*/
|
|
4611
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4612
|
+
}
|
|
4613
|
+
namespace EndBehavior {
|
|
4614
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
4615
|
+
}
|
|
4616
|
+
}
|
|
4617
|
+
}
|
|
3171
4618
|
namespace BillingMode {
|
|
3172
4619
|
interface Flexible {
|
|
3173
4620
|
/**
|
|
@@ -3180,6 +4627,51 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3180
4627
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
3181
4628
|
}
|
|
3182
4629
|
}
|
|
4630
|
+
namespace BillingSchedule {
|
|
4631
|
+
interface AppliesTo {
|
|
4632
|
+
/**
|
|
4633
|
+
* The ID of the price object.
|
|
4634
|
+
*/
|
|
4635
|
+
price?: string;
|
|
4636
|
+
/**
|
|
4637
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4638
|
+
*/
|
|
4639
|
+
type: 'price';
|
|
4640
|
+
}
|
|
4641
|
+
interface BillUntil {
|
|
4642
|
+
/**
|
|
4643
|
+
* Specifies the billing period.
|
|
4644
|
+
*/
|
|
4645
|
+
duration?: BillUntil.Duration;
|
|
4646
|
+
/**
|
|
4647
|
+
* The end date of the billing schedule.
|
|
4648
|
+
*/
|
|
4649
|
+
timestamp?: number;
|
|
4650
|
+
/**
|
|
4651
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
4652
|
+
*/
|
|
4653
|
+
type: BillUntil.Type;
|
|
4654
|
+
}
|
|
4655
|
+
namespace BillUntil {
|
|
4656
|
+
interface Duration {
|
|
4657
|
+
/**
|
|
4658
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
4659
|
+
*/
|
|
4660
|
+
interval: Duration.Interval;
|
|
4661
|
+
/**
|
|
4662
|
+
* The multiplier applied to the interval.
|
|
4663
|
+
*/
|
|
4664
|
+
interval_count?: number;
|
|
4665
|
+
}
|
|
4666
|
+
type Type = 'duration' | 'timestamp';
|
|
4667
|
+
namespace Duration {
|
|
4668
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4669
|
+
}
|
|
4670
|
+
}
|
|
4671
|
+
}
|
|
4672
|
+
namespace DefaultSettings {
|
|
4673
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
4674
|
+
}
|
|
3183
4675
|
namespace Phase {
|
|
3184
4676
|
interface AddInvoiceItem {
|
|
3185
4677
|
/**
|
|
@@ -3246,10 +4738,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3246
4738
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3247
4739
|
*/
|
|
3248
4740
|
discount?: string;
|
|
4741
|
+
/**
|
|
4742
|
+
* Details to determine how long the discount should be applied for.
|
|
4743
|
+
*/
|
|
4744
|
+
discount_end?: Discount.DiscountEnd;
|
|
3249
4745
|
/**
|
|
3250
4746
|
* ID of the promotion code to create a new discount for.
|
|
3251
4747
|
*/
|
|
3252
4748
|
promotion_code?: string;
|
|
4749
|
+
/**
|
|
4750
|
+
* Settings for discount application including service period anchoring.
|
|
4751
|
+
*/
|
|
4752
|
+
settings?: Discount.Settings;
|
|
3253
4753
|
}
|
|
3254
4754
|
interface Duration {
|
|
3255
4755
|
/**
|
|
@@ -3261,6 +4761,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3261
4761
|
*/
|
|
3262
4762
|
interval_count?: number;
|
|
3263
4763
|
}
|
|
4764
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
3264
4765
|
interface InvoiceSettings {
|
|
3265
4766
|
/**
|
|
3266
4767
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -3305,9 +4806,23 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3305
4806
|
*/
|
|
3306
4807
|
quantity?: number;
|
|
3307
4808
|
/**
|
|
3308
|
-
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
4809
|
+
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
4810
|
+
*/
|
|
4811
|
+
tax_rates?: Emptyable<Array<string>>;
|
|
4812
|
+
/**
|
|
4813
|
+
* Options that configure the trial on the subscription item.
|
|
4814
|
+
*/
|
|
4815
|
+
trial?: Item.Trial;
|
|
4816
|
+
/**
|
|
4817
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4818
|
+
*/
|
|
4819
|
+
trial_offer?: string;
|
|
4820
|
+
}
|
|
4821
|
+
interface PauseCollection {
|
|
4822
|
+
/**
|
|
4823
|
+
* The payment collection behavior for this subscription while paused.
|
|
3309
4824
|
*/
|
|
3310
|
-
|
|
4825
|
+
behavior: PauseCollection.Behavior;
|
|
3311
4826
|
}
|
|
3312
4827
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3313
4828
|
interface TransferData {
|
|
@@ -3320,6 +4835,13 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3320
4835
|
*/
|
|
3321
4836
|
destination: string;
|
|
3322
4837
|
}
|
|
4838
|
+
type TrialContinuation = 'continue' | 'none';
|
|
4839
|
+
interface TrialSettings {
|
|
4840
|
+
/**
|
|
4841
|
+
* Defines how the subscription should behave when a trial ends.
|
|
4842
|
+
*/
|
|
4843
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
4844
|
+
}
|
|
3323
4845
|
namespace AddInvoiceItem {
|
|
3324
4846
|
interface Discount {
|
|
3325
4847
|
/**
|
|
@@ -3330,6 +4852,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3330
4852
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3331
4853
|
*/
|
|
3332
4854
|
discount?: string;
|
|
4855
|
+
/**
|
|
4856
|
+
* Details to determine how long the discount should be applied for.
|
|
4857
|
+
*/
|
|
4858
|
+
discount_end?: Discount.DiscountEnd;
|
|
3333
4859
|
/**
|
|
3334
4860
|
* ID of the promotion code to create a new discount for.
|
|
3335
4861
|
*/
|
|
@@ -3367,6 +4893,38 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3367
4893
|
*/
|
|
3368
4894
|
unit_amount_decimal?: Decimal;
|
|
3369
4895
|
}
|
|
4896
|
+
namespace Discount {
|
|
4897
|
+
interface DiscountEnd {
|
|
4898
|
+
/**
|
|
4899
|
+
* Time span for the redeemed discount.
|
|
4900
|
+
*/
|
|
4901
|
+
duration?: DiscountEnd.Duration;
|
|
4902
|
+
/**
|
|
4903
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4904
|
+
*/
|
|
4905
|
+
timestamp?: number;
|
|
4906
|
+
/**
|
|
4907
|
+
* The type of calculation made to determine when the discount ends.
|
|
4908
|
+
*/
|
|
4909
|
+
type: DiscountEnd.Type;
|
|
4910
|
+
}
|
|
4911
|
+
namespace DiscountEnd {
|
|
4912
|
+
interface Duration {
|
|
4913
|
+
/**
|
|
4914
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4915
|
+
*/
|
|
4916
|
+
interval: Duration.Interval;
|
|
4917
|
+
/**
|
|
4918
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4919
|
+
*/
|
|
4920
|
+
interval_count: number;
|
|
4921
|
+
}
|
|
4922
|
+
type Type = 'duration' | 'timestamp';
|
|
4923
|
+
namespace Duration {
|
|
4924
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4925
|
+
}
|
|
4926
|
+
}
|
|
4927
|
+
}
|
|
3370
4928
|
namespace Period {
|
|
3371
4929
|
interface End {
|
|
3372
4930
|
/**
|
|
@@ -3411,7 +4969,87 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3411
4969
|
type: Liability.Type;
|
|
3412
4970
|
}
|
|
3413
4971
|
namespace Liability {
|
|
3414
|
-
type Type = 'account' | 'self';
|
|
4972
|
+
type Type = 'account' | 'application' | 'self';
|
|
4973
|
+
}
|
|
4974
|
+
}
|
|
4975
|
+
namespace Discount {
|
|
4976
|
+
interface DiscountEnd {
|
|
4977
|
+
/**
|
|
4978
|
+
* Time span for the redeemed discount.
|
|
4979
|
+
*/
|
|
4980
|
+
duration?: DiscountEnd.Duration;
|
|
4981
|
+
/**
|
|
4982
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4983
|
+
*/
|
|
4984
|
+
timestamp?: number;
|
|
4985
|
+
/**
|
|
4986
|
+
* The type of calculation made to determine when the discount ends.
|
|
4987
|
+
*/
|
|
4988
|
+
type: DiscountEnd.Type;
|
|
4989
|
+
}
|
|
4990
|
+
interface Settings {
|
|
4991
|
+
/**
|
|
4992
|
+
* Configures service period cycle anchoring.
|
|
4993
|
+
*/
|
|
4994
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4995
|
+
/**
|
|
4996
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
4997
|
+
*/
|
|
4998
|
+
start_date?: Settings.StartDate;
|
|
4999
|
+
}
|
|
5000
|
+
namespace DiscountEnd {
|
|
5001
|
+
interface Duration {
|
|
5002
|
+
/**
|
|
5003
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5004
|
+
*/
|
|
5005
|
+
interval: Duration.Interval;
|
|
5006
|
+
/**
|
|
5007
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5008
|
+
*/
|
|
5009
|
+
interval_count: number;
|
|
5010
|
+
}
|
|
5011
|
+
type Type = 'duration' | 'timestamp';
|
|
5012
|
+
namespace Duration {
|
|
5013
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5014
|
+
}
|
|
5015
|
+
}
|
|
5016
|
+
namespace Settings {
|
|
5017
|
+
interface ServicePeriodAnchorConfig {
|
|
5018
|
+
/**
|
|
5019
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5020
|
+
*/
|
|
5021
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5022
|
+
/**
|
|
5023
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
5024
|
+
*/
|
|
5025
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5026
|
+
}
|
|
5027
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
5028
|
+
namespace ServicePeriodAnchorConfig {
|
|
5029
|
+
interface Custom {
|
|
5030
|
+
/**
|
|
5031
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5032
|
+
*/
|
|
5033
|
+
day_of_month: number;
|
|
5034
|
+
/**
|
|
5035
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5036
|
+
*/
|
|
5037
|
+
hour?: number;
|
|
5038
|
+
/**
|
|
5039
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5040
|
+
*/
|
|
5041
|
+
minute?: number;
|
|
5042
|
+
/**
|
|
5043
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5044
|
+
*/
|
|
5045
|
+
month?: number;
|
|
5046
|
+
/**
|
|
5047
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5048
|
+
*/
|
|
5049
|
+
second?: number;
|
|
5050
|
+
}
|
|
5051
|
+
type Type = 'custom' | 'inherit';
|
|
5052
|
+
}
|
|
3415
5053
|
}
|
|
3416
5054
|
}
|
|
3417
5055
|
namespace Duration {
|
|
@@ -3429,7 +5067,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3429
5067
|
type: Issuer.Type;
|
|
3430
5068
|
}
|
|
3431
5069
|
namespace Issuer {
|
|
3432
|
-
type Type = 'account' | 'self';
|
|
5070
|
+
type Type = 'account' | 'application' | 'self';
|
|
3433
5071
|
}
|
|
3434
5072
|
}
|
|
3435
5073
|
namespace Item {
|
|
@@ -3448,10 +5086,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3448
5086
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3449
5087
|
*/
|
|
3450
5088
|
discount?: string;
|
|
5089
|
+
/**
|
|
5090
|
+
* Details to determine how long the discount should be applied for.
|
|
5091
|
+
*/
|
|
5092
|
+
discount_end?: Discount.DiscountEnd;
|
|
3451
5093
|
/**
|
|
3452
5094
|
* ID of the promotion code to create a new discount for.
|
|
3453
5095
|
*/
|
|
3454
5096
|
promotion_code?: string;
|
|
5097
|
+
/**
|
|
5098
|
+
* Settings for discount application including service period anchoring.
|
|
5099
|
+
*/
|
|
5100
|
+
settings?: Discount.Settings;
|
|
3455
5101
|
}
|
|
3456
5102
|
interface PriceData {
|
|
3457
5103
|
/**
|
|
@@ -3479,6 +5125,96 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3479
5125
|
*/
|
|
3480
5126
|
unit_amount_decimal?: Decimal;
|
|
3481
5127
|
}
|
|
5128
|
+
interface Trial {
|
|
5129
|
+
/**
|
|
5130
|
+
* 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.
|
|
5131
|
+
*/
|
|
5132
|
+
converts_to?: Array<string>;
|
|
5133
|
+
/**
|
|
5134
|
+
* Determines the type of trial for this item.
|
|
5135
|
+
*/
|
|
5136
|
+
type: Trial.Type;
|
|
5137
|
+
}
|
|
5138
|
+
namespace Discount {
|
|
5139
|
+
interface DiscountEnd {
|
|
5140
|
+
/**
|
|
5141
|
+
* Time span for the redeemed discount.
|
|
5142
|
+
*/
|
|
5143
|
+
duration?: DiscountEnd.Duration;
|
|
5144
|
+
/**
|
|
5145
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5146
|
+
*/
|
|
5147
|
+
timestamp?: number;
|
|
5148
|
+
/**
|
|
5149
|
+
* The type of calculation made to determine when the discount ends.
|
|
5150
|
+
*/
|
|
5151
|
+
type: DiscountEnd.Type;
|
|
5152
|
+
}
|
|
5153
|
+
interface Settings {
|
|
5154
|
+
/**
|
|
5155
|
+
* Configures service period cycle anchoring.
|
|
5156
|
+
*/
|
|
5157
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
5158
|
+
/**
|
|
5159
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
5160
|
+
*/
|
|
5161
|
+
start_date?: Settings.StartDate;
|
|
5162
|
+
}
|
|
5163
|
+
namespace DiscountEnd {
|
|
5164
|
+
interface Duration {
|
|
5165
|
+
/**
|
|
5166
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5167
|
+
*/
|
|
5168
|
+
interval: Duration.Interval;
|
|
5169
|
+
/**
|
|
5170
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5171
|
+
*/
|
|
5172
|
+
interval_count: number;
|
|
5173
|
+
}
|
|
5174
|
+
type Type = 'duration' | 'timestamp';
|
|
5175
|
+
namespace Duration {
|
|
5176
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5177
|
+
}
|
|
5178
|
+
}
|
|
5179
|
+
namespace Settings {
|
|
5180
|
+
interface ServicePeriodAnchorConfig {
|
|
5181
|
+
/**
|
|
5182
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5183
|
+
*/
|
|
5184
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5185
|
+
/**
|
|
5186
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
5187
|
+
*/
|
|
5188
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5189
|
+
}
|
|
5190
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
5191
|
+
namespace ServicePeriodAnchorConfig {
|
|
5192
|
+
interface Custom {
|
|
5193
|
+
/**
|
|
5194
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5195
|
+
*/
|
|
5196
|
+
day_of_month: number;
|
|
5197
|
+
/**
|
|
5198
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5199
|
+
*/
|
|
5200
|
+
hour?: number;
|
|
5201
|
+
/**
|
|
5202
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5203
|
+
*/
|
|
5204
|
+
minute?: number;
|
|
5205
|
+
/**
|
|
5206
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5207
|
+
*/
|
|
5208
|
+
month?: number;
|
|
5209
|
+
/**
|
|
5210
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5211
|
+
*/
|
|
5212
|
+
second?: number;
|
|
5213
|
+
}
|
|
5214
|
+
type Type = 'custom' | 'inherit';
|
|
5215
|
+
}
|
|
5216
|
+
}
|
|
5217
|
+
}
|
|
3482
5218
|
namespace PriceData {
|
|
3483
5219
|
interface Recurring {
|
|
3484
5220
|
/**
|
|
@@ -3495,6 +5231,65 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3495
5231
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3496
5232
|
}
|
|
3497
5233
|
}
|
|
5234
|
+
namespace Trial {
|
|
5235
|
+
type Type = 'free' | 'paid';
|
|
5236
|
+
}
|
|
5237
|
+
}
|
|
5238
|
+
namespace PauseCollection {
|
|
5239
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
5240
|
+
}
|
|
5241
|
+
namespace TrialSettings {
|
|
5242
|
+
interface EndBehavior {
|
|
5243
|
+
/**
|
|
5244
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
5245
|
+
*/
|
|
5246
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
5247
|
+
}
|
|
5248
|
+
namespace EndBehavior {
|
|
5249
|
+
type ProrateUpFront = 'defer' | 'include';
|
|
5250
|
+
}
|
|
5251
|
+
}
|
|
5252
|
+
}
|
|
5253
|
+
namespace Prebilling {
|
|
5254
|
+
interface BillUntil {
|
|
5255
|
+
/**
|
|
5256
|
+
* End the prebilled period when a specified amendment ends.
|
|
5257
|
+
*/
|
|
5258
|
+
amendment_end?: BillUntil.AmendmentEnd;
|
|
5259
|
+
/**
|
|
5260
|
+
* Time span for prebilling, starting from `bill_from`.
|
|
5261
|
+
*/
|
|
5262
|
+
duration?: BillUntil.Duration;
|
|
5263
|
+
/**
|
|
5264
|
+
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
5265
|
+
*/
|
|
5266
|
+
timestamp?: number;
|
|
5267
|
+
/**
|
|
5268
|
+
* Select one of several ways to pass the `bill_until` value.
|
|
5269
|
+
*/
|
|
5270
|
+
type: BillUntil.Type;
|
|
5271
|
+
}
|
|
5272
|
+
namespace BillUntil {
|
|
5273
|
+
interface AmendmentEnd {
|
|
5274
|
+
/**
|
|
5275
|
+
* The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
5276
|
+
*/
|
|
5277
|
+
index: number;
|
|
5278
|
+
}
|
|
5279
|
+
interface Duration {
|
|
5280
|
+
/**
|
|
5281
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5282
|
+
*/
|
|
5283
|
+
interval: Duration.Interval;
|
|
5284
|
+
/**
|
|
5285
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5286
|
+
*/
|
|
5287
|
+
interval_count: number;
|
|
5288
|
+
}
|
|
5289
|
+
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
5290
|
+
namespace Duration {
|
|
5291
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5292
|
+
}
|
|
3498
5293
|
}
|
|
3499
5294
|
}
|
|
3500
5295
|
}
|
|
@@ -3534,6 +5329,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3534
5329
|
* Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
|
3535
5330
|
*/
|
|
3536
5331
|
clear_usage?: boolean;
|
|
5332
|
+
/**
|
|
5333
|
+
* The trial offer to apply to this subscription item.
|
|
5334
|
+
*/
|
|
5335
|
+
current_trial?: Item.CurrentTrial;
|
|
3537
5336
|
/**
|
|
3538
5337
|
* A flag that, if set to `true`, will delete the specified item.
|
|
3539
5338
|
*/
|
|
@@ -3571,6 +5370,26 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3571
5370
|
*/
|
|
3572
5371
|
tax_rates?: Emptyable<Array<string>>;
|
|
3573
5372
|
}
|
|
5373
|
+
interface Pause {
|
|
5374
|
+
/**
|
|
5375
|
+
* Controls what to bill for when pausing the subscription.
|
|
5376
|
+
*/
|
|
5377
|
+
bill_for?: Pause.BillFor;
|
|
5378
|
+
/**
|
|
5379
|
+
* Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.
|
|
5380
|
+
*/
|
|
5381
|
+
invoicing_behavior?: Pause.InvoicingBehavior;
|
|
5382
|
+
/**
|
|
5383
|
+
* The type of pause to apply. Defaults to `subscription`.
|
|
5384
|
+
*/
|
|
5385
|
+
type?: 'subscription';
|
|
5386
|
+
}
|
|
5387
|
+
interface Prebilling {
|
|
5388
|
+
/**
|
|
5389
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
5390
|
+
*/
|
|
5391
|
+
iterations: number;
|
|
5392
|
+
}
|
|
3574
5393
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3575
5394
|
namespace BillingMode {
|
|
3576
5395
|
interface Flexible {
|
|
@@ -3633,6 +5452,16 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3633
5452
|
*/
|
|
3634
5453
|
usage_gte: number;
|
|
3635
5454
|
}
|
|
5455
|
+
interface CurrentTrial {
|
|
5456
|
+
/**
|
|
5457
|
+
* Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
|
|
5458
|
+
*/
|
|
5459
|
+
trial_end?: number;
|
|
5460
|
+
/**
|
|
5461
|
+
* The ID of the trial offer to apply to the subscription item.
|
|
5462
|
+
*/
|
|
5463
|
+
trial_offer: string;
|
|
5464
|
+
}
|
|
3636
5465
|
interface Discount {
|
|
3637
5466
|
/**
|
|
3638
5467
|
* ID of the coupon to create a new discount for.
|
|
@@ -3642,10 +5471,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3642
5471
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3643
5472
|
*/
|
|
3644
5473
|
discount?: string;
|
|
5474
|
+
/**
|
|
5475
|
+
* Details to determine how long the discount should be applied for.
|
|
5476
|
+
*/
|
|
5477
|
+
discount_end?: Discount.DiscountEnd;
|
|
3645
5478
|
/**
|
|
3646
5479
|
* ID of the promotion code to create a new discount for.
|
|
3647
5480
|
*/
|
|
3648
5481
|
promotion_code?: string;
|
|
5482
|
+
/**
|
|
5483
|
+
* Settings for discount application including service period anchoring.
|
|
5484
|
+
*/
|
|
5485
|
+
settings?: Discount.Settings;
|
|
3649
5486
|
}
|
|
3650
5487
|
interface PriceData {
|
|
3651
5488
|
/**
|
|
@@ -3673,6 +5510,86 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3673
5510
|
*/
|
|
3674
5511
|
unit_amount_decimal?: Decimal;
|
|
3675
5512
|
}
|
|
5513
|
+
namespace Discount {
|
|
5514
|
+
interface DiscountEnd {
|
|
5515
|
+
/**
|
|
5516
|
+
* Time span for the redeemed discount.
|
|
5517
|
+
*/
|
|
5518
|
+
duration?: DiscountEnd.Duration;
|
|
5519
|
+
/**
|
|
5520
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5521
|
+
*/
|
|
5522
|
+
timestamp?: number;
|
|
5523
|
+
/**
|
|
5524
|
+
* The type of calculation made to determine when the discount ends.
|
|
5525
|
+
*/
|
|
5526
|
+
type: DiscountEnd.Type;
|
|
5527
|
+
}
|
|
5528
|
+
interface Settings {
|
|
5529
|
+
/**
|
|
5530
|
+
* Configures service period cycle anchoring.
|
|
5531
|
+
*/
|
|
5532
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
5533
|
+
/**
|
|
5534
|
+
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
|
|
5535
|
+
*/
|
|
5536
|
+
start_date?: Settings.StartDate;
|
|
5537
|
+
}
|
|
5538
|
+
namespace DiscountEnd {
|
|
5539
|
+
interface Duration {
|
|
5540
|
+
/**
|
|
5541
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5542
|
+
*/
|
|
5543
|
+
interval: Duration.Interval;
|
|
5544
|
+
/**
|
|
5545
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5546
|
+
*/
|
|
5547
|
+
interval_count: number;
|
|
5548
|
+
}
|
|
5549
|
+
type Type = 'duration' | 'timestamp';
|
|
5550
|
+
namespace Duration {
|
|
5551
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5552
|
+
}
|
|
5553
|
+
}
|
|
5554
|
+
namespace Settings {
|
|
5555
|
+
interface ServicePeriodAnchorConfig {
|
|
5556
|
+
/**
|
|
5557
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5558
|
+
*/
|
|
5559
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5560
|
+
/**
|
|
5561
|
+
* The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
|
|
5562
|
+
*/
|
|
5563
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5564
|
+
}
|
|
5565
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'now';
|
|
5566
|
+
namespace ServicePeriodAnchorConfig {
|
|
5567
|
+
interface Custom {
|
|
5568
|
+
/**
|
|
5569
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5570
|
+
*/
|
|
5571
|
+
day_of_month: number;
|
|
5572
|
+
/**
|
|
5573
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5574
|
+
*/
|
|
5575
|
+
hour?: number;
|
|
5576
|
+
/**
|
|
5577
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5578
|
+
*/
|
|
5579
|
+
minute?: number;
|
|
5580
|
+
/**
|
|
5581
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5582
|
+
*/
|
|
5583
|
+
month?: number;
|
|
5584
|
+
/**
|
|
5585
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5586
|
+
*/
|
|
5587
|
+
second?: number;
|
|
5588
|
+
}
|
|
5589
|
+
type Type = 'custom' | 'subscription_service_cycle_anchor';
|
|
5590
|
+
}
|
|
5591
|
+
}
|
|
5592
|
+
}
|
|
3676
5593
|
namespace PriceData {
|
|
3677
5594
|
interface Recurring {
|
|
3678
5595
|
/**
|
|
@@ -3690,8 +5607,51 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3690
5607
|
}
|
|
3691
5608
|
}
|
|
3692
5609
|
}
|
|
5610
|
+
namespace Pause {
|
|
5611
|
+
interface BillFor {
|
|
5612
|
+
/**
|
|
5613
|
+
* Controls when to bill for metered usage in the current period. Defaults to `{ type: "now" }`.
|
|
5614
|
+
*/
|
|
5615
|
+
outstanding_usage_through?: BillFor.OutstandingUsageThrough;
|
|
5616
|
+
/**
|
|
5617
|
+
* Controls when to credit for unused time on licensed items. Defaults to `{ type: "now" }`.
|
|
5618
|
+
*/
|
|
5619
|
+
unused_time_from?: BillFor.UnusedTimeFrom;
|
|
5620
|
+
}
|
|
5621
|
+
type InvoicingBehavior = 'invoice' | 'pending_invoice_item';
|
|
5622
|
+
namespace BillFor {
|
|
5623
|
+
interface OutstandingUsageThrough {
|
|
5624
|
+
/**
|
|
5625
|
+
* When to bill metered usage in the current period.
|
|
5626
|
+
*/
|
|
5627
|
+
type: OutstandingUsageThrough.Type;
|
|
5628
|
+
}
|
|
5629
|
+
interface UnusedTimeFrom {
|
|
5630
|
+
/**
|
|
5631
|
+
* When to credit for unused time.
|
|
5632
|
+
*/
|
|
5633
|
+
type: UnusedTimeFrom.Type;
|
|
5634
|
+
}
|
|
5635
|
+
namespace OutstandingUsageThrough {
|
|
5636
|
+
type Type = 'none' | 'now';
|
|
5637
|
+
}
|
|
5638
|
+
namespace UnusedTimeFrom {
|
|
5639
|
+
type Type = 'item_current_period_start' | 'none' | 'now';
|
|
5640
|
+
}
|
|
5641
|
+
}
|
|
5642
|
+
}
|
|
3693
5643
|
}
|
|
3694
5644
|
}
|
|
5645
|
+
export interface InvoiceDetachPaymentParams {
|
|
5646
|
+
/**
|
|
5647
|
+
* Specifies which fields in the response should be expanded.
|
|
5648
|
+
*/
|
|
5649
|
+
expand?: Array<string>;
|
|
5650
|
+
/**
|
|
5651
|
+
* The ID of the PaymentIntent to detach from the invoice.
|
|
5652
|
+
*/
|
|
5653
|
+
payment_intent?: string;
|
|
5654
|
+
}
|
|
3695
5655
|
export interface InvoiceFinalizeInvoiceParams {
|
|
3696
5656
|
/**
|
|
3697
5657
|
* Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
|
|
@@ -3801,6 +5761,32 @@ export interface InvoiceSendInvoiceParams {
|
|
|
3801
5761
|
*/
|
|
3802
5762
|
expand?: Array<string>;
|
|
3803
5763
|
}
|
|
5764
|
+
export interface InvoiceSerializeBatchAddLinesParams {
|
|
5765
|
+
}
|
|
5766
|
+
export interface InvoiceSerializeBatchCreateParams {
|
|
5767
|
+
}
|
|
5768
|
+
export interface InvoiceSerializeBatchCreatePreviewParams {
|
|
5769
|
+
}
|
|
5770
|
+
export interface InvoiceSerializeBatchDeleteParams {
|
|
5771
|
+
}
|
|
5772
|
+
export interface InvoiceSerializeBatchFinalizeInvoiceParams {
|
|
5773
|
+
}
|
|
5774
|
+
export interface InvoiceSerializeBatchMarkUncollectibleParams {
|
|
5775
|
+
}
|
|
5776
|
+
export interface InvoiceSerializeBatchPayParams {
|
|
5777
|
+
}
|
|
5778
|
+
export interface InvoiceSerializeBatchRemoveLinesParams {
|
|
5779
|
+
}
|
|
5780
|
+
export interface InvoiceSerializeBatchSendInvoiceParams {
|
|
5781
|
+
}
|
|
5782
|
+
export interface InvoiceSerializeBatchUpdateParams {
|
|
5783
|
+
}
|
|
5784
|
+
export interface InvoiceSerializeBatchUpdateLineItemParams {
|
|
5785
|
+
}
|
|
5786
|
+
export interface InvoiceSerializeBatchUpdateLinesParams {
|
|
5787
|
+
}
|
|
5788
|
+
export interface InvoiceSerializeBatchVoidInvoiceParams {
|
|
5789
|
+
}
|
|
3804
5790
|
export interface InvoiceUpdateLinesParams {
|
|
3805
5791
|
/**
|
|
3806
5792
|
* The line items to update.
|
|
@@ -3839,6 +5825,10 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3839
5825
|
* ID of an existing line item on the invoice.
|
|
3840
5826
|
*/
|
|
3841
5827
|
id: string;
|
|
5828
|
+
/**
|
|
5829
|
+
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
5830
|
+
*/
|
|
5831
|
+
margins?: Emptyable<Array<string>>;
|
|
3842
5832
|
/**
|
|
3843
5833
|
* 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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
3844
5834
|
*/
|
|
@@ -3882,6 +5872,10 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3882
5872
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3883
5873
|
*/
|
|
3884
5874
|
discount?: string;
|
|
5875
|
+
/**
|
|
5876
|
+
* Details to determine how long the discount should be applied for.
|
|
5877
|
+
*/
|
|
5878
|
+
discount_end?: Discount.DiscountEnd;
|
|
3885
5879
|
/**
|
|
3886
5880
|
* ID of the promotion code to create a new discount for.
|
|
3887
5881
|
*/
|
|
@@ -3949,6 +5943,38 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3949
5943
|
*/
|
|
3950
5944
|
taxable_amount: number;
|
|
3951
5945
|
}
|
|
5946
|
+
namespace Discount {
|
|
5947
|
+
interface DiscountEnd {
|
|
5948
|
+
/**
|
|
5949
|
+
* Time span for the redeemed discount.
|
|
5950
|
+
*/
|
|
5951
|
+
duration?: DiscountEnd.Duration;
|
|
5952
|
+
/**
|
|
5953
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5954
|
+
*/
|
|
5955
|
+
timestamp?: number;
|
|
5956
|
+
/**
|
|
5957
|
+
* The type of calculation made to determine when the discount ends.
|
|
5958
|
+
*/
|
|
5959
|
+
type: DiscountEnd.Type;
|
|
5960
|
+
}
|
|
5961
|
+
namespace DiscountEnd {
|
|
5962
|
+
interface Duration {
|
|
5963
|
+
/**
|
|
5964
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5965
|
+
*/
|
|
5966
|
+
interval: Duration.Interval;
|
|
5967
|
+
/**
|
|
5968
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5969
|
+
*/
|
|
5970
|
+
interval_count: number;
|
|
5971
|
+
}
|
|
5972
|
+
type Type = 'duration' | 'timestamp';
|
|
5973
|
+
namespace Duration {
|
|
5974
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5975
|
+
}
|
|
5976
|
+
}
|
|
5977
|
+
}
|
|
3952
5978
|
namespace PriceData {
|
|
3953
5979
|
interface ProductData {
|
|
3954
5980
|
/**
|
|
@@ -3971,12 +5997,28 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3971
5997
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3972
5998
|
*/
|
|
3973
5999
|
tax_code?: string;
|
|
6000
|
+
/**
|
|
6001
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
6002
|
+
*/
|
|
6003
|
+
tax_details?: ProductData.TaxDetails;
|
|
3974
6004
|
/**
|
|
3975
6005
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
3976
6006
|
*/
|
|
3977
6007
|
unit_label?: string;
|
|
3978
6008
|
}
|
|
3979
6009
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
6010
|
+
namespace ProductData {
|
|
6011
|
+
interface TaxDetails {
|
|
6012
|
+
/**
|
|
6013
|
+
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
6014
|
+
*/
|
|
6015
|
+
performance_location?: string;
|
|
6016
|
+
/**
|
|
6017
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
6018
|
+
*/
|
|
6019
|
+
tax_code?: Emptyable<string>;
|
|
6020
|
+
}
|
|
6021
|
+
}
|
|
3980
6022
|
}
|
|
3981
6023
|
namespace TaxAmount {
|
|
3982
6024
|
interface TaxRateData {
|
|
@@ -4046,6 +6088,10 @@ export interface InvoiceUpdateLineItemParams {
|
|
|
4046
6088
|
* Specifies which fields in the response should be expanded.
|
|
4047
6089
|
*/
|
|
4048
6090
|
expand?: Array<string>;
|
|
6091
|
+
/**
|
|
6092
|
+
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
6093
|
+
*/
|
|
6094
|
+
margins?: Emptyable<Array<string>>;
|
|
4049
6095
|
/**
|
|
4050
6096
|
* 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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](https://docs.stripe.com/api/invoices/line_item) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
4051
6097
|
*/
|
|
@@ -4089,6 +6135,10 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4089
6135
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4090
6136
|
*/
|
|
4091
6137
|
discount?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* Details to determine how long the discount should be applied for.
|
|
6140
|
+
*/
|
|
6141
|
+
discount_end?: Discount.DiscountEnd;
|
|
4092
6142
|
/**
|
|
4093
6143
|
* ID of the promotion code to create a new discount for.
|
|
4094
6144
|
*/
|
|
@@ -4156,6 +6206,38 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4156
6206
|
*/
|
|
4157
6207
|
taxable_amount: number;
|
|
4158
6208
|
}
|
|
6209
|
+
namespace Discount {
|
|
6210
|
+
interface DiscountEnd {
|
|
6211
|
+
/**
|
|
6212
|
+
* Time span for the redeemed discount.
|
|
6213
|
+
*/
|
|
6214
|
+
duration?: DiscountEnd.Duration;
|
|
6215
|
+
/**
|
|
6216
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
6217
|
+
*/
|
|
6218
|
+
timestamp?: number;
|
|
6219
|
+
/**
|
|
6220
|
+
* The type of calculation made to determine when the discount ends.
|
|
6221
|
+
*/
|
|
6222
|
+
type: DiscountEnd.Type;
|
|
6223
|
+
}
|
|
6224
|
+
namespace DiscountEnd {
|
|
6225
|
+
interface Duration {
|
|
6226
|
+
/**
|
|
6227
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
6228
|
+
*/
|
|
6229
|
+
interval: Duration.Interval;
|
|
6230
|
+
/**
|
|
6231
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
6232
|
+
*/
|
|
6233
|
+
interval_count: number;
|
|
6234
|
+
}
|
|
6235
|
+
type Type = 'duration' | 'timestamp';
|
|
6236
|
+
namespace Duration {
|
|
6237
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
6238
|
+
}
|
|
6239
|
+
}
|
|
6240
|
+
}
|
|
4159
6241
|
namespace PriceData {
|
|
4160
6242
|
interface ProductData {
|
|
4161
6243
|
/**
|
|
@@ -4178,12 +6260,28 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4178
6260
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
4179
6261
|
*/
|
|
4180
6262
|
tax_code?: string;
|
|
6263
|
+
/**
|
|
6264
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
6265
|
+
*/
|
|
6266
|
+
tax_details?: ProductData.TaxDetails;
|
|
4181
6267
|
/**
|
|
4182
6268
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
4183
6269
|
*/
|
|
4184
6270
|
unit_label?: string;
|
|
4185
6271
|
}
|
|
4186
6272
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
6273
|
+
namespace ProductData {
|
|
6274
|
+
interface TaxDetails {
|
|
6275
|
+
/**
|
|
6276
|
+
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
6277
|
+
*/
|
|
6278
|
+
performance_location?: string;
|
|
6279
|
+
/**
|
|
6280
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
6281
|
+
*/
|
|
6282
|
+
tax_code?: Emptyable<string>;
|
|
6283
|
+
}
|
|
6284
|
+
}
|
|
4187
6285
|
}
|
|
4188
6286
|
namespace TaxAmount {
|
|
4189
6287
|
interface TaxRateData {
|