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