stripe 22.3.0-alpha.4 → 22.3.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 +61 -2844
- package/OPENAPI_VERSION +1 -1
- package/README.md +60 -44
- package/VERSION +1 -1
- package/cjs/Error.d.ts +0 -53
- package/cjs/Error.js +1 -134
- package/cjs/Error.js.map +1 -1
- package/cjs/Types.d.ts +2 -4
- 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 +0 -467
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/Accounts.d.ts +7 -1021
- package/cjs/resources/Accounts.js +1 -48
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/ApplicationFees.d.ts +1 -28
- package/cjs/resources/Apps/Secrets.d.ts +14 -16
- package/cjs/resources/Apps/index.d.ts +1 -1
- package/cjs/resources/Balance.d.ts +0 -134
- package/cjs/resources/BalanceSettings.d.ts +0 -18
- package/cjs/resources/BalanceTransactions.d.ts +6 -6
- package/cjs/resources/BalanceTransactions.js +2 -2
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertTriggereds.d.ts +1 -57
- package/cjs/resources/Billing/Alerts.d.ts +32 -437
- package/cjs/resources/Billing/Alerts.js +5 -321
- package/cjs/resources/Billing/Alerts.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceSummary.d.ts +40 -166
- package/cjs/resources/Billing/CreditBalanceSummary.js +1 -39
- package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +75 -171
- package/cjs/resources/Billing/CreditBalanceTransactions.js +1 -100
- package/cjs/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/cjs/resources/Billing/CreditGrants.d.ts +41 -125
- package/cjs/resources/Billing/CreditGrants.js +5 -134
- package/cjs/resources/Billing/CreditGrants.js.map +1 -1
- package/cjs/resources/Billing/MeterEventAdjustments.d.ts +9 -11
- package/cjs/resources/Billing/MeterEventSummaries.d.ts +0 -6
- package/cjs/resources/Billing/Meters.d.ts +39 -72
- package/cjs/resources/Billing/index.d.ts +7 -13
- package/cjs/resources/Billing/index.js +0 -2
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/BillingPortal/Configurations.d.ts +132 -134
- package/cjs/resources/BillingPortal/Sessions.d.ts +100 -102
- package/cjs/resources/BillingPortal/index.d.ts +2 -2
- package/cjs/resources/Capabilities.d.ts +2 -25
- package/cjs/resources/Cards.d.ts +0 -15
- package/cjs/resources/Charges.d.ts +84 -3317
- package/cjs/resources/Charges.js.map +1 -1
- package/cjs/resources/Checkout/Sessions.d.ts +1610 -2321
- package/cjs/resources/Checkout/Sessions.js +0 -88
- package/cjs/resources/Checkout/Sessions.js.map +1 -1
- package/cjs/resources/Checkout/index.d.ts +1 -2
- package/cjs/resources/Climate/Orders.d.ts +47 -49
- package/cjs/resources/Climate/Products.d.ts +15 -17
- package/cjs/resources/Climate/Suppliers.d.ts +25 -27
- package/cjs/resources/Climate/index.d.ts +3 -3
- package/cjs/resources/ConfirmationTokens.d.ts +13 -139
- 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 +8 -11
- package/cjs/resources/CreditNotes.js +2 -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 +1 -85
- 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 +28 -44
- package/cjs/resources/Disputes.js +0 -14
- package/cjs/resources/Disputes.js.map +1 -1
- package/cjs/resources/Entitlements/index.d.ts +2 -2
- 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 +169 -217
- package/cjs/resources/FinancialConnections/Accounts.js +0 -8
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Sessions.d.ts +43 -193
- package/cjs/resources/FinancialConnections/Transactions.d.ts +13 -15
- package/cjs/resources/FinancialConnections/index.d.ts +9 -24
- package/cjs/resources/FinancialConnections/index.js +0 -4
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/Forwarding/Requests.d.ts +57 -59
- package/cjs/resources/Forwarding/index.d.ts +1 -1
- package/cjs/resources/Identity/VerificationReports.d.ts +256 -289
- package/cjs/resources/Identity/VerificationReports.js.map +1 -1
- package/cjs/resources/Identity/VerificationSessions.d.ts +150 -160
- package/cjs/resources/Identity/index.d.ts +12 -20
- package/cjs/resources/Identity/index.js +0 -2
- package/cjs/resources/Identity/index.js.map +1 -1
- package/cjs/resources/InvoiceItems.d.ts +2 -203
- 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 +37 -2080
- package/cjs/resources/Invoices.js +0 -221
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Authorizations.d.ts +354 -646
- package/cjs/resources/Issuing/Cardholders.d.ts +146 -149
- package/cjs/resources/Issuing/Cards.d.ts +183 -221
- package/cjs/resources/Issuing/Disputes.d.ts +185 -420
- package/cjs/resources/Issuing/PersonalizationDesigns.d.ts +47 -49
- package/cjs/resources/Issuing/PhysicalBundles.d.ts +24 -26
- package/cjs/resources/Issuing/Tokens.d.ts +130 -154
- package/cjs/resources/Issuing/Transactions.d.ts +209 -368
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +30 -63
- package/cjs/resources/Issuing/index.js +0 -8
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +4 -30
- package/cjs/resources/Mandates.d.ts +1 -47
- package/cjs/resources/Mandates.js +0 -8
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/PaymentAttemptRecords.d.ts +11 -581
- package/cjs/resources/PaymentAttemptRecords.js +0 -42
- package/cjs/resources/PaymentAttemptRecords.js.map +1 -1
- package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +0 -17
- package/cjs/resources/PaymentIntents.d.ts +5870 -18814
- package/cjs/resources/PaymentIntents.js +0 -46
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +15 -74
- package/cjs/resources/PaymentMethodConfigurations.d.ts +0 -350
- package/cjs/resources/PaymentMethods.d.ts +16 -278
- package/cjs/resources/PaymentMethods.js +0 -20
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +24 -536
- 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 +0 -76
- package/cjs/resources/Prices.js +0 -27
- package/cjs/resources/Prices.js.map +1 -1
- package/cjs/resources/Products.d.ts +0 -198
- 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 +105 -3399
- package/cjs/resources/Quotes.js +13 -1181
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +293 -357
- package/cjs/resources/Radar/ValueListItems.d.ts +14 -24
- package/cjs/resources/Radar/ValueListItems.js +0 -13
- package/cjs/resources/Radar/ValueListItems.js.map +1 -1
- package/cjs/resources/Radar/ValueLists.d.ts +18 -20
- package/cjs/resources/Radar/index.d.ts +22 -39
- package/cjs/resources/Radar/index.js +0 -6
- package/cjs/resources/Radar/index.js.map +1 -1
- package/cjs/resources/Refunds.d.ts +0 -35
- package/cjs/resources/Refunds.js +0 -27
- package/cjs/resources/Refunds.js.map +1 -1
- package/cjs/resources/Reporting/ReportRuns.d.ts +35 -37
- package/cjs/resources/Reporting/index.d.ts +2 -2
- package/cjs/resources/Reserve/Holds.d.ts +24 -64
- package/cjs/resources/Reserve/Holds.js +0 -19
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +25 -43
- package/cjs/resources/Reserve/Plans.js +0 -11
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +17 -59
- package/cjs/resources/Reserve/Releases.js +0 -19
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +3 -14
- package/cjs/resources/Reserve/index.js +0 -9
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/SetupAttempts.d.ts +8 -26
- package/cjs/resources/SetupIntents.d.ts +14 -593
- package/cjs/resources/Sigma/ScheduledQueryRuns.d.ts +7 -9
- package/cjs/resources/Sigma/index.d.ts +1 -1
- package/cjs/resources/Sources.d.ts +1 -16
- package/cjs/resources/SubscriptionItems.d.ts +0 -265
- package/cjs/resources/SubscriptionItems.js +0 -41
- package/cjs/resources/SubscriptionItems.js.map +1 -1
- package/cjs/resources/SubscriptionSchedules.d.ts +23 -1952
- package/cjs/resources/SubscriptionSchedules.js +0 -61
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +67 -954
- package/cjs/resources/Subscriptions.js +1 -290
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/Associations.d.ts +24 -26
- package/cjs/resources/Tax/CalculationLineItems.d.ts +57 -70
- package/cjs/resources/Tax/Calculations.d.ts +158 -202
- package/cjs/resources/Tax/Registrations.d.ts +1091 -1262
- package/cjs/resources/Tax/Registrations.js +0 -27
- package/cjs/resources/Tax/Registrations.js.map +1 -1
- package/cjs/resources/Tax/Settings.d.ts +37 -47
- package/cjs/resources/Tax/Settings.js +0 -13
- package/cjs/resources/Tax/Settings.js.map +1 -1
- package/cjs/resources/Tax/TransactionLineItems.d.ts +12 -21
- package/cjs/resources/Tax/Transactions.d.ts +113 -123
- package/cjs/resources/Tax/Transactions.js +0 -13
- package/cjs/resources/Tax/Transactions.js.map +1 -1
- package/cjs/resources/Tax/index.d.ts +18 -32
- package/cjs/resources/Tax/index.js +0 -4
- package/cjs/resources/Tax/index.js.map +1 -1
- package/cjs/resources/TaxCodes.d.ts +0 -15
- package/cjs/resources/TaxIds.d.ts +0 -6
- package/cjs/resources/TaxIds.js +0 -13
- package/cjs/resources/TaxIds.js.map +1 -1
- package/cjs/resources/TaxRates.d.ts +0 -12
- package/cjs/resources/TaxRates.js +0 -27
- package/cjs/resources/TaxRates.js.map +1 -1
- package/cjs/resources/Terminal/Configurations.d.ts +479 -508
- package/cjs/resources/Terminal/Locations.d.ts +72 -74
- package/cjs/resources/Terminal/OnboardingLinks.d.ts +16 -18
- package/cjs/resources/Terminal/Readers.d.ts +479 -497
- package/cjs/resources/Terminal/index.d.ts +11 -13
- 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 -95
- package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +0 -8
- package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +0 -16
- 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/TestClocks.d.ts +27 -29
- 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 +8 -15
- package/cjs/resources/TestHelpers/index.js +6 -12
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Tokens.d.ts +0 -61
- package/cjs/resources/Topups.d.ts +18 -0
- package/cjs/resources/Transfers.d.ts +0 -12
- package/cjs/resources/Transfers.js.map +1 -1
- package/cjs/resources/Treasury/CreditReversals.d.ts +11 -13
- package/cjs/resources/Treasury/DebitReversals.d.ts +18 -20
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +252 -259
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +88 -123
- package/cjs/resources/Treasury/InboundTransfers.d.ts +79 -81
- package/cjs/resources/Treasury/OutboundPayments.d.ts +125 -135
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +114 -160
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +118 -142
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +86 -114
- package/cjs/resources/Treasury/TransactionEntries.d.ts +75 -77
- package/cjs/resources/Treasury/Transactions.d.ts +86 -88
- package/cjs/resources/Treasury/index.d.ts +10 -10
- package/cjs/resources/V2/Billing/MeterEventAdjustments.d.ts +9 -13
- package/cjs/resources/V2/Billing/index.d.ts +9 -177
- package/cjs/resources/V2/Billing/index.js +0 -32
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalogImports.d.ts +132 -131
- package/cjs/resources/V2/Core/AccountLinks.d.ts +80 -236
- package/cjs/resources/V2/Core/AccountPersons.d.ts +369 -373
- package/cjs/resources/V2/Core/AccountTokens.d.ts +2 -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 +5211 -16314
- package/cjs/resources/V2/Core/Accounts.js +38 -8050
- package/cjs/resources/V2/Core/Accounts.js.map +1 -1
- package/cjs/resources/V2/Core/EventDestinations.d.ts +78 -82
- package/cjs/resources/V2/Core/Events.d.ts +252 -7625
- package/cjs/resources/V2/Core/index.d.ts +19 -68
- package/cjs/resources/V2/Core/index.js +0 -16
- 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 +14 -262
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.cjs.node.d.ts +14384 -3
- package/cjs/stripe.cjs.node.js +1 -4
- package/cjs/stripe.cjs.node.js.map +1 -1
- package/cjs/stripe.core.d.ts +94 -125
- package/cjs/stripe.core.js +32 -73
- package/cjs/stripe.core.js.map +1 -1
- package/esm/Error.d.ts +0 -53
- package/esm/Error.js +0 -117
- package/esm/Error.js.map +1 -1
- package/esm/Types.d.ts +2 -4
- 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 +0 -467
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/Accounts.d.ts +7 -1021
- package/esm/resources/Accounts.js +1 -48
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/ApplicationFees.d.ts +1 -28
- package/esm/resources/Apps/Secrets.d.ts +14 -16
- package/esm/resources/Apps/index.d.ts +1 -1
- package/esm/resources/Balance.d.ts +0 -134
- package/esm/resources/BalanceSettings.d.ts +0 -18
- package/esm/resources/BalanceTransactions.d.ts +6 -6
- package/esm/resources/BalanceTransactions.js +2 -2
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertTriggereds.d.ts +1 -57
- package/esm/resources/Billing/Alerts.d.ts +32 -437
- package/esm/resources/Billing/Alerts.js +5 -321
- package/esm/resources/Billing/Alerts.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceSummary.d.ts +40 -166
- package/esm/resources/Billing/CreditBalanceSummary.js +1 -39
- package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
- package/esm/resources/Billing/CreditBalanceTransactions.d.ts +75 -171
- package/esm/resources/Billing/CreditBalanceTransactions.js +1 -100
- package/esm/resources/Billing/CreditBalanceTransactions.js.map +1 -1
- package/esm/resources/Billing/CreditGrants.d.ts +41 -125
- package/esm/resources/Billing/CreditGrants.js +5 -134
- package/esm/resources/Billing/CreditGrants.js.map +1 -1
- package/esm/resources/Billing/MeterEventAdjustments.d.ts +9 -11
- package/esm/resources/Billing/MeterEventSummaries.d.ts +0 -6
- package/esm/resources/Billing/Meters.d.ts +39 -72
- package/esm/resources/Billing/index.d.ts +7 -13
- package/esm/resources/Billing/index.js +0 -2
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/BillingPortal/Configurations.d.ts +132 -134
- package/esm/resources/BillingPortal/Sessions.d.ts +100 -102
- package/esm/resources/BillingPortal/index.d.ts +2 -2
- package/esm/resources/Capabilities.d.ts +2 -25
- package/esm/resources/Cards.d.ts +0 -15
- package/esm/resources/Charges.d.ts +84 -3317
- package/esm/resources/Charges.js.map +1 -1
- package/esm/resources/Checkout/Sessions.d.ts +1610 -2321
- package/esm/resources/Checkout/Sessions.js +0 -88
- package/esm/resources/Checkout/Sessions.js.map +1 -1
- package/esm/resources/Checkout/index.d.ts +1 -2
- package/esm/resources/Climate/Orders.d.ts +47 -49
- package/esm/resources/Climate/Products.d.ts +15 -17
- package/esm/resources/Climate/Suppliers.d.ts +25 -27
- package/esm/resources/Climate/index.d.ts +3 -3
- package/esm/resources/ConfirmationTokens.d.ts +13 -139
- 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 +8 -11
- package/esm/resources/CreditNotes.js +2 -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 +1 -85
- 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 +28 -44
- package/esm/resources/Disputes.js +0 -14
- package/esm/resources/Disputes.js.map +1 -1
- package/esm/resources/Entitlements/index.d.ts +2 -2
- 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 +169 -217
- package/esm/resources/FinancialConnections/Accounts.js +0 -8
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Sessions.d.ts +43 -193
- package/esm/resources/FinancialConnections/Transactions.d.ts +13 -15
- package/esm/resources/FinancialConnections/index.d.ts +9 -24
- package/esm/resources/FinancialConnections/index.js +0 -4
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/Forwarding/Requests.d.ts +57 -59
- package/esm/resources/Forwarding/index.d.ts +1 -1
- package/esm/resources/Identity/VerificationReports.d.ts +256 -289
- package/esm/resources/Identity/VerificationReports.js.map +1 -1
- package/esm/resources/Identity/VerificationSessions.d.ts +150 -160
- package/esm/resources/Identity/index.d.ts +12 -20
- package/esm/resources/Identity/index.js +0 -2
- package/esm/resources/Identity/index.js.map +1 -1
- package/esm/resources/InvoiceItems.d.ts +2 -203
- 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 +37 -2080
- package/esm/resources/Invoices.js +0 -221
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Authorizations.d.ts +354 -646
- package/esm/resources/Issuing/Cardholders.d.ts +146 -149
- package/esm/resources/Issuing/Cards.d.ts +183 -221
- package/esm/resources/Issuing/Disputes.d.ts +185 -420
- package/esm/resources/Issuing/PersonalizationDesigns.d.ts +47 -49
- package/esm/resources/Issuing/PhysicalBundles.d.ts +24 -26
- package/esm/resources/Issuing/Tokens.d.ts +130 -154
- package/esm/resources/Issuing/Transactions.d.ts +209 -368
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +30 -63
- package/esm/resources/Issuing/index.js +0 -8
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +4 -30
- package/esm/resources/Mandates.d.ts +1 -47
- package/esm/resources/Mandates.js +0 -8
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/PaymentAttemptRecords.d.ts +11 -581
- package/esm/resources/PaymentAttemptRecords.js +0 -42
- package/esm/resources/PaymentAttemptRecords.js.map +1 -1
- package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +0 -17
- package/esm/resources/PaymentIntents.d.ts +5870 -18814
- package/esm/resources/PaymentIntents.js +0 -46
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +15 -74
- package/esm/resources/PaymentMethodConfigurations.d.ts +0 -350
- package/esm/resources/PaymentMethods.d.ts +16 -278
- package/esm/resources/PaymentMethods.js +0 -20
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +24 -536
- 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 +0 -76
- package/esm/resources/Prices.js +0 -27
- package/esm/resources/Prices.js.map +1 -1
- package/esm/resources/Products.d.ts +0 -198
- 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 +105 -3399
- package/esm/resources/Quotes.js +13 -1181
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/PaymentEvaluations.d.ts +293 -357
- package/esm/resources/Radar/ValueListItems.d.ts +14 -24
- package/esm/resources/Radar/ValueListItems.js +0 -13
- package/esm/resources/Radar/ValueListItems.js.map +1 -1
- package/esm/resources/Radar/ValueLists.d.ts +18 -20
- package/esm/resources/Radar/index.d.ts +22 -39
- package/esm/resources/Radar/index.js +0 -6
- package/esm/resources/Radar/index.js.map +1 -1
- package/esm/resources/Refunds.d.ts +0 -35
- package/esm/resources/Refunds.js +0 -27
- package/esm/resources/Refunds.js.map +1 -1
- package/esm/resources/Reporting/ReportRuns.d.ts +35 -37
- package/esm/resources/Reporting/index.d.ts +2 -2
- package/esm/resources/Reserve/Holds.d.ts +24 -64
- package/esm/resources/Reserve/Holds.js +1 -17
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +25 -43
- package/esm/resources/Reserve/Plans.js +1 -9
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +17 -59
- package/esm/resources/Reserve/Releases.js +1 -17
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +3 -14
- package/esm/resources/Reserve/index.js +0 -9
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/SetupAttempts.d.ts +8 -26
- package/esm/resources/SetupIntents.d.ts +14 -593
- package/esm/resources/Sigma/ScheduledQueryRuns.d.ts +7 -9
- package/esm/resources/Sigma/index.d.ts +1 -1
- package/esm/resources/Sources.d.ts +1 -16
- package/esm/resources/SubscriptionItems.d.ts +0 -265
- package/esm/resources/SubscriptionItems.js +0 -41
- package/esm/resources/SubscriptionItems.js.map +1 -1
- package/esm/resources/SubscriptionSchedules.d.ts +23 -1952
- package/esm/resources/SubscriptionSchedules.js +0 -61
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +67 -954
- package/esm/resources/Subscriptions.js +1 -290
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/Associations.d.ts +24 -26
- package/esm/resources/Tax/CalculationLineItems.d.ts +57 -70
- package/esm/resources/Tax/Calculations.d.ts +158 -202
- package/esm/resources/Tax/Registrations.d.ts +1091 -1262
- package/esm/resources/Tax/Registrations.js +0 -27
- package/esm/resources/Tax/Registrations.js.map +1 -1
- package/esm/resources/Tax/Settings.d.ts +37 -47
- package/esm/resources/Tax/Settings.js +0 -13
- package/esm/resources/Tax/Settings.js.map +1 -1
- package/esm/resources/Tax/TransactionLineItems.d.ts +12 -21
- package/esm/resources/Tax/Transactions.d.ts +113 -123
- package/esm/resources/Tax/Transactions.js +0 -13
- package/esm/resources/Tax/Transactions.js.map +1 -1
- package/esm/resources/Tax/index.d.ts +18 -32
- package/esm/resources/Tax/index.js +0 -4
- package/esm/resources/Tax/index.js.map +1 -1
- package/esm/resources/TaxCodes.d.ts +0 -15
- package/esm/resources/TaxIds.d.ts +0 -6
- package/esm/resources/TaxIds.js +0 -13
- package/esm/resources/TaxIds.js.map +1 -1
- package/esm/resources/TaxRates.d.ts +0 -12
- package/esm/resources/TaxRates.js +0 -27
- package/esm/resources/TaxRates.js.map +1 -1
- package/esm/resources/Terminal/Configurations.d.ts +479 -508
- package/esm/resources/Terminal/Locations.d.ts +72 -74
- package/esm/resources/Terminal/OnboardingLinks.d.ts +16 -18
- package/esm/resources/Terminal/Readers.d.ts +479 -497
- package/esm/resources/Terminal/index.d.ts +11 -13
- 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 -95
- package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +0 -8
- package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +0 -16
- 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/TestClocks.d.ts +27 -29
- 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 +8 -15
- package/esm/resources/TestHelpers/index.js +0 -6
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Tokens.d.ts +0 -61
- package/esm/resources/Topups.d.ts +18 -0
- package/esm/resources/Transfers.d.ts +0 -12
- package/esm/resources/Transfers.js.map +1 -1
- package/esm/resources/Treasury/CreditReversals.d.ts +11 -13
- package/esm/resources/Treasury/DebitReversals.d.ts +18 -20
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +252 -259
- package/esm/resources/Treasury/FinancialAccounts.d.ts +88 -123
- package/esm/resources/Treasury/InboundTransfers.d.ts +79 -81
- package/esm/resources/Treasury/OutboundPayments.d.ts +125 -135
- package/esm/resources/Treasury/OutboundTransfers.d.ts +114 -160
- package/esm/resources/Treasury/ReceivedCredits.d.ts +118 -142
- package/esm/resources/Treasury/ReceivedDebits.d.ts +86 -114
- package/esm/resources/Treasury/TransactionEntries.d.ts +75 -77
- package/esm/resources/Treasury/Transactions.d.ts +86 -88
- package/esm/resources/Treasury/index.d.ts +10 -10
- package/esm/resources/V2/Billing/MeterEventAdjustments.d.ts +9 -13
- package/esm/resources/V2/Billing/index.d.ts +9 -177
- package/esm/resources/V2/Billing/index.js +0 -32
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Commerce/ProductCatalogImports.d.ts +132 -131
- package/esm/resources/V2/Core/AccountLinks.d.ts +80 -236
- package/esm/resources/V2/Core/AccountPersons.d.ts +369 -373
- package/esm/resources/V2/Core/AccountTokens.d.ts +2 -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 +5211 -16314
- package/esm/resources/V2/Core/Accounts.js +38 -8050
- package/esm/resources/V2/Core/Accounts.js.map +1 -1
- package/esm/resources/V2/Core/EventDestinations.d.ts +78 -82
- package/esm/resources/V2/Core/Events.d.ts +252 -7625
- package/esm/resources/V2/Core/index.d.ts +19 -68
- package/esm/resources/V2/Core/index.js +0 -16
- 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 -236
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +94 -125
- package/esm/stripe.core.js +2 -43
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +94 -125
- 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 -471
- 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 -110
- 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/AlertRecovereds.d.ts +0 -40
- 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 -191
- 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 -98
- 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 -143
- 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/DelegatedCheckout/OrderEvents.d.ts +0 -130
- 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 -161
- 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 -1418
- 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/Authorizations.d.ts +0 -87
- package/cjs/resources/FinancialConnections/Authorizations.js +0 -15
- package/cjs/resources/FinancialConnections/Authorizations.js.map +0 -1
- package/cjs/resources/FinancialConnections/Institutions.d.ts +0 -101
- package/cjs/resources/FinancialConnections/Institutions.js +0 -23
- package/cjs/resources/FinancialConnections/Institutions.js.map +0 -1
- package/cjs/resources/FrMealVouchersOnboardings.d.ts +0 -173
- package/cjs/resources/FrMealVouchersOnboardings.js +0 -42
- package/cjs/resources/FrMealVouchersOnboardings.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 -246
- 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 -157
- 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 -640
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -47
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
- package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +0 -95
- 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 -85
- 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 -122
- 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 -37
- 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 -229
- 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 -127
- 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 -26
- 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 -1173
- package/cjs/resources/QuotePreviewInvoices.js +0 -4
- package/cjs/resources/QuotePreviewInvoices.js.map +0 -1
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -901
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +0 -4
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/cjs/resources/Radar/AccountEvaluations.d.ts +0 -310
- 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 -246
- 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 -435
- 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 -1136
- 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 -322
- 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 -230
- 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 -126
- package/cjs/resources/TaxFunds.js +0 -23
- package/cjs/resources/TaxFunds.js.map +0 -1
- package/cjs/resources/Terminal/ReaderCollectedData.d.ts +0 -52
- 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 -104
- package/cjs/resources/TestHelpers/Issuing/Disputes.js +0 -33
- package/cjs/resources/TestHelpers/Issuing/Disputes.js.map +0 -1
- package/cjs/resources/TestHelpers/PaymentIntents.d.ts +0 -37
- 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 -75
- 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 -284
- 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 -88
- 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 -1015
- 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 -240
- 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 -779
- package/cjs/resources/V2/Billing/CollectionSettings.js +0 -166
- package/cjs/resources/V2/Billing/CollectionSettings.js.map +0 -1
- package/cjs/resources/V2/Billing/ContractLicensePricingQuantityChanges.d.ts +0 -45
- package/cjs/resources/V2/Billing/ContractLicensePricingQuantityChanges.js +0 -4
- package/cjs/resources/V2/Billing/ContractLicensePricingQuantityChanges.js.map +0 -1
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.d.ts +0 -23
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js +0 -17
- package/cjs/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js.map +0 -1
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.d.ts +0 -8
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.js +0 -15
- package/cjs/resources/V2/Billing/Contracts/LicensePricing.js.map +0 -1
- package/cjs/resources/V2/Billing/Contracts.d.ts +0 -2028
- package/cjs/resources/V2/Billing/Contracts.js +0 -376
- 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 -607
- 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 -1257
- 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 -82
- 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 -364
- 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 -174
- 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 -222
- 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 -174
- 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 -84
- 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 -624
- 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 -173
- 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 -166
- 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 -115
- 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 -219
- 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 -340
- 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 -514
- 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 -160
- 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 -334
- 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 -373
- 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 -229
- 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 -90
- 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 -237
- 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 -203
- package/cjs/resources/V2/Core/FeeEntries.js +0 -23
- package/cjs/resources/V2/Core/FeeEntries.js.map +0 -1
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -285
- 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 -255
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -63
- 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 -73
- 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 -82
- 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 -177
- 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 -166
- 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 -123
- 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 -214
- 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 -280
- 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 -139
- 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 -135
- 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 -171
- 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 -103
- 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 -417
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -50
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -308
- 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 -254
- 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 -222
- 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 -524
- 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 -321
- 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 -342
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -39
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -270
- 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 -96
- 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 -458
- 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 -251
- 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 -120
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +0 -27
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -253
- 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 -284
- 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 -128
- package/cjs/resources/V2/MoneyManagement/index.js +0 -45
- package/cjs/resources/V2/MoneyManagement/index.js.map +0 -1
- package/cjs/resources/V2/Network/BusinessProfiles.d.ts +0 -96
- 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 -147
- 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 -827
- 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 -77
- 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 -213
- 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 -194
- 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 -110
- 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 -176
- 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 -335
- 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 -44
- 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 -467
- 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 -110
- 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/AlertRecovereds.d.ts +0 -40
- 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 -191
- 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 -98
- 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 -143
- 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/DelegatedCheckout/OrderEvents.d.ts +0 -130
- 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 -161
- 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 -1418
- 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/Authorizations.d.ts +0 -87
- package/esm/resources/FinancialConnections/Authorizations.js +0 -11
- package/esm/resources/FinancialConnections/Authorizations.js.map +0 -1
- package/esm/resources/FinancialConnections/Institutions.d.ts +0 -101
- package/esm/resources/FinancialConnections/Institutions.js +0 -19
- package/esm/resources/FinancialConnections/Institutions.js.map +0 -1
- package/esm/resources/FrMealVouchersOnboardings.d.ts +0 -173
- package/esm/resources/FrMealVouchersOnboardings.js +0 -38
- package/esm/resources/FrMealVouchersOnboardings.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 -246
- 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 -157
- 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 -640
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -43
- package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
- package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +0 -95
- 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 -85
- 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 -122
- 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 -37
- 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 -229
- 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 -127
- 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 -26
- 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 -1173
- package/esm/resources/QuotePreviewInvoices.js +0 -3
- package/esm/resources/QuotePreviewInvoices.js.map +0 -1
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -901
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +0 -3
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/esm/resources/Radar/AccountEvaluations.d.ts +0 -310
- 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 -246
- 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 -435
- 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 -1136
- 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 -322
- 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 -230
- 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 -126
- package/esm/resources/TaxFunds.js +0 -19
- package/esm/resources/TaxFunds.js.map +0 -1
- package/esm/resources/Terminal/ReaderCollectedData.d.ts +0 -52
- 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 -104
- package/esm/resources/TestHelpers/Issuing/Disputes.js +0 -29
- package/esm/resources/TestHelpers/Issuing/Disputes.js.map +0 -1
- package/esm/resources/TestHelpers/PaymentIntents.d.ts +0 -37
- 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 -75
- 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 -284
- 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 -88
- 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 -1015
- 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 -240
- 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 -779
- package/esm/resources/V2/Billing/CollectionSettings.js +0 -162
- package/esm/resources/V2/Billing/CollectionSettings.js.map +0 -1
- package/esm/resources/V2/Billing/ContractLicensePricingQuantityChanges.d.ts +0 -45
- package/esm/resources/V2/Billing/ContractLicensePricingQuantityChanges.js +0 -3
- package/esm/resources/V2/Billing/ContractLicensePricingQuantityChanges.js.map +0 -1
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.d.ts +0 -23
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js +0 -13
- package/esm/resources/V2/Billing/Contracts/LicensePricing/QuantityChanges.js.map +0 -1
- package/esm/resources/V2/Billing/Contracts/LicensePricing.d.ts +0 -8
- package/esm/resources/V2/Billing/Contracts/LicensePricing.js +0 -11
- package/esm/resources/V2/Billing/Contracts/LicensePricing.js.map +0 -1
- package/esm/resources/V2/Billing/Contracts.d.ts +0 -2028
- package/esm/resources/V2/Billing/Contracts.js +0 -372
- 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 -607
- 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 -1257
- 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 -82
- 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 -364
- 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 -174
- 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 -222
- 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 -174
- 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 -84
- 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 -624
- 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 -173
- 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 -166
- 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 -115
- 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 -219
- 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 -340
- 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 -514
- 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 -160
- 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 -334
- 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 -373
- 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 -229
- 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 -90
- 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 -237
- 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 -203
- package/esm/resources/V2/Core/FeeEntries.js +0 -19
- package/esm/resources/V2/Core/FeeEntries.js.map +0 -1
- package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -285
- 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 -255
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -59
- 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 -73
- 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 -82
- 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 -177
- 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 -166
- 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 -123
- 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 -214
- 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 -280
- 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 -139
- 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 -135
- 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 -171
- 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 -103
- 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 -417
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -46
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -308
- 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 -254
- 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 -222
- 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 -524
- 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 -321
- 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 -342
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -35
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -270
- 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 -96
- 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 -458
- 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 -251
- 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 -120
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +0 -23
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -253
- 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 -284
- 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 -128
- package/esm/resources/V2/MoneyManagement/index.js +0 -41
- package/esm/resources/V2/MoneyManagement/index.js.map +0 -1
- package/esm/resources/V2/Network/BusinessProfiles.d.ts +0 -96
- 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 -147
- 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 -827
- 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 -77
- 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 -213
- 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 -194
- 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 -110
- 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 -176
- 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 -335
- 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 -44
- 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,10 +1,6 @@
|
|
|
1
1
|
import { StripeResource } from '../StripeResource.js';
|
|
2
|
-
import { InvoiceLineItem } from './InvoiceLineItems.js';
|
|
3
2
|
import { LineItem } from './LineItems.js';
|
|
4
|
-
import {
|
|
5
|
-
import { QuotePreviewInvoice } from './QuotePreviewInvoices.js';
|
|
6
|
-
import { QuotePreviewSubscriptionSchedule } from './QuotePreviewSubscriptionSchedules.js';
|
|
7
|
-
import { Discount } from './Discounts.js';
|
|
3
|
+
import { Discount as _Discount } from './Discounts.js';
|
|
8
4
|
import { Application, DeletedApplication } from './Applications.js';
|
|
9
5
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
10
6
|
import { TaxRate } from './TaxRates.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, 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
|
*/
|
|
@@ -152,7 +115,7 @@ export interface Quote {
|
|
|
152
115
|
/**
|
|
153
116
|
* The discounts applied to this quote.
|
|
154
117
|
*/
|
|
155
|
-
discounts: Array<string |
|
|
118
|
+
discounts: Array<string | _Discount>;
|
|
156
119
|
/**
|
|
157
120
|
* The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
|
|
158
121
|
*/
|
|
@@ -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 {
|
|
@@ -286,11 +225,7 @@ export declare namespace Quote {
|
|
|
286
225
|
days_until_due: number | null;
|
|
287
226
|
issuer: InvoiceSettings.Issuer;
|
|
288
227
|
}
|
|
289
|
-
type Status = 'accepted' | '
|
|
290
|
-
interface StatusDetails {
|
|
291
|
-
canceled?: StatusDetails.Canceled;
|
|
292
|
-
stale?: StatusDetails.Stale;
|
|
293
|
-
}
|
|
228
|
+
type Status = 'accepted' | 'canceled' | 'draft' | 'open';
|
|
294
229
|
interface StatusTransitions {
|
|
295
230
|
/**
|
|
296
231
|
* The time that the quote was accepted. Measured in seconds since Unix epoch.
|
|
@@ -306,26 +241,10 @@ export declare namespace Quote {
|
|
|
306
241
|
finalized_at: number | null;
|
|
307
242
|
}
|
|
308
243
|
interface SubscriptionData {
|
|
309
|
-
/**
|
|
310
|
-
* Describes the period to bill for upon accepting the quote.
|
|
311
|
-
*/
|
|
312
|
-
bill_on_acceptance?: SubscriptionData.BillOnAcceptance | null;
|
|
313
|
-
/**
|
|
314
|
-
* 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.
|
|
315
|
-
*/
|
|
316
|
-
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
317
|
-
/**
|
|
318
|
-
* Whether the subscription will always start a new billing period when the quote is accepted.
|
|
319
|
-
*/
|
|
320
|
-
billing_cycle_anchor?: 'reset' | null;
|
|
321
244
|
/**
|
|
322
245
|
* The billing mode of the quote.
|
|
323
246
|
*/
|
|
324
247
|
billing_mode: SubscriptionData.BillingMode;
|
|
325
|
-
/**
|
|
326
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
|
|
327
|
-
*/
|
|
328
|
-
billing_schedules?: Array<SubscriptionData.BillingSchedule>;
|
|
329
248
|
/**
|
|
330
249
|
* 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.
|
|
331
250
|
*/
|
|
@@ -334,77 +253,15 @@ export declare namespace Quote {
|
|
|
334
253
|
* 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.
|
|
335
254
|
*/
|
|
336
255
|
effective_date: number | null;
|
|
337
|
-
/**
|
|
338
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
339
|
-
*/
|
|
340
|
-
end_behavior?: SubscriptionData.EndBehavior | null;
|
|
341
|
-
/**
|
|
342
|
-
* The id of the subscription that will be updated when the quote is accepted.
|
|
343
|
-
*/
|
|
344
|
-
from_subscription?: string | Subscription | null;
|
|
345
256
|
/**
|
|
346
257
|
* 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.
|
|
347
258
|
*/
|
|
348
259
|
metadata: Metadata | null;
|
|
349
|
-
/**
|
|
350
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
351
|
-
*/
|
|
352
|
-
phase_effective_at?: SubscriptionData.PhaseEffectiveAt | null;
|
|
353
|
-
/**
|
|
354
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
355
|
-
*/
|
|
356
|
-
prebilling?: SubscriptionData.Prebilling | null;
|
|
357
|
-
/**
|
|
358
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
359
|
-
*/
|
|
360
|
-
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
361
260
|
/**
|
|
362
261
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
363
262
|
*/
|
|
364
263
|
trial_period_days: number | null;
|
|
365
264
|
}
|
|
366
|
-
interface SubscriptionDataOverride {
|
|
367
|
-
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
368
|
-
/**
|
|
369
|
-
* Describes the period to bill for upon accepting the quote.
|
|
370
|
-
*/
|
|
371
|
-
bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance | null;
|
|
372
|
-
/**
|
|
373
|
-
* 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.
|
|
374
|
-
*/
|
|
375
|
-
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
376
|
-
/**
|
|
377
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
|
|
378
|
-
*/
|
|
379
|
-
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
380
|
-
/**
|
|
381
|
-
* The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
|
|
382
|
-
*/
|
|
383
|
-
customer: string | null;
|
|
384
|
-
/**
|
|
385
|
-
* 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.
|
|
386
|
-
*/
|
|
387
|
-
description: string | null;
|
|
388
|
-
/**
|
|
389
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
390
|
-
*/
|
|
391
|
-
end_behavior?: SubscriptionDataOverride.EndBehavior | null;
|
|
392
|
-
/**
|
|
393
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
394
|
-
*/
|
|
395
|
-
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt | null;
|
|
396
|
-
/**
|
|
397
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
|
|
398
|
-
*/
|
|
399
|
-
proration_behavior?: SubscriptionDataOverride.ProrationBehavior | null;
|
|
400
|
-
}
|
|
401
|
-
interface SubscriptionSchedule {
|
|
402
|
-
applies_to: SubscriptionSchedule.AppliesTo;
|
|
403
|
-
/**
|
|
404
|
-
* The subscription schedule that was created or updated from this quote.
|
|
405
|
-
*/
|
|
406
|
-
subscription_schedule: string;
|
|
407
|
-
}
|
|
408
265
|
interface TotalDetails {
|
|
409
266
|
/**
|
|
410
267
|
* This is the sum of all the discounts.
|
|
@@ -447,20 +304,10 @@ export declare namespace Quote {
|
|
|
447
304
|
}
|
|
448
305
|
type Status = 'complete' | 'failed' | 'requires_location_inputs';
|
|
449
306
|
namespace Liability {
|
|
450
|
-
type Type = 'account' | '
|
|
307
|
+
type Type = 'account' | 'self';
|
|
451
308
|
}
|
|
452
309
|
}
|
|
453
310
|
namespace Computed {
|
|
454
|
-
interface LastReestimationDetails {
|
|
455
|
-
/**
|
|
456
|
-
* When `status` is `failed`, provides details about the quote reestimation failure.
|
|
457
|
-
*/
|
|
458
|
-
failed: LastReestimationDetails.Failed | null;
|
|
459
|
-
/**
|
|
460
|
-
* Latest status of the reestimation.
|
|
461
|
-
*/
|
|
462
|
-
status: LastReestimationDetails.Status;
|
|
463
|
-
}
|
|
464
311
|
interface Recurring {
|
|
465
312
|
/**
|
|
466
313
|
* Total before any discounts or taxes are applied.
|
|
@@ -495,26 +342,6 @@ export declare namespace Quote {
|
|
|
495
342
|
line_items?: ApiList<LineItem>;
|
|
496
343
|
total_details: Upfront.TotalDetails;
|
|
497
344
|
}
|
|
498
|
-
namespace LastReestimationDetails {
|
|
499
|
-
interface Failed {
|
|
500
|
-
/**
|
|
501
|
-
* 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.
|
|
502
|
-
*/
|
|
503
|
-
failure_code: string | null;
|
|
504
|
-
/**
|
|
505
|
-
* 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".
|
|
506
|
-
*/
|
|
507
|
-
message: string | null;
|
|
508
|
-
/**
|
|
509
|
-
* The reason the reestimation failed.
|
|
510
|
-
*/
|
|
511
|
-
reason: Failed.Reason;
|
|
512
|
-
}
|
|
513
|
-
type Status = 'failed' | 'in_progress' | 'succeeded';
|
|
514
|
-
namespace Failed {
|
|
515
|
-
type Reason = 'automation_failure' | 'internal_error';
|
|
516
|
-
}
|
|
517
|
-
}
|
|
518
345
|
namespace Recurring {
|
|
519
346
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
520
347
|
interface TotalDetails {
|
|
@@ -555,7 +382,7 @@ export declare namespace Quote {
|
|
|
555
382
|
*
|
|
556
383
|
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
557
384
|
*/
|
|
558
|
-
discount:
|
|
385
|
+
discount: _Discount;
|
|
559
386
|
}
|
|
560
387
|
interface Tax {
|
|
561
388
|
/**
|
|
@@ -622,7 +449,7 @@ export declare namespace Quote {
|
|
|
622
449
|
*
|
|
623
450
|
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
624
451
|
*/
|
|
625
|
-
discount:
|
|
452
|
+
discount: _Discount;
|
|
626
453
|
}
|
|
627
454
|
interface Tax {
|
|
628
455
|
/**
|
|
@@ -663,117 +490,10 @@ export declare namespace Quote {
|
|
|
663
490
|
type: Issuer.Type;
|
|
664
491
|
}
|
|
665
492
|
namespace Issuer {
|
|
666
|
-
type Type = 'account' | '
|
|
667
|
-
}
|
|
668
|
-
}
|
|
669
|
-
namespace StatusDetails {
|
|
670
|
-
interface Canceled {
|
|
671
|
-
/**
|
|
672
|
-
* The reason this quote was marked as canceled.
|
|
673
|
-
*/
|
|
674
|
-
reason: Canceled.Reason | null;
|
|
675
|
-
/**
|
|
676
|
-
* Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.
|
|
677
|
-
*/
|
|
678
|
-
transitioned_at: number | null;
|
|
679
|
-
}
|
|
680
|
-
interface Stale {
|
|
681
|
-
/**
|
|
682
|
-
* Time at which the quote expires. Measured in seconds since the Unix epoch.
|
|
683
|
-
*/
|
|
684
|
-
expires_at: number | null;
|
|
685
|
-
/**
|
|
686
|
-
* The most recent reason this quote was marked as stale.
|
|
687
|
-
*/
|
|
688
|
-
last_reason: Stale.LastReason | null;
|
|
689
|
-
/**
|
|
690
|
-
* Time at which the stale reason was updated. Measured in seconds since the Unix epoch.
|
|
691
|
-
*/
|
|
692
|
-
last_updated_at: number | null;
|
|
693
|
-
/**
|
|
694
|
-
* Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.
|
|
695
|
-
*/
|
|
696
|
-
transitioned_at: number | null;
|
|
697
|
-
}
|
|
698
|
-
namespace Canceled {
|
|
699
|
-
type Reason = 'canceled' | 'quote_accepted' | 'quote_expired' | 'quote_superseded' | 'subscription_canceled';
|
|
700
|
-
}
|
|
701
|
-
namespace Stale {
|
|
702
|
-
interface LastReason {
|
|
703
|
-
/**
|
|
704
|
-
* The ID of the line that is invalid if the stale reason type is `line_invalid`.
|
|
705
|
-
*/
|
|
706
|
-
line_invalid?: string;
|
|
707
|
-
/**
|
|
708
|
-
* The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.
|
|
709
|
-
*/
|
|
710
|
-
lines_invalid?: Array<LastReason.LinesInvalid>;
|
|
711
|
-
/**
|
|
712
|
-
* The user supplied mark stale reason.
|
|
713
|
-
*/
|
|
714
|
-
marked_stale?: string | null;
|
|
715
|
-
/**
|
|
716
|
-
* The ID of the subscription that was canceled.
|
|
717
|
-
*/
|
|
718
|
-
subscription_canceled?: string;
|
|
719
|
-
subscription_changed?: LastReason.SubscriptionChanged;
|
|
720
|
-
/**
|
|
721
|
-
* The ID of the subscription that was expired.
|
|
722
|
-
*/
|
|
723
|
-
subscription_expired?: string;
|
|
724
|
-
/**
|
|
725
|
-
* The ID of the subscription schedule that was canceled.
|
|
726
|
-
*/
|
|
727
|
-
subscription_schedule_canceled?: string;
|
|
728
|
-
subscription_schedule_changed?: LastReason.SubscriptionScheduleChanged;
|
|
729
|
-
/**
|
|
730
|
-
* The ID of the subscription schedule that was released.
|
|
731
|
-
*/
|
|
732
|
-
subscription_schedule_released?: string;
|
|
733
|
-
/**
|
|
734
|
-
* The reason the quote was marked as stale.
|
|
735
|
-
*/
|
|
736
|
-
type: LastReason.Type | null;
|
|
737
|
-
}
|
|
738
|
-
namespace LastReason {
|
|
739
|
-
interface LinesInvalid {
|
|
740
|
-
/**
|
|
741
|
-
* The timestamp at which the lines were marked as invalid.
|
|
742
|
-
*/
|
|
743
|
-
invalid_at: number;
|
|
744
|
-
/**
|
|
745
|
-
* The list of lines that became invalid at the given timestamp.
|
|
746
|
-
*/
|
|
747
|
-
lines: Array<string>;
|
|
748
|
-
}
|
|
749
|
-
interface SubscriptionChanged {
|
|
750
|
-
/**
|
|
751
|
-
* The subscription's state before the quote was marked as stale.
|
|
752
|
-
*/
|
|
753
|
-
previous_subscription: Subscription | null;
|
|
754
|
-
}
|
|
755
|
-
interface SubscriptionScheduleChanged {
|
|
756
|
-
/**
|
|
757
|
-
* The subscription schedule's state before the quote was marked as stale.
|
|
758
|
-
*/
|
|
759
|
-
previous_subscription_schedule: SubscriptionSchedule | null;
|
|
760
|
-
}
|
|
761
|
-
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';
|
|
762
|
-
}
|
|
493
|
+
type Type = 'account' | 'self';
|
|
763
494
|
}
|
|
764
495
|
}
|
|
765
496
|
namespace SubscriptionData {
|
|
766
|
-
interface BillOnAcceptance {
|
|
767
|
-
/**
|
|
768
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
769
|
-
*/
|
|
770
|
-
bill_from: BillOnAcceptance.BillFrom | null;
|
|
771
|
-
/**
|
|
772
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
773
|
-
*/
|
|
774
|
-
bill_until: BillOnAcceptance.BillUntil | null;
|
|
775
|
-
}
|
|
776
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
777
497
|
interface BillingMode {
|
|
778
498
|
flexible?: BillingMode.Flexible;
|
|
779
499
|
/**
|
|
@@ -781,27 +501,6 @@ export declare namespace Quote {
|
|
|
781
501
|
*/
|
|
782
502
|
type: BillingMode.Type;
|
|
783
503
|
}
|
|
784
|
-
interface BillingSchedule {
|
|
785
|
-
/**
|
|
786
|
-
* Specifies which subscription items the billing schedule applies to.
|
|
787
|
-
*/
|
|
788
|
-
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
789
|
-
/**
|
|
790
|
-
* Specifies the start of the billing period.
|
|
791
|
-
*/
|
|
792
|
-
bill_from?: BillingSchedule.BillFrom | null;
|
|
793
|
-
bill_until: BillingSchedule.BillUntil;
|
|
794
|
-
/**
|
|
795
|
-
* Unique identifier for the billing schedule.
|
|
796
|
-
*/
|
|
797
|
-
key: string;
|
|
798
|
-
}
|
|
799
|
-
type EndBehavior = 'cancel' | 'release';
|
|
800
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
801
|
-
interface Prebilling {
|
|
802
|
-
iterations: number;
|
|
803
|
-
}
|
|
804
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
805
504
|
namespace BillingMode {
|
|
806
505
|
interface Flexible {
|
|
807
506
|
/**
|
|
@@ -814,428 +513,49 @@ export declare namespace Quote {
|
|
|
814
513
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
815
514
|
}
|
|
816
515
|
}
|
|
817
|
-
namespace BillingSchedule {
|
|
818
|
-
interface AppliesTo {
|
|
819
|
-
/**
|
|
820
|
-
* The billing schedule will apply to the subscription item with the given price ID.
|
|
821
|
-
*/
|
|
822
|
-
price: string | Price | null;
|
|
823
|
-
/**
|
|
824
|
-
* Controls which subscription items the billing schedule applies to.
|
|
825
|
-
*/
|
|
826
|
-
type: 'price';
|
|
827
|
-
}
|
|
828
|
-
interface BillFrom {
|
|
829
|
-
/**
|
|
830
|
-
* The time the billing schedule applies from.
|
|
831
|
-
*/
|
|
832
|
-
computed_timestamp: number | null;
|
|
833
|
-
/**
|
|
834
|
-
* Lets you bill the period starting from a particular Quote line.
|
|
835
|
-
*/
|
|
836
|
-
line_starts_at: BillFrom.LineStartsAt | null;
|
|
837
|
-
/**
|
|
838
|
-
* Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
|
|
839
|
-
*/
|
|
840
|
-
timestamp: number | null;
|
|
841
|
-
/**
|
|
842
|
-
* 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`.
|
|
843
|
-
*/
|
|
844
|
-
type: BillFrom.Type;
|
|
845
|
-
}
|
|
846
|
-
interface BillUntil {
|
|
847
|
-
/**
|
|
848
|
-
* The timestamp the billing schedule will apply until.
|
|
849
|
-
*/
|
|
850
|
-
computed_timestamp: number | null;
|
|
851
|
-
/**
|
|
852
|
-
* Specifies the billing period.
|
|
853
|
-
*/
|
|
854
|
-
duration: BillUntil.Duration | null;
|
|
855
|
-
/**
|
|
856
|
-
* Lets you bill the period ending at a particular Quote line.
|
|
857
|
-
*/
|
|
858
|
-
line_ends_at?: BillUntil.LineEndsAt | null;
|
|
859
|
-
/**
|
|
860
|
-
* If specified, the billing schedule will apply until the specified timestamp.
|
|
861
|
-
*/
|
|
862
|
-
timestamp: number | null;
|
|
863
|
-
/**
|
|
864
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
865
|
-
*/
|
|
866
|
-
type: BillUntil.Type;
|
|
867
|
-
}
|
|
868
|
-
namespace BillFrom {
|
|
869
|
-
interface LineStartsAt {
|
|
870
|
-
/**
|
|
871
|
-
* Unique identifier for the object.
|
|
872
|
-
*/
|
|
873
|
-
id: string;
|
|
874
|
-
}
|
|
875
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
876
|
-
}
|
|
877
|
-
namespace BillUntil {
|
|
878
|
-
interface Duration {
|
|
879
|
-
/**
|
|
880
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
881
|
-
*/
|
|
882
|
-
interval: Duration.Interval;
|
|
883
|
-
/**
|
|
884
|
-
* The multiplier applied to the interval.
|
|
885
|
-
*/
|
|
886
|
-
interval_count: number | null;
|
|
887
|
-
}
|
|
888
|
-
interface LineEndsAt {
|
|
889
|
-
/**
|
|
890
|
-
* Unique identifier for the object.
|
|
891
|
-
*/
|
|
892
|
-
id: string;
|
|
893
|
-
}
|
|
894
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
895
|
-
namespace Duration {
|
|
896
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
897
|
-
}
|
|
898
|
-
}
|
|
899
|
-
}
|
|
900
|
-
namespace BillOnAcceptance {
|
|
901
|
-
interface BillFrom {
|
|
902
|
-
/**
|
|
903
|
-
* The materialized time.
|
|
904
|
-
*/
|
|
905
|
-
computed: number | null;
|
|
906
|
-
/**
|
|
907
|
-
* The timestamp the given line starts at.
|
|
908
|
-
*/
|
|
909
|
-
line_starts_at: BillFrom.LineStartsAt | null;
|
|
910
|
-
/**
|
|
911
|
-
* A precise Unix timestamp.
|
|
912
|
-
*/
|
|
913
|
-
timestamp: number | null;
|
|
914
|
-
/**
|
|
915
|
-
* The type of method to specify the `bill_from` time.
|
|
916
|
-
*/
|
|
917
|
-
type: BillFrom.Type;
|
|
918
|
-
}
|
|
919
|
-
interface BillUntil {
|
|
920
|
-
/**
|
|
921
|
-
* The materialized time.
|
|
922
|
-
*/
|
|
923
|
-
computed: number | null;
|
|
924
|
-
/**
|
|
925
|
-
* Time span for the quote line starting from the `starts_at` date.
|
|
926
|
-
*/
|
|
927
|
-
duration: BillUntil.Duration | null;
|
|
928
|
-
/**
|
|
929
|
-
* The timestamp the given line ends at.
|
|
930
|
-
*/
|
|
931
|
-
line_ends_at: BillUntil.LineEndsAt | null;
|
|
932
|
-
/**
|
|
933
|
-
* A precise Unix timestamp.
|
|
934
|
-
*/
|
|
935
|
-
timestamp: number | null;
|
|
936
|
-
/**
|
|
937
|
-
* The type of method to specify the `bill_until` time.
|
|
938
|
-
*/
|
|
939
|
-
type: BillUntil.Type;
|
|
940
|
-
}
|
|
941
|
-
namespace BillFrom {
|
|
942
|
-
interface LineStartsAt {
|
|
943
|
-
/**
|
|
944
|
-
* Unique identifier for the object.
|
|
945
|
-
*/
|
|
946
|
-
id: string;
|
|
947
|
-
}
|
|
948
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
949
|
-
}
|
|
950
|
-
namespace BillUntil {
|
|
951
|
-
interface Duration {
|
|
952
|
-
/**
|
|
953
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
954
|
-
*/
|
|
955
|
-
interval: Duration.Interval;
|
|
956
|
-
/**
|
|
957
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
958
|
-
*/
|
|
959
|
-
interval_count: number;
|
|
960
|
-
}
|
|
961
|
-
interface LineEndsAt {
|
|
962
|
-
/**
|
|
963
|
-
* Unique identifier for the object.
|
|
964
|
-
*/
|
|
965
|
-
id: string;
|
|
966
|
-
}
|
|
967
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
968
|
-
namespace Duration {
|
|
969
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
970
|
-
}
|
|
971
|
-
}
|
|
972
|
-
}
|
|
973
516
|
}
|
|
974
|
-
namespace
|
|
975
|
-
interface
|
|
976
|
-
/**
|
|
977
|
-
* 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.
|
|
978
|
-
*/
|
|
979
|
-
new_reference: string | null;
|
|
980
|
-
/**
|
|
981
|
-
* The ID of the schedule the line applies to.
|
|
982
|
-
*/
|
|
983
|
-
subscription_schedule: string | null;
|
|
984
|
-
/**
|
|
985
|
-
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
986
|
-
*/
|
|
987
|
-
type: AppliesTo.Type;
|
|
988
|
-
}
|
|
989
|
-
interface BillOnAcceptance {
|
|
990
|
-
/**
|
|
991
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
992
|
-
*/
|
|
993
|
-
bill_from: BillOnAcceptance.BillFrom | null;
|
|
994
|
-
/**
|
|
995
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
996
|
-
*/
|
|
997
|
-
bill_until: BillOnAcceptance.BillUntil | null;
|
|
998
|
-
}
|
|
999
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1000
|
-
interface BillingSchedule {
|
|
1001
|
-
/**
|
|
1002
|
-
* Specifies which subscription items the billing schedule applies to.
|
|
1003
|
-
*/
|
|
1004
|
-
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
517
|
+
namespace TotalDetails {
|
|
518
|
+
interface Breakdown {
|
|
1005
519
|
/**
|
|
1006
|
-
*
|
|
520
|
+
* The aggregated discounts.
|
|
1007
521
|
*/
|
|
1008
|
-
|
|
1009
|
-
bill_until: BillingSchedule.BillUntil;
|
|
522
|
+
discounts: Array<Breakdown.Discount>;
|
|
1010
523
|
/**
|
|
1011
|
-
*
|
|
524
|
+
* The aggregated tax amounts by rate.
|
|
1012
525
|
*/
|
|
1013
|
-
|
|
1014
|
-
}
|
|
1015
|
-
type EndBehavior = 'cancel' | 'release';
|
|
1016
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1017
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1018
|
-
namespace AppliesTo {
|
|
1019
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
526
|
+
taxes: Array<Breakdown.Tax>;
|
|
1020
527
|
}
|
|
1021
|
-
namespace
|
|
1022
|
-
interface
|
|
528
|
+
namespace Breakdown {
|
|
529
|
+
interface Discount {
|
|
1023
530
|
/**
|
|
1024
|
-
* The
|
|
531
|
+
* The amount discounted.
|
|
1025
532
|
*/
|
|
1026
|
-
|
|
533
|
+
amount: number;
|
|
1027
534
|
/**
|
|
1028
|
-
*
|
|
535
|
+
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
536
|
+
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
537
|
+
*
|
|
538
|
+
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
1029
539
|
*/
|
|
1030
|
-
|
|
540
|
+
discount: _Discount;
|
|
1031
541
|
}
|
|
1032
|
-
interface
|
|
542
|
+
interface Tax {
|
|
1033
543
|
/**
|
|
1034
|
-
*
|
|
544
|
+
* Amount of tax applied for this rate.
|
|
1035
545
|
*/
|
|
1036
|
-
|
|
546
|
+
amount: number;
|
|
1037
547
|
/**
|
|
1038
|
-
*
|
|
548
|
+
* 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.
|
|
549
|
+
*
|
|
550
|
+
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
1039
551
|
*/
|
|
1040
|
-
|
|
552
|
+
rate: TaxRate;
|
|
1041
553
|
/**
|
|
1042
|
-
*
|
|
554
|
+
* 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.
|
|
1043
555
|
*/
|
|
1044
|
-
|
|
556
|
+
taxability_reason: Tax.TaxabilityReason | null;
|
|
1045
557
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
*/
|
|
1048
|
-
type: BillFrom.Type;
|
|
1049
|
-
}
|
|
1050
|
-
interface BillUntil {
|
|
1051
|
-
/**
|
|
1052
|
-
* The timestamp the billing schedule will apply until.
|
|
1053
|
-
*/
|
|
1054
|
-
computed_timestamp: number | null;
|
|
1055
|
-
/**
|
|
1056
|
-
* Specifies the billing period.
|
|
1057
|
-
*/
|
|
1058
|
-
duration: BillUntil.Duration | null;
|
|
1059
|
-
/**
|
|
1060
|
-
* Lets you bill the period ending at a particular Quote line.
|
|
1061
|
-
*/
|
|
1062
|
-
line_ends_at?: BillUntil.LineEndsAt | null;
|
|
1063
|
-
/**
|
|
1064
|
-
* If specified, the billing schedule will apply until the specified timestamp.
|
|
1065
|
-
*/
|
|
1066
|
-
timestamp: number | null;
|
|
1067
|
-
/**
|
|
1068
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1069
|
-
*/
|
|
1070
|
-
type: BillUntil.Type;
|
|
1071
|
-
}
|
|
1072
|
-
namespace BillFrom {
|
|
1073
|
-
interface LineStartsAt {
|
|
1074
|
-
/**
|
|
1075
|
-
* Unique identifier for the object.
|
|
1076
|
-
*/
|
|
1077
|
-
id: string;
|
|
1078
|
-
}
|
|
1079
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
1080
|
-
}
|
|
1081
|
-
namespace BillUntil {
|
|
1082
|
-
interface Duration {
|
|
1083
|
-
/**
|
|
1084
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1085
|
-
*/
|
|
1086
|
-
interval: Duration.Interval;
|
|
1087
|
-
/**
|
|
1088
|
-
* The multiplier applied to the interval.
|
|
1089
|
-
*/
|
|
1090
|
-
interval_count: number | null;
|
|
1091
|
-
}
|
|
1092
|
-
interface LineEndsAt {
|
|
1093
|
-
/**
|
|
1094
|
-
* Unique identifier for the object.
|
|
1095
|
-
*/
|
|
1096
|
-
id: string;
|
|
1097
|
-
}
|
|
1098
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
1099
|
-
namespace Duration {
|
|
1100
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1101
|
-
}
|
|
1102
|
-
}
|
|
1103
|
-
}
|
|
1104
|
-
namespace BillOnAcceptance {
|
|
1105
|
-
interface BillFrom {
|
|
1106
|
-
/**
|
|
1107
|
-
* The materialized time.
|
|
1108
|
-
*/
|
|
1109
|
-
computed: number | null;
|
|
1110
|
-
/**
|
|
1111
|
-
* The timestamp the given line starts at.
|
|
1112
|
-
*/
|
|
1113
|
-
line_starts_at: BillFrom.LineStartsAt | null;
|
|
1114
|
-
/**
|
|
1115
|
-
* A precise Unix timestamp.
|
|
1116
|
-
*/
|
|
1117
|
-
timestamp: number | null;
|
|
1118
|
-
/**
|
|
1119
|
-
* The type of method to specify the `bill_from` time.
|
|
1120
|
-
*/
|
|
1121
|
-
type: BillFrom.Type;
|
|
1122
|
-
}
|
|
1123
|
-
interface BillUntil {
|
|
1124
|
-
/**
|
|
1125
|
-
* The materialized time.
|
|
1126
|
-
*/
|
|
1127
|
-
computed: number | null;
|
|
1128
|
-
/**
|
|
1129
|
-
* Time span for the quote line starting from the `starts_at` date.
|
|
1130
|
-
*/
|
|
1131
|
-
duration: BillUntil.Duration | null;
|
|
1132
|
-
/**
|
|
1133
|
-
* The timestamp the given line ends at.
|
|
1134
|
-
*/
|
|
1135
|
-
line_ends_at: BillUntil.LineEndsAt | null;
|
|
1136
|
-
/**
|
|
1137
|
-
* A precise Unix timestamp.
|
|
1138
|
-
*/
|
|
1139
|
-
timestamp: number | null;
|
|
1140
|
-
/**
|
|
1141
|
-
* The type of method to specify the `bill_until` time.
|
|
1142
|
-
*/
|
|
1143
|
-
type: BillUntil.Type;
|
|
1144
|
-
}
|
|
1145
|
-
namespace BillFrom {
|
|
1146
|
-
interface LineStartsAt {
|
|
1147
|
-
/**
|
|
1148
|
-
* Unique identifier for the object.
|
|
1149
|
-
*/
|
|
1150
|
-
id: string;
|
|
1151
|
-
}
|
|
1152
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
1153
|
-
}
|
|
1154
|
-
namespace BillUntil {
|
|
1155
|
-
interface Duration {
|
|
1156
|
-
/**
|
|
1157
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1158
|
-
*/
|
|
1159
|
-
interval: Duration.Interval;
|
|
1160
|
-
/**
|
|
1161
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1162
|
-
*/
|
|
1163
|
-
interval_count: number;
|
|
1164
|
-
}
|
|
1165
|
-
interface LineEndsAt {
|
|
1166
|
-
/**
|
|
1167
|
-
* Unique identifier for the object.
|
|
1168
|
-
*/
|
|
1169
|
-
id: string;
|
|
1170
|
-
}
|
|
1171
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
1172
|
-
namespace Duration {
|
|
1173
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1174
|
-
}
|
|
1175
|
-
}
|
|
1176
|
-
}
|
|
1177
|
-
}
|
|
1178
|
-
namespace SubscriptionSchedule {
|
|
1179
|
-
interface AppliesTo {
|
|
1180
|
-
/**
|
|
1181
|
-
* 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.
|
|
1182
|
-
*/
|
|
1183
|
-
new_reference: string | null;
|
|
1184
|
-
/**
|
|
1185
|
-
* The ID of the schedule the line applies to.
|
|
1186
|
-
*/
|
|
1187
|
-
subscription_schedule: string | null;
|
|
1188
|
-
/**
|
|
1189
|
-
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
1190
|
-
*/
|
|
1191
|
-
type: AppliesTo.Type;
|
|
1192
|
-
}
|
|
1193
|
-
namespace AppliesTo {
|
|
1194
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
1195
|
-
}
|
|
1196
|
-
}
|
|
1197
|
-
namespace TotalDetails {
|
|
1198
|
-
interface Breakdown {
|
|
1199
|
-
/**
|
|
1200
|
-
* The aggregated discounts.
|
|
1201
|
-
*/
|
|
1202
|
-
discounts: Array<Breakdown.Discount>;
|
|
1203
|
-
/**
|
|
1204
|
-
* The aggregated tax amounts by rate.
|
|
1205
|
-
*/
|
|
1206
|
-
taxes: Array<Breakdown.Tax>;
|
|
1207
|
-
}
|
|
1208
|
-
namespace Breakdown {
|
|
1209
|
-
interface Discount {
|
|
1210
|
-
/**
|
|
1211
|
-
* The amount discounted.
|
|
1212
|
-
*/
|
|
1213
|
-
amount: number;
|
|
1214
|
-
/**
|
|
1215
|
-
* A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
1216
|
-
* It contains information about when the discount began, when it will end, and what it is applied to.
|
|
1217
|
-
*
|
|
1218
|
-
* Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
1219
|
-
*/
|
|
1220
|
-
discount: Discount;
|
|
1221
|
-
}
|
|
1222
|
-
interface Tax {
|
|
1223
|
-
/**
|
|
1224
|
-
* Amount of tax applied for this rate.
|
|
1225
|
-
*/
|
|
1226
|
-
amount: number;
|
|
1227
|
-
/**
|
|
1228
|
-
* 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.
|
|
1229
|
-
*
|
|
1230
|
-
* Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
|
|
1231
|
-
*/
|
|
1232
|
-
rate: TaxRate;
|
|
1233
|
-
/**
|
|
1234
|
-
* 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.
|
|
1235
|
-
*/
|
|
1236
|
-
taxability_reason: Tax.TaxabilityReason | null;
|
|
1237
|
-
/**
|
|
1238
|
-
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
558
|
+
* The amount on which tax is calculated, in cents (or local equivalent).
|
|
1239
559
|
*/
|
|
1240
560
|
taxable_amount: number | null;
|
|
1241
561
|
}
|
|
@@ -1246,10 +566,6 @@ export declare namespace Quote {
|
|
|
1246
566
|
}
|
|
1247
567
|
}
|
|
1248
568
|
export interface QuoteCreateParams {
|
|
1249
|
-
/**
|
|
1250
|
-
* Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
|
|
1251
|
-
*/
|
|
1252
|
-
allow_backdated_lines?: boolean;
|
|
1253
569
|
/**
|
|
1254
570
|
* 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.
|
|
1255
571
|
*/
|
|
@@ -1314,10 +630,6 @@ export interface QuoteCreateParams {
|
|
|
1314
630
|
* 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.
|
|
1315
631
|
*/
|
|
1316
632
|
line_items?: Array<QuoteCreateParams.LineItem>;
|
|
1317
|
-
/**
|
|
1318
|
-
* 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.
|
|
1319
|
-
*/
|
|
1320
|
-
lines?: Array<QuoteCreateParams.Line>;
|
|
1321
633
|
/**
|
|
1322
634
|
* 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`.
|
|
1323
635
|
*/
|
|
@@ -1330,10 +642,6 @@ export interface QuoteCreateParams {
|
|
|
1330
642
|
* 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.
|
|
1331
643
|
*/
|
|
1332
644
|
subscription_data?: QuoteCreateParams.SubscriptionData;
|
|
1333
|
-
/**
|
|
1334
|
-
* List representing overrides for `subscription_data` configurations for specific subscription schedules.
|
|
1335
|
-
*/
|
|
1336
|
-
subscription_data_overrides?: Array<QuoteCreateParams.SubscriptionDataOverride>;
|
|
1337
645
|
/**
|
|
1338
646
|
* ID of the test clock to attach to the quote.
|
|
1339
647
|
*/
|
|
@@ -1364,10 +672,6 @@ export declare namespace QuoteCreateParams {
|
|
|
1364
672
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1365
673
|
*/
|
|
1366
674
|
discount?: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* Details to determine how long the discount should be applied for.
|
|
1369
|
-
*/
|
|
1370
|
-
discount_end?: Discount.DiscountEnd;
|
|
1371
675
|
/**
|
|
1372
676
|
* ID of the promotion code to create a new discount for.
|
|
1373
677
|
*/
|
|
@@ -1415,160 +719,28 @@ export declare namespace QuoteCreateParams {
|
|
|
1415
719
|
*/
|
|
1416
720
|
tax_rates?: Emptyable<Array<string>>;
|
|
1417
721
|
}
|
|
1418
|
-
interface Line {
|
|
1419
|
-
/**
|
|
1420
|
-
* An array of operations the quote line performs.
|
|
1421
|
-
*/
|
|
1422
|
-
actions?: Array<Line.Action>;
|
|
1423
|
-
/**
|
|
1424
|
-
* Details to identify the subscription schedule the quote line applies to.
|
|
1425
|
-
*/
|
|
1426
|
-
applies_to?: Line.AppliesTo;
|
|
1427
|
-
/**
|
|
1428
|
-
* 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.
|
|
1429
|
-
*/
|
|
1430
|
-
billing_cycle_anchor?: Line.BillingCycleAnchor;
|
|
1431
|
-
/**
|
|
1432
|
-
* 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.
|
|
1433
|
-
*/
|
|
1434
|
-
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
1435
|
-
/**
|
|
1436
|
-
* Configures how the quote handles billing for line transitions.
|
|
1437
|
-
*/
|
|
1438
|
-
effective_at?: Line.EffectiveAt;
|
|
1439
|
-
/**
|
|
1440
|
-
* 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.
|
|
1441
|
-
*/
|
|
1442
|
-
ends_at?: Line.EndsAt;
|
|
1443
|
-
/**
|
|
1444
|
-
* 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.
|
|
1445
|
-
*/
|
|
1446
|
-
proration_behavior?: Line.ProrationBehavior;
|
|
1447
|
-
/**
|
|
1448
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
1449
|
-
*/
|
|
1450
|
-
set_pause_collection?: Line.SetPauseCollection;
|
|
1451
|
-
/**
|
|
1452
|
-
* Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
|
|
1453
|
-
*/
|
|
1454
|
-
set_schedule_end?: Line.SetScheduleEnd;
|
|
1455
|
-
/**
|
|
1456
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
1457
|
-
*/
|
|
1458
|
-
starts_at?: Line.StartsAt;
|
|
1459
|
-
/**
|
|
1460
|
-
* Settings related to subscription trials.
|
|
1461
|
-
*/
|
|
1462
|
-
trial_settings?: Line.TrialSettings;
|
|
1463
|
-
}
|
|
1464
722
|
interface SubscriptionData {
|
|
1465
|
-
/**
|
|
1466
|
-
* Describes the period to bill for upon accepting the quote.
|
|
1467
|
-
*/
|
|
1468
|
-
bill_on_acceptance?: SubscriptionData.BillOnAcceptance;
|
|
1469
|
-
/**
|
|
1470
|
-
* 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.
|
|
1471
|
-
*/
|
|
1472
|
-
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
1473
|
-
/**
|
|
1474
|
-
* When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
|
1475
|
-
*/
|
|
1476
|
-
billing_cycle_anchor?: Emptyable<'reset'>;
|
|
1477
723
|
/**
|
|
1478
724
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
1479
725
|
*/
|
|
1480
726
|
billing_mode?: SubscriptionData.BillingMode;
|
|
1481
|
-
/**
|
|
1482
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1483
|
-
*/
|
|
1484
|
-
billing_schedules?: Array<SubscriptionData.BillingSchedule>;
|
|
1485
727
|
/**
|
|
1486
728
|
* 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.
|
|
1487
729
|
*/
|
|
1488
730
|
description?: string;
|
|
1489
731
|
/**
|
|
1490
|
-
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
|
|
732
|
+
* 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.
|
|
1491
733
|
*/
|
|
1492
734
|
effective_date?: Emptyable<'current_period_end' | number>;
|
|
1493
|
-
/**
|
|
1494
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1495
|
-
*/
|
|
1496
|
-
end_behavior?: SubscriptionData.EndBehavior;
|
|
1497
|
-
/**
|
|
1498
|
-
* 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.
|
|
1499
|
-
*/
|
|
1500
|
-
from_subscription?: string;
|
|
1501
735
|
/**
|
|
1502
736
|
* 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.
|
|
1503
737
|
*/
|
|
1504
738
|
metadata?: MetadataParam;
|
|
1505
|
-
/**
|
|
1506
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
1507
|
-
*/
|
|
1508
|
-
phase_effective_at?: SubscriptionData.PhaseEffectiveAt;
|
|
1509
|
-
/**
|
|
1510
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
1511
|
-
*/
|
|
1512
|
-
prebilling?: Emptyable<SubscriptionData.Prebilling>;
|
|
1513
|
-
/**
|
|
1514
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1515
|
-
*
|
|
1516
|
-
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1517
|
-
*
|
|
1518
|
-
* 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`.
|
|
1519
|
-
*
|
|
1520
|
-
* Prorations can be disabled by passing `none`.
|
|
1521
|
-
*/
|
|
1522
|
-
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
1523
739
|
/**
|
|
1524
740
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
1525
741
|
*/
|
|
1526
742
|
trial_period_days?: Emptyable<number>;
|
|
1527
743
|
}
|
|
1528
|
-
interface SubscriptionDataOverride {
|
|
1529
|
-
/**
|
|
1530
|
-
* Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
|
|
1531
|
-
*/
|
|
1532
|
-
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
1533
|
-
/**
|
|
1534
|
-
* Describes the period to bill for upon accepting the quote.
|
|
1535
|
-
*/
|
|
1536
|
-
bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance;
|
|
1537
|
-
/**
|
|
1538
|
-
* 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.
|
|
1539
|
-
*/
|
|
1540
|
-
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
1541
|
-
/**
|
|
1542
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1543
|
-
*/
|
|
1544
|
-
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
1545
|
-
/**
|
|
1546
|
-
* The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
|
|
1547
|
-
*/
|
|
1548
|
-
customer?: string;
|
|
1549
|
-
/**
|
|
1550
|
-
* 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.
|
|
1551
|
-
*/
|
|
1552
|
-
description?: string;
|
|
1553
|
-
/**
|
|
1554
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1555
|
-
*/
|
|
1556
|
-
end_behavior?: SubscriptionDataOverride.EndBehavior;
|
|
1557
|
-
/**
|
|
1558
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
1559
|
-
*/
|
|
1560
|
-
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
1561
|
-
/**
|
|
1562
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1563
|
-
*
|
|
1564
|
-
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1565
|
-
*
|
|
1566
|
-
* 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`.
|
|
1567
|
-
*
|
|
1568
|
-
* Prorations can be disabled by passing `none`.
|
|
1569
|
-
*/
|
|
1570
|
-
proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
|
|
1571
|
-
}
|
|
1572
744
|
interface TransferData {
|
|
1573
745
|
/**
|
|
1574
746
|
* 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.
|
|
@@ -1595,39 +767,7 @@ export declare namespace QuoteCreateParams {
|
|
|
1595
767
|
type: Liability.Type;
|
|
1596
768
|
}
|
|
1597
769
|
namespace Liability {
|
|
1598
|
-
type Type = 'account' | '
|
|
1599
|
-
}
|
|
1600
|
-
}
|
|
1601
|
-
namespace Discount {
|
|
1602
|
-
interface DiscountEnd {
|
|
1603
|
-
/**
|
|
1604
|
-
* Time span for the redeemed discount.
|
|
1605
|
-
*/
|
|
1606
|
-
duration?: DiscountEnd.Duration;
|
|
1607
|
-
/**
|
|
1608
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1609
|
-
*/
|
|
1610
|
-
timestamp?: number;
|
|
1611
|
-
/**
|
|
1612
|
-
* The type of calculation made to determine when the discount ends.
|
|
1613
|
-
*/
|
|
1614
|
-
type: DiscountEnd.Type;
|
|
1615
|
-
}
|
|
1616
|
-
namespace DiscountEnd {
|
|
1617
|
-
interface Duration {
|
|
1618
|
-
/**
|
|
1619
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1620
|
-
*/
|
|
1621
|
-
interval: Duration.Interval;
|
|
1622
|
-
/**
|
|
1623
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1624
|
-
*/
|
|
1625
|
-
interval_count: number;
|
|
1626
|
-
}
|
|
1627
|
-
type Type = 'duration' | 'timestamp';
|
|
1628
|
-
namespace Duration {
|
|
1629
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1630
|
-
}
|
|
770
|
+
type Type = 'account' | 'self';
|
|
1631
771
|
}
|
|
1632
772
|
}
|
|
1633
773
|
namespace InvoiceSettings {
|
|
@@ -1642,1187 +782,88 @@ export declare namespace QuoteCreateParams {
|
|
|
1642
782
|
type: Issuer.Type;
|
|
1643
783
|
}
|
|
1644
784
|
namespace Issuer {
|
|
1645
|
-
type Type = 'account' | '
|
|
785
|
+
type Type = 'account' | 'self';
|
|
1646
786
|
}
|
|
1647
787
|
}
|
|
1648
|
-
namespace
|
|
1649
|
-
interface
|
|
1650
|
-
/**
|
|
1651
|
-
* Details for the `add_discount` type.
|
|
1652
|
-
*/
|
|
1653
|
-
add_discount?: Action.AddDiscount;
|
|
788
|
+
namespace LineItem {
|
|
789
|
+
interface Discount {
|
|
1654
790
|
/**
|
|
1655
|
-
*
|
|
791
|
+
* ID of the coupon to create a new discount for.
|
|
1656
792
|
*/
|
|
1657
|
-
|
|
793
|
+
coupon?: string;
|
|
1658
794
|
/**
|
|
1659
|
-
*
|
|
795
|
+
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1660
796
|
*/
|
|
1661
|
-
|
|
1662
|
-
[key: string]: string;
|
|
1663
|
-
};
|
|
797
|
+
discount?: string;
|
|
1664
798
|
/**
|
|
1665
|
-
*
|
|
799
|
+
* ID of the promotion code to create a new discount for.
|
|
1666
800
|
*/
|
|
1667
|
-
|
|
801
|
+
promotion_code?: string;
|
|
802
|
+
}
|
|
803
|
+
interface PriceData {
|
|
1668
804
|
/**
|
|
1669
|
-
*
|
|
805
|
+
* 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).
|
|
1670
806
|
*/
|
|
1671
|
-
|
|
807
|
+
currency: string;
|
|
1672
808
|
/**
|
|
1673
|
-
*
|
|
809
|
+
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
1674
810
|
*/
|
|
1675
|
-
|
|
811
|
+
product: string;
|
|
1676
812
|
/**
|
|
1677
|
-
*
|
|
813
|
+
* The recurring components of a price such as `interval` and `interval_count`.
|
|
1678
814
|
*/
|
|
1679
|
-
|
|
815
|
+
recurring?: PriceData.Recurring;
|
|
1680
816
|
/**
|
|
1681
|
-
*
|
|
817
|
+
* 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.
|
|
1682
818
|
*/
|
|
1683
|
-
|
|
819
|
+
tax_behavior?: PriceData.TaxBehavior;
|
|
1684
820
|
/**
|
|
1685
|
-
*
|
|
821
|
+
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
1686
822
|
*/
|
|
1687
|
-
|
|
1688
|
-
[key: string]: string;
|
|
1689
|
-
}>;
|
|
823
|
+
unit_amount?: number;
|
|
1690
824
|
/**
|
|
1691
|
-
*
|
|
825
|
+
* 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.
|
|
1692
826
|
*/
|
|
1693
|
-
|
|
827
|
+
unit_amount_decimal?: Decimal;
|
|
1694
828
|
}
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
829
|
+
namespace PriceData {
|
|
830
|
+
interface Recurring {
|
|
831
|
+
/**
|
|
832
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
833
|
+
*/
|
|
834
|
+
interval: Recurring.Interval;
|
|
835
|
+
/**
|
|
836
|
+
* 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).
|
|
837
|
+
*/
|
|
838
|
+
interval_count?: number;
|
|
839
|
+
}
|
|
840
|
+
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
841
|
+
namespace Recurring {
|
|
842
|
+
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
843
|
+
}
|
|
1708
844
|
}
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
* Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
|
|
1713
|
-
*/
|
|
1714
|
-
cancel_at: 'line_starts_at';
|
|
845
|
+
}
|
|
846
|
+
namespace SubscriptionData {
|
|
847
|
+
interface BillingMode {
|
|
1715
848
|
/**
|
|
1716
|
-
*
|
|
849
|
+
* Configure behavior for flexible billing mode.
|
|
1717
850
|
*/
|
|
1718
|
-
|
|
851
|
+
flexible?: BillingMode.Flexible;
|
|
1719
852
|
/**
|
|
1720
|
-
*
|
|
853
|
+
* Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
|
|
1721
854
|
*/
|
|
1722
|
-
|
|
855
|
+
type: BillingMode.Type;
|
|
1723
856
|
}
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
/**
|
|
1727
|
-
* Use the `end` time of a given discount.
|
|
1728
|
-
*/
|
|
1729
|
-
discount_end?: EndsAt.DiscountEnd;
|
|
1730
|
-
/**
|
|
1731
|
-
* Time span for the quote line starting from the `starts_at` date.
|
|
1732
|
-
*/
|
|
1733
|
-
duration?: EndsAt.Duration;
|
|
1734
|
-
/**
|
|
1735
|
-
* A precise Unix timestamp.
|
|
1736
|
-
*/
|
|
1737
|
-
timestamp?: number;
|
|
1738
|
-
/**
|
|
1739
|
-
* Select a way to pass in `ends_at`.
|
|
1740
|
-
*/
|
|
1741
|
-
type: EndsAt.Type;
|
|
1742
|
-
}
|
|
1743
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1744
|
-
interface SetPauseCollection {
|
|
1745
|
-
/**
|
|
1746
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
1747
|
-
*/
|
|
1748
|
-
set?: SetPauseCollection.Set;
|
|
1749
|
-
/**
|
|
1750
|
-
* Determines the type of the pause_collection amendment.
|
|
1751
|
-
*/
|
|
1752
|
-
type: SetPauseCollection.Type;
|
|
1753
|
-
}
|
|
1754
|
-
type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
|
|
1755
|
-
interface StartsAt {
|
|
1756
|
-
/**
|
|
1757
|
-
* Use the `end` time of a given discount.
|
|
1758
|
-
*/
|
|
1759
|
-
discount_end?: StartsAt.DiscountEnd;
|
|
1760
|
-
/**
|
|
1761
|
-
* The timestamp the given line ends at.
|
|
1762
|
-
*/
|
|
1763
|
-
line_ends_at?: StartsAt.LineEndsAt;
|
|
1764
|
-
/**
|
|
1765
|
-
* A precise Unix timestamp.
|
|
1766
|
-
*/
|
|
1767
|
-
timestamp?: number;
|
|
1768
|
-
/**
|
|
1769
|
-
* Select a way to pass in `starts_at`.
|
|
1770
|
-
*/
|
|
1771
|
-
type: StartsAt.Type;
|
|
1772
|
-
}
|
|
1773
|
-
interface TrialSettings {
|
|
1774
|
-
/**
|
|
1775
|
-
* Defines how the subscription should behave when a trial ends.
|
|
1776
|
-
*/
|
|
1777
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
1778
|
-
}
|
|
1779
|
-
namespace Action {
|
|
1780
|
-
interface AddDiscount {
|
|
1781
|
-
/**
|
|
1782
|
-
* The coupon code to redeem.
|
|
1783
|
-
*/
|
|
1784
|
-
coupon?: string;
|
|
1785
|
-
/**
|
|
1786
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
1787
|
-
*/
|
|
1788
|
-
discount?: string;
|
|
1789
|
-
/**
|
|
1790
|
-
* Details to determine how long the discount should be applied for.
|
|
1791
|
-
*/
|
|
1792
|
-
discount_end?: AddDiscount.DiscountEnd;
|
|
1793
|
-
/**
|
|
1794
|
-
* 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.
|
|
1795
|
-
*/
|
|
1796
|
-
index?: number;
|
|
1797
|
-
/**
|
|
1798
|
-
* The promotion code to redeem.
|
|
1799
|
-
*/
|
|
1800
|
-
promotion_code?: string;
|
|
1801
|
-
/**
|
|
1802
|
-
* Settings for discount application including service period anchoring.
|
|
1803
|
-
*/
|
|
1804
|
-
settings?: AddDiscount.Settings;
|
|
1805
|
-
}
|
|
1806
|
-
interface AddItem {
|
|
1807
|
-
/**
|
|
1808
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
1809
|
-
*/
|
|
1810
|
-
discounts?: Array<AddItem.Discount>;
|
|
1811
|
-
/**
|
|
1812
|
-
* 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`.
|
|
1813
|
-
*/
|
|
1814
|
-
metadata?: MetadataParam;
|
|
1815
|
-
/**
|
|
1816
|
-
* The ID of the price object.
|
|
1817
|
-
*/
|
|
1818
|
-
price: string;
|
|
1819
|
-
/**
|
|
1820
|
-
* Quantity for this item.
|
|
1821
|
-
*/
|
|
1822
|
-
quantity?: number;
|
|
1823
|
-
/**
|
|
1824
|
-
* 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`.
|
|
1825
|
-
*/
|
|
1826
|
-
tax_rates?: Array<string>;
|
|
1827
|
-
/**
|
|
1828
|
-
* Options that configure the trial on the subscription item.
|
|
1829
|
-
*/
|
|
1830
|
-
trial?: AddItem.Trial;
|
|
1831
|
-
/**
|
|
1832
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
1833
|
-
*/
|
|
1834
|
-
trial_offer?: string;
|
|
1835
|
-
}
|
|
1836
|
-
interface RemoveDiscount {
|
|
1837
|
-
/**
|
|
1838
|
-
* The coupon code to remove from the `discounts` array.
|
|
1839
|
-
*/
|
|
1840
|
-
coupon?: string;
|
|
1841
|
-
/**
|
|
1842
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
1843
|
-
*/
|
|
1844
|
-
discount?: string;
|
|
1845
|
-
/**
|
|
1846
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
1847
|
-
*/
|
|
1848
|
-
promotion_code?: string;
|
|
1849
|
-
}
|
|
1850
|
-
interface RemoveItem {
|
|
1851
|
-
/**
|
|
1852
|
-
* ID of a price to remove.
|
|
1853
|
-
*/
|
|
1854
|
-
price: string;
|
|
1855
|
-
}
|
|
1856
|
-
interface SetDiscount {
|
|
1857
|
-
/**
|
|
1858
|
-
* The coupon code to replace the `discounts` array with.
|
|
1859
|
-
*/
|
|
1860
|
-
coupon?: string;
|
|
1861
|
-
/**
|
|
1862
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
1863
|
-
*/
|
|
1864
|
-
discount?: string;
|
|
1865
|
-
/**
|
|
1866
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
1867
|
-
*/
|
|
1868
|
-
promotion_code?: string;
|
|
1869
|
-
/**
|
|
1870
|
-
* Settings for discount application including service period anchoring.
|
|
1871
|
-
*/
|
|
1872
|
-
settings?: SetDiscount.Settings;
|
|
1873
|
-
}
|
|
1874
|
-
interface SetItem {
|
|
1875
|
-
/**
|
|
1876
|
-
* 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`.
|
|
1877
|
-
*/
|
|
1878
|
-
discounts?: Array<SetItem.Discount>;
|
|
1879
|
-
/**
|
|
1880
|
-
* 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`.
|
|
1881
|
-
*/
|
|
1882
|
-
metadata?: MetadataParam;
|
|
1883
|
-
/**
|
|
1884
|
-
* The ID of the price object.
|
|
1885
|
-
*/
|
|
1886
|
-
price: string;
|
|
1887
|
-
/**
|
|
1888
|
-
* 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`.
|
|
1889
|
-
*/
|
|
1890
|
-
quantity?: number;
|
|
1891
|
-
/**
|
|
1892
|
-
* 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`.
|
|
1893
|
-
*/
|
|
1894
|
-
tax_rates?: Array<string>;
|
|
1895
|
-
/**
|
|
1896
|
-
* 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`.
|
|
1897
|
-
*/
|
|
1898
|
-
trial?: SetItem.Trial;
|
|
1899
|
-
/**
|
|
1900
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
1901
|
-
*/
|
|
1902
|
-
trial_offer?: string;
|
|
1903
|
-
}
|
|
1904
|
-
type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata';
|
|
1905
|
-
namespace AddDiscount {
|
|
1906
|
-
interface DiscountEnd {
|
|
1907
|
-
/**
|
|
1908
|
-
* The type of calculation made to determine when the discount ends.
|
|
1909
|
-
*/
|
|
1910
|
-
type: 'line_ends_at';
|
|
1911
|
-
}
|
|
1912
|
-
interface Settings {
|
|
1913
|
-
/**
|
|
1914
|
-
* Configures service period cycle anchoring.
|
|
1915
|
-
*/
|
|
1916
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1917
|
-
/**
|
|
1918
|
-
* 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.
|
|
1919
|
-
*/
|
|
1920
|
-
start_date?: Settings.StartDate;
|
|
1921
|
-
}
|
|
1922
|
-
namespace Settings {
|
|
1923
|
-
interface ServicePeriodAnchorConfig {
|
|
1924
|
-
/**
|
|
1925
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1926
|
-
*/
|
|
1927
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1928
|
-
/**
|
|
1929
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1930
|
-
*/
|
|
1931
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
1932
|
-
}
|
|
1933
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
1934
|
-
namespace ServicePeriodAnchorConfig {
|
|
1935
|
-
interface Custom {
|
|
1936
|
-
/**
|
|
1937
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1938
|
-
*/
|
|
1939
|
-
day_of_month: number;
|
|
1940
|
-
/**
|
|
1941
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1942
|
-
*/
|
|
1943
|
-
hour?: number;
|
|
1944
|
-
/**
|
|
1945
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1946
|
-
*/
|
|
1947
|
-
minute?: number;
|
|
1948
|
-
/**
|
|
1949
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1950
|
-
*/
|
|
1951
|
-
month?: number;
|
|
1952
|
-
/**
|
|
1953
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1954
|
-
*/
|
|
1955
|
-
second?: number;
|
|
1956
|
-
}
|
|
1957
|
-
type Type = 'custom' | 'inherit';
|
|
1958
|
-
}
|
|
1959
|
-
}
|
|
1960
|
-
}
|
|
1961
|
-
namespace AddItem {
|
|
1962
|
-
interface Discount {
|
|
1963
|
-
/**
|
|
1964
|
-
* ID of the coupon to create a new discount for.
|
|
1965
|
-
*/
|
|
1966
|
-
coupon?: string;
|
|
1967
|
-
/**
|
|
1968
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1969
|
-
*/
|
|
1970
|
-
discount?: string;
|
|
1971
|
-
/**
|
|
1972
|
-
* Details to determine how long the discount should be applied for.
|
|
1973
|
-
*/
|
|
1974
|
-
discount_end?: Discount.DiscountEnd;
|
|
1975
|
-
/**
|
|
1976
|
-
* ID of the promotion code to create a new discount for.
|
|
1977
|
-
*/
|
|
1978
|
-
promotion_code?: string;
|
|
1979
|
-
/**
|
|
1980
|
-
* Settings for discount application including service period anchoring.
|
|
1981
|
-
*/
|
|
1982
|
-
settings?: Discount.Settings;
|
|
1983
|
-
}
|
|
1984
|
-
interface Trial {
|
|
1985
|
-
/**
|
|
1986
|
-
* 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.
|
|
1987
|
-
*/
|
|
1988
|
-
converts_to?: Array<string>;
|
|
1989
|
-
/**
|
|
1990
|
-
* Determines the type of trial for this item.
|
|
1991
|
-
*/
|
|
1992
|
-
type: Trial.Type;
|
|
1993
|
-
}
|
|
1994
|
-
namespace Discount {
|
|
1995
|
-
interface DiscountEnd {
|
|
1996
|
-
/**
|
|
1997
|
-
* Time span for the redeemed discount.
|
|
1998
|
-
*/
|
|
1999
|
-
duration?: DiscountEnd.Duration;
|
|
2000
|
-
/**
|
|
2001
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2002
|
-
*/
|
|
2003
|
-
timestamp?: number;
|
|
2004
|
-
/**
|
|
2005
|
-
* The type of calculation made to determine when the discount ends.
|
|
2006
|
-
*/
|
|
2007
|
-
type: DiscountEnd.Type;
|
|
2008
|
-
}
|
|
2009
|
-
interface Settings {
|
|
2010
|
-
/**
|
|
2011
|
-
* Configures service period cycle anchoring.
|
|
2012
|
-
*/
|
|
2013
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2014
|
-
/**
|
|
2015
|
-
* 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.
|
|
2016
|
-
*/
|
|
2017
|
-
start_date?: Settings.StartDate;
|
|
2018
|
-
}
|
|
2019
|
-
namespace DiscountEnd {
|
|
2020
|
-
interface Duration {
|
|
2021
|
-
/**
|
|
2022
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2023
|
-
*/
|
|
2024
|
-
interval: Duration.Interval;
|
|
2025
|
-
/**
|
|
2026
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2027
|
-
*/
|
|
2028
|
-
interval_count: number;
|
|
2029
|
-
}
|
|
2030
|
-
type Type = 'duration' | 'timestamp';
|
|
2031
|
-
namespace Duration {
|
|
2032
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2033
|
-
}
|
|
2034
|
-
}
|
|
2035
|
-
namespace Settings {
|
|
2036
|
-
interface ServicePeriodAnchorConfig {
|
|
2037
|
-
/**
|
|
2038
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2039
|
-
*/
|
|
2040
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2041
|
-
/**
|
|
2042
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2043
|
-
*/
|
|
2044
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
2045
|
-
}
|
|
2046
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
2047
|
-
namespace ServicePeriodAnchorConfig {
|
|
2048
|
-
interface Custom {
|
|
2049
|
-
/**
|
|
2050
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2051
|
-
*/
|
|
2052
|
-
day_of_month: number;
|
|
2053
|
-
/**
|
|
2054
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2055
|
-
*/
|
|
2056
|
-
hour?: number;
|
|
2057
|
-
/**
|
|
2058
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2059
|
-
*/
|
|
2060
|
-
minute?: number;
|
|
2061
|
-
/**
|
|
2062
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2063
|
-
*/
|
|
2064
|
-
month?: number;
|
|
2065
|
-
/**
|
|
2066
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2067
|
-
*/
|
|
2068
|
-
second?: number;
|
|
2069
|
-
}
|
|
2070
|
-
type Type = 'custom' | 'inherit';
|
|
2071
|
-
}
|
|
2072
|
-
}
|
|
2073
|
-
}
|
|
2074
|
-
namespace Trial {
|
|
2075
|
-
type Type = 'free' | 'paid';
|
|
2076
|
-
}
|
|
2077
|
-
}
|
|
2078
|
-
namespace SetDiscount {
|
|
2079
|
-
interface Settings {
|
|
2080
|
-
/**
|
|
2081
|
-
* Configures service period cycle anchoring.
|
|
2082
|
-
*/
|
|
2083
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2084
|
-
/**
|
|
2085
|
-
* 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.
|
|
2086
|
-
*/
|
|
2087
|
-
start_date?: Settings.StartDate;
|
|
2088
|
-
}
|
|
2089
|
-
namespace Settings {
|
|
2090
|
-
interface ServicePeriodAnchorConfig {
|
|
2091
|
-
/**
|
|
2092
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2093
|
-
*/
|
|
2094
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2095
|
-
/**
|
|
2096
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2097
|
-
*/
|
|
2098
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
2099
|
-
}
|
|
2100
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
2101
|
-
namespace ServicePeriodAnchorConfig {
|
|
2102
|
-
interface Custom {
|
|
2103
|
-
/**
|
|
2104
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2105
|
-
*/
|
|
2106
|
-
day_of_month: number;
|
|
2107
|
-
/**
|
|
2108
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2109
|
-
*/
|
|
2110
|
-
hour?: number;
|
|
2111
|
-
/**
|
|
2112
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2113
|
-
*/
|
|
2114
|
-
minute?: number;
|
|
2115
|
-
/**
|
|
2116
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2117
|
-
*/
|
|
2118
|
-
month?: number;
|
|
2119
|
-
/**
|
|
2120
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2121
|
-
*/
|
|
2122
|
-
second?: number;
|
|
2123
|
-
}
|
|
2124
|
-
type Type = 'custom' | 'inherit';
|
|
2125
|
-
}
|
|
2126
|
-
}
|
|
2127
|
-
}
|
|
2128
|
-
namespace SetItem {
|
|
2129
|
-
interface Discount {
|
|
2130
|
-
/**
|
|
2131
|
-
* ID of the coupon to create a new discount for.
|
|
2132
|
-
*/
|
|
2133
|
-
coupon?: string;
|
|
2134
|
-
/**
|
|
2135
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2136
|
-
*/
|
|
2137
|
-
discount?: string;
|
|
2138
|
-
/**
|
|
2139
|
-
* Details to determine how long the discount should be applied for.
|
|
2140
|
-
*/
|
|
2141
|
-
discount_end?: Discount.DiscountEnd;
|
|
2142
|
-
/**
|
|
2143
|
-
* ID of the promotion code to create a new discount for.
|
|
2144
|
-
*/
|
|
2145
|
-
promotion_code?: string;
|
|
2146
|
-
/**
|
|
2147
|
-
* Settings for discount application including service period anchoring.
|
|
2148
|
-
*/
|
|
2149
|
-
settings?: Discount.Settings;
|
|
2150
|
-
}
|
|
2151
|
-
interface Trial {
|
|
2152
|
-
/**
|
|
2153
|
-
* 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.
|
|
2154
|
-
*/
|
|
2155
|
-
converts_to?: Array<string>;
|
|
2156
|
-
/**
|
|
2157
|
-
* Determines the type of trial for this item.
|
|
2158
|
-
*/
|
|
2159
|
-
type: Trial.Type;
|
|
2160
|
-
}
|
|
2161
|
-
namespace Discount {
|
|
2162
|
-
interface DiscountEnd {
|
|
2163
|
-
/**
|
|
2164
|
-
* Time span for the redeemed discount.
|
|
2165
|
-
*/
|
|
2166
|
-
duration?: DiscountEnd.Duration;
|
|
2167
|
-
/**
|
|
2168
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2169
|
-
*/
|
|
2170
|
-
timestamp?: number;
|
|
2171
|
-
/**
|
|
2172
|
-
* The type of calculation made to determine when the discount ends.
|
|
2173
|
-
*/
|
|
2174
|
-
type: DiscountEnd.Type;
|
|
2175
|
-
}
|
|
2176
|
-
interface Settings {
|
|
2177
|
-
/**
|
|
2178
|
-
* Configures service period cycle anchoring.
|
|
2179
|
-
*/
|
|
2180
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2181
|
-
/**
|
|
2182
|
-
* 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.
|
|
2183
|
-
*/
|
|
2184
|
-
start_date?: Settings.StartDate;
|
|
2185
|
-
}
|
|
2186
|
-
namespace DiscountEnd {
|
|
2187
|
-
interface Duration {
|
|
2188
|
-
/**
|
|
2189
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2190
|
-
*/
|
|
2191
|
-
interval: Duration.Interval;
|
|
2192
|
-
/**
|
|
2193
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2194
|
-
*/
|
|
2195
|
-
interval_count: number;
|
|
2196
|
-
}
|
|
2197
|
-
type Type = 'duration' | 'timestamp';
|
|
2198
|
-
namespace Duration {
|
|
2199
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2200
|
-
}
|
|
2201
|
-
}
|
|
2202
|
-
namespace Settings {
|
|
2203
|
-
interface ServicePeriodAnchorConfig {
|
|
2204
|
-
/**
|
|
2205
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2206
|
-
*/
|
|
2207
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2208
|
-
/**
|
|
2209
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2210
|
-
*/
|
|
2211
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
2212
|
-
}
|
|
2213
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
2214
|
-
namespace ServicePeriodAnchorConfig {
|
|
2215
|
-
interface Custom {
|
|
2216
|
-
/**
|
|
2217
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2218
|
-
*/
|
|
2219
|
-
day_of_month: number;
|
|
2220
|
-
/**
|
|
2221
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2222
|
-
*/
|
|
2223
|
-
hour?: number;
|
|
2224
|
-
/**
|
|
2225
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2226
|
-
*/
|
|
2227
|
-
minute?: number;
|
|
2228
|
-
/**
|
|
2229
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2230
|
-
*/
|
|
2231
|
-
month?: number;
|
|
2232
|
-
/**
|
|
2233
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2234
|
-
*/
|
|
2235
|
-
second?: number;
|
|
2236
|
-
}
|
|
2237
|
-
type Type = 'custom' | 'inherit';
|
|
2238
|
-
}
|
|
2239
|
-
}
|
|
2240
|
-
}
|
|
2241
|
-
namespace Trial {
|
|
2242
|
-
type Type = 'free' | 'paid';
|
|
2243
|
-
}
|
|
2244
|
-
}
|
|
2245
|
-
}
|
|
2246
|
-
namespace AppliesTo {
|
|
2247
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
2248
|
-
}
|
|
2249
|
-
namespace EndsAt {
|
|
2250
|
-
interface DiscountEnd {
|
|
2251
|
-
/**
|
|
2252
|
-
* The ID of a specific discount.
|
|
2253
|
-
*/
|
|
2254
|
-
discount: string;
|
|
2255
|
-
}
|
|
2256
|
-
interface Duration {
|
|
2257
|
-
/**
|
|
2258
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2259
|
-
*/
|
|
2260
|
-
interval: Duration.Interval;
|
|
2261
|
-
/**
|
|
2262
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2263
|
-
*/
|
|
2264
|
-
interval_count: number;
|
|
2265
|
-
}
|
|
2266
|
-
type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2267
|
-
namespace Duration {
|
|
2268
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2269
|
-
}
|
|
2270
|
-
}
|
|
2271
|
-
namespace SetPauseCollection {
|
|
2272
|
-
interface Set {
|
|
2273
|
-
/**
|
|
2274
|
-
* The payment collection behavior for this subscription while paused.
|
|
2275
|
-
*/
|
|
2276
|
-
behavior: Set.Behavior;
|
|
2277
|
-
}
|
|
2278
|
-
type Type = 'remove' | 'set';
|
|
2279
|
-
namespace Set {
|
|
2280
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2281
|
-
}
|
|
2282
|
-
}
|
|
2283
|
-
namespace StartsAt {
|
|
2284
|
-
interface DiscountEnd {
|
|
2285
|
-
/**
|
|
2286
|
-
* The ID of a specific discount.
|
|
2287
|
-
*/
|
|
2288
|
-
discount: string;
|
|
2289
|
-
}
|
|
2290
|
-
interface LineEndsAt {
|
|
2291
|
-
/**
|
|
2292
|
-
* 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.
|
|
2293
|
-
*/
|
|
2294
|
-
index?: number;
|
|
2295
|
-
}
|
|
2296
|
-
type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2297
|
-
}
|
|
2298
|
-
namespace TrialSettings {
|
|
2299
|
-
interface EndBehavior {
|
|
2300
|
-
/**
|
|
2301
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2302
|
-
*/
|
|
2303
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2304
|
-
}
|
|
2305
|
-
namespace EndBehavior {
|
|
2306
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
2307
|
-
}
|
|
2308
|
-
}
|
|
2309
|
-
}
|
|
2310
|
-
namespace LineItem {
|
|
2311
|
-
interface Discount {
|
|
2312
|
-
/**
|
|
2313
|
-
* ID of the coupon to create a new discount for.
|
|
2314
|
-
*/
|
|
2315
|
-
coupon?: string;
|
|
2316
|
-
/**
|
|
2317
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2318
|
-
*/
|
|
2319
|
-
discount?: string;
|
|
2320
|
-
/**
|
|
2321
|
-
* Details to determine how long the discount should be applied for.
|
|
2322
|
-
*/
|
|
2323
|
-
discount_end?: Discount.DiscountEnd;
|
|
2324
|
-
/**
|
|
2325
|
-
* ID of the promotion code to create a new discount for.
|
|
2326
|
-
*/
|
|
2327
|
-
promotion_code?: string;
|
|
2328
|
-
}
|
|
2329
|
-
interface PriceData {
|
|
2330
|
-
/**
|
|
2331
|
-
* 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).
|
|
2332
|
-
*/
|
|
2333
|
-
currency: string;
|
|
2334
|
-
/**
|
|
2335
|
-
* The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
2336
|
-
*/
|
|
2337
|
-
product: string;
|
|
2338
|
-
/**
|
|
2339
|
-
* The recurring components of a price such as `interval` and `interval_count`.
|
|
2340
|
-
*/
|
|
2341
|
-
recurring?: PriceData.Recurring;
|
|
2342
|
-
/**
|
|
2343
|
-
* 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.
|
|
2344
|
-
*/
|
|
2345
|
-
tax_behavior?: PriceData.TaxBehavior;
|
|
2346
|
-
/**
|
|
2347
|
-
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
2348
|
-
*/
|
|
2349
|
-
unit_amount?: number;
|
|
2350
|
-
/**
|
|
2351
|
-
* 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.
|
|
2352
|
-
*/
|
|
2353
|
-
unit_amount_decimal?: Decimal;
|
|
2354
|
-
}
|
|
2355
|
-
namespace Discount {
|
|
2356
|
-
interface DiscountEnd {
|
|
2357
|
-
/**
|
|
2358
|
-
* Time span for the redeemed discount.
|
|
2359
|
-
*/
|
|
2360
|
-
duration?: DiscountEnd.Duration;
|
|
2361
|
-
/**
|
|
2362
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2363
|
-
*/
|
|
2364
|
-
timestamp?: number;
|
|
2365
|
-
/**
|
|
2366
|
-
* The type of calculation made to determine when the discount ends.
|
|
2367
|
-
*/
|
|
2368
|
-
type: DiscountEnd.Type;
|
|
2369
|
-
}
|
|
2370
|
-
namespace DiscountEnd {
|
|
2371
|
-
interface Duration {
|
|
2372
|
-
/**
|
|
2373
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2374
|
-
*/
|
|
2375
|
-
interval: Duration.Interval;
|
|
2376
|
-
/**
|
|
2377
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2378
|
-
*/
|
|
2379
|
-
interval_count: number;
|
|
2380
|
-
}
|
|
2381
|
-
type Type = 'duration' | 'timestamp';
|
|
2382
|
-
namespace Duration {
|
|
2383
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2384
|
-
}
|
|
2385
|
-
}
|
|
2386
|
-
}
|
|
2387
|
-
namespace PriceData {
|
|
2388
|
-
interface Recurring {
|
|
2389
|
-
/**
|
|
2390
|
-
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
2391
|
-
*/
|
|
2392
|
-
interval: Recurring.Interval;
|
|
2393
|
-
/**
|
|
2394
|
-
* 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).
|
|
2395
|
-
*/
|
|
2396
|
-
interval_count?: number;
|
|
2397
|
-
}
|
|
2398
|
-
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
2399
|
-
namespace Recurring {
|
|
2400
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2401
|
-
}
|
|
2402
|
-
}
|
|
2403
|
-
}
|
|
2404
|
-
namespace SubscriptionData {
|
|
2405
|
-
interface BillOnAcceptance {
|
|
2406
|
-
/**
|
|
2407
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
2408
|
-
*/
|
|
2409
|
-
bill_from?: BillOnAcceptance.BillFrom;
|
|
2410
|
-
/**
|
|
2411
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
2412
|
-
*/
|
|
2413
|
-
bill_until?: BillOnAcceptance.BillUntil;
|
|
2414
|
-
}
|
|
2415
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
2416
|
-
interface BillingMode {
|
|
2417
|
-
/**
|
|
2418
|
-
* Configure behavior for flexible billing mode.
|
|
2419
|
-
*/
|
|
2420
|
-
flexible?: BillingMode.Flexible;
|
|
2421
|
-
/**
|
|
2422
|
-
* Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
|
|
2423
|
-
*/
|
|
2424
|
-
type: BillingMode.Type;
|
|
2425
|
-
}
|
|
2426
|
-
interface BillingSchedule {
|
|
2427
|
-
/**
|
|
2428
|
-
* Configure billing schedule differently for individual subscription items.
|
|
2429
|
-
*/
|
|
2430
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
2431
|
-
/**
|
|
2432
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
2433
|
-
*/
|
|
2434
|
-
bill_from: BillingSchedule.BillFrom;
|
|
2435
|
-
/**
|
|
2436
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
2437
|
-
*/
|
|
2438
|
-
bill_until: BillingSchedule.BillUntil;
|
|
2439
|
-
/**
|
|
2440
|
-
* 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.
|
|
2441
|
-
*/
|
|
2442
|
-
key?: string;
|
|
2443
|
-
}
|
|
2444
|
-
type EndBehavior = 'cancel' | 'release';
|
|
2445
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
2446
|
-
interface Prebilling {
|
|
2447
|
-
/**
|
|
2448
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
2449
|
-
*/
|
|
2450
|
-
iterations: number;
|
|
2451
|
-
}
|
|
2452
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2453
|
-
namespace BillingMode {
|
|
2454
|
-
interface Flexible {
|
|
2455
|
-
/**
|
|
2456
|
-
* Controls how invoices and invoice items display proration amounts and discount amounts.
|
|
2457
|
-
*/
|
|
2458
|
-
proration_discounts?: Flexible.ProrationDiscounts;
|
|
2459
|
-
}
|
|
2460
|
-
type Type = 'classic' | 'flexible';
|
|
2461
|
-
namespace Flexible {
|
|
2462
|
-
type ProrationDiscounts = 'included' | 'itemized';
|
|
2463
|
-
}
|
|
2464
|
-
}
|
|
2465
|
-
namespace BillingSchedule {
|
|
2466
|
-
interface AppliesTo {
|
|
2467
|
-
/**
|
|
2468
|
-
* The ID of the price object.
|
|
2469
|
-
*/
|
|
2470
|
-
price?: string;
|
|
2471
|
-
/**
|
|
2472
|
-
* Controls which subscription items the billing schedule applies to.
|
|
2473
|
-
*/
|
|
2474
|
-
type: 'price';
|
|
2475
|
-
}
|
|
2476
|
-
interface BillFrom {
|
|
2477
|
-
/**
|
|
2478
|
-
* Details of a Quote line to start the bill period from.
|
|
2479
|
-
*/
|
|
2480
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
2481
|
-
/**
|
|
2482
|
-
* A precise Unix timestamp.
|
|
2483
|
-
*/
|
|
2484
|
-
timestamp?: number;
|
|
2485
|
-
/**
|
|
2486
|
-
* The type of method to specify the `bill_from` time.
|
|
2487
|
-
*/
|
|
2488
|
-
type: BillFrom.Type;
|
|
2489
|
-
}
|
|
2490
|
-
interface BillUntil {
|
|
2491
|
-
/**
|
|
2492
|
-
* Details of the duration over which to bill.
|
|
2493
|
-
*/
|
|
2494
|
-
duration?: BillUntil.Duration;
|
|
2495
|
-
/**
|
|
2496
|
-
* Details of a Quote line item from which to bill until.
|
|
2497
|
-
*/
|
|
2498
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
2499
|
-
/**
|
|
2500
|
-
* A precise Unix timestamp.
|
|
2501
|
-
*/
|
|
2502
|
-
timestamp?: number;
|
|
2503
|
-
/**
|
|
2504
|
-
* The type of method to specify the `bill_until` time.
|
|
2505
|
-
*/
|
|
2506
|
-
type: BillUntil.Type;
|
|
2507
|
-
}
|
|
2508
|
-
namespace BillFrom {
|
|
2509
|
-
interface LineStartsAt {
|
|
2510
|
-
/**
|
|
2511
|
-
* The ID of a quote line.
|
|
2512
|
-
*/
|
|
2513
|
-
id?: string;
|
|
2514
|
-
/**
|
|
2515
|
-
* 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.
|
|
2516
|
-
*/
|
|
2517
|
-
index?: number;
|
|
2518
|
-
}
|
|
2519
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
2520
|
-
}
|
|
2521
|
-
namespace BillUntil {
|
|
2522
|
-
interface Duration {
|
|
2523
|
-
/**
|
|
2524
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2525
|
-
*/
|
|
2526
|
-
interval: Duration.Interval;
|
|
2527
|
-
/**
|
|
2528
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2529
|
-
*/
|
|
2530
|
-
interval_count: number;
|
|
2531
|
-
}
|
|
2532
|
-
interface LineEndsAt {
|
|
2533
|
-
/**
|
|
2534
|
-
* The ID of a quote line.
|
|
2535
|
-
*/
|
|
2536
|
-
id?: string;
|
|
2537
|
-
/**
|
|
2538
|
-
* 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.
|
|
2539
|
-
*/
|
|
2540
|
-
index?: number;
|
|
2541
|
-
}
|
|
2542
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2543
|
-
namespace Duration {
|
|
2544
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2545
|
-
}
|
|
2546
|
-
}
|
|
2547
|
-
}
|
|
2548
|
-
namespace BillOnAcceptance {
|
|
2549
|
-
interface BillFrom {
|
|
2550
|
-
/**
|
|
2551
|
-
* Details of a Quote line to start the bill period from.
|
|
2552
|
-
*/
|
|
2553
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
2554
|
-
/**
|
|
2555
|
-
* A precise Unix timestamp.
|
|
2556
|
-
*/
|
|
2557
|
-
timestamp?: number;
|
|
2558
|
-
/**
|
|
2559
|
-
* The type of method to specify the `bill_from` time.
|
|
2560
|
-
*/
|
|
2561
|
-
type: BillFrom.Type;
|
|
2562
|
-
}
|
|
2563
|
-
interface BillUntil {
|
|
2564
|
-
/**
|
|
2565
|
-
* Details of the duration over which to bill.
|
|
2566
|
-
*/
|
|
2567
|
-
duration?: BillUntil.Duration;
|
|
2568
|
-
/**
|
|
2569
|
-
* Details of a Quote line item from which to bill until.
|
|
2570
|
-
*/
|
|
2571
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
2572
|
-
/**
|
|
2573
|
-
* A precise Unix timestamp.
|
|
2574
|
-
*/
|
|
2575
|
-
timestamp?: number;
|
|
2576
|
-
/**
|
|
2577
|
-
* The type of method to specify the `bill_until` time.
|
|
2578
|
-
*/
|
|
2579
|
-
type: BillUntil.Type;
|
|
2580
|
-
}
|
|
2581
|
-
namespace BillFrom {
|
|
2582
|
-
interface LineStartsAt {
|
|
2583
|
-
/**
|
|
2584
|
-
* The ID of a quote line.
|
|
2585
|
-
*/
|
|
2586
|
-
id?: string;
|
|
2587
|
-
/**
|
|
2588
|
-
* 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.
|
|
2589
|
-
*/
|
|
2590
|
-
index?: number;
|
|
2591
|
-
}
|
|
2592
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
2593
|
-
}
|
|
2594
|
-
namespace BillUntil {
|
|
2595
|
-
interface Duration {
|
|
2596
|
-
/**
|
|
2597
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2598
|
-
*/
|
|
2599
|
-
interval: Duration.Interval;
|
|
2600
|
-
/**
|
|
2601
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2602
|
-
*/
|
|
2603
|
-
interval_count: number;
|
|
2604
|
-
}
|
|
2605
|
-
interface LineEndsAt {
|
|
2606
|
-
/**
|
|
2607
|
-
* The ID of a quote line.
|
|
2608
|
-
*/
|
|
2609
|
-
id?: string;
|
|
2610
|
-
/**
|
|
2611
|
-
* 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.
|
|
2612
|
-
*/
|
|
2613
|
-
index?: number;
|
|
2614
|
-
}
|
|
2615
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2616
|
-
namespace Duration {
|
|
2617
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2618
|
-
}
|
|
2619
|
-
}
|
|
2620
|
-
}
|
|
2621
|
-
}
|
|
2622
|
-
namespace SubscriptionDataOverride {
|
|
2623
|
-
interface AppliesTo {
|
|
2624
|
-
/**
|
|
2625
|
-
* 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.
|
|
2626
|
-
*/
|
|
2627
|
-
new_reference?: string;
|
|
2628
|
-
/**
|
|
2629
|
-
* The ID of the schedule the line applies to.
|
|
2630
|
-
*/
|
|
2631
|
-
subscription_schedule?: string;
|
|
2632
|
-
/**
|
|
2633
|
-
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
2634
|
-
*/
|
|
2635
|
-
type: AppliesTo.Type;
|
|
2636
|
-
}
|
|
2637
|
-
interface BillOnAcceptance {
|
|
2638
|
-
/**
|
|
2639
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
2640
|
-
*/
|
|
2641
|
-
bill_from?: BillOnAcceptance.BillFrom;
|
|
2642
|
-
/**
|
|
2643
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
2644
|
-
*/
|
|
2645
|
-
bill_until?: BillOnAcceptance.BillUntil;
|
|
2646
|
-
}
|
|
2647
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
2648
|
-
interface BillingSchedule {
|
|
2649
|
-
/**
|
|
2650
|
-
* Configure billing schedule differently for individual subscription items.
|
|
2651
|
-
*/
|
|
2652
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
2653
|
-
/**
|
|
2654
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
2655
|
-
*/
|
|
2656
|
-
bill_from: BillingSchedule.BillFrom;
|
|
2657
|
-
/**
|
|
2658
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
2659
|
-
*/
|
|
2660
|
-
bill_until: BillingSchedule.BillUntil;
|
|
2661
|
-
/**
|
|
2662
|
-
* 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.
|
|
2663
|
-
*/
|
|
2664
|
-
key?: string;
|
|
2665
|
-
}
|
|
2666
|
-
type EndBehavior = 'cancel' | 'release';
|
|
2667
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
2668
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2669
|
-
namespace AppliesTo {
|
|
2670
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
2671
|
-
}
|
|
2672
|
-
namespace BillingSchedule {
|
|
2673
|
-
interface AppliesTo {
|
|
2674
|
-
/**
|
|
2675
|
-
* The ID of the price object.
|
|
2676
|
-
*/
|
|
2677
|
-
price?: string;
|
|
2678
|
-
/**
|
|
2679
|
-
* Controls which subscription items the billing schedule applies to.
|
|
2680
|
-
*/
|
|
2681
|
-
type: 'price';
|
|
2682
|
-
}
|
|
2683
|
-
interface BillFrom {
|
|
2684
|
-
/**
|
|
2685
|
-
* Details of a Quote line to start the bill period from.
|
|
2686
|
-
*/
|
|
2687
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
2688
|
-
/**
|
|
2689
|
-
* A precise Unix timestamp.
|
|
2690
|
-
*/
|
|
2691
|
-
timestamp?: number;
|
|
2692
|
-
/**
|
|
2693
|
-
* The type of method to specify the `bill_from` time.
|
|
2694
|
-
*/
|
|
2695
|
-
type: BillFrom.Type;
|
|
2696
|
-
}
|
|
2697
|
-
interface BillUntil {
|
|
2698
|
-
/**
|
|
2699
|
-
* Details of the duration over which to bill.
|
|
2700
|
-
*/
|
|
2701
|
-
duration?: BillUntil.Duration;
|
|
2702
|
-
/**
|
|
2703
|
-
* Details of a Quote line item from which to bill until.
|
|
2704
|
-
*/
|
|
2705
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
2706
|
-
/**
|
|
2707
|
-
* A precise Unix timestamp.
|
|
2708
|
-
*/
|
|
2709
|
-
timestamp?: number;
|
|
2710
|
-
/**
|
|
2711
|
-
* The type of method to specify the `bill_until` time.
|
|
2712
|
-
*/
|
|
2713
|
-
type: BillUntil.Type;
|
|
2714
|
-
}
|
|
2715
|
-
namespace BillFrom {
|
|
2716
|
-
interface LineStartsAt {
|
|
2717
|
-
/**
|
|
2718
|
-
* The ID of a quote line.
|
|
2719
|
-
*/
|
|
2720
|
-
id?: string;
|
|
2721
|
-
/**
|
|
2722
|
-
* 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.
|
|
2723
|
-
*/
|
|
2724
|
-
index?: number;
|
|
2725
|
-
}
|
|
2726
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
2727
|
-
}
|
|
2728
|
-
namespace BillUntil {
|
|
2729
|
-
interface Duration {
|
|
2730
|
-
/**
|
|
2731
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2732
|
-
*/
|
|
2733
|
-
interval: Duration.Interval;
|
|
2734
|
-
/**
|
|
2735
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2736
|
-
*/
|
|
2737
|
-
interval_count: number;
|
|
2738
|
-
}
|
|
2739
|
-
interface LineEndsAt {
|
|
2740
|
-
/**
|
|
2741
|
-
* The ID of a quote line.
|
|
2742
|
-
*/
|
|
2743
|
-
id?: string;
|
|
2744
|
-
/**
|
|
2745
|
-
* 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.
|
|
2746
|
-
*/
|
|
2747
|
-
index?: number;
|
|
2748
|
-
}
|
|
2749
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2750
|
-
namespace Duration {
|
|
2751
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2752
|
-
}
|
|
2753
|
-
}
|
|
2754
|
-
}
|
|
2755
|
-
namespace BillOnAcceptance {
|
|
2756
|
-
interface BillFrom {
|
|
2757
|
-
/**
|
|
2758
|
-
* Details of a Quote line to start the bill period from.
|
|
2759
|
-
*/
|
|
2760
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
2761
|
-
/**
|
|
2762
|
-
* A precise Unix timestamp.
|
|
2763
|
-
*/
|
|
2764
|
-
timestamp?: number;
|
|
2765
|
-
/**
|
|
2766
|
-
* The type of method to specify the `bill_from` time.
|
|
2767
|
-
*/
|
|
2768
|
-
type: BillFrom.Type;
|
|
2769
|
-
}
|
|
2770
|
-
interface BillUntil {
|
|
2771
|
-
/**
|
|
2772
|
-
* Details of the duration over which to bill.
|
|
2773
|
-
*/
|
|
2774
|
-
duration?: BillUntil.Duration;
|
|
2775
|
-
/**
|
|
2776
|
-
* Details of a Quote line item from which to bill until.
|
|
2777
|
-
*/
|
|
2778
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
2779
|
-
/**
|
|
2780
|
-
* A precise Unix timestamp.
|
|
2781
|
-
*/
|
|
2782
|
-
timestamp?: number;
|
|
857
|
+
namespace BillingMode {
|
|
858
|
+
interface Flexible {
|
|
2783
859
|
/**
|
|
2784
|
-
*
|
|
860
|
+
* Controls how invoices and invoice items display proration amounts and discount amounts.
|
|
2785
861
|
*/
|
|
2786
|
-
|
|
2787
|
-
}
|
|
2788
|
-
namespace BillFrom {
|
|
2789
|
-
interface LineStartsAt {
|
|
2790
|
-
/**
|
|
2791
|
-
* The ID of a quote line.
|
|
2792
|
-
*/
|
|
2793
|
-
id?: string;
|
|
2794
|
-
/**
|
|
2795
|
-
* 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.
|
|
2796
|
-
*/
|
|
2797
|
-
index?: number;
|
|
2798
|
-
}
|
|
2799
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
862
|
+
proration_discounts?: Flexible.ProrationDiscounts;
|
|
2800
863
|
}
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2805
|
-
*/
|
|
2806
|
-
interval: Duration.Interval;
|
|
2807
|
-
/**
|
|
2808
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2809
|
-
*/
|
|
2810
|
-
interval_count: number;
|
|
2811
|
-
}
|
|
2812
|
-
interface LineEndsAt {
|
|
2813
|
-
/**
|
|
2814
|
-
* The ID of a quote line.
|
|
2815
|
-
*/
|
|
2816
|
-
id?: string;
|
|
2817
|
-
/**
|
|
2818
|
-
* 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.
|
|
2819
|
-
*/
|
|
2820
|
-
index?: number;
|
|
2821
|
-
}
|
|
2822
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
2823
|
-
namespace Duration {
|
|
2824
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2825
|
-
}
|
|
864
|
+
type Type = 'classic' | 'flexible';
|
|
865
|
+
namespace Flexible {
|
|
866
|
+
type ProrationDiscounts = 'included' | 'itemized';
|
|
2826
867
|
}
|
|
2827
868
|
}
|
|
2828
869
|
}
|
|
@@ -2834,10 +875,6 @@ export interface QuoteRetrieveParams {
|
|
|
2834
875
|
expand?: Array<string>;
|
|
2835
876
|
}
|
|
2836
877
|
export interface QuoteUpdateParams {
|
|
2837
|
-
/**
|
|
2838
|
-
* Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
|
|
2839
|
-
*/
|
|
2840
|
-
allow_backdated_lines?: boolean;
|
|
2841
878
|
/**
|
|
2842
879
|
* 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.
|
|
2843
880
|
*/
|
|
@@ -2898,10 +935,6 @@ export interface QuoteUpdateParams {
|
|
|
2898
935
|
* 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.
|
|
2899
936
|
*/
|
|
2900
937
|
line_items?: Array<QuoteUpdateParams.LineItem>;
|
|
2901
|
-
/**
|
|
2902
|
-
* 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.
|
|
2903
|
-
*/
|
|
2904
|
-
lines?: Array<QuoteUpdateParams.Line>;
|
|
2905
938
|
/**
|
|
2906
939
|
* 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`.
|
|
2907
940
|
*/
|
|
@@ -2914,10 +947,6 @@ export interface QuoteUpdateParams {
|
|
|
2914
947
|
* 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.
|
|
2915
948
|
*/
|
|
2916
949
|
subscription_data?: QuoteUpdateParams.SubscriptionData;
|
|
2917
|
-
/**
|
|
2918
|
-
* List representing overrides for `subscription_data` configurations for specific subscription schedules.
|
|
2919
|
-
*/
|
|
2920
|
-
subscription_data_overrides?: Emptyable<Array<QuoteUpdateParams.SubscriptionDataOverride>>;
|
|
2921
950
|
/**
|
|
2922
951
|
* The data with which to automatically create a Transfer for each of the invoices.
|
|
2923
952
|
*/
|
|
@@ -2944,10 +973,6 @@ export declare namespace QuoteUpdateParams {
|
|
|
2944
973
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2945
974
|
*/
|
|
2946
975
|
discount?: string;
|
|
2947
|
-
/**
|
|
2948
|
-
* Details to determine how long the discount should be applied for.
|
|
2949
|
-
*/
|
|
2950
|
-
discount_end?: Discount.DiscountEnd;
|
|
2951
976
|
/**
|
|
2952
977
|
* ID of the promotion code to create a new discount for.
|
|
2953
978
|
*/
|
|
@@ -2989,156 +1014,24 @@ export declare namespace QuoteUpdateParams {
|
|
|
2989
1014
|
*/
|
|
2990
1015
|
tax_rates?: Emptyable<Array<string>>;
|
|
2991
1016
|
}
|
|
2992
|
-
interface Line {
|
|
2993
|
-
/**
|
|
2994
|
-
* An array of operations the quote line performs.
|
|
2995
|
-
*/
|
|
2996
|
-
actions?: Array<Line.Action>;
|
|
2997
|
-
/**
|
|
2998
|
-
* Details to identify the subscription schedule the quote line applies to.
|
|
2999
|
-
*/
|
|
3000
|
-
applies_to?: Line.AppliesTo;
|
|
3001
|
-
/**
|
|
3002
|
-
* 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.
|
|
3003
|
-
*/
|
|
3004
|
-
billing_cycle_anchor?: Line.BillingCycleAnchor;
|
|
3005
|
-
/**
|
|
3006
|
-
* 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.
|
|
3007
|
-
*/
|
|
3008
|
-
cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
|
|
3009
|
-
/**
|
|
3010
|
-
* Configures how the quote handles billing for line transitions.
|
|
3011
|
-
*/
|
|
3012
|
-
effective_at?: Line.EffectiveAt;
|
|
3013
|
-
/**
|
|
3014
|
-
* 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.
|
|
3015
|
-
*/
|
|
3016
|
-
ends_at?: Line.EndsAt;
|
|
3017
|
-
/**
|
|
3018
|
-
* The ID of an existing line on the quote.
|
|
3019
|
-
*/
|
|
3020
|
-
id?: string;
|
|
3021
|
-
/**
|
|
3022
|
-
* 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.
|
|
3023
|
-
*/
|
|
3024
|
-
proration_behavior?: Line.ProrationBehavior;
|
|
3025
|
-
/**
|
|
3026
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3027
|
-
*/
|
|
3028
|
-
set_pause_collection?: Line.SetPauseCollection;
|
|
3029
|
-
/**
|
|
3030
|
-
* Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
|
|
3031
|
-
*/
|
|
3032
|
-
set_schedule_end?: Line.SetScheduleEnd;
|
|
3033
|
-
/**
|
|
3034
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
3035
|
-
*/
|
|
3036
|
-
starts_at?: Line.StartsAt;
|
|
3037
|
-
/**
|
|
3038
|
-
* Settings related to subscription trials.
|
|
3039
|
-
*/
|
|
3040
|
-
trial_settings?: Line.TrialSettings;
|
|
3041
|
-
}
|
|
3042
1017
|
interface SubscriptionData {
|
|
3043
|
-
/**
|
|
3044
|
-
* Describes the period to bill for upon accepting the quote.
|
|
3045
|
-
*/
|
|
3046
|
-
bill_on_acceptance?: Emptyable<SubscriptionData.BillOnAcceptance>;
|
|
3047
|
-
/**
|
|
3048
|
-
* 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.
|
|
3049
|
-
*/
|
|
3050
|
-
billing_behavior?: SubscriptionData.BillingBehavior;
|
|
3051
|
-
/**
|
|
3052
|
-
* When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
|
3053
|
-
*/
|
|
3054
|
-
billing_cycle_anchor?: Emptyable<'reset'>;
|
|
3055
|
-
/**
|
|
3056
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
3057
|
-
*/
|
|
3058
|
-
billing_schedules?: Emptyable<Array<SubscriptionData.BillingSchedule>>;
|
|
3059
1018
|
/**
|
|
3060
1019
|
* 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.
|
|
3061
1020
|
*/
|
|
3062
1021
|
description?: Emptyable<string>;
|
|
3063
1022
|
/**
|
|
3064
|
-
* When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
|
|
1023
|
+
* 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.
|
|
3065
1024
|
*/
|
|
3066
1025
|
effective_date?: Emptyable<'current_period_end' | number>;
|
|
3067
|
-
/**
|
|
3068
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
3069
|
-
*/
|
|
3070
|
-
end_behavior?: SubscriptionData.EndBehavior;
|
|
3071
1026
|
/**
|
|
3072
1027
|
* 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.
|
|
3073
1028
|
*/
|
|
3074
1029
|
metadata?: MetadataParam;
|
|
3075
|
-
/**
|
|
3076
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
3077
|
-
*/
|
|
3078
|
-
phase_effective_at?: SubscriptionData.PhaseEffectiveAt;
|
|
3079
|
-
/**
|
|
3080
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
3081
|
-
*/
|
|
3082
|
-
prebilling?: Emptyable<SubscriptionData.Prebilling>;
|
|
3083
|
-
/**
|
|
3084
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
3085
|
-
*
|
|
3086
|
-
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
3087
|
-
*
|
|
3088
|
-
* 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`.
|
|
3089
|
-
*
|
|
3090
|
-
* Prorations can be disabled by passing `none`.
|
|
3091
|
-
*/
|
|
3092
|
-
proration_behavior?: SubscriptionData.ProrationBehavior;
|
|
3093
1030
|
/**
|
|
3094
1031
|
* Integer representing the number of trial period days before the customer is charged for the first time.
|
|
3095
1032
|
*/
|
|
3096
1033
|
trial_period_days?: Emptyable<number>;
|
|
3097
1034
|
}
|
|
3098
|
-
interface SubscriptionDataOverride {
|
|
3099
|
-
/**
|
|
3100
|
-
* Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
|
|
3101
|
-
*/
|
|
3102
|
-
applies_to: SubscriptionDataOverride.AppliesTo;
|
|
3103
|
-
/**
|
|
3104
|
-
* Describes the period to bill for upon accepting the quote.
|
|
3105
|
-
*/
|
|
3106
|
-
bill_on_acceptance?: Emptyable<SubscriptionDataOverride.BillOnAcceptance>;
|
|
3107
|
-
/**
|
|
3108
|
-
* 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.
|
|
3109
|
-
*/
|
|
3110
|
-
billing_behavior?: SubscriptionDataOverride.BillingBehavior;
|
|
3111
|
-
/**
|
|
3112
|
-
* Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
3113
|
-
*/
|
|
3114
|
-
billing_schedules?: Array<SubscriptionDataOverride.BillingSchedule>;
|
|
3115
|
-
/**
|
|
3116
|
-
* The customer the Subscription Data override applies to.
|
|
3117
|
-
*/
|
|
3118
|
-
customer?: string;
|
|
3119
|
-
/**
|
|
3120
|
-
* 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.
|
|
3121
|
-
*/
|
|
3122
|
-
description?: Emptyable<string>;
|
|
3123
|
-
/**
|
|
3124
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
3125
|
-
*/
|
|
3126
|
-
end_behavior?: SubscriptionDataOverride.EndBehavior;
|
|
3127
|
-
/**
|
|
3128
|
-
* Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
|
|
3129
|
-
*/
|
|
3130
|
-
phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt;
|
|
3131
|
-
/**
|
|
3132
|
-
* Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
3133
|
-
*
|
|
3134
|
-
* When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
3135
|
-
*
|
|
3136
|
-
* 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`.
|
|
3137
|
-
*
|
|
3138
|
-
* Prorations can be disabled by passing `none`.
|
|
3139
|
-
*/
|
|
3140
|
-
proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
|
|
3141
|
-
}
|
|
3142
1035
|
interface TransferData {
|
|
3143
1036
|
/**
|
|
3144
1037
|
* 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.
|
|
@@ -3149,59 +1042,12 @@ export declare namespace QuoteUpdateParams {
|
|
|
3149
1042
|
*/
|
|
3150
1043
|
amount_percent?: number;
|
|
3151
1044
|
/**
|
|
3152
|
-
* ID of an existing, connected Stripe account.
|
|
3153
|
-
*/
|
|
3154
|
-
destination: string;
|
|
3155
|
-
}
|
|
3156
|
-
namespace AutomaticTax {
|
|
3157
|
-
interface Liability {
|
|
3158
|
-
/**
|
|
3159
|
-
* The connected account being referenced when `type` is `account`.
|
|
3160
|
-
*/
|
|
3161
|
-
account?: string;
|
|
3162
|
-
/**
|
|
3163
|
-
* Type of the account referenced in the request.
|
|
3164
|
-
*/
|
|
3165
|
-
type: Liability.Type;
|
|
3166
|
-
}
|
|
3167
|
-
namespace Liability {
|
|
3168
|
-
type Type = 'account' | 'application' | 'self';
|
|
3169
|
-
}
|
|
3170
|
-
}
|
|
3171
|
-
namespace Discount {
|
|
3172
|
-
interface DiscountEnd {
|
|
3173
|
-
/**
|
|
3174
|
-
* Time span for the redeemed discount.
|
|
3175
|
-
*/
|
|
3176
|
-
duration?: DiscountEnd.Duration;
|
|
3177
|
-
/**
|
|
3178
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3179
|
-
*/
|
|
3180
|
-
timestamp?: number;
|
|
3181
|
-
/**
|
|
3182
|
-
* The type of calculation made to determine when the discount ends.
|
|
3183
|
-
*/
|
|
3184
|
-
type: DiscountEnd.Type;
|
|
3185
|
-
}
|
|
3186
|
-
namespace DiscountEnd {
|
|
3187
|
-
interface Duration {
|
|
3188
|
-
/**
|
|
3189
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3190
|
-
*/
|
|
3191
|
-
interval: Duration.Interval;
|
|
3192
|
-
/**
|
|
3193
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3194
|
-
*/
|
|
3195
|
-
interval_count: number;
|
|
3196
|
-
}
|
|
3197
|
-
type Type = 'duration' | 'timestamp';
|
|
3198
|
-
namespace Duration {
|
|
3199
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3200
|
-
}
|
|
3201
|
-
}
|
|
1045
|
+
* ID of an existing, connected Stripe account.
|
|
1046
|
+
*/
|
|
1047
|
+
destination: string;
|
|
3202
1048
|
}
|
|
3203
|
-
namespace
|
|
3204
|
-
interface
|
|
1049
|
+
namespace AutomaticTax {
|
|
1050
|
+
interface Liability {
|
|
3205
1051
|
/**
|
|
3206
1052
|
* The connected account being referenced when `type` is `account`.
|
|
3207
1053
|
*/
|
|
@@ -3209,676 +1055,25 @@ export declare namespace QuoteUpdateParams {
|
|
|
3209
1055
|
/**
|
|
3210
1056
|
* Type of the account referenced in the request.
|
|
3211
1057
|
*/
|
|
3212
|
-
type:
|
|
1058
|
+
type: Liability.Type;
|
|
3213
1059
|
}
|
|
3214
|
-
namespace
|
|
3215
|
-
type Type = 'account' | '
|
|
1060
|
+
namespace Liability {
|
|
1061
|
+
type Type = 'account' | 'self';
|
|
3216
1062
|
}
|
|
3217
1063
|
}
|
|
3218
|
-
namespace
|
|
3219
|
-
interface
|
|
3220
|
-
/**
|
|
3221
|
-
* Details for the `add_discount` type.
|
|
3222
|
-
*/
|
|
3223
|
-
add_discount?: Action.AddDiscount;
|
|
3224
|
-
/**
|
|
3225
|
-
* Details for the `add_item` type.
|
|
3226
|
-
*/
|
|
3227
|
-
add_item?: Action.AddItem;
|
|
3228
|
-
/**
|
|
3229
|
-
* Details for the `add_metadata` type: specify a hash of key-value pairs.
|
|
3230
|
-
*/
|
|
3231
|
-
add_metadata?: {
|
|
3232
|
-
[key: string]: string;
|
|
3233
|
-
};
|
|
3234
|
-
/**
|
|
3235
|
-
* Details for the `remove_discount` type.
|
|
3236
|
-
*/
|
|
3237
|
-
remove_discount?: Action.RemoveDiscount;
|
|
3238
|
-
/**
|
|
3239
|
-
* Details for the `remove_item` type.
|
|
3240
|
-
*/
|
|
3241
|
-
remove_item?: Action.RemoveItem;
|
|
3242
|
-
/**
|
|
3243
|
-
* Details for the `remove_metadata` type: specify an array of metadata keys.
|
|
3244
|
-
*/
|
|
3245
|
-
remove_metadata?: Array<string>;
|
|
3246
|
-
/**
|
|
3247
|
-
* Details for the `set_discounts` type.
|
|
3248
|
-
*/
|
|
3249
|
-
set_discounts?: Array<Action.SetDiscount>;
|
|
3250
|
-
/**
|
|
3251
|
-
* Details for the `set_items` type.
|
|
3252
|
-
*/
|
|
3253
|
-
set_items?: Array<Action.SetItem>;
|
|
3254
|
-
/**
|
|
3255
|
-
* Details for the `set_metadata` type: specify an array of key-value pairs.
|
|
3256
|
-
*/
|
|
3257
|
-
set_metadata?: Emptyable<{
|
|
3258
|
-
[key: string]: string;
|
|
3259
|
-
}>;
|
|
3260
|
-
/**
|
|
3261
|
-
* The type of action the quote line performs.
|
|
3262
|
-
*/
|
|
3263
|
-
type: Action.Type;
|
|
3264
|
-
}
|
|
3265
|
-
interface AppliesTo {
|
|
3266
|
-
/**
|
|
3267
|
-
* 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.
|
|
3268
|
-
*/
|
|
3269
|
-
new_reference?: string;
|
|
3270
|
-
/**
|
|
3271
|
-
* The ID of the schedule the line applies to.
|
|
3272
|
-
*/
|
|
3273
|
-
subscription_schedule?: string;
|
|
3274
|
-
/**
|
|
3275
|
-
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
3276
|
-
*/
|
|
3277
|
-
type: AppliesTo.Type;
|
|
3278
|
-
}
|
|
3279
|
-
type BillingCycleAnchor = 'automatic' | 'line_starts_at';
|
|
3280
|
-
interface CancelSubscriptionSchedule {
|
|
3281
|
-
/**
|
|
3282
|
-
* Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
|
|
3283
|
-
*/
|
|
3284
|
-
cancel_at: 'line_starts_at';
|
|
3285
|
-
/**
|
|
3286
|
-
* 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`.
|
|
3287
|
-
*/
|
|
3288
|
-
invoice_now?: boolean;
|
|
3289
|
-
/**
|
|
3290
|
-
* If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
|
|
3291
|
-
*/
|
|
3292
|
-
prorate?: boolean;
|
|
3293
|
-
}
|
|
3294
|
-
type EffectiveAt = 'billing_period_start' | 'line_start';
|
|
3295
|
-
interface EndsAt {
|
|
3296
|
-
/**
|
|
3297
|
-
* Use the `end` time of a given discount.
|
|
3298
|
-
*/
|
|
3299
|
-
discount_end?: EndsAt.DiscountEnd;
|
|
3300
|
-
/**
|
|
3301
|
-
* Time span for the quote line starting from the `starts_at` date.
|
|
3302
|
-
*/
|
|
3303
|
-
duration?: EndsAt.Duration;
|
|
3304
|
-
/**
|
|
3305
|
-
* A precise Unix timestamp.
|
|
3306
|
-
*/
|
|
3307
|
-
timestamp?: number;
|
|
3308
|
-
/**
|
|
3309
|
-
* Select a way to pass in `ends_at`.
|
|
3310
|
-
*/
|
|
3311
|
-
type: EndsAt.Type;
|
|
3312
|
-
}
|
|
3313
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3314
|
-
interface SetPauseCollection {
|
|
3315
|
-
/**
|
|
3316
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
3317
|
-
*/
|
|
3318
|
-
set?: SetPauseCollection.Set;
|
|
3319
|
-
/**
|
|
3320
|
-
* Determines the type of the pause_collection amendment.
|
|
3321
|
-
*/
|
|
3322
|
-
type: SetPauseCollection.Type;
|
|
3323
|
-
}
|
|
3324
|
-
type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
|
|
3325
|
-
interface StartsAt {
|
|
3326
|
-
/**
|
|
3327
|
-
* Use the `end` time of a given discount.
|
|
3328
|
-
*/
|
|
3329
|
-
discount_end?: StartsAt.DiscountEnd;
|
|
3330
|
-
/**
|
|
3331
|
-
* The timestamp the given line ends at.
|
|
3332
|
-
*/
|
|
3333
|
-
line_ends_at?: StartsAt.LineEndsAt;
|
|
3334
|
-
/**
|
|
3335
|
-
* A precise Unix timestamp.
|
|
3336
|
-
*/
|
|
3337
|
-
timestamp?: number;
|
|
1064
|
+
namespace InvoiceSettings {
|
|
1065
|
+
interface Issuer {
|
|
3338
1066
|
/**
|
|
3339
|
-
*
|
|
1067
|
+
* The connected account being referenced when `type` is `account`.
|
|
3340
1068
|
*/
|
|
3341
|
-
|
|
3342
|
-
}
|
|
3343
|
-
interface TrialSettings {
|
|
1069
|
+
account?: string;
|
|
3344
1070
|
/**
|
|
3345
|
-
*
|
|
3346
|
-
*/
|
|
3347
|
-
|
|
3348
|
-
}
|
|
3349
|
-
namespace Action {
|
|
3350
|
-
interface AddDiscount {
|
|
3351
|
-
/**
|
|
3352
|
-
* The coupon code to redeem.
|
|
3353
|
-
*/
|
|
3354
|
-
coupon?: string;
|
|
3355
|
-
/**
|
|
3356
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3357
|
-
*/
|
|
3358
|
-
discount?: string;
|
|
3359
|
-
/**
|
|
3360
|
-
* Details to determine how long the discount should be applied for.
|
|
3361
|
-
*/
|
|
3362
|
-
discount_end?: AddDiscount.DiscountEnd;
|
|
3363
|
-
/**
|
|
3364
|
-
* 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.
|
|
3365
|
-
*/
|
|
3366
|
-
index?: number;
|
|
3367
|
-
/**
|
|
3368
|
-
* The promotion code to redeem.
|
|
3369
|
-
*/
|
|
3370
|
-
promotion_code?: string;
|
|
3371
|
-
/**
|
|
3372
|
-
* Settings for discount application including service period anchoring.
|
|
3373
|
-
*/
|
|
3374
|
-
settings?: AddDiscount.Settings;
|
|
3375
|
-
}
|
|
3376
|
-
interface AddItem {
|
|
3377
|
-
/**
|
|
3378
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3379
|
-
*/
|
|
3380
|
-
discounts?: Array<AddItem.Discount>;
|
|
3381
|
-
/**
|
|
3382
|
-
* 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`.
|
|
3383
|
-
*/
|
|
3384
|
-
metadata?: MetadataParam;
|
|
3385
|
-
/**
|
|
3386
|
-
* The ID of the price object.
|
|
3387
|
-
*/
|
|
3388
|
-
price: string;
|
|
3389
|
-
/**
|
|
3390
|
-
* Quantity for this item.
|
|
3391
|
-
*/
|
|
3392
|
-
quantity?: number;
|
|
3393
|
-
/**
|
|
3394
|
-
* 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`.
|
|
3395
|
-
*/
|
|
3396
|
-
tax_rates?: Array<string>;
|
|
3397
|
-
/**
|
|
3398
|
-
* Options that configure the trial on the subscription item.
|
|
3399
|
-
*/
|
|
3400
|
-
trial?: AddItem.Trial;
|
|
3401
|
-
/**
|
|
3402
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3403
|
-
*/
|
|
3404
|
-
trial_offer?: string;
|
|
3405
|
-
}
|
|
3406
|
-
interface RemoveDiscount {
|
|
3407
|
-
/**
|
|
3408
|
-
* The coupon code to remove from the `discounts` array.
|
|
3409
|
-
*/
|
|
3410
|
-
coupon?: string;
|
|
3411
|
-
/**
|
|
3412
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
3413
|
-
*/
|
|
3414
|
-
discount?: string;
|
|
3415
|
-
/**
|
|
3416
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
3417
|
-
*/
|
|
3418
|
-
promotion_code?: string;
|
|
3419
|
-
}
|
|
3420
|
-
interface RemoveItem {
|
|
3421
|
-
/**
|
|
3422
|
-
* ID of a price to remove.
|
|
3423
|
-
*/
|
|
3424
|
-
price: string;
|
|
3425
|
-
}
|
|
3426
|
-
interface SetDiscount {
|
|
3427
|
-
/**
|
|
3428
|
-
* The coupon code to replace the `discounts` array with.
|
|
3429
|
-
*/
|
|
3430
|
-
coupon?: string;
|
|
3431
|
-
/**
|
|
3432
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
3433
|
-
*/
|
|
3434
|
-
discount?: string;
|
|
3435
|
-
/**
|
|
3436
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3437
|
-
*/
|
|
3438
|
-
promotion_code?: string;
|
|
3439
|
-
/**
|
|
3440
|
-
* Settings for discount application including service period anchoring.
|
|
3441
|
-
*/
|
|
3442
|
-
settings?: SetDiscount.Settings;
|
|
3443
|
-
}
|
|
3444
|
-
interface SetItem {
|
|
3445
|
-
/**
|
|
3446
|
-
* 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`.
|
|
3447
|
-
*/
|
|
3448
|
-
discounts?: Array<SetItem.Discount>;
|
|
3449
|
-
/**
|
|
3450
|
-
* 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`.
|
|
3451
|
-
*/
|
|
3452
|
-
metadata?: MetadataParam;
|
|
3453
|
-
/**
|
|
3454
|
-
* The ID of the price object.
|
|
3455
|
-
*/
|
|
3456
|
-
price: string;
|
|
3457
|
-
/**
|
|
3458
|
-
* 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`.
|
|
3459
|
-
*/
|
|
3460
|
-
quantity?: number;
|
|
3461
|
-
/**
|
|
3462
|
-
* 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`.
|
|
3463
|
-
*/
|
|
3464
|
-
tax_rates?: Array<string>;
|
|
3465
|
-
/**
|
|
3466
|
-
* 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`.
|
|
3467
|
-
*/
|
|
3468
|
-
trial?: SetItem.Trial;
|
|
3469
|
-
/**
|
|
3470
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3471
|
-
*/
|
|
3472
|
-
trial_offer?: string;
|
|
3473
|
-
}
|
|
3474
|
-
type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata';
|
|
3475
|
-
namespace AddDiscount {
|
|
3476
|
-
interface DiscountEnd {
|
|
3477
|
-
/**
|
|
3478
|
-
* The type of calculation made to determine when the discount ends.
|
|
3479
|
-
*/
|
|
3480
|
-
type: 'line_ends_at';
|
|
3481
|
-
}
|
|
3482
|
-
interface Settings {
|
|
3483
|
-
/**
|
|
3484
|
-
* Configures service period cycle anchoring.
|
|
3485
|
-
*/
|
|
3486
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3487
|
-
/**
|
|
3488
|
-
* 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.
|
|
3489
|
-
*/
|
|
3490
|
-
start_date?: Settings.StartDate;
|
|
3491
|
-
}
|
|
3492
|
-
namespace Settings {
|
|
3493
|
-
interface ServicePeriodAnchorConfig {
|
|
3494
|
-
/**
|
|
3495
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3496
|
-
*/
|
|
3497
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3498
|
-
/**
|
|
3499
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3500
|
-
*/
|
|
3501
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3502
|
-
}
|
|
3503
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
3504
|
-
namespace ServicePeriodAnchorConfig {
|
|
3505
|
-
interface Custom {
|
|
3506
|
-
/**
|
|
3507
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3508
|
-
*/
|
|
3509
|
-
day_of_month: number;
|
|
3510
|
-
/**
|
|
3511
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3512
|
-
*/
|
|
3513
|
-
hour?: number;
|
|
3514
|
-
/**
|
|
3515
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3516
|
-
*/
|
|
3517
|
-
minute?: number;
|
|
3518
|
-
/**
|
|
3519
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3520
|
-
*/
|
|
3521
|
-
month?: number;
|
|
3522
|
-
/**
|
|
3523
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3524
|
-
*/
|
|
3525
|
-
second?: number;
|
|
3526
|
-
}
|
|
3527
|
-
type Type = 'custom' | 'inherit';
|
|
3528
|
-
}
|
|
3529
|
-
}
|
|
3530
|
-
}
|
|
3531
|
-
namespace AddItem {
|
|
3532
|
-
interface Discount {
|
|
3533
|
-
/**
|
|
3534
|
-
* ID of the coupon to create a new discount for.
|
|
3535
|
-
*/
|
|
3536
|
-
coupon?: string;
|
|
3537
|
-
/**
|
|
3538
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3539
|
-
*/
|
|
3540
|
-
discount?: string;
|
|
3541
|
-
/**
|
|
3542
|
-
* Details to determine how long the discount should be applied for.
|
|
3543
|
-
*/
|
|
3544
|
-
discount_end?: Discount.DiscountEnd;
|
|
3545
|
-
/**
|
|
3546
|
-
* ID of the promotion code to create a new discount for.
|
|
3547
|
-
*/
|
|
3548
|
-
promotion_code?: string;
|
|
3549
|
-
/**
|
|
3550
|
-
* Settings for discount application including service period anchoring.
|
|
3551
|
-
*/
|
|
3552
|
-
settings?: Discount.Settings;
|
|
3553
|
-
}
|
|
3554
|
-
interface Trial {
|
|
3555
|
-
/**
|
|
3556
|
-
* 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.
|
|
3557
|
-
*/
|
|
3558
|
-
converts_to?: Array<string>;
|
|
3559
|
-
/**
|
|
3560
|
-
* Determines the type of trial for this item.
|
|
3561
|
-
*/
|
|
3562
|
-
type: Trial.Type;
|
|
3563
|
-
}
|
|
3564
|
-
namespace Discount {
|
|
3565
|
-
interface DiscountEnd {
|
|
3566
|
-
/**
|
|
3567
|
-
* Time span for the redeemed discount.
|
|
3568
|
-
*/
|
|
3569
|
-
duration?: DiscountEnd.Duration;
|
|
3570
|
-
/**
|
|
3571
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3572
|
-
*/
|
|
3573
|
-
timestamp?: number;
|
|
3574
|
-
/**
|
|
3575
|
-
* The type of calculation made to determine when the discount ends.
|
|
3576
|
-
*/
|
|
3577
|
-
type: DiscountEnd.Type;
|
|
3578
|
-
}
|
|
3579
|
-
interface Settings {
|
|
3580
|
-
/**
|
|
3581
|
-
* Configures service period cycle anchoring.
|
|
3582
|
-
*/
|
|
3583
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3584
|
-
/**
|
|
3585
|
-
* 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.
|
|
3586
|
-
*/
|
|
3587
|
-
start_date?: Settings.StartDate;
|
|
3588
|
-
}
|
|
3589
|
-
namespace DiscountEnd {
|
|
3590
|
-
interface Duration {
|
|
3591
|
-
/**
|
|
3592
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3593
|
-
*/
|
|
3594
|
-
interval: Duration.Interval;
|
|
3595
|
-
/**
|
|
3596
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3597
|
-
*/
|
|
3598
|
-
interval_count: number;
|
|
3599
|
-
}
|
|
3600
|
-
type Type = 'duration' | 'timestamp';
|
|
3601
|
-
namespace Duration {
|
|
3602
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3603
|
-
}
|
|
3604
|
-
}
|
|
3605
|
-
namespace Settings {
|
|
3606
|
-
interface ServicePeriodAnchorConfig {
|
|
3607
|
-
/**
|
|
3608
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3609
|
-
*/
|
|
3610
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3611
|
-
/**
|
|
3612
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3613
|
-
*/
|
|
3614
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3615
|
-
}
|
|
3616
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
3617
|
-
namespace ServicePeriodAnchorConfig {
|
|
3618
|
-
interface Custom {
|
|
3619
|
-
/**
|
|
3620
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3621
|
-
*/
|
|
3622
|
-
day_of_month: number;
|
|
3623
|
-
/**
|
|
3624
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3625
|
-
*/
|
|
3626
|
-
hour?: number;
|
|
3627
|
-
/**
|
|
3628
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3629
|
-
*/
|
|
3630
|
-
minute?: number;
|
|
3631
|
-
/**
|
|
3632
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3633
|
-
*/
|
|
3634
|
-
month?: number;
|
|
3635
|
-
/**
|
|
3636
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3637
|
-
*/
|
|
3638
|
-
second?: number;
|
|
3639
|
-
}
|
|
3640
|
-
type Type = 'custom' | 'inherit';
|
|
3641
|
-
}
|
|
3642
|
-
}
|
|
3643
|
-
}
|
|
3644
|
-
namespace Trial {
|
|
3645
|
-
type Type = 'free' | 'paid';
|
|
3646
|
-
}
|
|
3647
|
-
}
|
|
3648
|
-
namespace SetDiscount {
|
|
3649
|
-
interface Settings {
|
|
3650
|
-
/**
|
|
3651
|
-
* Configures service period cycle anchoring.
|
|
3652
|
-
*/
|
|
3653
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3654
|
-
/**
|
|
3655
|
-
* 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.
|
|
3656
|
-
*/
|
|
3657
|
-
start_date?: Settings.StartDate;
|
|
3658
|
-
}
|
|
3659
|
-
namespace Settings {
|
|
3660
|
-
interface ServicePeriodAnchorConfig {
|
|
3661
|
-
/**
|
|
3662
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3663
|
-
*/
|
|
3664
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3665
|
-
/**
|
|
3666
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3667
|
-
*/
|
|
3668
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3669
|
-
}
|
|
3670
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
3671
|
-
namespace ServicePeriodAnchorConfig {
|
|
3672
|
-
interface Custom {
|
|
3673
|
-
/**
|
|
3674
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3675
|
-
*/
|
|
3676
|
-
day_of_month: number;
|
|
3677
|
-
/**
|
|
3678
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3679
|
-
*/
|
|
3680
|
-
hour?: number;
|
|
3681
|
-
/**
|
|
3682
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3683
|
-
*/
|
|
3684
|
-
minute?: number;
|
|
3685
|
-
/**
|
|
3686
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3687
|
-
*/
|
|
3688
|
-
month?: number;
|
|
3689
|
-
/**
|
|
3690
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3691
|
-
*/
|
|
3692
|
-
second?: number;
|
|
3693
|
-
}
|
|
3694
|
-
type Type = 'custom' | 'inherit';
|
|
3695
|
-
}
|
|
3696
|
-
}
|
|
3697
|
-
}
|
|
3698
|
-
namespace SetItem {
|
|
3699
|
-
interface Discount {
|
|
3700
|
-
/**
|
|
3701
|
-
* ID of the coupon to create a new discount for.
|
|
3702
|
-
*/
|
|
3703
|
-
coupon?: string;
|
|
3704
|
-
/**
|
|
3705
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3706
|
-
*/
|
|
3707
|
-
discount?: string;
|
|
3708
|
-
/**
|
|
3709
|
-
* Details to determine how long the discount should be applied for.
|
|
3710
|
-
*/
|
|
3711
|
-
discount_end?: Discount.DiscountEnd;
|
|
3712
|
-
/**
|
|
3713
|
-
* ID of the promotion code to create a new discount for.
|
|
3714
|
-
*/
|
|
3715
|
-
promotion_code?: string;
|
|
3716
|
-
/**
|
|
3717
|
-
* Settings for discount application including service period anchoring.
|
|
3718
|
-
*/
|
|
3719
|
-
settings?: Discount.Settings;
|
|
3720
|
-
}
|
|
3721
|
-
interface Trial {
|
|
3722
|
-
/**
|
|
3723
|
-
* 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.
|
|
3724
|
-
*/
|
|
3725
|
-
converts_to?: Array<string>;
|
|
3726
|
-
/**
|
|
3727
|
-
* Determines the type of trial for this item.
|
|
3728
|
-
*/
|
|
3729
|
-
type: Trial.Type;
|
|
3730
|
-
}
|
|
3731
|
-
namespace Discount {
|
|
3732
|
-
interface DiscountEnd {
|
|
3733
|
-
/**
|
|
3734
|
-
* Time span for the redeemed discount.
|
|
3735
|
-
*/
|
|
3736
|
-
duration?: DiscountEnd.Duration;
|
|
3737
|
-
/**
|
|
3738
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3739
|
-
*/
|
|
3740
|
-
timestamp?: number;
|
|
3741
|
-
/**
|
|
3742
|
-
* The type of calculation made to determine when the discount ends.
|
|
3743
|
-
*/
|
|
3744
|
-
type: DiscountEnd.Type;
|
|
3745
|
-
}
|
|
3746
|
-
interface Settings {
|
|
3747
|
-
/**
|
|
3748
|
-
* Configures service period cycle anchoring.
|
|
3749
|
-
*/
|
|
3750
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3751
|
-
/**
|
|
3752
|
-
* 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.
|
|
3753
|
-
*/
|
|
3754
|
-
start_date?: Settings.StartDate;
|
|
3755
|
-
}
|
|
3756
|
-
namespace DiscountEnd {
|
|
3757
|
-
interface Duration {
|
|
3758
|
-
/**
|
|
3759
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3760
|
-
*/
|
|
3761
|
-
interval: Duration.Interval;
|
|
3762
|
-
/**
|
|
3763
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3764
|
-
*/
|
|
3765
|
-
interval_count: number;
|
|
3766
|
-
}
|
|
3767
|
-
type Type = 'duration' | 'timestamp';
|
|
3768
|
-
namespace Duration {
|
|
3769
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3770
|
-
}
|
|
3771
|
-
}
|
|
3772
|
-
namespace Settings {
|
|
3773
|
-
interface ServicePeriodAnchorConfig {
|
|
3774
|
-
/**
|
|
3775
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3776
|
-
*/
|
|
3777
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3778
|
-
/**
|
|
3779
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3780
|
-
*/
|
|
3781
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3782
|
-
}
|
|
3783
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'line_start';
|
|
3784
|
-
namespace ServicePeriodAnchorConfig {
|
|
3785
|
-
interface Custom {
|
|
3786
|
-
/**
|
|
3787
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3788
|
-
*/
|
|
3789
|
-
day_of_month: number;
|
|
3790
|
-
/**
|
|
3791
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3792
|
-
*/
|
|
3793
|
-
hour?: number;
|
|
3794
|
-
/**
|
|
3795
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3796
|
-
*/
|
|
3797
|
-
minute?: number;
|
|
3798
|
-
/**
|
|
3799
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3800
|
-
*/
|
|
3801
|
-
month?: number;
|
|
3802
|
-
/**
|
|
3803
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3804
|
-
*/
|
|
3805
|
-
second?: number;
|
|
3806
|
-
}
|
|
3807
|
-
type Type = 'custom' | 'inherit';
|
|
3808
|
-
}
|
|
3809
|
-
}
|
|
3810
|
-
}
|
|
3811
|
-
namespace Trial {
|
|
3812
|
-
type Type = 'free' | 'paid';
|
|
3813
|
-
}
|
|
3814
|
-
}
|
|
3815
|
-
}
|
|
3816
|
-
namespace AppliesTo {
|
|
3817
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
3818
|
-
}
|
|
3819
|
-
namespace EndsAt {
|
|
3820
|
-
interface DiscountEnd {
|
|
3821
|
-
/**
|
|
3822
|
-
* The ID of a specific discount.
|
|
3823
|
-
*/
|
|
3824
|
-
discount: string;
|
|
3825
|
-
}
|
|
3826
|
-
interface Duration {
|
|
3827
|
-
/**
|
|
3828
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3829
|
-
*/
|
|
3830
|
-
interval: Duration.Interval;
|
|
3831
|
-
/**
|
|
3832
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3833
|
-
*/
|
|
3834
|
-
interval_count: number;
|
|
3835
|
-
}
|
|
3836
|
-
type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
3837
|
-
namespace Duration {
|
|
3838
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3839
|
-
}
|
|
3840
|
-
}
|
|
3841
|
-
namespace SetPauseCollection {
|
|
3842
|
-
interface Set {
|
|
3843
|
-
/**
|
|
3844
|
-
* The payment collection behavior for this subscription while paused.
|
|
3845
|
-
*/
|
|
3846
|
-
behavior: Set.Behavior;
|
|
3847
|
-
}
|
|
3848
|
-
type Type = 'remove' | 'set';
|
|
3849
|
-
namespace Set {
|
|
3850
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3851
|
-
}
|
|
3852
|
-
}
|
|
3853
|
-
namespace StartsAt {
|
|
3854
|
-
interface DiscountEnd {
|
|
3855
|
-
/**
|
|
3856
|
-
* The ID of a specific discount.
|
|
3857
|
-
*/
|
|
3858
|
-
discount: string;
|
|
3859
|
-
}
|
|
3860
|
-
interface LineEndsAt {
|
|
3861
|
-
/**
|
|
3862
|
-
* The ID of a quote line.
|
|
3863
|
-
*/
|
|
3864
|
-
id?: string;
|
|
3865
|
-
/**
|
|
3866
|
-
* 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.
|
|
3867
|
-
*/
|
|
3868
|
-
index?: number;
|
|
3869
|
-
}
|
|
3870
|
-
type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
1071
|
+
* Type of the account referenced in the request.
|
|
1072
|
+
*/
|
|
1073
|
+
type: Issuer.Type;
|
|
3871
1074
|
}
|
|
3872
|
-
namespace
|
|
3873
|
-
|
|
3874
|
-
/**
|
|
3875
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3876
|
-
*/
|
|
3877
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3878
|
-
}
|
|
3879
|
-
namespace EndBehavior {
|
|
3880
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
3881
|
-
}
|
|
1075
|
+
namespace Issuer {
|
|
1076
|
+
type Type = 'account' | 'self';
|
|
3882
1077
|
}
|
|
3883
1078
|
}
|
|
3884
1079
|
namespace LineItem {
|
|
@@ -3891,10 +1086,6 @@ export declare namespace QuoteUpdateParams {
|
|
|
3891
1086
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3892
1087
|
*/
|
|
3893
1088
|
discount?: string;
|
|
3894
|
-
/**
|
|
3895
|
-
* Details to determine how long the discount should be applied for.
|
|
3896
|
-
*/
|
|
3897
|
-
discount_end?: Discount.DiscountEnd;
|
|
3898
1089
|
/**
|
|
3899
1090
|
* ID of the promotion code to create a new discount for.
|
|
3900
1091
|
*/
|
|
@@ -3926,38 +1117,6 @@ export declare namespace QuoteUpdateParams {
|
|
|
3926
1117
|
*/
|
|
3927
1118
|
unit_amount_decimal?: Decimal;
|
|
3928
1119
|
}
|
|
3929
|
-
namespace Discount {
|
|
3930
|
-
interface DiscountEnd {
|
|
3931
|
-
/**
|
|
3932
|
-
* Time span for the redeemed discount.
|
|
3933
|
-
*/
|
|
3934
|
-
duration?: DiscountEnd.Duration;
|
|
3935
|
-
/**
|
|
3936
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3937
|
-
*/
|
|
3938
|
-
timestamp?: number;
|
|
3939
|
-
/**
|
|
3940
|
-
* The type of calculation made to determine when the discount ends.
|
|
3941
|
-
*/
|
|
3942
|
-
type: DiscountEnd.Type;
|
|
3943
|
-
}
|
|
3944
|
-
namespace DiscountEnd {
|
|
3945
|
-
interface Duration {
|
|
3946
|
-
/**
|
|
3947
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3948
|
-
*/
|
|
3949
|
-
interval: Duration.Interval;
|
|
3950
|
-
/**
|
|
3951
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3952
|
-
*/
|
|
3953
|
-
interval_count: number;
|
|
3954
|
-
}
|
|
3955
|
-
type Type = 'duration' | 'timestamp';
|
|
3956
|
-
namespace Duration {
|
|
3957
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3958
|
-
}
|
|
3959
|
-
}
|
|
3960
|
-
}
|
|
3961
1120
|
namespace PriceData {
|
|
3962
1121
|
interface Recurring {
|
|
3963
1122
|
/**
|
|
@@ -3975,409 +1134,6 @@ export declare namespace QuoteUpdateParams {
|
|
|
3975
1134
|
}
|
|
3976
1135
|
}
|
|
3977
1136
|
}
|
|
3978
|
-
namespace SubscriptionData {
|
|
3979
|
-
interface BillOnAcceptance {
|
|
3980
|
-
/**
|
|
3981
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
3982
|
-
*/
|
|
3983
|
-
bill_from?: BillOnAcceptance.BillFrom;
|
|
3984
|
-
/**
|
|
3985
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
3986
|
-
*/
|
|
3987
|
-
bill_until?: BillOnAcceptance.BillUntil;
|
|
3988
|
-
}
|
|
3989
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3990
|
-
interface BillingSchedule {
|
|
3991
|
-
/**
|
|
3992
|
-
* Configure billing schedule differently for individual subscription items.
|
|
3993
|
-
*/
|
|
3994
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
3995
|
-
/**
|
|
3996
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
3997
|
-
*/
|
|
3998
|
-
bill_from?: BillingSchedule.BillFrom;
|
|
3999
|
-
/**
|
|
4000
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
4001
|
-
*/
|
|
4002
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
4003
|
-
/**
|
|
4004
|
-
* 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.
|
|
4005
|
-
*/
|
|
4006
|
-
key?: string;
|
|
4007
|
-
}
|
|
4008
|
-
type EndBehavior = 'cancel' | 'release';
|
|
4009
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
4010
|
-
interface Prebilling {
|
|
4011
|
-
/**
|
|
4012
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4013
|
-
*/
|
|
4014
|
-
iterations: number;
|
|
4015
|
-
}
|
|
4016
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4017
|
-
namespace BillingSchedule {
|
|
4018
|
-
interface AppliesTo {
|
|
4019
|
-
/**
|
|
4020
|
-
* The ID of the price object.
|
|
4021
|
-
*/
|
|
4022
|
-
price?: string;
|
|
4023
|
-
/**
|
|
4024
|
-
* Controls which subscription items the billing schedule applies to.
|
|
4025
|
-
*/
|
|
4026
|
-
type: 'price';
|
|
4027
|
-
}
|
|
4028
|
-
interface BillFrom {
|
|
4029
|
-
/**
|
|
4030
|
-
* Details of a Quote line to start the bill period from.
|
|
4031
|
-
*/
|
|
4032
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
4033
|
-
/**
|
|
4034
|
-
* A precise Unix timestamp.
|
|
4035
|
-
*/
|
|
4036
|
-
timestamp?: number;
|
|
4037
|
-
/**
|
|
4038
|
-
* The type of method to specify the `bill_from` time.
|
|
4039
|
-
*/
|
|
4040
|
-
type: BillFrom.Type;
|
|
4041
|
-
}
|
|
4042
|
-
interface BillUntil {
|
|
4043
|
-
/**
|
|
4044
|
-
* Details of the duration over which to bill.
|
|
4045
|
-
*/
|
|
4046
|
-
duration?: BillUntil.Duration;
|
|
4047
|
-
/**
|
|
4048
|
-
* Details of a Quote line item from which to bill until.
|
|
4049
|
-
*/
|
|
4050
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
4051
|
-
/**
|
|
4052
|
-
* A precise Unix timestamp.
|
|
4053
|
-
*/
|
|
4054
|
-
timestamp?: number;
|
|
4055
|
-
/**
|
|
4056
|
-
* The type of method to specify the `bill_until` time.
|
|
4057
|
-
*/
|
|
4058
|
-
type: BillUntil.Type;
|
|
4059
|
-
}
|
|
4060
|
-
namespace BillFrom {
|
|
4061
|
-
interface LineStartsAt {
|
|
4062
|
-
/**
|
|
4063
|
-
* The ID of a quote line.
|
|
4064
|
-
*/
|
|
4065
|
-
id?: string;
|
|
4066
|
-
/**
|
|
4067
|
-
* 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.
|
|
4068
|
-
*/
|
|
4069
|
-
index?: number;
|
|
4070
|
-
}
|
|
4071
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4072
|
-
}
|
|
4073
|
-
namespace BillUntil {
|
|
4074
|
-
interface Duration {
|
|
4075
|
-
/**
|
|
4076
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4077
|
-
*/
|
|
4078
|
-
interval: Duration.Interval;
|
|
4079
|
-
/**
|
|
4080
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4081
|
-
*/
|
|
4082
|
-
interval_count: number;
|
|
4083
|
-
}
|
|
4084
|
-
interface LineEndsAt {
|
|
4085
|
-
/**
|
|
4086
|
-
* The ID of a quote line.
|
|
4087
|
-
*/
|
|
4088
|
-
id?: string;
|
|
4089
|
-
/**
|
|
4090
|
-
* 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.
|
|
4091
|
-
*/
|
|
4092
|
-
index?: number;
|
|
4093
|
-
}
|
|
4094
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
4095
|
-
namespace Duration {
|
|
4096
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4097
|
-
}
|
|
4098
|
-
}
|
|
4099
|
-
}
|
|
4100
|
-
namespace BillOnAcceptance {
|
|
4101
|
-
interface BillFrom {
|
|
4102
|
-
/**
|
|
4103
|
-
* Details of a Quote line to start the bill period from.
|
|
4104
|
-
*/
|
|
4105
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
4106
|
-
/**
|
|
4107
|
-
* A precise Unix timestamp.
|
|
4108
|
-
*/
|
|
4109
|
-
timestamp?: number;
|
|
4110
|
-
/**
|
|
4111
|
-
* The type of method to specify the `bill_from` time.
|
|
4112
|
-
*/
|
|
4113
|
-
type: BillFrom.Type;
|
|
4114
|
-
}
|
|
4115
|
-
interface BillUntil {
|
|
4116
|
-
/**
|
|
4117
|
-
* Details of the duration over which to bill.
|
|
4118
|
-
*/
|
|
4119
|
-
duration?: BillUntil.Duration;
|
|
4120
|
-
/**
|
|
4121
|
-
* Details of a Quote line item from which to bill until.
|
|
4122
|
-
*/
|
|
4123
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
4124
|
-
/**
|
|
4125
|
-
* A precise Unix timestamp.
|
|
4126
|
-
*/
|
|
4127
|
-
timestamp?: number;
|
|
4128
|
-
/**
|
|
4129
|
-
* The type of method to specify the `bill_until` time.
|
|
4130
|
-
*/
|
|
4131
|
-
type: BillUntil.Type;
|
|
4132
|
-
}
|
|
4133
|
-
namespace BillFrom {
|
|
4134
|
-
interface LineStartsAt {
|
|
4135
|
-
/**
|
|
4136
|
-
* The ID of a quote line.
|
|
4137
|
-
*/
|
|
4138
|
-
id?: string;
|
|
4139
|
-
/**
|
|
4140
|
-
* 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.
|
|
4141
|
-
*/
|
|
4142
|
-
index?: number;
|
|
4143
|
-
}
|
|
4144
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4145
|
-
}
|
|
4146
|
-
namespace BillUntil {
|
|
4147
|
-
interface Duration {
|
|
4148
|
-
/**
|
|
4149
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4150
|
-
*/
|
|
4151
|
-
interval: Duration.Interval;
|
|
4152
|
-
/**
|
|
4153
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4154
|
-
*/
|
|
4155
|
-
interval_count: number;
|
|
4156
|
-
}
|
|
4157
|
-
interface LineEndsAt {
|
|
4158
|
-
/**
|
|
4159
|
-
* The ID of a quote line.
|
|
4160
|
-
*/
|
|
4161
|
-
id?: string;
|
|
4162
|
-
/**
|
|
4163
|
-
* 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.
|
|
4164
|
-
*/
|
|
4165
|
-
index?: number;
|
|
4166
|
-
}
|
|
4167
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
4168
|
-
namespace Duration {
|
|
4169
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4170
|
-
}
|
|
4171
|
-
}
|
|
4172
|
-
}
|
|
4173
|
-
}
|
|
4174
|
-
namespace SubscriptionDataOverride {
|
|
4175
|
-
interface AppliesTo {
|
|
4176
|
-
/**
|
|
4177
|
-
* 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.
|
|
4178
|
-
*/
|
|
4179
|
-
new_reference?: string;
|
|
4180
|
-
/**
|
|
4181
|
-
* The ID of the schedule the line applies to.
|
|
4182
|
-
*/
|
|
4183
|
-
subscription_schedule?: string;
|
|
4184
|
-
/**
|
|
4185
|
-
* Describes whether the quote line is affecting a new schedule or an existing schedule.
|
|
4186
|
-
*/
|
|
4187
|
-
type: AppliesTo.Type;
|
|
4188
|
-
}
|
|
4189
|
-
interface BillOnAcceptance {
|
|
4190
|
-
/**
|
|
4191
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
4192
|
-
*/
|
|
4193
|
-
bill_from?: BillOnAcceptance.BillFrom;
|
|
4194
|
-
/**
|
|
4195
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
4196
|
-
*/
|
|
4197
|
-
bill_until?: BillOnAcceptance.BillUntil;
|
|
4198
|
-
}
|
|
4199
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
4200
|
-
interface BillingSchedule {
|
|
4201
|
-
/**
|
|
4202
|
-
* Configure billing schedule differently for individual subscription items.
|
|
4203
|
-
*/
|
|
4204
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
4205
|
-
/**
|
|
4206
|
-
* The start of the period to bill from when the Quote is accepted.
|
|
4207
|
-
*/
|
|
4208
|
-
bill_from?: BillingSchedule.BillFrom;
|
|
4209
|
-
/**
|
|
4210
|
-
* The end of the period to bill until when the Quote is accepted.
|
|
4211
|
-
*/
|
|
4212
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
4213
|
-
/**
|
|
4214
|
-
* 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.
|
|
4215
|
-
*/
|
|
4216
|
-
key?: string;
|
|
4217
|
-
}
|
|
4218
|
-
type EndBehavior = 'cancel' | 'release';
|
|
4219
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
4220
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4221
|
-
namespace AppliesTo {
|
|
4222
|
-
type Type = 'new_reference' | 'subscription_schedule';
|
|
4223
|
-
}
|
|
4224
|
-
namespace BillingSchedule {
|
|
4225
|
-
interface AppliesTo {
|
|
4226
|
-
/**
|
|
4227
|
-
* The ID of the price object.
|
|
4228
|
-
*/
|
|
4229
|
-
price?: string;
|
|
4230
|
-
/**
|
|
4231
|
-
* Controls which subscription items the billing schedule applies to.
|
|
4232
|
-
*/
|
|
4233
|
-
type: 'price';
|
|
4234
|
-
}
|
|
4235
|
-
interface BillFrom {
|
|
4236
|
-
/**
|
|
4237
|
-
* Details of a Quote line to start the bill period from.
|
|
4238
|
-
*/
|
|
4239
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
4240
|
-
/**
|
|
4241
|
-
* A precise Unix timestamp.
|
|
4242
|
-
*/
|
|
4243
|
-
timestamp?: number;
|
|
4244
|
-
/**
|
|
4245
|
-
* The type of method to specify the `bill_from` time.
|
|
4246
|
-
*/
|
|
4247
|
-
type: BillFrom.Type;
|
|
4248
|
-
}
|
|
4249
|
-
interface BillUntil {
|
|
4250
|
-
/**
|
|
4251
|
-
* Details of the duration over which to bill.
|
|
4252
|
-
*/
|
|
4253
|
-
duration?: BillUntil.Duration;
|
|
4254
|
-
/**
|
|
4255
|
-
* Details of a Quote line item from which to bill until.
|
|
4256
|
-
*/
|
|
4257
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
4258
|
-
/**
|
|
4259
|
-
* A precise Unix timestamp.
|
|
4260
|
-
*/
|
|
4261
|
-
timestamp?: number;
|
|
4262
|
-
/**
|
|
4263
|
-
* The type of method to specify the `bill_until` time.
|
|
4264
|
-
*/
|
|
4265
|
-
type: BillUntil.Type;
|
|
4266
|
-
}
|
|
4267
|
-
namespace BillFrom {
|
|
4268
|
-
interface LineStartsAt {
|
|
4269
|
-
/**
|
|
4270
|
-
* The ID of a quote line.
|
|
4271
|
-
*/
|
|
4272
|
-
id?: string;
|
|
4273
|
-
/**
|
|
4274
|
-
* 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.
|
|
4275
|
-
*/
|
|
4276
|
-
index?: number;
|
|
4277
|
-
}
|
|
4278
|
-
type Type = 'line_starts_at' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4279
|
-
}
|
|
4280
|
-
namespace BillUntil {
|
|
4281
|
-
interface Duration {
|
|
4282
|
-
/**
|
|
4283
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4284
|
-
*/
|
|
4285
|
-
interval: Duration.Interval;
|
|
4286
|
-
/**
|
|
4287
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4288
|
-
*/
|
|
4289
|
-
interval_count: number;
|
|
4290
|
-
}
|
|
4291
|
-
interface LineEndsAt {
|
|
4292
|
-
/**
|
|
4293
|
-
* The ID of a quote line.
|
|
4294
|
-
*/
|
|
4295
|
-
id?: string;
|
|
4296
|
-
/**
|
|
4297
|
-
* 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.
|
|
4298
|
-
*/
|
|
4299
|
-
index?: number;
|
|
4300
|
-
}
|
|
4301
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
4302
|
-
namespace Duration {
|
|
4303
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4304
|
-
}
|
|
4305
|
-
}
|
|
4306
|
-
}
|
|
4307
|
-
namespace BillOnAcceptance {
|
|
4308
|
-
interface BillFrom {
|
|
4309
|
-
/**
|
|
4310
|
-
* Details of a Quote line to start the bill period from.
|
|
4311
|
-
*/
|
|
4312
|
-
line_starts_at?: BillFrom.LineStartsAt;
|
|
4313
|
-
/**
|
|
4314
|
-
* A precise Unix timestamp.
|
|
4315
|
-
*/
|
|
4316
|
-
timestamp?: number;
|
|
4317
|
-
/**
|
|
4318
|
-
* The type of method to specify the `bill_from` time.
|
|
4319
|
-
*/
|
|
4320
|
-
type: BillFrom.Type;
|
|
4321
|
-
}
|
|
4322
|
-
interface BillUntil {
|
|
4323
|
-
/**
|
|
4324
|
-
* Details of the duration over which to bill.
|
|
4325
|
-
*/
|
|
4326
|
-
duration?: BillUntil.Duration;
|
|
4327
|
-
/**
|
|
4328
|
-
* Details of a Quote line item from which to bill until.
|
|
4329
|
-
*/
|
|
4330
|
-
line_ends_at?: BillUntil.LineEndsAt;
|
|
4331
|
-
/**
|
|
4332
|
-
* A precise Unix timestamp.
|
|
4333
|
-
*/
|
|
4334
|
-
timestamp?: number;
|
|
4335
|
-
/**
|
|
4336
|
-
* The type of method to specify the `bill_until` time.
|
|
4337
|
-
*/
|
|
4338
|
-
type: BillUntil.Type;
|
|
4339
|
-
}
|
|
4340
|
-
namespace BillFrom {
|
|
4341
|
-
interface LineStartsAt {
|
|
4342
|
-
/**
|
|
4343
|
-
* The ID of a quote line.
|
|
4344
|
-
*/
|
|
4345
|
-
id?: string;
|
|
4346
|
-
/**
|
|
4347
|
-
* 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.
|
|
4348
|
-
*/
|
|
4349
|
-
index?: number;
|
|
4350
|
-
}
|
|
4351
|
-
type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
|
|
4352
|
-
}
|
|
4353
|
-
namespace BillUntil {
|
|
4354
|
-
interface Duration {
|
|
4355
|
-
/**
|
|
4356
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4357
|
-
*/
|
|
4358
|
-
interval: Duration.Interval;
|
|
4359
|
-
/**
|
|
4360
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4361
|
-
*/
|
|
4362
|
-
interval_count: number;
|
|
4363
|
-
}
|
|
4364
|
-
interface LineEndsAt {
|
|
4365
|
-
/**
|
|
4366
|
-
* The ID of a quote line.
|
|
4367
|
-
*/
|
|
4368
|
-
id?: string;
|
|
4369
|
-
/**
|
|
4370
|
-
* 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.
|
|
4371
|
-
*/
|
|
4372
|
-
index?: number;
|
|
4373
|
-
}
|
|
4374
|
-
type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
|
|
4375
|
-
namespace Duration {
|
|
4376
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4377
|
-
}
|
|
4378
|
-
}
|
|
4379
|
-
}
|
|
4380
|
-
}
|
|
4381
1137
|
}
|
|
4382
1138
|
export interface QuoteListParams extends PaginationParams {
|
|
4383
1139
|
/**
|
|
@@ -4392,10 +1148,6 @@ export interface QuoteListParams extends PaginationParams {
|
|
|
4392
1148
|
* Specifies which fields in the response should be expanded.
|
|
4393
1149
|
*/
|
|
4394
1150
|
expand?: Array<string>;
|
|
4395
|
-
/**
|
|
4396
|
-
* The subscription which the quote updates.
|
|
4397
|
-
*/
|
|
4398
|
-
from_subscription?: string;
|
|
4399
1151
|
/**
|
|
4400
1152
|
* The status of the quote.
|
|
4401
1153
|
*/
|
|
@@ -4406,7 +1158,7 @@ export interface QuoteListParams extends PaginationParams {
|
|
|
4406
1158
|
test_clock?: string;
|
|
4407
1159
|
}
|
|
4408
1160
|
export declare namespace QuoteListParams {
|
|
4409
|
-
type Status = 'accepted' | '
|
|
1161
|
+
type Status = 'accepted' | 'canceled' | 'draft' | 'open';
|
|
4410
1162
|
}
|
|
4411
1163
|
export interface QuoteAcceptParams {
|
|
4412
1164
|
/**
|
|
@@ -4430,12 +1182,6 @@ export interface QuoteFinalizeQuoteParams {
|
|
|
4430
1182
|
*/
|
|
4431
1183
|
expires_at?: number;
|
|
4432
1184
|
}
|
|
4433
|
-
export interface QuoteListPreviewInvoiceLinesParams extends PaginationParams {
|
|
4434
|
-
/**
|
|
4435
|
-
* Specifies which fields in the response should be expanded.
|
|
4436
|
-
*/
|
|
4437
|
-
expand?: Array<string>;
|
|
4438
|
-
}
|
|
4439
1185
|
export interface QuoteListComputedUpfrontLineItemsParams extends PaginationParams {
|
|
4440
1186
|
/**
|
|
4441
1187
|
* Specifies which fields in the response should be expanded.
|
|
@@ -4448,49 +1194,9 @@ export interface QuoteListLineItemsParams extends PaginationParams {
|
|
|
4448
1194
|
*/
|
|
4449
1195
|
expand?: Array<string>;
|
|
4450
1196
|
}
|
|
4451
|
-
export interface QuoteListLinesParams extends PaginationParams {
|
|
4452
|
-
/**
|
|
4453
|
-
* Specifies which fields in the response should be expanded.
|
|
4454
|
-
*/
|
|
4455
|
-
expand?: Array<string>;
|
|
4456
|
-
}
|
|
4457
|
-
export interface QuoteListPreviewInvoicesParams extends PaginationParams {
|
|
4458
|
-
/**
|
|
4459
|
-
* Specifies which fields in the response should be expanded.
|
|
4460
|
-
*/
|
|
4461
|
-
expand?: Array<string>;
|
|
4462
|
-
}
|
|
4463
|
-
export interface QuoteListPreviewSubscriptionSchedulesParams extends PaginationParams {
|
|
4464
|
-
/**
|
|
4465
|
-
* Specifies which fields in the response should be expanded.
|
|
4466
|
-
*/
|
|
4467
|
-
expand?: Array<string>;
|
|
4468
|
-
}
|
|
4469
|
-
export interface QuoteMarkDraftParams {
|
|
4470
|
-
/**
|
|
4471
|
-
* Specifies which fields in the response should be expanded.
|
|
4472
|
-
*/
|
|
4473
|
-
expand?: Array<string>;
|
|
4474
|
-
}
|
|
4475
|
-
export interface QuoteMarkStaleParams {
|
|
4476
|
-
/**
|
|
4477
|
-
* Specifies which fields in the response should be expanded.
|
|
4478
|
-
*/
|
|
4479
|
-
expand?: Array<string>;
|
|
4480
|
-
/**
|
|
4481
|
-
* Reason the Quote is being marked stale.
|
|
4482
|
-
*/
|
|
4483
|
-
reason?: string;
|
|
4484
|
-
}
|
|
4485
1197
|
export interface QuotePdfParams {
|
|
4486
1198
|
/**
|
|
4487
1199
|
* Specifies which fields in the response should be expanded.
|
|
4488
1200
|
*/
|
|
4489
1201
|
expand?: Array<string>;
|
|
4490
1202
|
}
|
|
4491
|
-
export interface QuoteReestimateParams {
|
|
4492
|
-
/**
|
|
4493
|
-
* Specifies which fields in the response should be expanded.
|
|
4494
|
-
*/
|
|
4495
|
-
expand?: Array<string>;
|
|
4496
|
-
}
|