stripe 22.4.0 → 22.5.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3171 -13
- package/OPENAPI_VERSION +1 -1
- package/README.md +44 -60
- package/VERSION +1 -1
- package/cjs/Error.d.ts +58 -0
- package/cjs/Error.js +135 -1
- package/cjs/Error.js.map +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +19 -0
- package/cjs/StripeEventNotificationHandler.js +491 -0
- package/cjs/StripeEventNotificationHandler.js.map +1 -0
- package/cjs/Types.d.ts +9 -2
- package/cjs/Types.js.map +1 -1
- package/cjs/apiVersion.d.ts +2 -2
- package/cjs/apiVersion.js +2 -2
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +5 -1
- package/cjs/resources/AccountNotices.d.ts +140 -0
- package/cjs/resources/AccountNotices.js +29 -0
- package/cjs/resources/AccountNotices.js.map +1 -0
- package/cjs/resources/AccountSessions.d.ts +564 -0
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/AccountSignals.d.ts +111 -0
- package/cjs/resources/AccountSignals.js +4 -0
- package/cjs/resources/AccountSignals.js.map +1 -0
- package/cjs/resources/Accounts.d.ts +1037 -6
- package/cjs/resources/Accounts.js +47 -0
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplicationFees.d.ts +28 -1
- package/cjs/resources/Balance.d.ts +134 -0
- package/cjs/resources/BalanceSettings.d.ts +18 -0
- package/cjs/resources/BalanceTransactions.d.ts +1 -1
- package/cjs/resources/BalanceTransfers.d.ts +160 -0
- package/cjs/resources/BalanceTransfers.js +15 -0
- package/cjs/resources/BalanceTransfers.js.map +1 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertNotifications.d.ts +75 -0
- package/cjs/resources/Billing/AlertNotifications.js +4 -0
- package/cjs/resources/Billing/AlertNotifications.js.map +1 -0
- package/cjs/resources/Billing/AlertRecovereds.d.ts +56 -0
- package/cjs/resources/Billing/AlertRecovereds.js +4 -0
- package/cjs/resources/Billing/AlertRecovereds.js.map +1 -0
- package/cjs/resources/Billing/AlertTriggereds.d.ts +55 -1
- package/cjs/resources/Billing/Alerts.d.ts +448 -5
- package/cjs/resources/Billing/Alerts.js +329 -5
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
- package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
- package/cjs/resources/Billing/Analytics/index.js +13 -0
- package/cjs/resources/Billing/Analytics/index.js.map +1 -0
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +136 -3
- package/cjs/resources/Billing/CreditBalanceSummary.js +39 -1
- package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/cjs/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/cjs/resources/Billing/CreditGrants.d.ts +105 -3
- package/cjs/resources/Billing/CreditGrants.js +134 -5
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/FeedbackOptions.d.ts +32 -0
- package/cjs/resources/Billing/FeedbackOptions.js +4 -0
- package/cjs/resources/Billing/FeedbackOptions.js.map +1 -0
- package/cjs/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/cjs/resources/Billing/Meters.d.ts +31 -0
- package/cjs/resources/Billing/index.d.ts +13 -0
- package/cjs/resources/Billing/index.js +2 -0
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/BillingPortal/Configurations.d.ts +5 -0
- package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
- package/cjs/resources/Capabilities.d.ts +25 -2
- package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
- package/cjs/resources/Capital/FinancingOffers.js +30 -0
- package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/Capital/FinancingSummary.d.ts +102 -0
- package/cjs/resources/Capital/FinancingSummary.js +15 -0
- package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
- package/cjs/resources/Capital/FinancingTransactions.d.ts +141 -0
- package/cjs/resources/Capital/FinancingTransactions.js +24 -0
- package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
- package/cjs/resources/Capital/index.d.ts +25 -0
- package/cjs/resources/Capital/index.js +17 -0
- package/cjs/resources/Capital/index.js.map +1 -0
- package/cjs/resources/Cards.d.ts +28 -0
- package/cjs/resources/Charges.d.ts +3367 -70
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1193 -12
- package/cjs/resources/Checkout/Sessions.js +115 -0
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -0
- package/cjs/resources/ConfirmationTokens.d.ts +146 -1
- package/cjs/resources/ConfirmationTokens.js.map +1 -1
- package/cjs/resources/Coupons.d.ts +128 -2
- package/cjs/resources/Coupons.js +41 -0
- package/cjs/resources/Coupons.js.map +1 -1
- package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
- package/cjs/resources/CreditNotes.d.ts +7 -1
- package/cjs/resources/CreditNotes.js +13 -0
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/Crypto/CustomerConsumerWallets.d.ts +30 -0
- package/cjs/resources/Crypto/CustomerConsumerWallets.js +4 -0
- package/cjs/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.d.ts +80 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.js +4 -0
- package/cjs/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
- package/cjs/resources/Crypto/Customers.d.ts +111 -0
- package/cjs/resources/Crypto/Customers.js +31 -0
- package/cjs/resources/Crypto/Customers.js.map +1 -0
- package/cjs/resources/Crypto/DepositAddresses.d.ts +128 -0
- package/cjs/resources/Crypto/DepositAddresses.js +31 -0
- package/cjs/resources/Crypto/DepositAddresses.js.map +1 -0
- package/cjs/resources/Crypto/OnrampSessions.d.ts +421 -0
- package/cjs/resources/Crypto/OnrampSessions.js +47 -0
- package/cjs/resources/Crypto/OnrampSessions.js.map +1 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.d.ts +61 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.js +15 -0
- package/cjs/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
- package/cjs/resources/Crypto/index.d.ts +41 -0
- package/cjs/resources/Crypto/index.js +19 -0
- package/cjs/resources/Crypto/index.js.map +1 -0
- package/cjs/resources/CustomerSessions.d.ts +74 -0
- package/cjs/resources/CustomerSessions.js +13 -0
- package/cjs/resources/CustomerSessions.js.map +1 -1
- package/cjs/resources/Customers.d.ts +98 -1
- package/cjs/resources/Customers.js +195 -0
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/DelegatedCheckout/OrderEvents.d.ts +129 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js +4 -0
- package/cjs/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/Orders.d.ts +159 -0
- package/cjs/resources/DelegatedCheckout/Orders.js +15 -0
- package/cjs/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.d.ts +1420 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +47 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/cjs/resources/DelegatedCheckout/index.d.ts +25 -0
- package/cjs/resources/DelegatedCheckout/index.js +15 -0
- package/cjs/resources/DelegatedCheckout/index.js.map +1 -0
- package/cjs/resources/Discounts.d.ts +19 -0
- package/cjs/resources/Disputes.d.ts +43 -0
- package/cjs/resources/Disputes.js +14 -0
- package/cjs/resources/Disputes.js.map +1 -1
- package/cjs/resources/Events.d.ts +574 -3
- package/cjs/resources/ExternalAccounts.d.ts +212 -1
- package/cjs/resources/ExternalAccounts.js +44 -0
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
- package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/cjs/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/cjs/resources/FinancialConnections/Accounts.js +8 -0
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Authorizations.d.ts +46 -1
- package/cjs/resources/FinancialConnections/Authorizations.js +11 -0
- package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -1
- package/cjs/resources/FinancialConnections/Institutions.d.ts +99 -0
- package/cjs/resources/FinancialConnections/Institutions.js +23 -0
- package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
- package/cjs/resources/FinancialConnections/Sessions.d.ts +124 -9
- package/cjs/resources/FinancialConnections/index.d.ts +21 -9
- package/cjs/resources/FinancialConnections/index.js +4 -0
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/FxQuotes.d.ts +212 -0
- package/cjs/resources/FxQuotes.js +29 -0
- package/cjs/resources/FxQuotes.js.map +1 -0
- package/cjs/resources/GiftCardOperations.d.ts +249 -0
- package/cjs/resources/GiftCardOperations.js +15 -0
- package/cjs/resources/GiftCardOperations.js.map +1 -0
- package/cjs/resources/GiftCards.d.ts +181 -0
- package/cjs/resources/GiftCards.js +51 -0
- package/cjs/resources/GiftCards.js.map +1 -0
- package/cjs/resources/Identity/BlocklistEntries.d.ts +155 -0
- package/cjs/resources/Identity/BlocklistEntries.js +54 -0
- package/cjs/resources/Identity/BlocklistEntries.js.map +1 -0
- package/cjs/resources/Identity/VerificationReports.d.ts +33 -2
- package/cjs/resources/Identity/VerificationReports.js.map +1 -1
- package/cjs/resources/Identity/VerificationSessions.d.ts +11 -3
- package/cjs/resources/Identity/index.d.ts +18 -10
- package/cjs/resources/Identity/index.js +2 -0
- package/cjs/resources/Identity/index.js.map +1 -1
- package/cjs/resources/InvoiceItems.d.ts +204 -3
- package/cjs/resources/InvoiceItems.js +41 -0
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +174 -4
- package/cjs/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/cjs/resources/InvoiceRenderingTemplates.js +28 -0
- package/cjs/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/cjs/resources/Invoices.d.ts +2125 -21
- package/cjs/resources/Invoices.js +221 -0
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +524 -1
- package/cjs/resources/Issuing/Authorizations.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +22 -4
- package/cjs/resources/Issuing/Cards.d.ts +82 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +53 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/cjs/resources/Issuing/Disputes.d.ts +246 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/cjs/resources/Issuing/Programs.d.ts +95 -0
- package/cjs/resources/Issuing/Programs.js +35 -0
- package/cjs/resources/Issuing/Programs.js.map +1 -0
- package/cjs/resources/Issuing/Settlements.d.ts +83 -0
- package/cjs/resources/Issuing/Settlements.js +4 -0
- package/cjs/resources/Issuing/Settlements.js.map +1 -0
- package/cjs/resources/Issuing/Tokens.d.ts +26 -0
- package/cjs/resources/Issuing/Transactions.d.ts +233 -0
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +56 -22
- package/cjs/resources/Issuing/index.js +8 -0
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +29 -2
- package/cjs/resources/Mandates.d.ts +47 -2
- package/cjs/resources/Mandates.js +8 -0
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/Margins.d.ts +115 -0
- package/cjs/resources/Margins.js +35 -0
- package/cjs/resources/Margins.js.map +1 -0
- package/cjs/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js +15 -0
- package/cjs/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/cjs/resources/Orchestration/index.d.ts +12 -0
- package/cjs/resources/Orchestration/index.js +13 -0
- package/cjs/resources/Orchestration/index.js.map +1 -0
- package/cjs/resources/Orders.d.ts +4773 -0
- package/cjs/resources/Orders.js +457 -0
- package/cjs/resources/Orders.js.map +1 -0
- package/cjs/resources/PaymentAttemptRecords.d.ts +679 -2
- package/cjs/resources/PaymentAttemptRecords.js +48 -0
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
- package/cjs/resources/PaymentIntents.d.ts +16109 -2361
- package/cjs/resources/PaymentIntents.js +46 -0
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +77 -15
- package/cjs/resources/PaymentLocationCapabilities.d.ts +123 -0
- package/cjs/resources/PaymentLocationCapabilities.js +29 -0
- package/cjs/resources/PaymentLocationCapabilities.js.map +1 -0
- package/cjs/resources/PaymentLocations.d.ts +178 -0
- package/cjs/resources/PaymentLocations.js +41 -0
- package/cjs/resources/PaymentLocations.js.map +1 -0
- package/cjs/resources/PaymentMethodBalances.d.ts +46 -0
- package/cjs/resources/PaymentMethodBalances.js +4 -0
- package/cjs/resources/PaymentMethodBalances.js.map +1 -0
- package/cjs/resources/PaymentMethodConfigurations.d.ts +420 -0
- package/cjs/resources/PaymentMethods.d.ts +300 -3
- package/cjs/resources/PaymentMethods.js +20 -0
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +737 -20
- package/cjs/resources/PaymentRecords.js +18 -0
- package/cjs/resources/PaymentRecords.js.map +1 -1
- package/cjs/resources/Persons.d.ts +25 -2
- package/cjs/resources/Plans.d.ts +16 -0
- package/cjs/resources/Prices.d.ts +77 -1
- package/cjs/resources/Prices.js +27 -0
- package/cjs/resources/Prices.js.map +1 -1
- package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
- package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/cjs/resources/Privacy/RedactionJobs.d.ts +227 -0
- package/cjs/resources/Privacy/RedactionJobs.js +73 -0
- package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
- package/cjs/resources/Privacy/index.d.ts +22 -0
- package/cjs/resources/Privacy/index.js +13 -0
- package/cjs/resources/Privacy/index.js.map +1 -0
- package/cjs/resources/ProductCatalog/TrialOffers.d.ts +158 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js +29 -0
- package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/cjs/resources/ProductCatalog/index.d.ts +14 -0
- package/cjs/resources/ProductCatalog/index.js +13 -0
- package/cjs/resources/ProductCatalog/index.js.map +1 -0
- package/cjs/resources/Products.d.ts +199 -1
- package/cjs/resources/Products.js +69 -0
- package/cjs/resources/Products.js.map +1 -1
- package/cjs/resources/Profiles.d.ts +68 -0
- package/cjs/resources/Profiles.js +4 -0
- package/cjs/resources/Profiles.js.map +1 -0
- package/cjs/resources/PromotionCodes.d.ts +12 -0
- package/cjs/resources/PromotionCodes.js +27 -0
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/QuoteLines.d.ts +684 -0
- package/cjs/resources/QuoteLines.js +4 -0
- package/cjs/resources/QuoteLines.js.map +1 -0
- package/cjs/resources/QuotePreviewInvoices.d.ts +1179 -0
- package/cjs/resources/QuotePreviewInvoices.js +4 -0
- package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +1045 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/cjs/resources/Quotes.d.ts +3548 -254
- package/cjs/resources/Quotes.js +1184 -16
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/cjs/resources/Radar/AccountEvaluations.js +27 -0
- package/cjs/resources/Radar/AccountEvaluations.js.map +1 -0
- package/cjs/resources/Radar/CustomerEvaluations.d.ts +245 -0
- package/cjs/resources/Radar/CustomerEvaluations.js +27 -0
- package/cjs/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js +15 -0
- package/cjs/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +115 -1
- package/cjs/resources/Radar/ValueListItems.d.ts +39 -1
- package/cjs/resources/Radar/ValueListItems.js +13 -0
- package/cjs/resources/Radar/ValueListItems.js.map +1 -1
- package/cjs/resources/Radar/index.d.ts +36 -16
- package/cjs/resources/Radar/index.js +6 -0
- package/cjs/resources/Radar/index.js.map +1 -1
- package/cjs/resources/Refunds.d.ts +39 -0
- package/cjs/resources/Refunds.js +27 -0
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reserve/Holds.d.ts +53 -1
- package/cjs/resources/Reserve/Holds.js +19 -0
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +16 -0
- package/cjs/resources/Reserve/Plans.js +11 -0
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +41 -1
- package/cjs/resources/Reserve/Releases.js +19 -0
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +17 -6
- package/cjs/resources/Reserve/index.js +9 -0
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/RiskSignals.d.ts +10 -0
- package/cjs/resources/RiskSignals.js +4 -0
- package/cjs/resources/RiskSignals.js.map +1 -0
- package/cjs/resources/SetupAttempts.d.ts +35 -1
- package/cjs/resources/SetupAttempts.js.map +1 -1
- package/cjs/resources/SetupIntents.d.ts +627 -11
- package/cjs/resources/SetupIntents.js.map +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +425 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
- package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/IssuedTokens.d.ts +344 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
- package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/cjs/resources/SharedPayment/index.d.ts +19 -0
- package/cjs/resources/SharedPayment/index.js +15 -0
- package/cjs/resources/SharedPayment/index.js.map +1 -0
- package/cjs/resources/Sources.d.ts +29 -1
- package/cjs/resources/SubscriptionItems.d.ts +266 -1
- package/cjs/resources/SubscriptionItems.js +41 -0
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +2398 -67
- package/cjs/resources/SubscriptionSchedules.js +61 -0
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +971 -13
- package/cjs/resources/Subscriptions.js +290 -1
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/cjs/resources/Tax/Calculations.d.ts +46 -4
- package/cjs/resources/Tax/Forms.d.ts +228 -0
- package/cjs/resources/Tax/Forms.js +32 -0
- package/cjs/resources/Tax/Forms.js.map +1 -0
- package/cjs/resources/Tax/Locations.d.ts +112 -0
- package/cjs/resources/Tax/Locations.js +33 -0
- package/cjs/resources/Tax/Locations.js.map +1 -0
- package/cjs/resources/Tax/Registrations.d.ts +171 -2
- package/cjs/resources/Tax/Registrations.js +27 -0
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +8 -0
- package/cjs/resources/Tax/Settings.js +13 -0
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/Transactions.d.ts +10 -2
- package/cjs/resources/Tax/Transactions.js +13 -0
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- package/cjs/resources/Tax/index.d.ts +31 -13
- package/cjs/resources/Tax/index.js +4 -0
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +16 -1
- package/cjs/resources/TaxFunds.d.ts +174 -0
- package/cjs/resources/TaxFunds.js +23 -0
- package/cjs/resources/TaxFunds.js.map +1 -0
- package/cjs/resources/TaxIds.d.ts +6 -0
- package/cjs/resources/TaxIds.js +13 -0
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +12 -0
- package/cjs/resources/TaxRates.js +27 -0
- package/cjs/resources/TaxRates.js.map +1 -1
- package/cjs/resources/Terminal/Configurations.d.ts +27 -0
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/cjs/resources/Terminal/Readers.d.ts +207 -2
- package/cjs/resources/Terminal/Readers.js +24 -0
- package/cjs/resources/Terminal/Readers.js.map +1 -1
- package/cjs/resources/Terminal/index.d.ts +9 -0
- package/cjs/resources/Terminal/index.js +2 -0
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/cjs/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/Capital/index.js +13 -0
- package/cjs/resources/TestHelpers/Capital/index.js.map +1 -0
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +100 -1
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +102 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.d.ts +127 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js +39 -0
- package/cjs/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +110 -0
- package/cjs/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js +2 -0
- package/cjs/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/cjs/resources/TestHelpers/PaymentIntents.d.ts +38 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js +15 -0
- package/cjs/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
- package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/cjs/resources/TestHelpers/Terminal/Readers.d.ts +15 -1
- package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/cjs/resources/TestHelpers/index.d.ts +14 -6
- package/cjs/resources/TestHelpers/index.js +12 -6
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Tokens.d.ts +82 -0
- package/cjs/resources/Transfers.d.ts +12 -0
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/TransitBalances.d.ts +25 -0
- package/cjs/resources/TransitBalances.js +4 -0
- package/cjs/resources/TransitBalances.js.map +1 -0
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +72 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/BillSettings.d.ts +281 -0
- package/cjs/resources/V2/Billing/BillSettings.js +41 -0
- package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js +4 -0
- package/cjs/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js +23 -0
- package/cjs/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/cjs/resources/V2/Billing/Cadences.d.ts +1011 -0
- package/cjs/resources/V2/Billing/Cadences.js +264 -0
- package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +237 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
- package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/CollectionSettings.d.ts +776 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js +4 -0
- package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +29 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.js +15 -0
- package/cjs/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
- package/cjs/resources/V2/Billing/Contracts.d.ts +1484 -0
- package/cjs/resources/V2/Billing/Contracts.js +331 -0
- package/cjs/resources/V2/Billing/Contracts.js.map +1 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +35 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/cjs/resources/V2/Billing/IntentActions.d.ts +603 -0
- package/cjs/resources/V2/Billing/IntentActions.js +4 -0
- package/cjs/resources/V2/Billing/IntentActions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +70 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/cjs/resources/V2/Billing/Intents.d.ts +1261 -0
- package/cjs/resources/V2/Billing/Intents.js +87 -0
- package/cjs/resources/V2/Billing/Intents.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js +4 -0
- package/cjs/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +64 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/LicenseFees.d.ts +360 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +148 -0
- package/cjs/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/cjs/resources/V2/Billing/LicensedItems.d.ts +170 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +35 -0
- package/cjs/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/cjs/resources/V2/Billing/MeteredItems.d.ts +218 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +35 -0
- package/cjs/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/cjs/resources/V2/Billing/OneTimeItems.d.ts +170 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js +35 -0
- package/cjs/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +296 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js +4 -0
- package/cjs/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +41 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +23 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/PricingPlans.d.ts +169 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +43 -0
- package/cjs/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/cjs/resources/V2/Billing/Profiles.d.ts +162 -0
- package/cjs/resources/V2/Billing/Profiles.js +35 -0
- package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardRates.d.ts +111 -0
- package/cjs/resources/V2/Billing/RateCardRates.js +4 -0
- package/cjs/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +41 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js +4 -0
- package/cjs/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +35 -0
- package/cjs/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +110 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +23 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/cjs/resources/V2/Billing/RateCards.d.ts +336 -0
- package/cjs/resources/V2/Billing/RateCards.js +76 -0
- package/cjs/resources/V2/Billing/RateCards.js.map +1 -0
- package/cjs/resources/V2/Billing/ServiceActions.d.ts +510 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +162 -0
- package/cjs/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/cjs/resources/V2/Billing/index.d.ts +175 -6
- package/cjs/resources/V2/Billing/index.js +32 -0
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Core/AccountEvaluations.d.ts +159 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js +15 -0
- package/cjs/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/cjs/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/cjs/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/cjs/resources/V2/Core/AccountTokens.d.ts +220 -2
- package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts.d.ts +16128 -1981
- package/cjs/resources/V2/Core/Accounts.js +10379 -53
- package/cjs/resources/V2/Core/Accounts.js.map +1 -1
- package/cjs/resources/V2/Core/ApprovalRequests.d.ts +331 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js +46 -0
- package/cjs/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/cjs/resources/V2/Core/BatchJobs.d.ts +360 -0
- package/cjs/resources/V2/Core/BatchJobs.js +225 -0
- package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +31 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/cjs/resources/V2/Core/ConnectionSessions.d.ts +86 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js +21 -0
- package/cjs/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/cjs/resources/V2/Core/Events.d.ts +7881 -232
- package/cjs/resources/V2/Core/FeeBatches.d.ts +234 -0
- package/cjs/resources/V2/Core/FeeBatches.js +23 -0
- package/cjs/resources/V2/Core/FeeBatches.js.map +1 -0
- package/cjs/resources/V2/Core/FeeEntries.d.ts +200 -0
- package/cjs/resources/V2/Core/FeeEntries.js +23 -0
- package/cjs/resources/V2/Core/FeeEntries.js.map +1 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.d.ts +416 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js +4 -0
- package/cjs/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js +101 -0
- package/cjs/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/cjs/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/cjs/resources/V2/Core/Health/Alerts.js +182 -0
- package/cjs/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/cjs/resources/V2/Core/Health/index.d.ts +16 -0
- package/cjs/resources/V2/Core/Health/index.js +13 -0
- package/cjs/resources/V2/Core/Health/index.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +280 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +252 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +65 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
- package/cjs/resources/V2/Core/Vault/index.js +15 -0
- package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
- package/cjs/resources/V2/Core/index.d.ts +66 -14
- package/cjs/resources/V2/Core/index.js +18 -0
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +74 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js +36 -0
- package/cjs/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js +4 -0
- package/cjs/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/cjs/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/cjs/resources/V2/Data/Analytics/index.js +13 -0
- package/cjs/resources/V2/Data/Analytics/index.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +172 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
- package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js +13 -0
- package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Data/index.d.ts +13 -0
- package/cjs/resources/V2/Data/index.js +15 -0
- package/cjs/resources/V2/Data/index.js.map +1 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +163 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
- package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/cjs/resources/V2/Extend/Workflows.d.ts +120 -0
- package/cjs/resources/V2/Extend/Workflows.js +30 -0
- package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
- package/cjs/resources/V2/Extend/index.d.ts +20 -0
- package/cjs/resources/V2/Extend/index.js +15 -0
- package/cjs/resources/V2/Extend/index.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
- package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
- package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/cjs/resources/V2/Iam/ActivityLogs.d.ts +218 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/cjs/resources/V2/Iam/ApiKeys.d.ts +305 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +47 -0
- package/cjs/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/cjs/resources/V2/Iam/index.d.ts +23 -0
- package/cjs/resources/V2/Iam/index.js +15 -0
- package/cjs/resources/V2/Iam/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +31 -0
- package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.d.ts +169 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js +29 -0
- package/cjs/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js +4 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +49 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +53 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +438 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +50 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +4 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +251 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +219 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +318 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.d.ts +525 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +481 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.d.ts +166 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js +29 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +27 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +34 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +15 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js +13 -0
- package/cjs/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +266 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +297 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/cjs/resources/V2/MoneyManagement/index.d.ts +150 -0
- package/cjs/resources/V2/MoneyManagement/index.js +51 -0
- package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +92 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
- package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/cjs/resources/V2/Network/index.d.ts +13 -0
- package/cjs/resources/V2/Network/index.js +13 -0
- package/cjs/resources/V2/Network/index.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
- package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
- package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.d.ts +835 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +53 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js +4 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +35 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +53 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/cjs/resources/V2/Payments/index.d.ts +31 -0
- package/cjs/resources/V2/Payments/index.js +15 -0
- package/cjs/resources/V2/Payments/index.js.map +1 -0
- package/cjs/resources/V2/Reporting/ReportRuns.d.ts +191 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js +50 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/cjs/resources/V2/Reporting/Reports.d.ts +106 -0
- package/cjs/resources/V2/Reporting/Reports.js +17 -0
- package/cjs/resources/V2/Reporting/Reports.js.map +1 -0
- package/cjs/resources/V2/Reporting/index.d.ts +18 -0
- package/cjs/resources/V2/Reporting/index.js +15 -0
- package/cjs/resources/V2/Reporting/index.js.map +1 -0
- package/cjs/resources/V2/Risk/Inquiries.d.ts +143 -0
- package/cjs/resources/V2/Risk/Inquiries.js +29 -0
- package/cjs/resources/V2/Risk/Inquiries.js.map +1 -0
- package/cjs/resources/V2/Risk/index.d.ts +14 -0
- package/cjs/resources/V2/Risk/index.js +13 -0
- package/cjs/resources/V2/Risk/index.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountActivity.d.ts +424 -0
- package/cjs/resources/V2/Signals/AccountActivity.js +27 -0
- package/cjs/resources/V2/Signals/AccountActivity.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.js +59 -0
- package/cjs/resources/V2/Signals/AccountEvaluations.js.map +1 -0
- package/cjs/resources/V2/Signals/AccountSignals.d.ts +281 -0
- package/cjs/resources/V2/Signals/AccountSignals.js +110 -0
- package/cjs/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/cjs/resources/V2/Signals/index.d.ts +26 -0
- package/cjs/resources/V2/Signals/index.js +17 -0
- package/cjs/resources/V2/Signals/index.js.map +1 -0
- package/cjs/resources/V2/Tax/ManualRules.d.ts +331 -0
- package/cjs/resources/V2/Tax/ManualRules.js +193 -0
- package/cjs/resources/V2/Tax/ManualRules.js.map +1 -0
- package/cjs/resources/V2/Tax/index.d.ts +16 -0
- package/cjs/resources/V2/Tax/index.js +13 -0
- package/cjs/resources/V2/Tax/index.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +15 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/cjs/resources/V2/TestHelpers/index.d.ts +10 -0
- package/cjs/resources/V2/TestHelpers/index.js +15 -0
- package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
- package/cjs/resources/V2/index.d.ts +42 -0
- package/cjs/resources/V2/index.js +24 -0
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +2 -2
- package/cjs/resources.d.ts +19 -0
- package/cjs/resources.js +290 -18
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +15353 -1281
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +158 -54
- package/cjs/stripe.core.js +72 -31
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +58 -0
- package/esm/Error.js +118 -0
- package/esm/Error.js.map +1 -1
- package/esm/StripeEventNotificationHandler.d.ts +19 -0
- package/esm/StripeEventNotificationHandler.js +487 -0
- package/esm/StripeEventNotificationHandler.js.map +1 -0
- package/esm/Types.d.ts +9 -2
- package/esm/Types.js.map +1 -1
- package/esm/apiVersion.d.ts +2 -2
- package/esm/apiVersion.js +2 -2
- package/esm/apiVersion.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +5 -1
- package/esm/resources/AccountNotices.d.ts +140 -0
- package/esm/resources/AccountNotices.js +25 -0
- package/esm/resources/AccountNotices.js.map +1 -0
- package/esm/resources/AccountSessions.d.ts +564 -0
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/AccountSignals.d.ts +111 -0
- package/esm/resources/AccountSignals.js +3 -0
- package/esm/resources/AccountSignals.js.map +1 -0
- package/esm/resources/Accounts.d.ts +1037 -6
- package/esm/resources/Accounts.js +47 -0
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplicationFees.d.ts +28 -1
- package/esm/resources/Balance.d.ts +134 -0
- package/esm/resources/BalanceSettings.d.ts +18 -0
- package/esm/resources/BalanceTransactions.d.ts +1 -1
- package/esm/resources/BalanceTransfers.d.ts +160 -0
- package/esm/resources/BalanceTransfers.js +11 -0
- package/esm/resources/BalanceTransfers.js.map +1 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertNotifications.d.ts +75 -0
- package/esm/resources/Billing/AlertNotifications.js +3 -0
- package/esm/resources/Billing/AlertNotifications.js.map +1 -0
- package/esm/resources/Billing/AlertRecovereds.d.ts +56 -0
- package/esm/resources/Billing/AlertRecovereds.js +3 -0
- package/esm/resources/Billing/AlertRecovereds.js.map +1 -0
- package/esm/resources/Billing/AlertTriggereds.d.ts +55 -1
- package/esm/resources/Billing/Alerts.d.ts +448 -5
- package/esm/resources/Billing/Alerts.js +329 -5
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/Analytics/MeterUsage.d.ts +88 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +38 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
- package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
- package/esm/resources/Billing/Analytics/index.d.ts +15 -0
- package/esm/resources/Billing/Analytics/index.js +9 -0
- package/esm/resources/Billing/Analytics/index.js.map +1 -0
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +136 -3
- package/esm/resources/Billing/CreditBalanceSummary.js +39 -1
- package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceTransactions.d.ts +97 -3
- package/esm/resources/Billing/CreditBalanceTransactions.js +100 -1
- package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/esm/resources/Billing/CreditGrants.d.ts +105 -3
- package/esm/resources/Billing/CreditGrants.js +134 -5
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/FeedbackOptions.d.ts +32 -0
- package/esm/resources/Billing/FeedbackOptions.js +3 -0
- package/esm/resources/Billing/FeedbackOptions.js.map +1 -0
- package/esm/resources/Billing/MeterEventSummaries.d.ts +6 -0
- package/esm/resources/Billing/Meters.d.ts +31 -0
- package/esm/resources/Billing/index.d.ts +13 -0
- package/esm/resources/Billing/index.js +2 -0
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/BillingPortal/Configurations.d.ts +5 -0
- package/esm/resources/BillingPortal/Configurations.js.map +1 -1
- package/esm/resources/Capabilities.d.ts +25 -2
- package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
- package/esm/resources/Capital/FinancingOffers.js +26 -0
- package/esm/resources/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/Capital/FinancingSummary.d.ts +102 -0
- package/esm/resources/Capital/FinancingSummary.js +11 -0
- package/esm/resources/Capital/FinancingSummary.js.map +1 -0
- package/esm/resources/Capital/FinancingTransactions.d.ts +141 -0
- package/esm/resources/Capital/FinancingTransactions.js +20 -0
- package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
- package/esm/resources/Capital/index.d.ts +25 -0
- package/esm/resources/Capital/index.js +13 -0
- package/esm/resources/Capital/index.js.map +1 -0
- package/esm/resources/Cards.d.ts +28 -0
- package/esm/resources/Charges.d.ts +3367 -70
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1193 -12
- package/esm/resources/Checkout/Sessions.js +115 -0
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -0
- package/esm/resources/ConfirmationTokens.d.ts +146 -1
- package/esm/resources/ConfirmationTokens.js.map +1 -1
- package/esm/resources/Coupons.d.ts +128 -2
- package/esm/resources/Coupons.js +41 -0
- package/esm/resources/Coupons.js.map +1 -1
- package/esm/resources/CreditNoteLineItems.d.ts +15 -1
- package/esm/resources/CreditNotes.d.ts +7 -1
- package/esm/resources/CreditNotes.js +13 -0
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/Crypto/CustomerConsumerWallets.d.ts +30 -0
- package/esm/resources/Crypto/CustomerConsumerWallets.js +3 -0
- package/esm/resources/Crypto/CustomerConsumerWallets.js.map +1 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.d.ts +80 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.js +3 -0
- package/esm/resources/Crypto/CustomerPaymentTokens.js.map +1 -0
- package/esm/resources/Crypto/Customers.d.ts +111 -0
- package/esm/resources/Crypto/Customers.js +27 -0
- package/esm/resources/Crypto/Customers.js.map +1 -0
- package/esm/resources/Crypto/DepositAddresses.d.ts +128 -0
- package/esm/resources/Crypto/DepositAddresses.js +27 -0
- package/esm/resources/Crypto/DepositAddresses.js.map +1 -0
- package/esm/resources/Crypto/OnrampSessions.d.ts +421 -0
- package/esm/resources/Crypto/OnrampSessions.js +43 -0
- package/esm/resources/Crypto/OnrampSessions.js.map +1 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.d.ts +61 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.js +11 -0
- package/esm/resources/Crypto/OnrampTransactionLimits.js.map +1 -0
- package/esm/resources/Crypto/index.d.ts +41 -0
- package/esm/resources/Crypto/index.js +15 -0
- package/esm/resources/Crypto/index.js.map +1 -0
- package/esm/resources/CustomerSessions.d.ts +74 -0
- package/esm/resources/CustomerSessions.js +13 -0
- package/esm/resources/CustomerSessions.js.map +1 -1
- package/esm/resources/Customers.d.ts +98 -1
- package/esm/resources/Customers.js +195 -0
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/DelegatedCheckout/OrderEvents.d.ts +129 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js +3 -0
- package/esm/resources/DelegatedCheckout/OrderEvents.js.map +1 -0
- package/esm/resources/DelegatedCheckout/Orders.d.ts +159 -0
- package/esm/resources/DelegatedCheckout/Orders.js +11 -0
- package/esm/resources/DelegatedCheckout/Orders.js.map +1 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.d.ts +1420 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +43 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js.map +1 -0
- package/esm/resources/DelegatedCheckout/index.d.ts +25 -0
- package/esm/resources/DelegatedCheckout/index.js +11 -0
- package/esm/resources/DelegatedCheckout/index.js.map +1 -0
- package/esm/resources/Discounts.d.ts +19 -0
- package/esm/resources/Disputes.d.ts +43 -0
- package/esm/resources/Disputes.js +14 -0
- package/esm/resources/Disputes.js.map +1 -1
- package/esm/resources/Events.d.ts +574 -3
- package/esm/resources/ExternalAccounts.d.ts +212 -1
- package/esm/resources/ExternalAccounts.js +42 -1
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
- package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
- package/esm/resources/FinancialConnections/Accounts.d.ts +69 -4
- package/esm/resources/FinancialConnections/Accounts.js +8 -0
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Authorizations.d.ts +46 -1
- package/esm/resources/FinancialConnections/Authorizations.js +9 -1
- package/esm/resources/FinancialConnections/Authorizations.js.map +1 -1
- package/esm/resources/FinancialConnections/Institutions.d.ts +99 -0
- package/esm/resources/FinancialConnections/Institutions.js +19 -0
- package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
- package/esm/resources/FinancialConnections/Sessions.d.ts +124 -9
- package/esm/resources/FinancialConnections/index.d.ts +21 -9
- package/esm/resources/FinancialConnections/index.js +4 -0
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/FxQuotes.d.ts +212 -0
- package/esm/resources/FxQuotes.js +25 -0
- package/esm/resources/FxQuotes.js.map +1 -0
- package/esm/resources/GiftCardOperations.d.ts +249 -0
- package/esm/resources/GiftCardOperations.js +11 -0
- package/esm/resources/GiftCardOperations.js.map +1 -0
- package/esm/resources/GiftCards.d.ts +181 -0
- package/esm/resources/GiftCards.js +47 -0
- package/esm/resources/GiftCards.js.map +1 -0
- package/esm/resources/Identity/BlocklistEntries.d.ts +155 -0
- package/esm/resources/Identity/BlocklistEntries.js +50 -0
- package/esm/resources/Identity/BlocklistEntries.js.map +1 -0
- package/esm/resources/Identity/VerificationReports.d.ts +33 -2
- package/esm/resources/Identity/VerificationReports.js.map +1 -1
- package/esm/resources/Identity/VerificationSessions.d.ts +11 -3
- package/esm/resources/Identity/index.d.ts +18 -10
- package/esm/resources/Identity/index.js +2 -0
- package/esm/resources/Identity/index.js.map +1 -1
- package/esm/resources/InvoiceItems.d.ts +204 -3
- package/esm/resources/InvoiceItems.js +41 -0
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +174 -4
- package/esm/resources/InvoiceRenderingTemplates.d.ts +12 -0
- package/esm/resources/InvoiceRenderingTemplates.js +28 -0
- package/esm/resources/InvoiceRenderingTemplates.js.map +1 -1
- package/esm/resources/Invoices.d.ts +2125 -21
- package/esm/resources/Invoices.js +221 -0
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +524 -1
- package/esm/resources/Issuing/Authorizations.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +22 -4
- package/esm/resources/Issuing/Cards.d.ts +82 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +654 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +49 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
- package/esm/resources/Issuing/Disputes.d.ts +246 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
- package/esm/resources/Issuing/Programs.d.ts +95 -0
- package/esm/resources/Issuing/Programs.js +31 -0
- package/esm/resources/Issuing/Programs.js.map +1 -0
- package/esm/resources/Issuing/Settlements.d.ts +83 -0
- package/esm/resources/Issuing/Settlements.js +3 -0
- package/esm/resources/Issuing/Settlements.js.map +1 -0
- package/esm/resources/Issuing/Tokens.d.ts +26 -0
- package/esm/resources/Issuing/Transactions.d.ts +233 -0
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +56 -22
- package/esm/resources/Issuing/index.js +8 -0
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +29 -2
- package/esm/resources/Mandates.d.ts +47 -2
- package/esm/resources/Mandates.js +8 -0
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/Margins.d.ts +115 -0
- package/esm/resources/Margins.js +31 -0
- package/esm/resources/Margins.js.map +1 -0
- package/esm/resources/Orchestration/PaymentAttempts.d.ts +34 -0
- package/esm/resources/Orchestration/PaymentAttempts.js +11 -0
- package/esm/resources/Orchestration/PaymentAttempts.js.map +1 -0
- package/esm/resources/Orchestration/index.d.ts +12 -0
- package/esm/resources/Orchestration/index.js +9 -0
- package/esm/resources/Orchestration/index.js.map +1 -0
- package/esm/resources/Orders.d.ts +4773 -0
- package/esm/resources/Orders.js +453 -0
- package/esm/resources/Orders.js.map +1 -0
- package/esm/resources/PaymentAttemptRecords.d.ts +679 -2
- package/esm/resources/PaymentAttemptRecords.js +48 -0
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +52 -0
- package/esm/resources/PaymentIntents.d.ts +16109 -2361
- package/esm/resources/PaymentIntents.js +46 -0
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +77 -15
- package/esm/resources/PaymentLocationCapabilities.d.ts +123 -0
- package/esm/resources/PaymentLocationCapabilities.js +25 -0
- package/esm/resources/PaymentLocationCapabilities.js.map +1 -0
- package/esm/resources/PaymentLocations.d.ts +178 -0
- package/esm/resources/PaymentLocations.js +37 -0
- package/esm/resources/PaymentLocations.js.map +1 -0
- package/esm/resources/PaymentMethodBalances.d.ts +46 -0
- package/esm/resources/PaymentMethodBalances.js +3 -0
- package/esm/resources/PaymentMethodBalances.js.map +1 -0
- package/esm/resources/PaymentMethodConfigurations.d.ts +420 -0
- package/esm/resources/PaymentMethods.d.ts +300 -3
- package/esm/resources/PaymentMethods.js +20 -0
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +737 -20
- package/esm/resources/PaymentRecords.js +18 -0
- package/esm/resources/PaymentRecords.js.map +1 -1
- package/esm/resources/Persons.d.ts +25 -2
- package/esm/resources/Plans.d.ts +16 -0
- package/esm/resources/Prices.d.ts +77 -1
- package/esm/resources/Prices.js +27 -0
- package/esm/resources/Prices.js.map +1 -1
- package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +36 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
- package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
- package/esm/resources/Privacy/RedactionJobs.d.ts +227 -0
- package/esm/resources/Privacy/RedactionJobs.js +69 -0
- package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
- package/esm/resources/Privacy/index.d.ts +22 -0
- package/esm/resources/Privacy/index.js +9 -0
- package/esm/resources/Privacy/index.js.map +1 -0
- package/esm/resources/ProductCatalog/TrialOffers.d.ts +158 -0
- package/esm/resources/ProductCatalog/TrialOffers.js +25 -0
- package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
- package/esm/resources/ProductCatalog/index.d.ts +14 -0
- package/esm/resources/ProductCatalog/index.js +9 -0
- package/esm/resources/ProductCatalog/index.js.map +1 -0
- package/esm/resources/Products.d.ts +199 -1
- package/esm/resources/Products.js +69 -0
- package/esm/resources/Products.js.map +1 -1
- package/esm/resources/Profiles.d.ts +68 -0
- package/esm/resources/Profiles.js +3 -0
- package/esm/resources/Profiles.js.map +1 -0
- package/esm/resources/PromotionCodes.d.ts +12 -0
- package/esm/resources/PromotionCodes.js +27 -0
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/QuoteLines.d.ts +684 -0
- package/esm/resources/QuoteLines.js +3 -0
- package/esm/resources/QuoteLines.js.map +1 -0
- package/esm/resources/QuotePreviewInvoices.d.ts +1179 -0
- package/esm/resources/QuotePreviewInvoices.js +3 -0
- package/esm/resources/QuotePreviewInvoices.js.map +1 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +1045 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
- package/esm/resources/Quotes.d.ts +3548 -254
- package/esm/resources/Quotes.js +1184 -16
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +308 -0
- package/esm/resources/Radar/AccountEvaluations.js +23 -0
- package/esm/resources/Radar/AccountEvaluations.js.map +1 -0
- package/esm/resources/Radar/CustomerEvaluations.d.ts +245 -0
- package/esm/resources/Radar/CustomerEvaluations.js +23 -0
- package/esm/resources/Radar/CustomerEvaluations.js.map +1 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.d.ts +433 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js +11 -0
- package/esm/resources/Radar/IssuingAuthorizationEvaluations.js.map +1 -0
- package/esm/resources/Radar/PaymentEvaluations.d.ts +115 -1
- package/esm/resources/Radar/ValueListItems.d.ts +39 -1
- package/esm/resources/Radar/ValueListItems.js +13 -0
- package/esm/resources/Radar/ValueListItems.js.map +1 -1
- package/esm/resources/Radar/index.d.ts +36 -16
- package/esm/resources/Radar/index.js +6 -0
- package/esm/resources/Radar/index.js.map +1 -1
- package/esm/resources/Refunds.d.ts +39 -0
- package/esm/resources/Refunds.js +27 -0
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reserve/Holds.d.ts +53 -1
- package/esm/resources/Reserve/Holds.js +17 -1
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +16 -0
- package/esm/resources/Reserve/Plans.js +9 -1
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +41 -1
- package/esm/resources/Reserve/Releases.js +17 -1
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +17 -6
- package/esm/resources/Reserve/index.js +9 -0
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/RiskSignals.d.ts +10 -0
- package/esm/resources/RiskSignals.js +3 -0
- package/esm/resources/RiskSignals.js.map +1 -0
- package/esm/resources/SetupAttempts.d.ts +35 -1
- package/esm/resources/SetupAttempts.js.map +1 -1
- package/esm/resources/SetupIntents.d.ts +627 -11
- package/esm/resources/SetupIntents.js.map +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +425 -0
- package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
- package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/IssuedTokens.d.ts +344 -0
- package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
- package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
- package/esm/resources/SharedPayment/index.d.ts +19 -0
- package/esm/resources/SharedPayment/index.js +11 -0
- package/esm/resources/SharedPayment/index.js.map +1 -0
- package/esm/resources/Sources.d.ts +29 -1
- package/esm/resources/SubscriptionItems.d.ts +266 -1
- package/esm/resources/SubscriptionItems.js +41 -0
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +2398 -67
- package/esm/resources/SubscriptionSchedules.js +61 -0
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +971 -13
- package/esm/resources/Subscriptions.js +290 -1
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +14 -3
- package/esm/resources/Tax/Calculations.d.ts +46 -4
- package/esm/resources/Tax/Forms.d.ts +228 -0
- package/esm/resources/Tax/Forms.js +28 -0
- package/esm/resources/Tax/Forms.js.map +1 -0
- package/esm/resources/Tax/Locations.d.ts +112 -0
- package/esm/resources/Tax/Locations.js +29 -0
- package/esm/resources/Tax/Locations.js.map +1 -0
- package/esm/resources/Tax/Registrations.d.ts +171 -2
- package/esm/resources/Tax/Registrations.js +27 -0
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +8 -0
- package/esm/resources/Tax/Settings.js +13 -0
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/Transactions.d.ts +10 -2
- package/esm/resources/Tax/Transactions.js +13 -0
- package/esm/resources/Tax/Transactions.js.map +1 -1
- package/esm/resources/Tax/index.d.ts +31 -13
- package/esm/resources/Tax/index.js +4 -0
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +16 -1
- package/esm/resources/TaxFunds.d.ts +174 -0
- package/esm/resources/TaxFunds.js +19 -0
- package/esm/resources/TaxFunds.js.map +1 -0
- package/esm/resources/TaxIds.d.ts +6 -0
- package/esm/resources/TaxIds.js +13 -0
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +12 -0
- package/esm/resources/TaxRates.js +27 -0
- package/esm/resources/TaxRates.js.map +1 -1
- package/esm/resources/Terminal/Configurations.d.ts +27 -0
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
- package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
- package/esm/resources/Terminal/Readers.d.ts +207 -2
- package/esm/resources/Terminal/Readers.js +24 -0
- package/esm/resources/Terminal/Readers.js.map +1 -1
- package/esm/resources/Terminal/index.d.ts +9 -0
- package/esm/resources/Terminal/index.js +2 -0
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/Capital/FinancingOffers.d.ts +81 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +17 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js.map +1 -0
- package/esm/resources/TestHelpers/Capital/index.d.ts +8 -0
- package/esm/resources/TestHelpers/Capital/index.js +9 -0
- package/esm/resources/TestHelpers/Capital/index.js.map +1 -0
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +100 -1
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +102 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.d.ts +127 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js +35 -0
- package/esm/resources/TestHelpers/Issuing/Disputes.js.map +1 -0
- package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +110 -0
- package/esm/resources/TestHelpers/Issuing/index.d.ts +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js +2 -0
- package/esm/resources/TestHelpers/Issuing/index.js.map +1 -1
- package/esm/resources/TestHelpers/PaymentIntents.d.ts +38 -0
- package/esm/resources/TestHelpers/PaymentIntents.js +11 -0
- package/esm/resources/TestHelpers/PaymentIntents.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +75 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
- package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
- package/esm/resources/TestHelpers/Terminal/Readers.d.ts +15 -1
- package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
- package/esm/resources/TestHelpers/index.d.ts +14 -6
- package/esm/resources/TestHelpers/index.js +6 -0
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Tokens.d.ts +82 -0
- package/esm/resources/Transfers.d.ts +12 -0
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/TransitBalances.d.ts +25 -0
- package/esm/resources/TransitBalances.js +3 -0
- package/esm/resources/TransitBalances.js.map +1 -0
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
- package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
- package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
- package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
- package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
- package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
- package/esm/resources/V2/Billing/BillSettingVersions.d.ts +72 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/BillSettings.d.ts +281 -0
- package/esm/resources/V2/Billing/BillSettings.js +37 -0
- package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.d.ts +84 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js +3 -0
- package/esm/resources/V2/Billing/CadenceSpendModifiers.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.d.ts +37 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js +19 -0
- package/esm/resources/V2/Billing/Cadences/SpendModifierRules.js.map +1 -0
- package/esm/resources/V2/Billing/Cadences.d.ts +1011 -0
- package/esm/resources/V2/Billing/Cadences.js +260 -0
- package/esm/resources/V2/Billing/Cadences.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +237 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
- package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/CollectionSettings.d.ts +776 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
- package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +47 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js +3 -0
- package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.d.ts +23 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js +25 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines/QuantityChanges.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.d.ts +8 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.js +11 -0
- package/esm/resources/V2/Billing/Contracts/PricingLines.js.map +1 -0
- package/esm/resources/V2/Billing/Contracts.d.ts +1484 -0
- package/esm/resources/V2/Billing/Contracts.js +327 -0
- package/esm/resources/V2/Billing/Contracts.js.map +1 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.d.ts +125 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +31 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js.map +1 -0
- package/esm/resources/V2/Billing/IntentActions.d.ts +603 -0
- package/esm/resources/V2/Billing/IntentActions.js +3 -0
- package/esm/resources/V2/Billing/IntentActions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents/Actions.d.ts +33 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +66 -0
- package/esm/resources/V2/Billing/Intents/Actions.js.map +1 -0
- package/esm/resources/V2/Billing/Intents.d.ts +1261 -0
- package/esm/resources/V2/Billing/Intents.js +83 -0
- package/esm/resources/V2/Billing/Intents.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.d.ts +78 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js +3 -0
- package/esm/resources/V2/Billing/LicenseFeeVersions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +60 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/LicenseFees.d.ts +360 -0
- package/esm/resources/V2/Billing/LicenseFees.js +144 -0
- package/esm/resources/V2/Billing/LicenseFees.js.map +1 -0
- package/esm/resources/V2/Billing/LicensedItems.d.ts +170 -0
- package/esm/resources/V2/Billing/LicensedItems.js +31 -0
- package/esm/resources/V2/Billing/LicensedItems.js.map +1 -0
- package/esm/resources/V2/Billing/MeteredItems.d.ts +218 -0
- package/esm/resources/V2/Billing/MeteredItems.js +31 -0
- package/esm/resources/V2/Billing/MeteredItems.js.map +1 -0
- package/esm/resources/V2/Billing/OneTimeItems.d.ts +170 -0
- package/esm/resources/V2/Billing/OneTimeItems.js +31 -0
- package/esm/resources/V2/Billing/OneTimeItems.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.d.ts +80 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanComponents.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.d.ts +620 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +292 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.d.ts +30 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js +3 -0
- package/esm/resources/V2/Billing/PricingPlanVersions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.d.ts +142 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +37 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +19 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/PricingPlans.d.ts +169 -0
- package/esm/resources/V2/Billing/PricingPlans.js +39 -0
- package/esm/resources/V2/Billing/PricingPlans.js.map +1 -0
- package/esm/resources/V2/Billing/Profiles.d.ts +162 -0
- package/esm/resources/V2/Billing/Profiles.js +31 -0
- package/esm/resources/V2/Billing/Profiles.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.d.ts +45 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardCustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardRates.d.ts +111 -0
- package/esm/resources/V2/Billing/RateCardRates.js +3 -0
- package/esm/resources/V2/Billing/RateCardRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.d.ts +215 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +37 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCardVersions.d.ts +22 -0
- package/esm/resources/V2/Billing/RateCardVersions.js +3 -0
- package/esm/resources/V2/Billing/RateCardVersions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.d.ts +79 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js +31 -0
- package/esm/resources/V2/Billing/RateCards/CustomPricingUnitOverageRates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Rates.d.ts +145 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +106 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards/Versions.d.ts +33 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +19 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js.map +1 -0
- package/esm/resources/V2/Billing/RateCards.d.ts +336 -0
- package/esm/resources/V2/Billing/RateCards.js +72 -0
- package/esm/resources/V2/Billing/RateCards.js.map +1 -0
- package/esm/resources/V2/Billing/ServiceActions.d.ts +510 -0
- package/esm/resources/V2/Billing/ServiceActions.js +158 -0
- package/esm/resources/V2/Billing/ServiceActions.js.map +1 -0
- package/esm/resources/V2/Billing/index.d.ts +175 -6
- package/esm/resources/V2/Billing/index.js +32 -0
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Core/AccountEvaluations.d.ts +159 -0
- package/esm/resources/V2/Core/AccountEvaluations.js +11 -0
- package/esm/resources/V2/Core/AccountEvaluations.js.map +1 -0
- package/esm/resources/V2/Core/AccountLinks.d.ts +158 -6
- package/esm/resources/V2/Core/AccountPersons.d.ts +1 -1
- package/esm/resources/V2/Core/AccountTokens.d.ts +220 -2
- package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts.d.ts +16128 -1981
- package/esm/resources/V2/Core/Accounts.js +10379 -53
- package/esm/resources/V2/Core/Accounts.js.map +1 -1
- package/esm/resources/V2/Core/ApprovalRequests.d.ts +331 -0
- package/esm/resources/V2/Core/ApprovalRequests.js +42 -0
- package/esm/resources/V2/Core/ApprovalRequests.js.map +1 -0
- package/esm/resources/V2/Core/BatchJobs.d.ts +360 -0
- package/esm/resources/V2/Core/BatchJobs.js +221 -0
- package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.d.ts +225 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +27 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js.map +1 -0
- package/esm/resources/V2/Core/ConnectionSessions.d.ts +86 -0
- package/esm/resources/V2/Core/ConnectionSessions.js +17 -0
- package/esm/resources/V2/Core/ConnectionSessions.js.map +1 -0
- package/esm/resources/V2/Core/Events.d.ts +7881 -232
- package/esm/resources/V2/Core/FeeBatches.d.ts +234 -0
- package/esm/resources/V2/Core/FeeBatches.js +19 -0
- package/esm/resources/V2/Core/FeeBatches.js.map +1 -0
- package/esm/resources/V2/Core/FeeEntries.d.ts +200 -0
- package/esm/resources/V2/Core/FeeEntries.js +19 -0
- package/esm/resources/V2/Core/FeeEntries.js.map +1 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.d.ts +416 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js +3 -0
- package/esm/resources/V2/Core/Health/AlertHistoryEntries.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts/History.d.ts +23 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js +97 -0
- package/esm/resources/V2/Core/Health/Alerts/History.js.map +1 -0
- package/esm/resources/V2/Core/Health/Alerts.d.ts +530 -0
- package/esm/resources/V2/Core/Health/Alerts.js +178 -0
- package/esm/resources/V2/Core/Health/Alerts.js.map +1 -0
- package/esm/resources/V2/Core/Health/index.d.ts +16 -0
- package/esm/resources/V2/Core/Health/index.js +9 -0
- package/esm/resources/V2/Core/Health/index.js.map +1 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +280 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +252 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +61 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
- package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
- package/esm/resources/V2/Core/Vault/index.js +11 -0
- package/esm/resources/V2/Core/Vault/index.js.map +1 -0
- package/esm/resources/V2/Core/index.d.ts +66 -14
- package/esm/resources/V2/Core/index.js +18 -0
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +74 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js +32 -0
- package/esm/resources/V2/Data/Analytics/MetricQuery.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.d.ts +76 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js +3 -0
- package/esm/resources/V2/Data/Analytics/MetricQueryResults.js.map +1 -0
- package/esm/resources/V2/Data/Analytics/index.d.ts +12 -0
- package/esm/resources/V2/Data/Analytics/index.js +9 -0
- package/esm/resources/V2/Data/Analytics/index.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +172 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
- package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
- package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
- package/esm/resources/V2/Data/Reporting/index.js +9 -0
- package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Data/index.d.ts +13 -0
- package/esm/resources/V2/Data/index.js +11 -0
- package/esm/resources/V2/Data/index.js.map +1 -0
- package/esm/resources/V2/Extend/WorkflowRuns.d.ts +163 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
- package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
- package/esm/resources/V2/Extend/Workflows.d.ts +120 -0
- package/esm/resources/V2/Extend/Workflows.js +26 -0
- package/esm/resources/V2/Extend/Workflows.js.map +1 -0
- package/esm/resources/V2/Extend/index.d.ts +20 -0
- package/esm/resources/V2/Extend/index.js +11 -0
- package/esm/resources/V2/Extend/index.js.map +1 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
- package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
- package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
- package/esm/resources/V2/Iam/ActivityLogs.d.ts +218 -0
- package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
- package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
- package/esm/resources/V2/Iam/ApiKeys.d.ts +305 -0
- package/esm/resources/V2/Iam/ApiKeys.js +43 -0
- package/esm/resources/V2/Iam/ApiKeys.js.map +1 -0
- package/esm/resources/V2/Iam/index.d.ts +23 -0
- package/esm/resources/V2/Iam/index.js +11 -0
- package/esm/resources/V2/Iam/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +135 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.d.ts +131 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +27 -0
- package/esm/resources/V2/MoneyManagement/CurrencyConversions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.d.ts +169 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js +25 -0
- package/esm/resources/V2/MoneyManagement/DebitDisputes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.d.ts +99 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js +3 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccountStatements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.d.ts +49 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js +49 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts/Statements.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +438 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +46 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.d.ts +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js +3 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddressDebitSimulations.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +304 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +251 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +219 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +638 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +318 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +394 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.d.ts +525 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutIntents.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +277 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +481 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.d.ts +166 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js +25 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebitMandates.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +308 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.d.ts +116 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +23 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.d.ts +34 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js +11 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.d.ts +8 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.js +9 -0
- package/esm/resources/V2/MoneyManagement/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +266 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/Transactions.d.ts +297 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
- package/esm/resources/V2/MoneyManagement/index.d.ts +150 -0
- package/esm/resources/V2/MoneyManagement/index.js +47 -0
- package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +92 -0
- package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
- package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
- package/esm/resources/V2/Network/index.d.ts +13 -0
- package/esm/resources/V2/Network/index.js +9 -0
- package/esm/resources/V2/Network/index.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
- package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
- package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
- package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
- package/esm/resources/V2/Payments/OffSessionPayments.d.ts +835 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +49 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.d.ts +73 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js +3 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntentSplits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.d.ts +85 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +31 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js.map +1 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.d.ts +209 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +49 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js.map +1 -0
- package/esm/resources/V2/Payments/index.d.ts +31 -0
- package/esm/resources/V2/Payments/index.js +11 -0
- package/esm/resources/V2/Payments/index.js.map +1 -0
- package/esm/resources/V2/Reporting/ReportRuns.d.ts +191 -0
- package/esm/resources/V2/Reporting/ReportRuns.js +46 -0
- package/esm/resources/V2/Reporting/ReportRuns.js.map +1 -0
- package/esm/resources/V2/Reporting/Reports.d.ts +106 -0
- package/esm/resources/V2/Reporting/Reports.js +13 -0
- package/esm/resources/V2/Reporting/Reports.js.map +1 -0
- package/esm/resources/V2/Reporting/index.d.ts +18 -0
- package/esm/resources/V2/Reporting/index.js +11 -0
- package/esm/resources/V2/Reporting/index.js.map +1 -0
- package/esm/resources/V2/Risk/Inquiries.d.ts +143 -0
- package/esm/resources/V2/Risk/Inquiries.js +25 -0
- package/esm/resources/V2/Risk/Inquiries.js.map +1 -0
- package/esm/resources/V2/Risk/index.d.ts +14 -0
- package/esm/resources/V2/Risk/index.js +9 -0
- package/esm/resources/V2/Risk/index.js.map +1 -0
- package/esm/resources/V2/Signals/AccountActivity.d.ts +424 -0
- package/esm/resources/V2/Signals/AccountActivity.js +23 -0
- package/esm/resources/V2/Signals/AccountActivity.js.map +1 -0
- package/esm/resources/V2/Signals/AccountEvaluations.d.ts +396 -0
- package/esm/resources/V2/Signals/AccountEvaluations.js +55 -0
- package/esm/resources/V2/Signals/AccountEvaluations.js.map +1 -0
- package/esm/resources/V2/Signals/AccountSignals.d.ts +281 -0
- package/esm/resources/V2/Signals/AccountSignals.js +106 -0
- package/esm/resources/V2/Signals/AccountSignals.js.map +1 -0
- package/esm/resources/V2/Signals/index.d.ts +26 -0
- package/esm/resources/V2/Signals/index.js +13 -0
- package/esm/resources/V2/Signals/index.js.map +1 -0
- package/esm/resources/V2/Tax/ManualRules.d.ts +331 -0
- package/esm/resources/V2/Tax/ManualRules.js +189 -0
- package/esm/resources/V2/Tax/ManualRules.js.map +1 -0
- package/esm/resources/V2/Tax/index.d.ts +16 -0
- package/esm/resources/V2/Tax/index.js +9 -0
- package/esm/resources/V2/Tax/index.js.map +1 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +45 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.d.ts +31 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +11 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js.map +1 -0
- package/esm/resources/V2/TestHelpers/index.d.ts +10 -0
- package/esm/resources/V2/TestHelpers/index.js +11 -0
- package/esm/resources/V2/TestHelpers/index.js.map +1 -0
- package/esm/resources/V2/index.d.ts +42 -0
- package/esm/resources/V2/index.js +24 -0
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +2 -2
- package/esm/resources.d.ts +19 -0
- package/esm/resources.js +261 -0
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +158 -54
- package/esm/stripe.core.js +43 -2
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +158 -54
- package/esm/stripe.esm.node.js +43 -2
- package/esm/stripe.esm.node.js.map +1 -1
- package/package.json +1 -1
|
@@ -4,11 +4,13 @@ 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';
|
|
10
11
|
import { Account } from './Accounts.js';
|
|
11
12
|
import { InvoicePayment } from './InvoicePayments.js';
|
|
13
|
+
import { GiftCardOperation } from './GiftCardOperations.js';
|
|
12
14
|
import { PaymentIntent } from './PaymentIntents.js';
|
|
13
15
|
import { SetupIntent } from './SetupIntents.js';
|
|
14
16
|
import { Subscription } from './Subscriptions.js';
|
|
@@ -67,6 +69,10 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
67
69
|
* See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
|
|
68
70
|
*/
|
|
69
71
|
attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
72
|
+
/**
|
|
73
|
+
* Detaches a payment from the invoice, removing it from the list of payments
|
|
74
|
+
*/
|
|
75
|
+
detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
70
76
|
/**
|
|
71
77
|
* 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
78
|
*/
|
|
@@ -111,6 +117,54 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
111
117
|
* 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
118
|
*/
|
|
113
119
|
createPreview(params?: InvoiceCreatePreviewParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
120
|
+
serializeBatchDelete(invoice: string, params?: Record<string, unknown>, options?: {
|
|
121
|
+
apiVersion?: string;
|
|
122
|
+
stripeContext?: string;
|
|
123
|
+
}): string;
|
|
124
|
+
serializeBatchUpdate(invoice: string, params?: Record<string, unknown>, options?: {
|
|
125
|
+
apiVersion?: string;
|
|
126
|
+
stripeContext?: string;
|
|
127
|
+
}): string;
|
|
128
|
+
serializeBatchCreate(params?: Record<string, unknown>, options?: {
|
|
129
|
+
apiVersion?: string;
|
|
130
|
+
stripeContext?: string;
|
|
131
|
+
}): string;
|
|
132
|
+
serializeBatchAddLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
133
|
+
apiVersion?: string;
|
|
134
|
+
stripeContext?: string;
|
|
135
|
+
}): string;
|
|
136
|
+
serializeBatchFinalizeInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
137
|
+
apiVersion?: string;
|
|
138
|
+
stripeContext?: string;
|
|
139
|
+
}): string;
|
|
140
|
+
serializeBatchMarkUncollectible(invoice: string, params?: Record<string, unknown>, options?: {
|
|
141
|
+
apiVersion?: string;
|
|
142
|
+
stripeContext?: string;
|
|
143
|
+
}): string;
|
|
144
|
+
serializeBatchPay(invoice: string, params?: Record<string, unknown>, options?: {
|
|
145
|
+
apiVersion?: string;
|
|
146
|
+
stripeContext?: string;
|
|
147
|
+
}): string;
|
|
148
|
+
serializeBatchRemoveLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
149
|
+
apiVersion?: string;
|
|
150
|
+
stripeContext?: string;
|
|
151
|
+
}): string;
|
|
152
|
+
serializeBatchSendInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
153
|
+
apiVersion?: string;
|
|
154
|
+
stripeContext?: string;
|
|
155
|
+
}): string;
|
|
156
|
+
serializeBatchUpdateLines(invoice: string, params?: Record<string, unknown>, options?: {
|
|
157
|
+
apiVersion?: string;
|
|
158
|
+
stripeContext?: string;
|
|
159
|
+
}): string;
|
|
160
|
+
serializeBatchVoidInvoice(invoice: string, params?: Record<string, unknown>, options?: {
|
|
161
|
+
apiVersion?: string;
|
|
162
|
+
stripeContext?: string;
|
|
163
|
+
}): string;
|
|
164
|
+
serializeBatchCreatePreview(params?: Record<string, unknown>, options?: {
|
|
165
|
+
apiVersion?: string;
|
|
166
|
+
stripeContext?: string;
|
|
167
|
+
}): string;
|
|
114
168
|
/**
|
|
115
169
|
* 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
170
|
*/
|
|
@@ -122,6 +176,10 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
122
176
|
* Updating an invoice's line item is only possible before the invoice is finalized.
|
|
123
177
|
*/
|
|
124
178
|
updateLineItem(invoiceId: string, id: string, params?: InvoiceUpdateLineItemParams, options?: RequestOptions): Promise<Response<InvoiceLineItem>>;
|
|
179
|
+
serializeBatchUpdateLineItem(invoice: string, lineItemId: string, params?: Record<string, unknown>, options?: {
|
|
180
|
+
apiVersion?: string;
|
|
181
|
+
stripeContext?: string;
|
|
182
|
+
}): string;
|
|
125
183
|
}
|
|
126
184
|
export interface Invoice {
|
|
127
185
|
/**
|
|
@@ -168,6 +226,10 @@ export interface Invoice {
|
|
|
168
226
|
* This is the sum of all the shipping amounts.
|
|
169
227
|
*/
|
|
170
228
|
amount_shipping: number;
|
|
229
|
+
/**
|
|
230
|
+
* List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
|
|
231
|
+
*/
|
|
232
|
+
amounts_due?: Array<Invoice.AmountsDue> | null;
|
|
171
233
|
/**
|
|
172
234
|
* ID of the Connect Application that created the invoice.
|
|
173
235
|
*/
|
|
@@ -257,6 +319,10 @@ export interface Invoice {
|
|
|
257
319
|
* 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
320
|
*/
|
|
259
321
|
customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
|
|
322
|
+
/**
|
|
323
|
+
* The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
|
|
324
|
+
*/
|
|
325
|
+
default_margins?: Array<string | Margin> | null;
|
|
260
326
|
/**
|
|
261
327
|
* 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
328
|
*/
|
|
@@ -421,6 +487,10 @@ export interface Invoice {
|
|
|
421
487
|
* The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
|
|
422
488
|
*/
|
|
423
489
|
total_excluding_tax: number | null;
|
|
490
|
+
/**
|
|
491
|
+
* The aggregate amounts calculated per margin across all line items.
|
|
492
|
+
*/
|
|
493
|
+
total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
|
|
424
494
|
/**
|
|
425
495
|
* 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
496
|
*/
|
|
@@ -449,6 +519,40 @@ export interface DeletedInvoice {
|
|
|
449
519
|
deleted: true;
|
|
450
520
|
}
|
|
451
521
|
export declare namespace Invoice {
|
|
522
|
+
interface AmountsDue {
|
|
523
|
+
/**
|
|
524
|
+
* Incremental amount due for this payment in cents (or local equivalent).
|
|
525
|
+
*/
|
|
526
|
+
amount: number;
|
|
527
|
+
/**
|
|
528
|
+
* The amount in cents (or local equivalent) that was paid for this payment.
|
|
529
|
+
*/
|
|
530
|
+
amount_paid: number;
|
|
531
|
+
/**
|
|
532
|
+
* The difference between the payment's amount and amount_paid, in cents (or local equivalent).
|
|
533
|
+
*/
|
|
534
|
+
amount_remaining: number;
|
|
535
|
+
/**
|
|
536
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
537
|
+
*/
|
|
538
|
+
days_until_due: number | null;
|
|
539
|
+
/**
|
|
540
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
541
|
+
*/
|
|
542
|
+
description: string | null;
|
|
543
|
+
/**
|
|
544
|
+
* Date on which a payment plan's payment is due.
|
|
545
|
+
*/
|
|
546
|
+
due_date: number | null;
|
|
547
|
+
/**
|
|
548
|
+
* Timestamp when the payment was paid.
|
|
549
|
+
*/
|
|
550
|
+
paid_at: number | null;
|
|
551
|
+
/**
|
|
552
|
+
* The status of the payment, one of `open`, `paid`, or `past_due`
|
|
553
|
+
*/
|
|
554
|
+
status: AmountsDue.Status;
|
|
555
|
+
}
|
|
452
556
|
interface AutomaticTax {
|
|
453
557
|
/**
|
|
454
558
|
* If Stripe disabled automatic tax, this enum describes why.
|
|
@@ -564,6 +668,11 @@ export declare namespace Invoice {
|
|
|
564
668
|
* A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
|
|
565
669
|
*/
|
|
566
670
|
doc_url?: string;
|
|
671
|
+
/**
|
|
672
|
+
* A GiftCardOperation represents an operation performed on a third-party gift card,
|
|
673
|
+
* such as activation, reload, cashout, balance check, or void.
|
|
674
|
+
*/
|
|
675
|
+
gift_card_operation?: GiftCardOperation;
|
|
567
676
|
/**
|
|
568
677
|
* A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
|
|
569
678
|
*/
|
|
@@ -641,10 +750,18 @@ export declare namespace Invoice {
|
|
|
641
750
|
type: LastFinalizationError.Type;
|
|
642
751
|
}
|
|
643
752
|
interface Parent {
|
|
753
|
+
/**
|
|
754
|
+
* Details about the billing cadence that generated this invoice
|
|
755
|
+
*/
|
|
756
|
+
billing_cadence_details?: Parent.BillingCadenceDetails | null;
|
|
644
757
|
/**
|
|
645
758
|
* Details about the quote that generated this invoice
|
|
646
759
|
*/
|
|
647
760
|
quote_details: Parent.QuoteDetails | null;
|
|
761
|
+
/**
|
|
762
|
+
* Details about the schedule that generated this invoice
|
|
763
|
+
*/
|
|
764
|
+
schedule_details?: Parent.ScheduleDetails | null;
|
|
648
765
|
/**
|
|
649
766
|
* Details about the subscription that generated this invoice
|
|
650
767
|
*/
|
|
@@ -766,6 +883,16 @@ export declare namespace Invoice {
|
|
|
766
883
|
*/
|
|
767
884
|
discount: string | Discount | DeletedDiscount;
|
|
768
885
|
}
|
|
886
|
+
interface TotalMarginAmount {
|
|
887
|
+
/**
|
|
888
|
+
* The amount, in cents (or local equivalent), of the reduction in line item amount.
|
|
889
|
+
*/
|
|
890
|
+
amount: number;
|
|
891
|
+
/**
|
|
892
|
+
* The margin that was applied to get this margin amount.
|
|
893
|
+
*/
|
|
894
|
+
margin: string | Margin;
|
|
895
|
+
}
|
|
769
896
|
interface TotalPretaxCreditAmount {
|
|
770
897
|
/**
|
|
771
898
|
* The amount, in cents (or local equivalent), of the pretax credit amount.
|
|
@@ -779,6 +906,10 @@ export declare namespace Invoice {
|
|
|
779
906
|
* The discount that was applied to get this pretax credit amount.
|
|
780
907
|
*/
|
|
781
908
|
discount?: string | Discount | DeletedDiscount;
|
|
909
|
+
/**
|
|
910
|
+
* The margin that was applied to get this pretax credit amount.
|
|
911
|
+
*/
|
|
912
|
+
margin?: string | Margin;
|
|
782
913
|
/**
|
|
783
914
|
* Type of the pretax credit amount referenced.
|
|
784
915
|
*/
|
|
@@ -810,6 +941,9 @@ export declare namespace Invoice {
|
|
|
810
941
|
*/
|
|
811
942
|
type: 'tax_rate_details';
|
|
812
943
|
}
|
|
944
|
+
namespace AmountsDue {
|
|
945
|
+
type Status = 'open' | 'paid' | 'past_due';
|
|
946
|
+
}
|
|
813
947
|
namespace AutomaticTax {
|
|
814
948
|
type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error' | OtherString;
|
|
815
949
|
interface Liability {
|
|
@@ -824,32 +958,52 @@ export declare namespace Invoice {
|
|
|
824
958
|
}
|
|
825
959
|
type Status = 'complete' | 'failed' | 'requires_location_inputs' | OtherString;
|
|
826
960
|
namespace Liability {
|
|
827
|
-
type Type = 'account' | 'self' | OtherString;
|
|
961
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
828
962
|
}
|
|
829
963
|
}
|
|
830
964
|
namespace CustomerTaxId {
|
|
831
965
|
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' | 'ic_nif' | '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
966
|
}
|
|
833
967
|
namespace Issuer {
|
|
834
|
-
type Type = 'account' | 'self' | OtherString;
|
|
968
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
835
969
|
}
|
|
836
970
|
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';
|
|
971
|
+
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
972
|
type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
|
|
839
973
|
}
|
|
840
974
|
namespace Parent {
|
|
975
|
+
interface BillingCadenceDetails {
|
|
976
|
+
/**
|
|
977
|
+
* The billing cadence that generated this invoice
|
|
978
|
+
*/
|
|
979
|
+
billing_cadence: string;
|
|
980
|
+
}
|
|
841
981
|
interface QuoteDetails {
|
|
842
982
|
/**
|
|
843
983
|
* The quote that generated this invoice
|
|
844
984
|
*/
|
|
845
985
|
quote: string;
|
|
846
986
|
}
|
|
987
|
+
interface ScheduleDetails {
|
|
988
|
+
/**
|
|
989
|
+
* The schedule that generated this invoice
|
|
990
|
+
*/
|
|
991
|
+
schedule: string;
|
|
992
|
+
/**
|
|
993
|
+
* The subscription associated with this schedule
|
|
994
|
+
*/
|
|
995
|
+
subscription: string | Subscription | null;
|
|
996
|
+
}
|
|
847
997
|
interface SubscriptionDetails {
|
|
848
998
|
/**
|
|
849
999
|
* 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
1000
|
* *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
|
|
851
1001
|
*/
|
|
852
1002
|
metadata: Metadata | null;
|
|
1003
|
+
/**
|
|
1004
|
+
* 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).
|
|
1005
|
+
*/
|
|
1006
|
+
pause_collection?: SubscriptionDetails.PauseCollection | null;
|
|
853
1007
|
/**
|
|
854
1008
|
* The subscription that generated this invoice
|
|
855
1009
|
*/
|
|
@@ -859,7 +1013,22 @@ export declare namespace Invoice {
|
|
|
859
1013
|
*/
|
|
860
1014
|
subscription_proration_date?: number;
|
|
861
1015
|
}
|
|
862
|
-
type Type = 'quote_details' | 'subscription_details' | OtherString;
|
|
1016
|
+
type Type = 'billing_cadence_details' | 'quote_details' | 'schedule_details' | 'subscription_details' | OtherString;
|
|
1017
|
+
namespace SubscriptionDetails {
|
|
1018
|
+
interface PauseCollection {
|
|
1019
|
+
/**
|
|
1020
|
+
* The payment collection behavior for this subscription while paused.
|
|
1021
|
+
*/
|
|
1022
|
+
behavior: PauseCollection.Behavior | null;
|
|
1023
|
+
/**
|
|
1024
|
+
* The time after which the subscription will resume collecting payments.
|
|
1025
|
+
*/
|
|
1026
|
+
resumes_at: number | null;
|
|
1027
|
+
}
|
|
1028
|
+
namespace PauseCollection {
|
|
1029
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1030
|
+
}
|
|
1031
|
+
}
|
|
863
1032
|
}
|
|
864
1033
|
namespace PaymentSettings {
|
|
865
1034
|
interface PaymentMethodOptions {
|
|
@@ -871,14 +1040,30 @@ export declare namespace Invoice {
|
|
|
871
1040
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
872
1041
|
*/
|
|
873
1042
|
bancontact: PaymentMethodOptions.Bancontact | null;
|
|
1043
|
+
/**
|
|
1044
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
1045
|
+
*/
|
|
1046
|
+
bizum?: PaymentMethodOptions.Bizum | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
1049
|
+
*/
|
|
1050
|
+
blik?: PaymentMethodOptions.Blik | null;
|
|
874
1051
|
/**
|
|
875
1052
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
876
1053
|
*/
|
|
877
1054
|
card: PaymentMethodOptions.Card | null;
|
|
1055
|
+
/**
|
|
1056
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
1057
|
+
*/
|
|
1058
|
+
check_scan?: PaymentMethodOptions.CheckScan | null;
|
|
878
1059
|
/**
|
|
879
1060
|
* 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
1061
|
*/
|
|
881
1062
|
customer_balance: PaymentMethodOptions.CustomerBalance | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* 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.
|
|
1065
|
+
*/
|
|
1066
|
+
id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
|
|
882
1067
|
/**
|
|
883
1068
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
884
1069
|
*/
|
|
@@ -903,8 +1088,12 @@ export declare namespace Invoice {
|
|
|
903
1088
|
* 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
1089
|
*/
|
|
905
1090
|
us_bank_account: PaymentMethodOptions.UsBankAccount | null;
|
|
1091
|
+
/**
|
|
1092
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
1093
|
+
*/
|
|
1094
|
+
wechat_pay?: PaymentMethodOptions.WechatPay | null;
|
|
906
1095
|
}
|
|
907
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | OtherString;
|
|
1096
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
|
|
908
1097
|
namespace PaymentMethodOptions {
|
|
909
1098
|
interface AcssDebit {
|
|
910
1099
|
mandate_options?: AcssDebit.MandateOptions;
|
|
@@ -919,6 +1108,10 @@ export declare namespace Invoice {
|
|
|
919
1108
|
*/
|
|
920
1109
|
preferred_language: Bancontact.PreferredLanguage;
|
|
921
1110
|
}
|
|
1111
|
+
interface Bizum {
|
|
1112
|
+
}
|
|
1113
|
+
interface Blik {
|
|
1114
|
+
}
|
|
922
1115
|
interface Card {
|
|
923
1116
|
installments?: Card.Installments;
|
|
924
1117
|
/**
|
|
@@ -926,6 +1119,8 @@ export declare namespace Invoice {
|
|
|
926
1119
|
*/
|
|
927
1120
|
request_three_d_secure: Card.RequestThreeDSecure | null;
|
|
928
1121
|
}
|
|
1122
|
+
interface CheckScan {
|
|
1123
|
+
}
|
|
929
1124
|
interface CustomerBalance {
|
|
930
1125
|
bank_transfer?: CustomerBalance.BankTransfer;
|
|
931
1126
|
/**
|
|
@@ -933,6 +1128,8 @@ export declare namespace Invoice {
|
|
|
933
1128
|
*/
|
|
934
1129
|
funding_type: 'bank_transfer' | null;
|
|
935
1130
|
}
|
|
1131
|
+
interface IdBankTransfer {
|
|
1132
|
+
}
|
|
936
1133
|
interface Konbini {
|
|
937
1134
|
}
|
|
938
1135
|
interface Payto {
|
|
@@ -960,6 +1157,16 @@ export declare namespace Invoice {
|
|
|
960
1157
|
*/
|
|
961
1158
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
962
1159
|
}
|
|
1160
|
+
interface WechatPay {
|
|
1161
|
+
/**
|
|
1162
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
1163
|
+
*/
|
|
1164
|
+
app_id?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* The client type that the end customer will pay from.
|
|
1167
|
+
*/
|
|
1168
|
+
client?: WechatPay.Client;
|
|
1169
|
+
}
|
|
963
1170
|
namespace AcssDebit {
|
|
964
1171
|
interface MandateOptions {
|
|
965
1172
|
/**
|
|
@@ -1069,14 +1276,21 @@ export declare namespace Invoice {
|
|
|
1069
1276
|
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
1070
1277
|
*/
|
|
1071
1278
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1279
|
+
/**
|
|
1280
|
+
* The institution to use to filter for possible accounts to link.
|
|
1281
|
+
*/
|
|
1282
|
+
institution?: string;
|
|
1072
1283
|
}
|
|
1073
1284
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions' | OtherString;
|
|
1074
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
|
|
1285
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
|
|
1075
1286
|
namespace Filters {
|
|
1076
1287
|
type AccountSubcategory = 'checking' | 'savings' | OtherString;
|
|
1077
1288
|
}
|
|
1078
1289
|
}
|
|
1079
1290
|
}
|
|
1291
|
+
namespace WechatPay {
|
|
1292
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
1293
|
+
}
|
|
1080
1294
|
}
|
|
1081
1295
|
}
|
|
1082
1296
|
namespace Rendering {
|
|
@@ -1128,7 +1342,7 @@ export declare namespace Invoice {
|
|
|
1128
1342
|
}
|
|
1129
1343
|
}
|
|
1130
1344
|
namespace TotalPretaxCreditAmount {
|
|
1131
|
-
type Type = 'credit_balance_transaction' | 'discount' | OtherString;
|
|
1345
|
+
type Type = 'credit_balance_transaction' | 'discount' | 'margin' | OtherString;
|
|
1132
1346
|
}
|
|
1133
1347
|
namespace TotalTax {
|
|
1134
1348
|
type TaxBehavior = 'exclusive' | 'inclusive';
|
|
@@ -1136,7 +1350,7 @@ export declare namespace Invoice {
|
|
|
1136
1350
|
/**
|
|
1137
1351
|
* ID of the tax rate
|
|
1138
1352
|
*/
|
|
1139
|
-
tax_rate: string;
|
|
1353
|
+
tax_rate: string | TaxRate;
|
|
1140
1354
|
}
|
|
1141
1355
|
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' | OtherString;
|
|
1142
1356
|
}
|
|
@@ -1146,6 +1360,10 @@ export interface InvoiceCreateParams {
|
|
|
1146
1360
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1147
1361
|
*/
|
|
1148
1362
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
1363
|
+
/**
|
|
1364
|
+
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
1365
|
+
*/
|
|
1366
|
+
amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
1149
1367
|
/**
|
|
1150
1368
|
* 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
1369
|
*/
|
|
@@ -1186,6 +1404,10 @@ export interface InvoiceCreateParams {
|
|
|
1186
1404
|
* The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
|
1187
1405
|
*/
|
|
1188
1406
|
days_until_due?: number;
|
|
1407
|
+
/**
|
|
1408
|
+
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
1409
|
+
*/
|
|
1410
|
+
default_margins?: Array<string>;
|
|
1189
1411
|
/**
|
|
1190
1412
|
* 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
1413
|
*/
|
|
@@ -1276,6 +1498,24 @@ export interface InvoiceCreateParams {
|
|
|
1276
1498
|
transfer_data?: InvoiceCreateParams.TransferData;
|
|
1277
1499
|
}
|
|
1278
1500
|
export declare namespace InvoiceCreateParams {
|
|
1501
|
+
interface AmountsDue {
|
|
1502
|
+
/**
|
|
1503
|
+
* The amount in cents (or local equivalent).
|
|
1504
|
+
*/
|
|
1505
|
+
amount: number;
|
|
1506
|
+
/**
|
|
1507
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
1508
|
+
*/
|
|
1509
|
+
days_until_due?: number;
|
|
1510
|
+
/**
|
|
1511
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1512
|
+
*/
|
|
1513
|
+
description: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* Date on which a payment plan's payment is due.
|
|
1516
|
+
*/
|
|
1517
|
+
due_date?: number;
|
|
1518
|
+
}
|
|
1279
1519
|
interface AutomaticTax {
|
|
1280
1520
|
/**
|
|
1281
1521
|
* 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 +1546,10 @@ export declare namespace InvoiceCreateParams {
|
|
|
1306
1546
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1307
1547
|
*/
|
|
1308
1548
|
discount?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Details to determine how long the discount should be applied for.
|
|
1551
|
+
*/
|
|
1552
|
+
discount_end?: Discount.DiscountEnd;
|
|
1309
1553
|
/**
|
|
1310
1554
|
* ID of the promotion code to create a new discount for.
|
|
1311
1555
|
*/
|
|
@@ -1410,11 +1654,43 @@ export declare namespace InvoiceCreateParams {
|
|
|
1410
1654
|
type: Liability.Type;
|
|
1411
1655
|
}
|
|
1412
1656
|
namespace Liability {
|
|
1413
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1657
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
namespace Discount {
|
|
1661
|
+
interface DiscountEnd {
|
|
1662
|
+
/**
|
|
1663
|
+
* Time span for the redeemed discount.
|
|
1664
|
+
*/
|
|
1665
|
+
duration?: DiscountEnd.Duration;
|
|
1666
|
+
/**
|
|
1667
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1668
|
+
*/
|
|
1669
|
+
timestamp?: number;
|
|
1670
|
+
/**
|
|
1671
|
+
* The type of calculation made to determine when the discount ends.
|
|
1672
|
+
*/
|
|
1673
|
+
type: DiscountEnd.Type;
|
|
1674
|
+
}
|
|
1675
|
+
namespace DiscountEnd {
|
|
1676
|
+
interface Duration {
|
|
1677
|
+
/**
|
|
1678
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1679
|
+
*/
|
|
1680
|
+
interval: Duration.Interval;
|
|
1681
|
+
/**
|
|
1682
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1683
|
+
*/
|
|
1684
|
+
interval_count: number;
|
|
1685
|
+
}
|
|
1686
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
1687
|
+
namespace Duration {
|
|
1688
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
1689
|
+
}
|
|
1414
1690
|
}
|
|
1415
1691
|
}
|
|
1416
1692
|
namespace Issuer {
|
|
1417
|
-
type Type = 'account' | 'self' | OtherString;
|
|
1693
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
1418
1694
|
}
|
|
1419
1695
|
namespace PaymentSettings {
|
|
1420
1696
|
interface PaymentMethodOptions {
|
|
@@ -1426,14 +1702,30 @@ export declare namespace InvoiceCreateParams {
|
|
|
1426
1702
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
1427
1703
|
*/
|
|
1428
1704
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
1705
|
+
/**
|
|
1706
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
1707
|
+
*/
|
|
1708
|
+
bizum?: Emptyable<PaymentMethodOptions.Bizum>;
|
|
1709
|
+
/**
|
|
1710
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
1711
|
+
*/
|
|
1712
|
+
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
1429
1713
|
/**
|
|
1430
1714
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
1431
1715
|
*/
|
|
1432
1716
|
card?: Emptyable<PaymentMethodOptions.Card>;
|
|
1717
|
+
/**
|
|
1718
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
1719
|
+
*/
|
|
1720
|
+
check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
|
|
1433
1721
|
/**
|
|
1434
1722
|
* 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
1723
|
*/
|
|
1436
1724
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
1725
|
+
/**
|
|
1726
|
+
* 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.
|
|
1727
|
+
*/
|
|
1728
|
+
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
1437
1729
|
/**
|
|
1438
1730
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1439
1731
|
*/
|
|
@@ -1458,8 +1750,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
1458
1750
|
* 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
1751
|
*/
|
|
1460
1752
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
1753
|
+
/**
|
|
1754
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
1755
|
+
*/
|
|
1756
|
+
wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
|
|
1461
1757
|
}
|
|
1462
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | OtherString;
|
|
1758
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
|
|
1463
1759
|
namespace PaymentMethodOptions {
|
|
1464
1760
|
interface AcssDebit {
|
|
1465
1761
|
/**
|
|
@@ -1477,6 +1773,10 @@ export declare namespace InvoiceCreateParams {
|
|
|
1477
1773
|
*/
|
|
1478
1774
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
1479
1775
|
}
|
|
1776
|
+
interface Bizum {
|
|
1777
|
+
}
|
|
1778
|
+
interface Blik {
|
|
1779
|
+
}
|
|
1480
1780
|
interface Card {
|
|
1481
1781
|
/**
|
|
1482
1782
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -1489,6 +1789,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
1489
1789
|
*/
|
|
1490
1790
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1491
1791
|
}
|
|
1792
|
+
interface CheckScan {
|
|
1793
|
+
}
|
|
1492
1794
|
interface CustomerBalance {
|
|
1493
1795
|
/**
|
|
1494
1796
|
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
|
@@ -1499,6 +1801,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
1499
1801
|
*/
|
|
1500
1802
|
funding_type?: string;
|
|
1501
1803
|
}
|
|
1804
|
+
interface IdBankTransfer {
|
|
1805
|
+
}
|
|
1502
1806
|
interface Konbini {
|
|
1503
1807
|
}
|
|
1504
1808
|
interface Payto {
|
|
@@ -1535,6 +1839,16 @@ export declare namespace InvoiceCreateParams {
|
|
|
1535
1839
|
*/
|
|
1536
1840
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
1537
1841
|
}
|
|
1842
|
+
interface WechatPay {
|
|
1843
|
+
/**
|
|
1844
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
1845
|
+
*/
|
|
1846
|
+
app_id?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* The client type that the end customer will pay from.
|
|
1849
|
+
*/
|
|
1850
|
+
client?: WechatPay.Client;
|
|
1851
|
+
}
|
|
1538
1852
|
namespace AcssDebit {
|
|
1539
1853
|
interface MandateOptions {
|
|
1540
1854
|
/**
|
|
@@ -1667,14 +1981,21 @@ export declare namespace InvoiceCreateParams {
|
|
|
1667
1981
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1668
1982
|
*/
|
|
1669
1983
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1984
|
+
/**
|
|
1985
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1986
|
+
*/
|
|
1987
|
+
institution?: string;
|
|
1670
1988
|
}
|
|
1671
1989
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1672
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
|
|
1990
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
|
|
1673
1991
|
namespace Filters {
|
|
1674
1992
|
type AccountSubcategory = 'checking' | 'savings' | OtherString;
|
|
1675
1993
|
}
|
|
1676
1994
|
}
|
|
1677
1995
|
}
|
|
1996
|
+
namespace WechatPay {
|
|
1997
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
1998
|
+
}
|
|
1678
1999
|
}
|
|
1679
2000
|
}
|
|
1680
2001
|
namespace Rendering {
|
|
@@ -1807,6 +2128,10 @@ export interface InvoiceUpdateParams {
|
|
|
1807
2128
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1808
2129
|
*/
|
|
1809
2130
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
2131
|
+
/**
|
|
2132
|
+
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
2133
|
+
*/
|
|
2134
|
+
amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
1810
2135
|
/**
|
|
1811
2136
|
* 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
2137
|
*/
|
|
@@ -1835,6 +2160,10 @@ export interface InvoiceUpdateParams {
|
|
|
1835
2160
|
* 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
2161
|
*/
|
|
1837
2162
|
days_until_due?: number;
|
|
2163
|
+
/**
|
|
2164
|
+
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
2165
|
+
*/
|
|
2166
|
+
default_margins?: Emptyable<Array<string>>;
|
|
1838
2167
|
/**
|
|
1839
2168
|
* 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
2169
|
*/
|
|
@@ -1913,6 +2242,24 @@ export interface InvoiceUpdateParams {
|
|
|
1913
2242
|
transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
|
|
1914
2243
|
}
|
|
1915
2244
|
export declare namespace InvoiceUpdateParams {
|
|
2245
|
+
interface AmountsDue {
|
|
2246
|
+
/**
|
|
2247
|
+
* The amount in cents (or local equivalent).
|
|
2248
|
+
*/
|
|
2249
|
+
amount: number;
|
|
2250
|
+
/**
|
|
2251
|
+
* Number of days from when invoice is finalized until the payment is due.
|
|
2252
|
+
*/
|
|
2253
|
+
days_until_due?: number;
|
|
2254
|
+
/**
|
|
2255
|
+
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
2256
|
+
*/
|
|
2257
|
+
description: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Date on which a payment plan's payment is due.
|
|
2260
|
+
*/
|
|
2261
|
+
due_date?: number;
|
|
2262
|
+
}
|
|
1916
2263
|
interface AutomaticTax {
|
|
1917
2264
|
/**
|
|
1918
2265
|
* 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 +2290,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
1943
2290
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1944
2291
|
*/
|
|
1945
2292
|
discount?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* Details to determine how long the discount should be applied for.
|
|
2295
|
+
*/
|
|
2296
|
+
discount_end?: Discount.DiscountEnd;
|
|
1946
2297
|
/**
|
|
1947
2298
|
* ID of the promotion code to create a new discount for.
|
|
1948
2299
|
*/
|
|
@@ -2036,11 +2387,43 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2036
2387
|
type: Liability.Type;
|
|
2037
2388
|
}
|
|
2038
2389
|
namespace Liability {
|
|
2039
|
-
type Type = 'account' | 'self' | OtherString;
|
|
2390
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
2391
|
+
}
|
|
2392
|
+
}
|
|
2393
|
+
namespace Discount {
|
|
2394
|
+
interface DiscountEnd {
|
|
2395
|
+
/**
|
|
2396
|
+
* Time span for the redeemed discount.
|
|
2397
|
+
*/
|
|
2398
|
+
duration?: DiscountEnd.Duration;
|
|
2399
|
+
/**
|
|
2400
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2401
|
+
*/
|
|
2402
|
+
timestamp?: number;
|
|
2403
|
+
/**
|
|
2404
|
+
* The type of calculation made to determine when the discount ends.
|
|
2405
|
+
*/
|
|
2406
|
+
type: DiscountEnd.Type;
|
|
2407
|
+
}
|
|
2408
|
+
namespace DiscountEnd {
|
|
2409
|
+
interface Duration {
|
|
2410
|
+
/**
|
|
2411
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2412
|
+
*/
|
|
2413
|
+
interval: Duration.Interval;
|
|
2414
|
+
/**
|
|
2415
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2416
|
+
*/
|
|
2417
|
+
interval_count: number;
|
|
2418
|
+
}
|
|
2419
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
2420
|
+
namespace Duration {
|
|
2421
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
2422
|
+
}
|
|
2040
2423
|
}
|
|
2041
2424
|
}
|
|
2042
2425
|
namespace Issuer {
|
|
2043
|
-
type Type = 'account' | 'self' | OtherString;
|
|
2426
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
2044
2427
|
}
|
|
2045
2428
|
namespace PaymentSettings {
|
|
2046
2429
|
interface PaymentMethodOptions {
|
|
@@ -2052,14 +2435,30 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2052
2435
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
2053
2436
|
*/
|
|
2054
2437
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
2438
|
+
/**
|
|
2439
|
+
* If paying by `bizum`, this sub-hash contains details about the Bizum payment method options to pass to the invoice's PaymentIntent.
|
|
2440
|
+
*/
|
|
2441
|
+
bizum?: Emptyable<PaymentMethodOptions.Bizum>;
|
|
2442
|
+
/**
|
|
2443
|
+
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
2444
|
+
*/
|
|
2445
|
+
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
2055
2446
|
/**
|
|
2056
2447
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
2057
2448
|
*/
|
|
2058
2449
|
card?: Emptyable<PaymentMethodOptions.Card>;
|
|
2450
|
+
/**
|
|
2451
|
+
* If paying by `check_scan`, this sub-hash contains details about the Check Scan payment method options to pass to the invoice's PaymentIntent.
|
|
2452
|
+
*/
|
|
2453
|
+
check_scan?: Emptyable<PaymentMethodOptions.CheckScan>;
|
|
2059
2454
|
/**
|
|
2060
2455
|
* 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
2456
|
*/
|
|
2062
2457
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
2458
|
+
/**
|
|
2459
|
+
* 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.
|
|
2460
|
+
*/
|
|
2461
|
+
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
2063
2462
|
/**
|
|
2064
2463
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
2065
2464
|
*/
|
|
@@ -2084,8 +2483,12 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2084
2483
|
* 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
2484
|
*/
|
|
2086
2485
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
2486
|
+
/**
|
|
2487
|
+
* If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the invoice's PaymentIntent.
|
|
2488
|
+
*/
|
|
2489
|
+
wechat_pay?: Emptyable<PaymentMethodOptions.WechatPay>;
|
|
2087
2490
|
}
|
|
2088
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | OtherString;
|
|
2491
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'alipay' | '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' | 'mb_way' | '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' | 'sequra' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | OtherString;
|
|
2089
2492
|
namespace PaymentMethodOptions {
|
|
2090
2493
|
interface AcssDebit {
|
|
2091
2494
|
/**
|
|
@@ -2103,6 +2506,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2103
2506
|
*/
|
|
2104
2507
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
2105
2508
|
}
|
|
2509
|
+
interface Bizum {
|
|
2510
|
+
}
|
|
2511
|
+
interface Blik {
|
|
2512
|
+
}
|
|
2106
2513
|
interface Card {
|
|
2107
2514
|
/**
|
|
2108
2515
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -2115,6 +2522,8 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2115
2522
|
*/
|
|
2116
2523
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
2117
2524
|
}
|
|
2525
|
+
interface CheckScan {
|
|
2526
|
+
}
|
|
2118
2527
|
interface CustomerBalance {
|
|
2119
2528
|
/**
|
|
2120
2529
|
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
|
@@ -2125,6 +2534,8 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2125
2534
|
*/
|
|
2126
2535
|
funding_type?: string;
|
|
2127
2536
|
}
|
|
2537
|
+
interface IdBankTransfer {
|
|
2538
|
+
}
|
|
2128
2539
|
interface Konbini {
|
|
2129
2540
|
}
|
|
2130
2541
|
interface Payto {
|
|
@@ -2161,6 +2572,16 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2161
2572
|
*/
|
|
2162
2573
|
verification_method?: UsBankAccount.VerificationMethod;
|
|
2163
2574
|
}
|
|
2575
|
+
interface WechatPay {
|
|
2576
|
+
/**
|
|
2577
|
+
* The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
|
|
2578
|
+
*/
|
|
2579
|
+
app_id?: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* The client type that the end customer will pay from.
|
|
2582
|
+
*/
|
|
2583
|
+
client?: WechatPay.Client;
|
|
2584
|
+
}
|
|
2164
2585
|
namespace AcssDebit {
|
|
2165
2586
|
interface MandateOptions {
|
|
2166
2587
|
/**
|
|
@@ -2293,14 +2714,21 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2293
2714
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2294
2715
|
*/
|
|
2295
2716
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2717
|
+
/**
|
|
2718
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
2719
|
+
*/
|
|
2720
|
+
institution?: string;
|
|
2296
2721
|
}
|
|
2297
2722
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
2298
|
-
type Prefetch = 'balances' | 'ownership' | 'transactions' | OtherString;
|
|
2723
|
+
type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions' | OtherString;
|
|
2299
2724
|
namespace Filters {
|
|
2300
2725
|
type AccountSubcategory = 'checking' | 'savings' | OtherString;
|
|
2301
2726
|
}
|
|
2302
2727
|
}
|
|
2303
2728
|
}
|
|
2729
|
+
namespace WechatPay {
|
|
2730
|
+
type Client = 'android' | 'ios' | 'mobile_web' | 'web';
|
|
2731
|
+
}
|
|
2304
2732
|
}
|
|
2305
2733
|
}
|
|
2306
2734
|
namespace Rendering {
|
|
@@ -2423,6 +2851,10 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2423
2851
|
}
|
|
2424
2852
|
}
|
|
2425
2853
|
export interface InvoiceListParams extends PaginationParams {
|
|
2854
|
+
/**
|
|
2855
|
+
* Only return invoices for the cadence specified by this billing cadence ID.
|
|
2856
|
+
*/
|
|
2857
|
+
billing_cadence?: string;
|
|
2426
2858
|
/**
|
|
2427
2859
|
* The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
|
|
2428
2860
|
*/
|
|
@@ -2497,6 +2929,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2497
2929
|
* ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
|
2498
2930
|
*/
|
|
2499
2931
|
invoice_item?: string;
|
|
2932
|
+
/**
|
|
2933
|
+
* 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.
|
|
2934
|
+
*/
|
|
2935
|
+
margins?: Emptyable<Array<string>>;
|
|
2500
2936
|
/**
|
|
2501
2937
|
* 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
2938
|
*/
|
|
@@ -2540,6 +2976,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2540
2976
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2541
2977
|
*/
|
|
2542
2978
|
discount?: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* Details to determine how long the discount should be applied for.
|
|
2981
|
+
*/
|
|
2982
|
+
discount_end?: Discount.DiscountEnd;
|
|
2543
2983
|
/**
|
|
2544
2984
|
* ID of the promotion code to create a new discount for.
|
|
2545
2985
|
*/
|
|
@@ -2607,6 +3047,38 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2607
3047
|
*/
|
|
2608
3048
|
taxable_amount: number;
|
|
2609
3049
|
}
|
|
3050
|
+
namespace Discount {
|
|
3051
|
+
interface DiscountEnd {
|
|
3052
|
+
/**
|
|
3053
|
+
* Time span for the redeemed discount.
|
|
3054
|
+
*/
|
|
3055
|
+
duration?: DiscountEnd.Duration;
|
|
3056
|
+
/**
|
|
3057
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3058
|
+
*/
|
|
3059
|
+
timestamp?: number;
|
|
3060
|
+
/**
|
|
3061
|
+
* The type of calculation made to determine when the discount ends.
|
|
3062
|
+
*/
|
|
3063
|
+
type: DiscountEnd.Type;
|
|
3064
|
+
}
|
|
3065
|
+
namespace DiscountEnd {
|
|
3066
|
+
interface Duration {
|
|
3067
|
+
/**
|
|
3068
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3069
|
+
*/
|
|
3070
|
+
interval: Duration.Interval;
|
|
3071
|
+
/**
|
|
3072
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3073
|
+
*/
|
|
3074
|
+
interval_count: number;
|
|
3075
|
+
}
|
|
3076
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3077
|
+
namespace Duration {
|
|
3078
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3079
|
+
}
|
|
3080
|
+
}
|
|
3081
|
+
}
|
|
2610
3082
|
namespace PriceData {
|
|
2611
3083
|
interface ProductData {
|
|
2612
3084
|
/**
|
|
@@ -2629,12 +3101,28 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2629
3101
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2630
3102
|
*/
|
|
2631
3103
|
tax_code?: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
3106
|
+
*/
|
|
3107
|
+
tax_details?: ProductData.TaxDetails;
|
|
2632
3108
|
/**
|
|
2633
3109
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
2634
3110
|
*/
|
|
2635
3111
|
unit_label?: string;
|
|
2636
3112
|
}
|
|
2637
3113
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3114
|
+
namespace ProductData {
|
|
3115
|
+
interface TaxDetails {
|
|
3116
|
+
/**
|
|
3117
|
+
* 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.
|
|
3118
|
+
*/
|
|
3119
|
+
performance_location?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3122
|
+
*/
|
|
3123
|
+
tax_code?: Emptyable<string>;
|
|
3124
|
+
}
|
|
3125
|
+
}
|
|
2638
3126
|
}
|
|
2639
3127
|
namespace TaxAmount {
|
|
2640
3128
|
interface TaxRateData {
|
|
@@ -2684,6 +3172,10 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2684
3172
|
}
|
|
2685
3173
|
}
|
|
2686
3174
|
export interface InvoiceAttachPaymentParams {
|
|
3175
|
+
/**
|
|
3176
|
+
* The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
|
3177
|
+
*/
|
|
3178
|
+
amount_requested?: number;
|
|
2687
3179
|
/**
|
|
2688
3180
|
* Specifies which fields in the response should be expanded.
|
|
2689
3181
|
*/
|
|
@@ -2696,12 +3188,48 @@ export interface InvoiceAttachPaymentParams {
|
|
|
2696
3188
|
* The ID of the PaymentRecord to attach to the invoice.
|
|
2697
3189
|
*/
|
|
2698
3190
|
payment_record?: string;
|
|
3191
|
+
/**
|
|
3192
|
+
* The PaymentRecord data for attaching an out of band payment to the invoice.
|
|
3193
|
+
*/
|
|
3194
|
+
payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
|
|
3195
|
+
}
|
|
3196
|
+
export declare namespace InvoiceAttachPaymentParams {
|
|
3197
|
+
interface PaymentRecordData {
|
|
3198
|
+
/**
|
|
3199
|
+
* The amount that was paid out of band.
|
|
3200
|
+
*/
|
|
3201
|
+
amount: number;
|
|
3202
|
+
/**
|
|
3203
|
+
* The currency that was paid out of band.
|
|
3204
|
+
*/
|
|
3205
|
+
currency: string;
|
|
3206
|
+
/**
|
|
3207
|
+
* 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`.
|
|
3208
|
+
*/
|
|
3209
|
+
metadata?: Emptyable<MetadataParam>;
|
|
3210
|
+
/**
|
|
3211
|
+
* The type of money movement for this out of band payment record.
|
|
3212
|
+
*/
|
|
3213
|
+
money_movement_type: string;
|
|
3214
|
+
/**
|
|
3215
|
+
* The timestamp when this out of band payment was paid.
|
|
3216
|
+
*/
|
|
3217
|
+
paid_at?: number;
|
|
3218
|
+
/**
|
|
3219
|
+
* The reference for this out of band payment record.
|
|
3220
|
+
*/
|
|
3221
|
+
payment_reference?: string;
|
|
3222
|
+
}
|
|
2699
3223
|
}
|
|
2700
3224
|
export interface InvoiceCreatePreviewParams {
|
|
2701
3225
|
/**
|
|
2702
3226
|
* Settings for automatic tax lookup for this invoice preview.
|
|
2703
3227
|
*/
|
|
2704
3228
|
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
|
|
3229
|
+
/**
|
|
3230
|
+
* 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.
|
|
3231
|
+
*/
|
|
3232
|
+
billing_cadence?: string;
|
|
2705
3233
|
/**
|
|
2706
3234
|
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
|
2707
3235
|
*/
|
|
@@ -2801,10 +3329,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2801
3329
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2802
3330
|
*/
|
|
2803
3331
|
discount?: string;
|
|
3332
|
+
/**
|
|
3333
|
+
* Details to determine how long the discount should be applied for.
|
|
3334
|
+
*/
|
|
3335
|
+
discount_end?: Discount.DiscountEnd;
|
|
2804
3336
|
/**
|
|
2805
3337
|
* ID of the promotion code to create a new discount for.
|
|
2806
3338
|
*/
|
|
2807
3339
|
promotion_code?: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Settings for discount application including service period anchoring.
|
|
3342
|
+
*/
|
|
3343
|
+
settings?: Discount.Settings;
|
|
2808
3344
|
}
|
|
2809
3345
|
interface InvoiceItem {
|
|
2810
3346
|
/**
|
|
@@ -2889,9 +3425,25 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2889
3425
|
type PreviewMode = 'next' | 'recurring' | OtherString;
|
|
2890
3426
|
interface ScheduleDetails {
|
|
2891
3427
|
/**
|
|
2892
|
-
*
|
|
3428
|
+
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
3429
|
+
*/
|
|
3430
|
+
amendments?: Array<ScheduleDetails.Amendment>;
|
|
3431
|
+
/**
|
|
3432
|
+
* 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.
|
|
3433
|
+
*/
|
|
3434
|
+
billing_behavior?: ScheduleDetails.BillingBehavior;
|
|
3435
|
+
/**
|
|
3436
|
+
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
2893
3437
|
*/
|
|
2894
3438
|
billing_mode?: ScheduleDetails.BillingMode;
|
|
3439
|
+
/**
|
|
3440
|
+
* Sets the billing schedules for the subscription schedule.
|
|
3441
|
+
*/
|
|
3442
|
+
billing_schedules?: Emptyable<Array<ScheduleDetails.BillingSchedule>>;
|
|
3443
|
+
/**
|
|
3444
|
+
* Object representing the subscription schedule's default settings.
|
|
3445
|
+
*/
|
|
3446
|
+
default_settings?: ScheduleDetails.DefaultSettings;
|
|
2895
3447
|
/**
|
|
2896
3448
|
* 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
3449
|
*/
|
|
@@ -2900,6 +3452,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2900
3452
|
* 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
3453
|
*/
|
|
2902
3454
|
phases?: Array<ScheduleDetails.Phase>;
|
|
3455
|
+
/**
|
|
3456
|
+
* Provide any time periods to bill in advance.
|
|
3457
|
+
*/
|
|
3458
|
+
prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
|
|
2903
3459
|
/**
|
|
2904
3460
|
* 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
3461
|
*/
|
|
@@ -2942,6 +3498,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2942
3498
|
* 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`.
|
|
2943
3499
|
*/
|
|
2944
3500
|
metadata?: Emptyable<MetadataParam>;
|
|
3501
|
+
/**
|
|
3502
|
+
* 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.
|
|
3503
|
+
*
|
|
3504
|
+
* To receive a preview invoice, set `invoicing_behavior` to `invoice`. A preview isn't available if the `bill_for` options produce no billable amounts.
|
|
3505
|
+
*
|
|
3506
|
+
* `pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.
|
|
3507
|
+
*/
|
|
3508
|
+
pause?: SubscriptionDetails.Pause;
|
|
3509
|
+
/**
|
|
3510
|
+
* The pre-billing to apply to the subscription as a preview.
|
|
3511
|
+
*/
|
|
3512
|
+
prebilling?: SubscriptionDetails.Prebilling;
|
|
2945
3513
|
/**
|
|
2946
3514
|
* 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`.
|
|
2947
3515
|
*/
|
|
@@ -2975,7 +3543,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
2975
3543
|
type: Liability.Type;
|
|
2976
3544
|
}
|
|
2977
3545
|
namespace Liability {
|
|
2978
|
-
type Type = 'account' | 'self' | OtherString;
|
|
3546
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
2979
3547
|
}
|
|
2980
3548
|
}
|
|
2981
3549
|
namespace CustomerDetails {
|
|
@@ -3014,6 +3582,86 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3014
3582
|
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' | 'ic_nif' | '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';
|
|
3015
3583
|
}
|
|
3016
3584
|
}
|
|
3585
|
+
namespace Discount {
|
|
3586
|
+
interface DiscountEnd {
|
|
3587
|
+
/**
|
|
3588
|
+
* Time span for the redeemed discount.
|
|
3589
|
+
*/
|
|
3590
|
+
duration?: DiscountEnd.Duration;
|
|
3591
|
+
/**
|
|
3592
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3593
|
+
*/
|
|
3594
|
+
timestamp?: number;
|
|
3595
|
+
/**
|
|
3596
|
+
* The type of calculation made to determine when the discount ends.
|
|
3597
|
+
*/
|
|
3598
|
+
type: DiscountEnd.Type;
|
|
3599
|
+
}
|
|
3600
|
+
interface Settings {
|
|
3601
|
+
/**
|
|
3602
|
+
* Configures service period cycle anchoring.
|
|
3603
|
+
*/
|
|
3604
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3605
|
+
/**
|
|
3606
|
+
* 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.
|
|
3607
|
+
*/
|
|
3608
|
+
start_date?: Settings.StartDate;
|
|
3609
|
+
}
|
|
3610
|
+
namespace DiscountEnd {
|
|
3611
|
+
interface Duration {
|
|
3612
|
+
/**
|
|
3613
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3614
|
+
*/
|
|
3615
|
+
interval: Duration.Interval;
|
|
3616
|
+
/**
|
|
3617
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3618
|
+
*/
|
|
3619
|
+
interval_count: number;
|
|
3620
|
+
}
|
|
3621
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3622
|
+
namespace Duration {
|
|
3623
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3624
|
+
}
|
|
3625
|
+
}
|
|
3626
|
+
namespace Settings {
|
|
3627
|
+
interface ServicePeriodAnchorConfig {
|
|
3628
|
+
/**
|
|
3629
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3630
|
+
*/
|
|
3631
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3632
|
+
/**
|
|
3633
|
+
* The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
|
|
3634
|
+
*/
|
|
3635
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
3636
|
+
}
|
|
3637
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'now' | OtherString;
|
|
3638
|
+
namespace ServicePeriodAnchorConfig {
|
|
3639
|
+
interface Custom {
|
|
3640
|
+
/**
|
|
3641
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3642
|
+
*/
|
|
3643
|
+
day_of_month: number;
|
|
3644
|
+
/**
|
|
3645
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3646
|
+
*/
|
|
3647
|
+
hour?: number;
|
|
3648
|
+
/**
|
|
3649
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3650
|
+
*/
|
|
3651
|
+
minute?: number;
|
|
3652
|
+
/**
|
|
3653
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3654
|
+
*/
|
|
3655
|
+
month?: number;
|
|
3656
|
+
/**
|
|
3657
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3658
|
+
*/
|
|
3659
|
+
second?: number;
|
|
3660
|
+
}
|
|
3661
|
+
type Type = 'custom' | 'subscription_service_cycle_anchor' | OtherString;
|
|
3662
|
+
}
|
|
3663
|
+
}
|
|
3664
|
+
}
|
|
3017
3665
|
namespace InvoiceItem {
|
|
3018
3666
|
interface Discount {
|
|
3019
3667
|
/**
|
|
@@ -3024,6 +3672,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3024
3672
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3025
3673
|
*/
|
|
3026
3674
|
discount?: string;
|
|
3675
|
+
/**
|
|
3676
|
+
* Details to determine how long the discount should be applied for.
|
|
3677
|
+
*/
|
|
3678
|
+
discount_end?: Discount.DiscountEnd;
|
|
3027
3679
|
/**
|
|
3028
3680
|
* ID of the promotion code to create a new discount for.
|
|
3029
3681
|
*/
|
|
@@ -3062,14 +3714,97 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3062
3714
|
unit_amount_decimal?: Decimal;
|
|
3063
3715
|
}
|
|
3064
3716
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3717
|
+
namespace Discount {
|
|
3718
|
+
interface DiscountEnd {
|
|
3719
|
+
/**
|
|
3720
|
+
* Time span for the redeemed discount.
|
|
3721
|
+
*/
|
|
3722
|
+
duration?: DiscountEnd.Duration;
|
|
3723
|
+
/**
|
|
3724
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3725
|
+
*/
|
|
3726
|
+
timestamp?: number;
|
|
3727
|
+
/**
|
|
3728
|
+
* The type of calculation made to determine when the discount ends.
|
|
3729
|
+
*/
|
|
3730
|
+
type: DiscountEnd.Type;
|
|
3731
|
+
}
|
|
3732
|
+
namespace DiscountEnd {
|
|
3733
|
+
interface Duration {
|
|
3734
|
+
/**
|
|
3735
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3736
|
+
*/
|
|
3737
|
+
interval: Duration.Interval;
|
|
3738
|
+
/**
|
|
3739
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3740
|
+
*/
|
|
3741
|
+
interval_count: number;
|
|
3742
|
+
}
|
|
3743
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
3744
|
+
namespace Duration {
|
|
3745
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
3746
|
+
}
|
|
3747
|
+
}
|
|
3748
|
+
}
|
|
3065
3749
|
namespace PriceData {
|
|
3066
3750
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3067
3751
|
}
|
|
3068
3752
|
}
|
|
3069
3753
|
namespace Issuer {
|
|
3070
|
-
type Type = 'account' | 'self' | OtherString;
|
|
3754
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
3071
3755
|
}
|
|
3072
3756
|
namespace ScheduleDetails {
|
|
3757
|
+
interface Amendment {
|
|
3758
|
+
/**
|
|
3759
|
+
* 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.
|
|
3760
|
+
*/
|
|
3761
|
+
amendment_end?: Amendment.AmendmentEnd;
|
|
3762
|
+
/**
|
|
3763
|
+
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
3764
|
+
*/
|
|
3765
|
+
amendment_start: Amendment.AmendmentStart;
|
|
3766
|
+
/**
|
|
3767
|
+
* 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.
|
|
3768
|
+
*/
|
|
3769
|
+
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
3770
|
+
/**
|
|
3771
|
+
* Actions to apply to the billing schedules.
|
|
3772
|
+
*/
|
|
3773
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
3774
|
+
/**
|
|
3775
|
+
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
3776
|
+
*/
|
|
3777
|
+
discount_actions?: Array<Amendment.DiscountAction>;
|
|
3778
|
+
/**
|
|
3779
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3780
|
+
*/
|
|
3781
|
+
effective_at?: Amendment.EffectiveAt;
|
|
3782
|
+
/**
|
|
3783
|
+
* Changes to the subscription items during the amendment time span.
|
|
3784
|
+
*/
|
|
3785
|
+
item_actions?: Array<Amendment.ItemAction>;
|
|
3786
|
+
/**
|
|
3787
|
+
* Instructions for how to modify phase metadata
|
|
3788
|
+
*/
|
|
3789
|
+
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
3790
|
+
/**
|
|
3791
|
+
* 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`.
|
|
3792
|
+
*/
|
|
3793
|
+
proration_behavior?: Amendment.ProrationBehavior;
|
|
3794
|
+
/**
|
|
3795
|
+
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3796
|
+
*/
|
|
3797
|
+
set_pause_collection?: Amendment.SetPauseCollection;
|
|
3798
|
+
/**
|
|
3799
|
+
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
3800
|
+
*/
|
|
3801
|
+
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
3802
|
+
/**
|
|
3803
|
+
* Settings related to subscription trials.
|
|
3804
|
+
*/
|
|
3805
|
+
trial_settings?: Amendment.TrialSettings;
|
|
3806
|
+
}
|
|
3807
|
+
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3073
3808
|
interface BillingMode {
|
|
3074
3809
|
/**
|
|
3075
3810
|
* Configure behavior for flexible billing mode.
|
|
@@ -3080,6 +3815,26 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3080
3815
|
*/
|
|
3081
3816
|
type: BillingMode.Type;
|
|
3082
3817
|
}
|
|
3818
|
+
interface BillingSchedule {
|
|
3819
|
+
/**
|
|
3820
|
+
* Configure billing schedule differently for individual subscription items.
|
|
3821
|
+
*/
|
|
3822
|
+
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
3823
|
+
/**
|
|
3824
|
+
* The end date for the billing schedule.
|
|
3825
|
+
*/
|
|
3826
|
+
bill_until?: BillingSchedule.BillUntil;
|
|
3827
|
+
/**
|
|
3828
|
+
* 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.
|
|
3829
|
+
*/
|
|
3830
|
+
key?: string;
|
|
3831
|
+
}
|
|
3832
|
+
interface DefaultSettings {
|
|
3833
|
+
/**
|
|
3834
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3835
|
+
*/
|
|
3836
|
+
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
3837
|
+
}
|
|
3083
3838
|
type EndBehavior = 'cancel' | 'release';
|
|
3084
3839
|
interface Phase {
|
|
3085
3840
|
/**
|
|
@@ -3130,6 +3885,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3130
3885
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
3131
3886
|
*/
|
|
3132
3887
|
duration?: Phase.Duration;
|
|
3888
|
+
/**
|
|
3889
|
+
* Configures how the subscription schedule handles billing for phase transitions.
|
|
3890
|
+
*/
|
|
3891
|
+
effective_at?: Phase.EffectiveAt;
|
|
3133
3892
|
/**
|
|
3134
3893
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
3135
3894
|
*/
|
|
@@ -3150,6 +3909,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3150
3909
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
3151
3910
|
*/
|
|
3152
3911
|
on_behalf_of?: string;
|
|
3912
|
+
/**
|
|
3913
|
+
* 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).
|
|
3914
|
+
*/
|
|
3915
|
+
pause_collection?: Phase.PauseCollection;
|
|
3153
3916
|
/**
|
|
3154
3917
|
* 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.
|
|
3155
3918
|
*/
|
|
@@ -3166,12 +3929,702 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3166
3929
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
3167
3930
|
*/
|
|
3168
3931
|
trial?: boolean;
|
|
3932
|
+
/**
|
|
3933
|
+
* Specify trial behavior when crossing phase boundaries
|
|
3934
|
+
*/
|
|
3935
|
+
trial_continuation?: Phase.TrialContinuation;
|
|
3169
3936
|
/**
|
|
3170
3937
|
* Sets the phase to trialing from the start date to this date. Must be within the phase. When previewing an update, if combined with `trial=true`, it must match the phase end date.
|
|
3171
3938
|
*/
|
|
3172
3939
|
trial_end?: number | 'now';
|
|
3940
|
+
/**
|
|
3941
|
+
* Settings related to subscription trials.
|
|
3942
|
+
*/
|
|
3943
|
+
trial_settings?: Phase.TrialSettings;
|
|
3944
|
+
}
|
|
3945
|
+
interface Prebilling {
|
|
3946
|
+
/**
|
|
3947
|
+
* The end of the prebilled time period.
|
|
3948
|
+
*/
|
|
3949
|
+
bill_until?: Prebilling.BillUntil;
|
|
3950
|
+
/**
|
|
3951
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
3952
|
+
*/
|
|
3953
|
+
iterations?: number;
|
|
3173
3954
|
}
|
|
3174
3955
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3956
|
+
namespace Amendment {
|
|
3957
|
+
interface AmendmentEnd {
|
|
3958
|
+
/**
|
|
3959
|
+
* Use the `end` time of a given discount.
|
|
3960
|
+
*/
|
|
3961
|
+
discount_end?: AmendmentEnd.DiscountEnd;
|
|
3962
|
+
/**
|
|
3963
|
+
* Time span for the amendment starting from the `amendment_start`.
|
|
3964
|
+
*/
|
|
3965
|
+
duration?: AmendmentEnd.Duration;
|
|
3966
|
+
/**
|
|
3967
|
+
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
3968
|
+
*/
|
|
3969
|
+
timestamp?: number;
|
|
3970
|
+
/**
|
|
3971
|
+
* Select one of three ways to pass the `amendment_end`.
|
|
3972
|
+
*/
|
|
3973
|
+
type: AmendmentEnd.Type;
|
|
3974
|
+
}
|
|
3975
|
+
interface AmendmentStart {
|
|
3976
|
+
/**
|
|
3977
|
+
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
3978
|
+
*/
|
|
3979
|
+
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
3980
|
+
/**
|
|
3981
|
+
* Use the `end` time of a given discount.
|
|
3982
|
+
*/
|
|
3983
|
+
discount_end?: AmendmentStart.DiscountEnd;
|
|
3984
|
+
/**
|
|
3985
|
+
* A precise Unix timestamp for the amendment to start.
|
|
3986
|
+
*/
|
|
3987
|
+
timestamp?: number;
|
|
3988
|
+
/**
|
|
3989
|
+
* Select one of three ways to pass the `amendment_start`.
|
|
3990
|
+
*/
|
|
3991
|
+
type: AmendmentStart.Type;
|
|
3992
|
+
}
|
|
3993
|
+
type BillingCycleAnchor = 'amendment_start' | 'automatic' | OtherString;
|
|
3994
|
+
interface BillingSchedulesAction {
|
|
3995
|
+
/**
|
|
3996
|
+
* Specify which subscription items the billing schedule applies to.
|
|
3997
|
+
*/
|
|
3998
|
+
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
3999
|
+
/**
|
|
4000
|
+
* Select the action.
|
|
4001
|
+
*/
|
|
4002
|
+
type: BillingSchedulesAction.Type;
|
|
4003
|
+
}
|
|
4004
|
+
interface DiscountAction {
|
|
4005
|
+
/**
|
|
4006
|
+
* Details of the discount to add.
|
|
4007
|
+
*/
|
|
4008
|
+
add?: DiscountAction.Add;
|
|
4009
|
+
/**
|
|
4010
|
+
* Details of the discount to remove.
|
|
4011
|
+
*/
|
|
4012
|
+
remove?: DiscountAction.Remove;
|
|
4013
|
+
/**
|
|
4014
|
+
* Details of the discount to replace the existing discounts with.
|
|
4015
|
+
*/
|
|
4016
|
+
set?: DiscountAction.Set;
|
|
4017
|
+
/**
|
|
4018
|
+
* Determines the type of discount action.
|
|
4019
|
+
*/
|
|
4020
|
+
type: DiscountAction.Type;
|
|
4021
|
+
}
|
|
4022
|
+
type EffectiveAt = 'amendment_start' | 'billing_period_start' | OtherString;
|
|
4023
|
+
interface ItemAction {
|
|
4024
|
+
/**
|
|
4025
|
+
* 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.
|
|
4026
|
+
*/
|
|
4027
|
+
add?: ItemAction.Add;
|
|
4028
|
+
/**
|
|
4029
|
+
* Details of the subscription item to remove.
|
|
4030
|
+
*/
|
|
4031
|
+
remove?: ItemAction.Remove;
|
|
4032
|
+
/**
|
|
4033
|
+
* 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.
|
|
4034
|
+
*/
|
|
4035
|
+
set?: ItemAction.Set;
|
|
4036
|
+
/**
|
|
4037
|
+
* Determines the type of item action.
|
|
4038
|
+
*/
|
|
4039
|
+
type: ItemAction.Type;
|
|
4040
|
+
}
|
|
4041
|
+
interface MetadataAction {
|
|
4042
|
+
/**
|
|
4043
|
+
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
4044
|
+
*/
|
|
4045
|
+
add?: {
|
|
4046
|
+
[key: string]: string;
|
|
4047
|
+
};
|
|
4048
|
+
/**
|
|
4049
|
+
* Keys to remove from schedule phase metadata.
|
|
4050
|
+
*/
|
|
4051
|
+
remove?: Array<string>;
|
|
4052
|
+
/**
|
|
4053
|
+
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
4054
|
+
*/
|
|
4055
|
+
set?: Emptyable<{
|
|
4056
|
+
[key: string]: string;
|
|
4057
|
+
}>;
|
|
4058
|
+
/**
|
|
4059
|
+
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
4060
|
+
*/
|
|
4061
|
+
type: MetadataAction.Type;
|
|
4062
|
+
}
|
|
4063
|
+
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
4064
|
+
interface SetPauseCollection {
|
|
4065
|
+
/**
|
|
4066
|
+
* Details of the pause_collection behavior to apply to the amendment.
|
|
4067
|
+
*/
|
|
4068
|
+
set?: SetPauseCollection.Set;
|
|
4069
|
+
/**
|
|
4070
|
+
* Determines the type of the pause_collection amendment.
|
|
4071
|
+
*/
|
|
4072
|
+
type: SetPauseCollection.Type;
|
|
4073
|
+
}
|
|
4074
|
+
type SetScheduleEnd = 'amendment_end' | 'amendment_start' | OtherString;
|
|
4075
|
+
interface TrialSettings {
|
|
4076
|
+
/**
|
|
4077
|
+
* Defines how the subscription should behave when a trial ends.
|
|
4078
|
+
*/
|
|
4079
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
4080
|
+
}
|
|
4081
|
+
namespace AmendmentEnd {
|
|
4082
|
+
interface DiscountEnd {
|
|
4083
|
+
/**
|
|
4084
|
+
* The ID of a specific discount.
|
|
4085
|
+
*/
|
|
4086
|
+
discount: string;
|
|
4087
|
+
}
|
|
4088
|
+
interface Duration {
|
|
4089
|
+
/**
|
|
4090
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4091
|
+
*/
|
|
4092
|
+
interval: Duration.Interval;
|
|
4093
|
+
/**
|
|
4094
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4095
|
+
*/
|
|
4096
|
+
interval_count: number;
|
|
4097
|
+
}
|
|
4098
|
+
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
|
|
4099
|
+
namespace Duration {
|
|
4100
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4101
|
+
}
|
|
4102
|
+
}
|
|
4103
|
+
namespace AmendmentStart {
|
|
4104
|
+
interface AmendmentEnd {
|
|
4105
|
+
/**
|
|
4106
|
+
* 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.
|
|
4107
|
+
*/
|
|
4108
|
+
index: number;
|
|
4109
|
+
}
|
|
4110
|
+
interface DiscountEnd {
|
|
4111
|
+
/**
|
|
4112
|
+
* The ID of a specific discount.
|
|
4113
|
+
*/
|
|
4114
|
+
discount: string;
|
|
4115
|
+
}
|
|
4116
|
+
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice' | OtherString;
|
|
4117
|
+
}
|
|
4118
|
+
namespace BillingSchedulesAction {
|
|
4119
|
+
interface AppliesTo {
|
|
4120
|
+
/**
|
|
4121
|
+
* The ID of the price object.
|
|
4122
|
+
*/
|
|
4123
|
+
price?: string;
|
|
4124
|
+
/**
|
|
4125
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4126
|
+
*/
|
|
4127
|
+
type: 'price';
|
|
4128
|
+
}
|
|
4129
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
4130
|
+
}
|
|
4131
|
+
namespace DiscountAction {
|
|
4132
|
+
interface Add {
|
|
4133
|
+
/**
|
|
4134
|
+
* The coupon code to redeem.
|
|
4135
|
+
*/
|
|
4136
|
+
coupon?: string;
|
|
4137
|
+
/**
|
|
4138
|
+
* An ID of an existing discount for a coupon that was already redeemed.
|
|
4139
|
+
*/
|
|
4140
|
+
discount?: string;
|
|
4141
|
+
/**
|
|
4142
|
+
* Details to determine how long the discount should be applied for.
|
|
4143
|
+
*/
|
|
4144
|
+
discount_end?: Add.DiscountEnd;
|
|
4145
|
+
/**
|
|
4146
|
+
* 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.
|
|
4147
|
+
*/
|
|
4148
|
+
index?: number;
|
|
4149
|
+
/**
|
|
4150
|
+
* The promotion code to redeem.
|
|
4151
|
+
*/
|
|
4152
|
+
promotion_code?: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* Settings for discount application including service period anchoring.
|
|
4155
|
+
*/
|
|
4156
|
+
settings?: Add.Settings;
|
|
4157
|
+
}
|
|
4158
|
+
interface Remove {
|
|
4159
|
+
/**
|
|
4160
|
+
* The coupon code to remove from the `discounts` array.
|
|
4161
|
+
*/
|
|
4162
|
+
coupon?: string;
|
|
4163
|
+
/**
|
|
4164
|
+
* The ID of a discount to remove from the `discounts` array.
|
|
4165
|
+
*/
|
|
4166
|
+
discount?: string;
|
|
4167
|
+
/**
|
|
4168
|
+
* The ID of a promotion code to remove from the `discounts` array.
|
|
4169
|
+
*/
|
|
4170
|
+
promotion_code?: string;
|
|
4171
|
+
}
|
|
4172
|
+
interface Set {
|
|
4173
|
+
/**
|
|
4174
|
+
* The coupon code to replace the `discounts` array with.
|
|
4175
|
+
*/
|
|
4176
|
+
coupon?: string;
|
|
4177
|
+
/**
|
|
4178
|
+
* An ID of an existing discount to replace the `discounts` array with.
|
|
4179
|
+
*/
|
|
4180
|
+
discount?: string;
|
|
4181
|
+
/**
|
|
4182
|
+
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
4183
|
+
*/
|
|
4184
|
+
promotion_code?: string;
|
|
4185
|
+
/**
|
|
4186
|
+
* Settings for discount application including service period anchoring.
|
|
4187
|
+
*/
|
|
4188
|
+
settings?: Set.Settings;
|
|
4189
|
+
}
|
|
4190
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
4191
|
+
namespace Add {
|
|
4192
|
+
interface DiscountEnd {
|
|
4193
|
+
/**
|
|
4194
|
+
* The type of calculation made to determine when the discount ends.
|
|
4195
|
+
*/
|
|
4196
|
+
type: 'amendment_end';
|
|
4197
|
+
}
|
|
4198
|
+
interface Settings {
|
|
4199
|
+
/**
|
|
4200
|
+
* Configures service period cycle anchoring.
|
|
4201
|
+
*/
|
|
4202
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4203
|
+
/**
|
|
4204
|
+
* 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.
|
|
4205
|
+
*/
|
|
4206
|
+
start_date?: Settings.StartDate;
|
|
4207
|
+
}
|
|
4208
|
+
namespace Settings {
|
|
4209
|
+
interface ServicePeriodAnchorConfig {
|
|
4210
|
+
/**
|
|
4211
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4212
|
+
*/
|
|
4213
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4214
|
+
/**
|
|
4215
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4216
|
+
*/
|
|
4217
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4218
|
+
}
|
|
4219
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4220
|
+
namespace ServicePeriodAnchorConfig {
|
|
4221
|
+
interface Custom {
|
|
4222
|
+
/**
|
|
4223
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4224
|
+
*/
|
|
4225
|
+
day_of_month: number;
|
|
4226
|
+
/**
|
|
4227
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4228
|
+
*/
|
|
4229
|
+
hour?: number;
|
|
4230
|
+
/**
|
|
4231
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4232
|
+
*/
|
|
4233
|
+
minute?: number;
|
|
4234
|
+
/**
|
|
4235
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4236
|
+
*/
|
|
4237
|
+
month?: number;
|
|
4238
|
+
/**
|
|
4239
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4240
|
+
*/
|
|
4241
|
+
second?: number;
|
|
4242
|
+
}
|
|
4243
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4244
|
+
}
|
|
4245
|
+
}
|
|
4246
|
+
}
|
|
4247
|
+
namespace Set {
|
|
4248
|
+
interface Settings {
|
|
4249
|
+
/**
|
|
4250
|
+
* Configures service period cycle anchoring.
|
|
4251
|
+
*/
|
|
4252
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4253
|
+
/**
|
|
4254
|
+
* 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.
|
|
4255
|
+
*/
|
|
4256
|
+
start_date?: Settings.StartDate;
|
|
4257
|
+
}
|
|
4258
|
+
namespace Settings {
|
|
4259
|
+
interface ServicePeriodAnchorConfig {
|
|
4260
|
+
/**
|
|
4261
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4262
|
+
*/
|
|
4263
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4264
|
+
/**
|
|
4265
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4266
|
+
*/
|
|
4267
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4268
|
+
}
|
|
4269
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4270
|
+
namespace ServicePeriodAnchorConfig {
|
|
4271
|
+
interface Custom {
|
|
4272
|
+
/**
|
|
4273
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4274
|
+
*/
|
|
4275
|
+
day_of_month: number;
|
|
4276
|
+
/**
|
|
4277
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4278
|
+
*/
|
|
4279
|
+
hour?: number;
|
|
4280
|
+
/**
|
|
4281
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4282
|
+
*/
|
|
4283
|
+
minute?: number;
|
|
4284
|
+
/**
|
|
4285
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4286
|
+
*/
|
|
4287
|
+
month?: number;
|
|
4288
|
+
/**
|
|
4289
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4290
|
+
*/
|
|
4291
|
+
second?: number;
|
|
4292
|
+
}
|
|
4293
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4294
|
+
}
|
|
4295
|
+
}
|
|
4296
|
+
}
|
|
4297
|
+
}
|
|
4298
|
+
namespace ItemAction {
|
|
4299
|
+
interface Add {
|
|
4300
|
+
/**
|
|
4301
|
+
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
4302
|
+
*/
|
|
4303
|
+
discounts?: Array<Add.Discount>;
|
|
4304
|
+
/**
|
|
4305
|
+
* 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`.
|
|
4306
|
+
*/
|
|
4307
|
+
metadata?: MetadataParam;
|
|
4308
|
+
/**
|
|
4309
|
+
* The ID of the price object.
|
|
4310
|
+
*/
|
|
4311
|
+
price: string;
|
|
4312
|
+
/**
|
|
4313
|
+
* Quantity for this item.
|
|
4314
|
+
*/
|
|
4315
|
+
quantity?: number;
|
|
4316
|
+
/**
|
|
4317
|
+
* 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`.
|
|
4318
|
+
*/
|
|
4319
|
+
tax_rates?: Array<string>;
|
|
4320
|
+
/**
|
|
4321
|
+
* Options that configure the trial on the subscription item.
|
|
4322
|
+
*/
|
|
4323
|
+
trial?: Add.Trial;
|
|
4324
|
+
/**
|
|
4325
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4326
|
+
*/
|
|
4327
|
+
trial_offer?: string;
|
|
4328
|
+
}
|
|
4329
|
+
interface Remove {
|
|
4330
|
+
/**
|
|
4331
|
+
* ID of a price to remove.
|
|
4332
|
+
*/
|
|
4333
|
+
price: string;
|
|
4334
|
+
}
|
|
4335
|
+
interface Set {
|
|
4336
|
+
/**
|
|
4337
|
+
* 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`.
|
|
4338
|
+
*/
|
|
4339
|
+
discounts?: Array<Set.Discount>;
|
|
4340
|
+
/**
|
|
4341
|
+
* 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`.
|
|
4342
|
+
*/
|
|
4343
|
+
metadata?: MetadataParam;
|
|
4344
|
+
/**
|
|
4345
|
+
* The ID of the price object.
|
|
4346
|
+
*/
|
|
4347
|
+
price: string;
|
|
4348
|
+
/**
|
|
4349
|
+
* 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`.
|
|
4350
|
+
*/
|
|
4351
|
+
quantity?: number;
|
|
4352
|
+
/**
|
|
4353
|
+
* 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`.
|
|
4354
|
+
*/
|
|
4355
|
+
tax_rates?: Array<string>;
|
|
4356
|
+
/**
|
|
4357
|
+
* 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`.
|
|
4358
|
+
*/
|
|
4359
|
+
trial?: Set.Trial;
|
|
4360
|
+
/**
|
|
4361
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4362
|
+
*/
|
|
4363
|
+
trial_offer?: string;
|
|
4364
|
+
}
|
|
4365
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
4366
|
+
namespace Add {
|
|
4367
|
+
interface Discount {
|
|
4368
|
+
/**
|
|
4369
|
+
* ID of the coupon to create a new discount for.
|
|
4370
|
+
*/
|
|
4371
|
+
coupon?: string;
|
|
4372
|
+
/**
|
|
4373
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4374
|
+
*/
|
|
4375
|
+
discount?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
* Details to determine how long the discount should be applied for.
|
|
4378
|
+
*/
|
|
4379
|
+
discount_end?: Discount.DiscountEnd;
|
|
4380
|
+
/**
|
|
4381
|
+
* ID of the promotion code to create a new discount for.
|
|
4382
|
+
*/
|
|
4383
|
+
promotion_code?: string;
|
|
4384
|
+
/**
|
|
4385
|
+
* Settings for discount application including service period anchoring.
|
|
4386
|
+
*/
|
|
4387
|
+
settings?: Discount.Settings;
|
|
4388
|
+
}
|
|
4389
|
+
interface Trial {
|
|
4390
|
+
/**
|
|
4391
|
+
* 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.
|
|
4392
|
+
*/
|
|
4393
|
+
converts_to?: Array<string>;
|
|
4394
|
+
/**
|
|
4395
|
+
* Determines the type of trial for this item.
|
|
4396
|
+
*/
|
|
4397
|
+
type: Trial.Type;
|
|
4398
|
+
}
|
|
4399
|
+
namespace Discount {
|
|
4400
|
+
interface DiscountEnd {
|
|
4401
|
+
/**
|
|
4402
|
+
* Time span for the redeemed discount.
|
|
4403
|
+
*/
|
|
4404
|
+
duration?: DiscountEnd.Duration;
|
|
4405
|
+
/**
|
|
4406
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4407
|
+
*/
|
|
4408
|
+
timestamp?: number;
|
|
4409
|
+
/**
|
|
4410
|
+
* The type of calculation made to determine when the discount ends.
|
|
4411
|
+
*/
|
|
4412
|
+
type: DiscountEnd.Type;
|
|
4413
|
+
}
|
|
4414
|
+
interface Settings {
|
|
4415
|
+
/**
|
|
4416
|
+
* Configures service period cycle anchoring.
|
|
4417
|
+
*/
|
|
4418
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4419
|
+
/**
|
|
4420
|
+
* 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.
|
|
4421
|
+
*/
|
|
4422
|
+
start_date?: Settings.StartDate;
|
|
4423
|
+
}
|
|
4424
|
+
namespace DiscountEnd {
|
|
4425
|
+
interface Duration {
|
|
4426
|
+
/**
|
|
4427
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4428
|
+
*/
|
|
4429
|
+
interval: Duration.Interval;
|
|
4430
|
+
/**
|
|
4431
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4432
|
+
*/
|
|
4433
|
+
interval_count: number;
|
|
4434
|
+
}
|
|
4435
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4436
|
+
namespace Duration {
|
|
4437
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4438
|
+
}
|
|
4439
|
+
}
|
|
4440
|
+
namespace Settings {
|
|
4441
|
+
interface ServicePeriodAnchorConfig {
|
|
4442
|
+
/**
|
|
4443
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4444
|
+
*/
|
|
4445
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4446
|
+
/**
|
|
4447
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4448
|
+
*/
|
|
4449
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4450
|
+
}
|
|
4451
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4452
|
+
namespace ServicePeriodAnchorConfig {
|
|
4453
|
+
interface Custom {
|
|
4454
|
+
/**
|
|
4455
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4456
|
+
*/
|
|
4457
|
+
day_of_month: number;
|
|
4458
|
+
/**
|
|
4459
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4460
|
+
*/
|
|
4461
|
+
hour?: number;
|
|
4462
|
+
/**
|
|
4463
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4464
|
+
*/
|
|
4465
|
+
minute?: number;
|
|
4466
|
+
/**
|
|
4467
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4468
|
+
*/
|
|
4469
|
+
month?: number;
|
|
4470
|
+
/**
|
|
4471
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4472
|
+
*/
|
|
4473
|
+
second?: number;
|
|
4474
|
+
}
|
|
4475
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4476
|
+
}
|
|
4477
|
+
}
|
|
4478
|
+
}
|
|
4479
|
+
namespace Trial {
|
|
4480
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
4481
|
+
}
|
|
4482
|
+
}
|
|
4483
|
+
namespace Set {
|
|
4484
|
+
interface Discount {
|
|
4485
|
+
/**
|
|
4486
|
+
* ID of the coupon to create a new discount for.
|
|
4487
|
+
*/
|
|
4488
|
+
coupon?: string;
|
|
4489
|
+
/**
|
|
4490
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4491
|
+
*/
|
|
4492
|
+
discount?: string;
|
|
4493
|
+
/**
|
|
4494
|
+
* Details to determine how long the discount should be applied for.
|
|
4495
|
+
*/
|
|
4496
|
+
discount_end?: Discount.DiscountEnd;
|
|
4497
|
+
/**
|
|
4498
|
+
* ID of the promotion code to create a new discount for.
|
|
4499
|
+
*/
|
|
4500
|
+
promotion_code?: string;
|
|
4501
|
+
/**
|
|
4502
|
+
* Settings for discount application including service period anchoring.
|
|
4503
|
+
*/
|
|
4504
|
+
settings?: Discount.Settings;
|
|
4505
|
+
}
|
|
4506
|
+
interface Trial {
|
|
4507
|
+
/**
|
|
4508
|
+
* 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.
|
|
4509
|
+
*/
|
|
4510
|
+
converts_to?: Array<string>;
|
|
4511
|
+
/**
|
|
4512
|
+
* Determines the type of trial for this item.
|
|
4513
|
+
*/
|
|
4514
|
+
type: Trial.Type;
|
|
4515
|
+
}
|
|
4516
|
+
namespace Discount {
|
|
4517
|
+
interface DiscountEnd {
|
|
4518
|
+
/**
|
|
4519
|
+
* Time span for the redeemed discount.
|
|
4520
|
+
*/
|
|
4521
|
+
duration?: DiscountEnd.Duration;
|
|
4522
|
+
/**
|
|
4523
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4524
|
+
*/
|
|
4525
|
+
timestamp?: number;
|
|
4526
|
+
/**
|
|
4527
|
+
* The type of calculation made to determine when the discount ends.
|
|
4528
|
+
*/
|
|
4529
|
+
type: DiscountEnd.Type;
|
|
4530
|
+
}
|
|
4531
|
+
interface Settings {
|
|
4532
|
+
/**
|
|
4533
|
+
* Configures service period cycle anchoring.
|
|
4534
|
+
*/
|
|
4535
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
4536
|
+
/**
|
|
4537
|
+
* 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.
|
|
4538
|
+
*/
|
|
4539
|
+
start_date?: Settings.StartDate;
|
|
4540
|
+
}
|
|
4541
|
+
namespace DiscountEnd {
|
|
4542
|
+
interface Duration {
|
|
4543
|
+
/**
|
|
4544
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4545
|
+
*/
|
|
4546
|
+
interval: Duration.Interval;
|
|
4547
|
+
/**
|
|
4548
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4549
|
+
*/
|
|
4550
|
+
interval_count: number;
|
|
4551
|
+
}
|
|
4552
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4553
|
+
namespace Duration {
|
|
4554
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4555
|
+
}
|
|
4556
|
+
}
|
|
4557
|
+
namespace Settings {
|
|
4558
|
+
interface ServicePeriodAnchorConfig {
|
|
4559
|
+
/**
|
|
4560
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
4561
|
+
*/
|
|
4562
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
4563
|
+
/**
|
|
4564
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
4565
|
+
*/
|
|
4566
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
4567
|
+
}
|
|
4568
|
+
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start' | OtherString;
|
|
4569
|
+
namespace ServicePeriodAnchorConfig {
|
|
4570
|
+
interface Custom {
|
|
4571
|
+
/**
|
|
4572
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
4573
|
+
*/
|
|
4574
|
+
day_of_month: number;
|
|
4575
|
+
/**
|
|
4576
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
4577
|
+
*/
|
|
4578
|
+
hour?: number;
|
|
4579
|
+
/**
|
|
4580
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
4581
|
+
*/
|
|
4582
|
+
minute?: number;
|
|
4583
|
+
/**
|
|
4584
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
4585
|
+
*/
|
|
4586
|
+
month?: number;
|
|
4587
|
+
/**
|
|
4588
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
4589
|
+
*/
|
|
4590
|
+
second?: number;
|
|
4591
|
+
}
|
|
4592
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
4593
|
+
}
|
|
4594
|
+
}
|
|
4595
|
+
}
|
|
4596
|
+
namespace Trial {
|
|
4597
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
4598
|
+
}
|
|
4599
|
+
}
|
|
4600
|
+
}
|
|
4601
|
+
namespace MetadataAction {
|
|
4602
|
+
type Type = 'add' | 'remove' | 'set' | OtherString;
|
|
4603
|
+
}
|
|
4604
|
+
namespace SetPauseCollection {
|
|
4605
|
+
interface Set {
|
|
4606
|
+
/**
|
|
4607
|
+
* The payment collection behavior for this subscription while paused.
|
|
4608
|
+
*/
|
|
4609
|
+
behavior: Set.Behavior;
|
|
4610
|
+
}
|
|
4611
|
+
type Type = 'remove' | 'set' | OtherString;
|
|
4612
|
+
namespace Set {
|
|
4613
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
4614
|
+
}
|
|
4615
|
+
}
|
|
4616
|
+
namespace TrialSettings {
|
|
4617
|
+
interface EndBehavior {
|
|
4618
|
+
/**
|
|
4619
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4620
|
+
*/
|
|
4621
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4622
|
+
}
|
|
4623
|
+
namespace EndBehavior {
|
|
4624
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
4625
|
+
}
|
|
4626
|
+
}
|
|
4627
|
+
}
|
|
3175
4628
|
namespace BillingMode {
|
|
3176
4629
|
interface Flexible {
|
|
3177
4630
|
/**
|
|
@@ -3184,6 +4637,51 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3184
4637
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
3185
4638
|
}
|
|
3186
4639
|
}
|
|
4640
|
+
namespace BillingSchedule {
|
|
4641
|
+
interface AppliesTo {
|
|
4642
|
+
/**
|
|
4643
|
+
* The ID of the price object.
|
|
4644
|
+
*/
|
|
4645
|
+
price?: string;
|
|
4646
|
+
/**
|
|
4647
|
+
* Controls which subscription items the billing schedule applies to.
|
|
4648
|
+
*/
|
|
4649
|
+
type: 'price';
|
|
4650
|
+
}
|
|
4651
|
+
interface BillUntil {
|
|
4652
|
+
/**
|
|
4653
|
+
* Specifies the billing period.
|
|
4654
|
+
*/
|
|
4655
|
+
duration?: BillUntil.Duration;
|
|
4656
|
+
/**
|
|
4657
|
+
* The end date of the billing schedule.
|
|
4658
|
+
*/
|
|
4659
|
+
timestamp?: number;
|
|
4660
|
+
/**
|
|
4661
|
+
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
4662
|
+
*/
|
|
4663
|
+
type: BillUntil.Type;
|
|
4664
|
+
}
|
|
4665
|
+
namespace BillUntil {
|
|
4666
|
+
interface Duration {
|
|
4667
|
+
/**
|
|
4668
|
+
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
4669
|
+
*/
|
|
4670
|
+
interval: Duration.Interval;
|
|
4671
|
+
/**
|
|
4672
|
+
* The multiplier applied to the interval.
|
|
4673
|
+
*/
|
|
4674
|
+
interval_count?: number;
|
|
4675
|
+
}
|
|
4676
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4677
|
+
namespace Duration {
|
|
4678
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4679
|
+
}
|
|
4680
|
+
}
|
|
4681
|
+
}
|
|
4682
|
+
namespace DefaultSettings {
|
|
4683
|
+
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
4684
|
+
}
|
|
3187
4685
|
namespace Phase {
|
|
3188
4686
|
interface AddInvoiceItem {
|
|
3189
4687
|
/**
|
|
@@ -3250,10 +4748,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3250
4748
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3251
4749
|
*/
|
|
3252
4750
|
discount?: string;
|
|
4751
|
+
/**
|
|
4752
|
+
* Details to determine how long the discount should be applied for.
|
|
4753
|
+
*/
|
|
4754
|
+
discount_end?: Discount.DiscountEnd;
|
|
3253
4755
|
/**
|
|
3254
4756
|
* ID of the promotion code to create a new discount for.
|
|
3255
4757
|
*/
|
|
3256
4758
|
promotion_code?: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* Settings for discount application including service period anchoring.
|
|
4761
|
+
*/
|
|
4762
|
+
settings?: Discount.Settings;
|
|
3257
4763
|
}
|
|
3258
4764
|
interface Duration {
|
|
3259
4765
|
/**
|
|
@@ -3265,6 +4771,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3265
4771
|
*/
|
|
3266
4772
|
interval_count?: number;
|
|
3267
4773
|
}
|
|
4774
|
+
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
3268
4775
|
interface InvoiceSettings {
|
|
3269
4776
|
/**
|
|
3270
4777
|
* 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.
|
|
@@ -3312,6 +4819,20 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3312
4819
|
* 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.
|
|
3313
4820
|
*/
|
|
3314
4821
|
tax_rates?: Emptyable<Array<string>>;
|
|
4822
|
+
/**
|
|
4823
|
+
* Options that configure the trial on the subscription item.
|
|
4824
|
+
*/
|
|
4825
|
+
trial?: Item.Trial;
|
|
4826
|
+
/**
|
|
4827
|
+
* The ID of the trial offer to apply to the configuration item.
|
|
4828
|
+
*/
|
|
4829
|
+
trial_offer?: string;
|
|
4830
|
+
}
|
|
4831
|
+
interface PauseCollection {
|
|
4832
|
+
/**
|
|
4833
|
+
* The payment collection behavior for this subscription while paused.
|
|
4834
|
+
*/
|
|
4835
|
+
behavior: PauseCollection.Behavior;
|
|
3315
4836
|
}
|
|
3316
4837
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3317
4838
|
interface TransferData {
|
|
@@ -3324,6 +4845,13 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3324
4845
|
*/
|
|
3325
4846
|
destination: string;
|
|
3326
4847
|
}
|
|
4848
|
+
type TrialContinuation = 'continue' | 'none' | OtherString;
|
|
4849
|
+
interface TrialSettings {
|
|
4850
|
+
/**
|
|
4851
|
+
* Defines how the subscription should behave when a trial ends.
|
|
4852
|
+
*/
|
|
4853
|
+
end_behavior?: TrialSettings.EndBehavior;
|
|
4854
|
+
}
|
|
3327
4855
|
namespace AddInvoiceItem {
|
|
3328
4856
|
interface Discount {
|
|
3329
4857
|
/**
|
|
@@ -3334,6 +4862,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3334
4862
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3335
4863
|
*/
|
|
3336
4864
|
discount?: string;
|
|
4865
|
+
/**
|
|
4866
|
+
* Details to determine how long the discount should be applied for.
|
|
4867
|
+
*/
|
|
4868
|
+
discount_end?: Discount.DiscountEnd;
|
|
3337
4869
|
/**
|
|
3338
4870
|
* ID of the promotion code to create a new discount for.
|
|
3339
4871
|
*/
|
|
@@ -3371,6 +4903,38 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3371
4903
|
*/
|
|
3372
4904
|
unit_amount_decimal?: Decimal;
|
|
3373
4905
|
}
|
|
4906
|
+
namespace Discount {
|
|
4907
|
+
interface DiscountEnd {
|
|
4908
|
+
/**
|
|
4909
|
+
* Time span for the redeemed discount.
|
|
4910
|
+
*/
|
|
4911
|
+
duration?: DiscountEnd.Duration;
|
|
4912
|
+
/**
|
|
4913
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4914
|
+
*/
|
|
4915
|
+
timestamp?: number;
|
|
4916
|
+
/**
|
|
4917
|
+
* The type of calculation made to determine when the discount ends.
|
|
4918
|
+
*/
|
|
4919
|
+
type: DiscountEnd.Type;
|
|
4920
|
+
}
|
|
4921
|
+
namespace DiscountEnd {
|
|
4922
|
+
interface Duration {
|
|
4923
|
+
/**
|
|
4924
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4925
|
+
*/
|
|
4926
|
+
interval: Duration.Interval;
|
|
4927
|
+
/**
|
|
4928
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4929
|
+
*/
|
|
4930
|
+
interval_count: number;
|
|
4931
|
+
}
|
|
4932
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
4933
|
+
namespace Duration {
|
|
4934
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
4935
|
+
}
|
|
4936
|
+
}
|
|
4937
|
+
}
|
|
3374
4938
|
namespace Period {
|
|
3375
4939
|
interface End {
|
|
3376
4940
|
/**
|
|
@@ -3415,7 +4979,87 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3415
4979
|
type: Liability.Type;
|
|
3416
4980
|
}
|
|
3417
4981
|
namespace Liability {
|
|
3418
|
-
type Type = 'account' | 'self' | OtherString;
|
|
4982
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
4983
|
+
}
|
|
4984
|
+
}
|
|
4985
|
+
namespace Discount {
|
|
4986
|
+
interface DiscountEnd {
|
|
4987
|
+
/**
|
|
4988
|
+
* Time span for the redeemed discount.
|
|
4989
|
+
*/
|
|
4990
|
+
duration?: DiscountEnd.Duration;
|
|
4991
|
+
/**
|
|
4992
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4993
|
+
*/
|
|
4994
|
+
timestamp?: number;
|
|
4995
|
+
/**
|
|
4996
|
+
* The type of calculation made to determine when the discount ends.
|
|
4997
|
+
*/
|
|
4998
|
+
type: DiscountEnd.Type;
|
|
4999
|
+
}
|
|
5000
|
+
interface Settings {
|
|
5001
|
+
/**
|
|
5002
|
+
* Configures service period cycle anchoring.
|
|
5003
|
+
*/
|
|
5004
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
5005
|
+
/**
|
|
5006
|
+
* 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.
|
|
5007
|
+
*/
|
|
5008
|
+
start_date?: Settings.StartDate;
|
|
5009
|
+
}
|
|
5010
|
+
namespace DiscountEnd {
|
|
5011
|
+
interface Duration {
|
|
5012
|
+
/**
|
|
5013
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5014
|
+
*/
|
|
5015
|
+
interval: Duration.Interval;
|
|
5016
|
+
/**
|
|
5017
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5018
|
+
*/
|
|
5019
|
+
interval_count: number;
|
|
5020
|
+
}
|
|
5021
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
5022
|
+
namespace Duration {
|
|
5023
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
5024
|
+
}
|
|
5025
|
+
}
|
|
5026
|
+
namespace Settings {
|
|
5027
|
+
interface ServicePeriodAnchorConfig {
|
|
5028
|
+
/**
|
|
5029
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5030
|
+
*/
|
|
5031
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5032
|
+
/**
|
|
5033
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
5034
|
+
*/
|
|
5035
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5036
|
+
}
|
|
5037
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
5038
|
+
namespace ServicePeriodAnchorConfig {
|
|
5039
|
+
interface Custom {
|
|
5040
|
+
/**
|
|
5041
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5042
|
+
*/
|
|
5043
|
+
day_of_month: number;
|
|
5044
|
+
/**
|
|
5045
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5046
|
+
*/
|
|
5047
|
+
hour?: number;
|
|
5048
|
+
/**
|
|
5049
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5050
|
+
*/
|
|
5051
|
+
minute?: number;
|
|
5052
|
+
/**
|
|
5053
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5054
|
+
*/
|
|
5055
|
+
month?: number;
|
|
5056
|
+
/**
|
|
5057
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5058
|
+
*/
|
|
5059
|
+
second?: number;
|
|
5060
|
+
}
|
|
5061
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
5062
|
+
}
|
|
3419
5063
|
}
|
|
3420
5064
|
}
|
|
3421
5065
|
namespace Duration {
|
|
@@ -3433,7 +5077,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3433
5077
|
type: Issuer.Type;
|
|
3434
5078
|
}
|
|
3435
5079
|
namespace Issuer {
|
|
3436
|
-
type Type = 'account' | 'self' | OtherString;
|
|
5080
|
+
type Type = 'account' | 'application' | 'self' | OtherString;
|
|
3437
5081
|
}
|
|
3438
5082
|
}
|
|
3439
5083
|
namespace Item {
|
|
@@ -3452,10 +5096,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3452
5096
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3453
5097
|
*/
|
|
3454
5098
|
discount?: string;
|
|
5099
|
+
/**
|
|
5100
|
+
* Details to determine how long the discount should be applied for.
|
|
5101
|
+
*/
|
|
5102
|
+
discount_end?: Discount.DiscountEnd;
|
|
3455
5103
|
/**
|
|
3456
5104
|
* ID of the promotion code to create a new discount for.
|
|
3457
5105
|
*/
|
|
3458
5106
|
promotion_code?: string;
|
|
5107
|
+
/**
|
|
5108
|
+
* Settings for discount application including service period anchoring.
|
|
5109
|
+
*/
|
|
5110
|
+
settings?: Discount.Settings;
|
|
3459
5111
|
}
|
|
3460
5112
|
interface PriceData {
|
|
3461
5113
|
/**
|
|
@@ -3483,6 +5135,96 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3483
5135
|
*/
|
|
3484
5136
|
unit_amount_decimal?: Decimal;
|
|
3485
5137
|
}
|
|
5138
|
+
interface Trial {
|
|
5139
|
+
/**
|
|
5140
|
+
* 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.
|
|
5141
|
+
*/
|
|
5142
|
+
converts_to?: Array<string>;
|
|
5143
|
+
/**
|
|
5144
|
+
* Determines the type of trial for this item.
|
|
5145
|
+
*/
|
|
5146
|
+
type: Trial.Type;
|
|
5147
|
+
}
|
|
5148
|
+
namespace Discount {
|
|
5149
|
+
interface DiscountEnd {
|
|
5150
|
+
/**
|
|
5151
|
+
* Time span for the redeemed discount.
|
|
5152
|
+
*/
|
|
5153
|
+
duration?: DiscountEnd.Duration;
|
|
5154
|
+
/**
|
|
5155
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5156
|
+
*/
|
|
5157
|
+
timestamp?: number;
|
|
5158
|
+
/**
|
|
5159
|
+
* The type of calculation made to determine when the discount ends.
|
|
5160
|
+
*/
|
|
5161
|
+
type: DiscountEnd.Type;
|
|
5162
|
+
}
|
|
5163
|
+
interface Settings {
|
|
5164
|
+
/**
|
|
5165
|
+
* Configures service period cycle anchoring.
|
|
5166
|
+
*/
|
|
5167
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
5168
|
+
/**
|
|
5169
|
+
* 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.
|
|
5170
|
+
*/
|
|
5171
|
+
start_date?: Settings.StartDate;
|
|
5172
|
+
}
|
|
5173
|
+
namespace DiscountEnd {
|
|
5174
|
+
interface Duration {
|
|
5175
|
+
/**
|
|
5176
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5177
|
+
*/
|
|
5178
|
+
interval: Duration.Interval;
|
|
5179
|
+
/**
|
|
5180
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5181
|
+
*/
|
|
5182
|
+
interval_count: number;
|
|
5183
|
+
}
|
|
5184
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
5185
|
+
namespace Duration {
|
|
5186
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
5187
|
+
}
|
|
5188
|
+
}
|
|
5189
|
+
namespace Settings {
|
|
5190
|
+
interface ServicePeriodAnchorConfig {
|
|
5191
|
+
/**
|
|
5192
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5193
|
+
*/
|
|
5194
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5195
|
+
/**
|
|
5196
|
+
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
5197
|
+
*/
|
|
5198
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5199
|
+
}
|
|
5200
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start' | OtherString;
|
|
5201
|
+
namespace ServicePeriodAnchorConfig {
|
|
5202
|
+
interface Custom {
|
|
5203
|
+
/**
|
|
5204
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5205
|
+
*/
|
|
5206
|
+
day_of_month: number;
|
|
5207
|
+
/**
|
|
5208
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5209
|
+
*/
|
|
5210
|
+
hour?: number;
|
|
5211
|
+
/**
|
|
5212
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5213
|
+
*/
|
|
5214
|
+
minute?: number;
|
|
5215
|
+
/**
|
|
5216
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5217
|
+
*/
|
|
5218
|
+
month?: number;
|
|
5219
|
+
/**
|
|
5220
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5221
|
+
*/
|
|
5222
|
+
second?: number;
|
|
5223
|
+
}
|
|
5224
|
+
type Type = 'custom' | 'inherit' | OtherString;
|
|
5225
|
+
}
|
|
5226
|
+
}
|
|
5227
|
+
}
|
|
3486
5228
|
namespace PriceData {
|
|
3487
5229
|
interface Recurring {
|
|
3488
5230
|
/**
|
|
@@ -3499,6 +5241,65 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3499
5241
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3500
5242
|
}
|
|
3501
5243
|
}
|
|
5244
|
+
namespace Trial {
|
|
5245
|
+
type Type = 'free' | 'paid' | OtherString;
|
|
5246
|
+
}
|
|
5247
|
+
}
|
|
5248
|
+
namespace PauseCollection {
|
|
5249
|
+
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void' | OtherString;
|
|
5250
|
+
}
|
|
5251
|
+
namespace TrialSettings {
|
|
5252
|
+
interface EndBehavior {
|
|
5253
|
+
/**
|
|
5254
|
+
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
5255
|
+
*/
|
|
5256
|
+
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
5257
|
+
}
|
|
5258
|
+
namespace EndBehavior {
|
|
5259
|
+
type ProrateUpFront = 'defer' | 'include' | OtherString;
|
|
5260
|
+
}
|
|
5261
|
+
}
|
|
5262
|
+
}
|
|
5263
|
+
namespace Prebilling {
|
|
5264
|
+
interface BillUntil {
|
|
5265
|
+
/**
|
|
5266
|
+
* End the prebilled period when a specified amendment ends.
|
|
5267
|
+
*/
|
|
5268
|
+
amendment_end?: BillUntil.AmendmentEnd;
|
|
5269
|
+
/**
|
|
5270
|
+
* Time span for prebilling, starting from `bill_from`.
|
|
5271
|
+
*/
|
|
5272
|
+
duration?: BillUntil.Duration;
|
|
5273
|
+
/**
|
|
5274
|
+
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
5275
|
+
*/
|
|
5276
|
+
timestamp?: number;
|
|
5277
|
+
/**
|
|
5278
|
+
* Select one of several ways to pass the `bill_until` value.
|
|
5279
|
+
*/
|
|
5280
|
+
type: BillUntil.Type;
|
|
5281
|
+
}
|
|
5282
|
+
namespace BillUntil {
|
|
5283
|
+
interface AmendmentEnd {
|
|
5284
|
+
/**
|
|
5285
|
+
* 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.
|
|
5286
|
+
*/
|
|
5287
|
+
index: number;
|
|
5288
|
+
}
|
|
5289
|
+
interface Duration {
|
|
5290
|
+
/**
|
|
5291
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5292
|
+
*/
|
|
5293
|
+
interval: Duration.Interval;
|
|
5294
|
+
/**
|
|
5295
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5296
|
+
*/
|
|
5297
|
+
interval_count: number;
|
|
5298
|
+
}
|
|
5299
|
+
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp' | OtherString;
|
|
5300
|
+
namespace Duration {
|
|
5301
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
5302
|
+
}
|
|
3502
5303
|
}
|
|
3503
5304
|
}
|
|
3504
5305
|
}
|
|
@@ -3538,6 +5339,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3538
5339
|
* 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.
|
|
3539
5340
|
*/
|
|
3540
5341
|
clear_usage?: boolean;
|
|
5342
|
+
/**
|
|
5343
|
+
* The trial offer to apply to this subscription item.
|
|
5344
|
+
*/
|
|
5345
|
+
current_trial?: Item.CurrentTrial;
|
|
3541
5346
|
/**
|
|
3542
5347
|
* A flag that, if set to `true`, will delete the specified item.
|
|
3543
5348
|
*/
|
|
@@ -3575,6 +5380,26 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3575
5380
|
*/
|
|
3576
5381
|
tax_rates?: Emptyable<Array<string>>;
|
|
3577
5382
|
}
|
|
5383
|
+
interface Pause {
|
|
5384
|
+
/**
|
|
5385
|
+
* Controls what to bill for when pausing the subscription.
|
|
5386
|
+
*/
|
|
5387
|
+
bill_for?: Pause.BillFor;
|
|
5388
|
+
/**
|
|
5389
|
+
* Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.
|
|
5390
|
+
*/
|
|
5391
|
+
invoicing_behavior?: Pause.InvoicingBehavior;
|
|
5392
|
+
/**
|
|
5393
|
+
* The type of pause to apply. Defaults to `subscription`.
|
|
5394
|
+
*/
|
|
5395
|
+
type?: 'subscription';
|
|
5396
|
+
}
|
|
5397
|
+
interface Prebilling {
|
|
5398
|
+
/**
|
|
5399
|
+
* This is used to determine the number of billing cycles to prebill.
|
|
5400
|
+
*/
|
|
5401
|
+
iterations: number;
|
|
5402
|
+
}
|
|
3578
5403
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none' | OtherString;
|
|
3579
5404
|
namespace BillingMode {
|
|
3580
5405
|
interface Flexible {
|
|
@@ -3637,6 +5462,16 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3637
5462
|
*/
|
|
3638
5463
|
usage_gte: number;
|
|
3639
5464
|
}
|
|
5465
|
+
interface CurrentTrial {
|
|
5466
|
+
/**
|
|
5467
|
+
* 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`.
|
|
5468
|
+
*/
|
|
5469
|
+
trial_end?: number;
|
|
5470
|
+
/**
|
|
5471
|
+
* The ID of the trial offer to apply to the subscription item.
|
|
5472
|
+
*/
|
|
5473
|
+
trial_offer: string;
|
|
5474
|
+
}
|
|
3640
5475
|
interface Discount {
|
|
3641
5476
|
/**
|
|
3642
5477
|
* ID of the coupon to create a new discount for.
|
|
@@ -3646,10 +5481,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3646
5481
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3647
5482
|
*/
|
|
3648
5483
|
discount?: string;
|
|
5484
|
+
/**
|
|
5485
|
+
* Details to determine how long the discount should be applied for.
|
|
5486
|
+
*/
|
|
5487
|
+
discount_end?: Discount.DiscountEnd;
|
|
3649
5488
|
/**
|
|
3650
5489
|
* ID of the promotion code to create a new discount for.
|
|
3651
5490
|
*/
|
|
3652
5491
|
promotion_code?: string;
|
|
5492
|
+
/**
|
|
5493
|
+
* Settings for discount application including service period anchoring.
|
|
5494
|
+
*/
|
|
5495
|
+
settings?: Discount.Settings;
|
|
3653
5496
|
}
|
|
3654
5497
|
interface PriceData {
|
|
3655
5498
|
/**
|
|
@@ -3677,6 +5520,86 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3677
5520
|
*/
|
|
3678
5521
|
unit_amount_decimal?: Decimal;
|
|
3679
5522
|
}
|
|
5523
|
+
namespace Discount {
|
|
5524
|
+
interface DiscountEnd {
|
|
5525
|
+
/**
|
|
5526
|
+
* Time span for the redeemed discount.
|
|
5527
|
+
*/
|
|
5528
|
+
duration?: DiscountEnd.Duration;
|
|
5529
|
+
/**
|
|
5530
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5531
|
+
*/
|
|
5532
|
+
timestamp?: number;
|
|
5533
|
+
/**
|
|
5534
|
+
* The type of calculation made to determine when the discount ends.
|
|
5535
|
+
*/
|
|
5536
|
+
type: DiscountEnd.Type;
|
|
5537
|
+
}
|
|
5538
|
+
interface Settings {
|
|
5539
|
+
/**
|
|
5540
|
+
* Configures service period cycle anchoring.
|
|
5541
|
+
*/
|
|
5542
|
+
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
5543
|
+
/**
|
|
5544
|
+
* 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.
|
|
5545
|
+
*/
|
|
5546
|
+
start_date?: Settings.StartDate;
|
|
5547
|
+
}
|
|
5548
|
+
namespace DiscountEnd {
|
|
5549
|
+
interface Duration {
|
|
5550
|
+
/**
|
|
5551
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5552
|
+
*/
|
|
5553
|
+
interval: Duration.Interval;
|
|
5554
|
+
/**
|
|
5555
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5556
|
+
*/
|
|
5557
|
+
interval_count: number;
|
|
5558
|
+
}
|
|
5559
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
5560
|
+
namespace Duration {
|
|
5561
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
5562
|
+
}
|
|
5563
|
+
}
|
|
5564
|
+
namespace Settings {
|
|
5565
|
+
interface ServicePeriodAnchorConfig {
|
|
5566
|
+
/**
|
|
5567
|
+
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
5568
|
+
*/
|
|
5569
|
+
custom?: ServicePeriodAnchorConfig.Custom;
|
|
5570
|
+
/**
|
|
5571
|
+
* The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
|
|
5572
|
+
*/
|
|
5573
|
+
type?: ServicePeriodAnchorConfig.Type;
|
|
5574
|
+
}
|
|
5575
|
+
type StartDate = 'current_period_end' | 'current_period_start' | 'now' | OtherString;
|
|
5576
|
+
namespace ServicePeriodAnchorConfig {
|
|
5577
|
+
interface Custom {
|
|
5578
|
+
/**
|
|
5579
|
+
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
5580
|
+
*/
|
|
5581
|
+
day_of_month: number;
|
|
5582
|
+
/**
|
|
5583
|
+
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
5584
|
+
*/
|
|
5585
|
+
hour?: number;
|
|
5586
|
+
/**
|
|
5587
|
+
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
5588
|
+
*/
|
|
5589
|
+
minute?: number;
|
|
5590
|
+
/**
|
|
5591
|
+
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
5592
|
+
*/
|
|
5593
|
+
month?: number;
|
|
5594
|
+
/**
|
|
5595
|
+
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
5596
|
+
*/
|
|
5597
|
+
second?: number;
|
|
5598
|
+
}
|
|
5599
|
+
type Type = 'custom' | 'subscription_service_cycle_anchor' | OtherString;
|
|
5600
|
+
}
|
|
5601
|
+
}
|
|
5602
|
+
}
|
|
3680
5603
|
namespace PriceData {
|
|
3681
5604
|
interface Recurring {
|
|
3682
5605
|
/**
|
|
@@ -3694,8 +5617,51 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3694
5617
|
}
|
|
3695
5618
|
}
|
|
3696
5619
|
}
|
|
5620
|
+
namespace Pause {
|
|
5621
|
+
interface BillFor {
|
|
5622
|
+
/**
|
|
5623
|
+
* Controls when to bill for metered usage in the current period. Defaults to `{ type: "now" }`.
|
|
5624
|
+
*/
|
|
5625
|
+
outstanding_usage_through?: BillFor.OutstandingUsageThrough;
|
|
5626
|
+
/**
|
|
5627
|
+
* Controls when to credit for unused time on licensed items. Defaults to `{ type: "now" }`.
|
|
5628
|
+
*/
|
|
5629
|
+
unused_time_from?: BillFor.UnusedTimeFrom;
|
|
5630
|
+
}
|
|
5631
|
+
type InvoicingBehavior = 'invoice' | 'pending_invoice_item' | OtherString;
|
|
5632
|
+
namespace BillFor {
|
|
5633
|
+
interface OutstandingUsageThrough {
|
|
5634
|
+
/**
|
|
5635
|
+
* When to bill metered usage in the current period.
|
|
5636
|
+
*/
|
|
5637
|
+
type: OutstandingUsageThrough.Type;
|
|
5638
|
+
}
|
|
5639
|
+
interface UnusedTimeFrom {
|
|
5640
|
+
/**
|
|
5641
|
+
* When to credit for unused time.
|
|
5642
|
+
*/
|
|
5643
|
+
type: UnusedTimeFrom.Type;
|
|
5644
|
+
}
|
|
5645
|
+
namespace OutstandingUsageThrough {
|
|
5646
|
+
type Type = 'none' | 'now';
|
|
5647
|
+
}
|
|
5648
|
+
namespace UnusedTimeFrom {
|
|
5649
|
+
type Type = 'item_current_period_start' | 'none' | 'now';
|
|
5650
|
+
}
|
|
5651
|
+
}
|
|
5652
|
+
}
|
|
3697
5653
|
}
|
|
3698
5654
|
}
|
|
5655
|
+
export interface InvoiceDetachPaymentParams {
|
|
5656
|
+
/**
|
|
5657
|
+
* Specifies which fields in the response should be expanded.
|
|
5658
|
+
*/
|
|
5659
|
+
expand?: Array<string>;
|
|
5660
|
+
/**
|
|
5661
|
+
* The ID of the PaymentIntent to detach from the invoice.
|
|
5662
|
+
*/
|
|
5663
|
+
payment_intent?: string;
|
|
5664
|
+
}
|
|
3699
5665
|
export interface InvoiceFinalizeInvoiceParams {
|
|
3700
5666
|
/**
|
|
3701
5667
|
* 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.
|
|
@@ -3805,6 +5771,32 @@ export interface InvoiceSendInvoiceParams {
|
|
|
3805
5771
|
*/
|
|
3806
5772
|
expand?: Array<string>;
|
|
3807
5773
|
}
|
|
5774
|
+
export interface InvoiceSerializeBatchAddLinesParams {
|
|
5775
|
+
}
|
|
5776
|
+
export interface InvoiceSerializeBatchCreateParams {
|
|
5777
|
+
}
|
|
5778
|
+
export interface InvoiceSerializeBatchCreatePreviewParams {
|
|
5779
|
+
}
|
|
5780
|
+
export interface InvoiceSerializeBatchDeleteParams {
|
|
5781
|
+
}
|
|
5782
|
+
export interface InvoiceSerializeBatchFinalizeInvoiceParams {
|
|
5783
|
+
}
|
|
5784
|
+
export interface InvoiceSerializeBatchMarkUncollectibleParams {
|
|
5785
|
+
}
|
|
5786
|
+
export interface InvoiceSerializeBatchPayParams {
|
|
5787
|
+
}
|
|
5788
|
+
export interface InvoiceSerializeBatchRemoveLinesParams {
|
|
5789
|
+
}
|
|
5790
|
+
export interface InvoiceSerializeBatchSendInvoiceParams {
|
|
5791
|
+
}
|
|
5792
|
+
export interface InvoiceSerializeBatchUpdateParams {
|
|
5793
|
+
}
|
|
5794
|
+
export interface InvoiceSerializeBatchUpdateLineItemParams {
|
|
5795
|
+
}
|
|
5796
|
+
export interface InvoiceSerializeBatchUpdateLinesParams {
|
|
5797
|
+
}
|
|
5798
|
+
export interface InvoiceSerializeBatchVoidInvoiceParams {
|
|
5799
|
+
}
|
|
3808
5800
|
export interface InvoiceUpdateLinesParams {
|
|
3809
5801
|
/**
|
|
3810
5802
|
* The line items to update.
|
|
@@ -3843,6 +5835,10 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3843
5835
|
* ID of an existing line item on the invoice.
|
|
3844
5836
|
*/
|
|
3845
5837
|
id: string;
|
|
5838
|
+
/**
|
|
5839
|
+
* 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.
|
|
5840
|
+
*/
|
|
5841
|
+
margins?: Emptyable<Array<string>>;
|
|
3846
5842
|
/**
|
|
3847
5843
|
* 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.
|
|
3848
5844
|
*/
|
|
@@ -3886,6 +5882,10 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3886
5882
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3887
5883
|
*/
|
|
3888
5884
|
discount?: string;
|
|
5885
|
+
/**
|
|
5886
|
+
* Details to determine how long the discount should be applied for.
|
|
5887
|
+
*/
|
|
5888
|
+
discount_end?: Discount.DiscountEnd;
|
|
3889
5889
|
/**
|
|
3890
5890
|
* ID of the promotion code to create a new discount for.
|
|
3891
5891
|
*/
|
|
@@ -3953,6 +5953,38 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3953
5953
|
*/
|
|
3954
5954
|
taxable_amount: number;
|
|
3955
5955
|
}
|
|
5956
|
+
namespace Discount {
|
|
5957
|
+
interface DiscountEnd {
|
|
5958
|
+
/**
|
|
5959
|
+
* Time span for the redeemed discount.
|
|
5960
|
+
*/
|
|
5961
|
+
duration?: DiscountEnd.Duration;
|
|
5962
|
+
/**
|
|
5963
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5964
|
+
*/
|
|
5965
|
+
timestamp?: number;
|
|
5966
|
+
/**
|
|
5967
|
+
* The type of calculation made to determine when the discount ends.
|
|
5968
|
+
*/
|
|
5969
|
+
type: DiscountEnd.Type;
|
|
5970
|
+
}
|
|
5971
|
+
namespace DiscountEnd {
|
|
5972
|
+
interface Duration {
|
|
5973
|
+
/**
|
|
5974
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5975
|
+
*/
|
|
5976
|
+
interval: Duration.Interval;
|
|
5977
|
+
/**
|
|
5978
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5979
|
+
*/
|
|
5980
|
+
interval_count: number;
|
|
5981
|
+
}
|
|
5982
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
5983
|
+
namespace Duration {
|
|
5984
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
5985
|
+
}
|
|
5986
|
+
}
|
|
5987
|
+
}
|
|
3956
5988
|
namespace PriceData {
|
|
3957
5989
|
interface ProductData {
|
|
3958
5990
|
/**
|
|
@@ -3975,12 +6007,28 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
3975
6007
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
3976
6008
|
*/
|
|
3977
6009
|
tax_code?: string;
|
|
6010
|
+
/**
|
|
6011
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
6012
|
+
*/
|
|
6013
|
+
tax_details?: ProductData.TaxDetails;
|
|
3978
6014
|
/**
|
|
3979
6015
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
3980
6016
|
*/
|
|
3981
6017
|
unit_label?: string;
|
|
3982
6018
|
}
|
|
3983
6019
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
6020
|
+
namespace ProductData {
|
|
6021
|
+
interface TaxDetails {
|
|
6022
|
+
/**
|
|
6023
|
+
* 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.
|
|
6024
|
+
*/
|
|
6025
|
+
performance_location?: string;
|
|
6026
|
+
/**
|
|
6027
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
6028
|
+
*/
|
|
6029
|
+
tax_code?: Emptyable<string>;
|
|
6030
|
+
}
|
|
6031
|
+
}
|
|
3984
6032
|
}
|
|
3985
6033
|
namespace TaxAmount {
|
|
3986
6034
|
interface TaxRateData {
|
|
@@ -4050,6 +6098,10 @@ export interface InvoiceUpdateLineItemParams {
|
|
|
4050
6098
|
* Specifies which fields in the response should be expanded.
|
|
4051
6099
|
*/
|
|
4052
6100
|
expand?: Array<string>;
|
|
6101
|
+
/**
|
|
6102
|
+
* 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.
|
|
6103
|
+
*/
|
|
6104
|
+
margins?: Emptyable<Array<string>>;
|
|
4053
6105
|
/**
|
|
4054
6106
|
* 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.
|
|
4055
6107
|
*/
|
|
@@ -4093,6 +6145,10 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4093
6145
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4094
6146
|
*/
|
|
4095
6147
|
discount?: string;
|
|
6148
|
+
/**
|
|
6149
|
+
* Details to determine how long the discount should be applied for.
|
|
6150
|
+
*/
|
|
6151
|
+
discount_end?: Discount.DiscountEnd;
|
|
4096
6152
|
/**
|
|
4097
6153
|
* ID of the promotion code to create a new discount for.
|
|
4098
6154
|
*/
|
|
@@ -4160,6 +6216,38 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4160
6216
|
*/
|
|
4161
6217
|
taxable_amount: number;
|
|
4162
6218
|
}
|
|
6219
|
+
namespace Discount {
|
|
6220
|
+
interface DiscountEnd {
|
|
6221
|
+
/**
|
|
6222
|
+
* Time span for the redeemed discount.
|
|
6223
|
+
*/
|
|
6224
|
+
duration?: DiscountEnd.Duration;
|
|
6225
|
+
/**
|
|
6226
|
+
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
6227
|
+
*/
|
|
6228
|
+
timestamp?: number;
|
|
6229
|
+
/**
|
|
6230
|
+
* The type of calculation made to determine when the discount ends.
|
|
6231
|
+
*/
|
|
6232
|
+
type: DiscountEnd.Type;
|
|
6233
|
+
}
|
|
6234
|
+
namespace DiscountEnd {
|
|
6235
|
+
interface Duration {
|
|
6236
|
+
/**
|
|
6237
|
+
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
6238
|
+
*/
|
|
6239
|
+
interval: Duration.Interval;
|
|
6240
|
+
/**
|
|
6241
|
+
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
6242
|
+
*/
|
|
6243
|
+
interval_count: number;
|
|
6244
|
+
}
|
|
6245
|
+
type Type = 'duration' | 'timestamp' | OtherString;
|
|
6246
|
+
namespace Duration {
|
|
6247
|
+
type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
|
|
6248
|
+
}
|
|
6249
|
+
}
|
|
6250
|
+
}
|
|
4163
6251
|
namespace PriceData {
|
|
4164
6252
|
interface ProductData {
|
|
4165
6253
|
/**
|
|
@@ -4182,12 +6270,28 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
4182
6270
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
4183
6271
|
*/
|
|
4184
6272
|
tax_code?: string;
|
|
6273
|
+
/**
|
|
6274
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
6275
|
+
*/
|
|
6276
|
+
tax_details?: ProductData.TaxDetails;
|
|
4185
6277
|
/**
|
|
4186
6278
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
4187
6279
|
*/
|
|
4188
6280
|
unit_label?: string;
|
|
4189
6281
|
}
|
|
4190
6282
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
6283
|
+
namespace ProductData {
|
|
6284
|
+
interface TaxDetails {
|
|
6285
|
+
/**
|
|
6286
|
+
* 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.
|
|
6287
|
+
*/
|
|
6288
|
+
performance_location?: string;
|
|
6289
|
+
/**
|
|
6290
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
6291
|
+
*/
|
|
6292
|
+
tax_code?: Emptyable<string>;
|
|
6293
|
+
}
|
|
6294
|
+
}
|
|
4191
6295
|
}
|
|
4192
6296
|
namespace TaxAmount {
|
|
4193
6297
|
interface TaxRateData {
|