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,13 +1,13 @@
|
|
|
1
1
|
import { StripeResource } from '../StripeResource.js';
|
|
2
|
+
import { Discount as _Discount } from './Discounts.js';
|
|
2
3
|
import { Application, DeletedApplication } from './Applications.js';
|
|
3
4
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
4
|
-
import { Invoice } from './Invoices.js';
|
|
5
5
|
import { Subscription } from './Subscriptions.js';
|
|
6
|
-
import { Price, DeletedPrice } from './Prices.js';
|
|
7
6
|
import { PaymentMethod } from './PaymentMethods.js';
|
|
8
7
|
import { Account } from './Accounts.js';
|
|
9
8
|
import { TaxId, DeletedTaxId } from './TaxIds.js';
|
|
10
9
|
import { TaxRate } from './TaxRates.js';
|
|
10
|
+
import { Price, DeletedPrice } from './Prices.js';
|
|
11
11
|
import { Coupon } from './Coupons.js';
|
|
12
12
|
import { PromotionCode } from './PromotionCodes.js';
|
|
13
13
|
import { Plan, DeletedPlan } from './Plans.js';
|
|
@@ -31,10 +31,6 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
31
31
|
* Updates an existing subscription schedule.
|
|
32
32
|
*/
|
|
33
33
|
update(id: string, params?: SubscriptionScheduleUpdateParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
34
|
-
/**
|
|
35
|
-
* Amends an existing subscription schedule.
|
|
36
|
-
*/
|
|
37
|
-
amend(id: string, params?: SubscriptionScheduleAmendParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
38
34
|
/**
|
|
39
35
|
* Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
|
|
40
36
|
*/
|
|
@@ -43,22 +39,6 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
43
39
|
* Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
|
|
44
40
|
*/
|
|
45
41
|
release(id: string, params?: SubscriptionScheduleReleaseParams, options?: RequestOptions): Promise<Response<SubscriptionSchedule>>;
|
|
46
|
-
serializeBatchCreate(params?: Record<string, unknown>, options?: {
|
|
47
|
-
apiVersion?: string;
|
|
48
|
-
stripeContext?: string;
|
|
49
|
-
}): string;
|
|
50
|
-
serializeBatchUpdate(schedule: string, params?: Record<string, unknown>, options?: {
|
|
51
|
-
apiVersion?: string;
|
|
52
|
-
stripeContext?: string;
|
|
53
|
-
}): string;
|
|
54
|
-
serializeBatchCancel(schedule: string, params?: Record<string, unknown>, options?: {
|
|
55
|
-
apiVersion?: string;
|
|
56
|
-
stripeContext?: string;
|
|
57
|
-
}): string;
|
|
58
|
-
serializeBatchRelease(schedule: string, params?: Record<string, unknown>, options?: {
|
|
59
|
-
apiVersion?: string;
|
|
60
|
-
stripeContext?: string;
|
|
61
|
-
}): string;
|
|
62
42
|
}
|
|
63
43
|
export interface SubscriptionSchedule {
|
|
64
44
|
/**
|
|
@@ -73,18 +53,10 @@ export interface SubscriptionSchedule {
|
|
|
73
53
|
* ID of the Connect Application that created the schedule.
|
|
74
54
|
*/
|
|
75
55
|
application: string | Application | DeletedApplication | null;
|
|
76
|
-
/**
|
|
77
|
-
* 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.
|
|
78
|
-
*/
|
|
79
|
-
billing_behavior?: SubscriptionSchedule.BillingBehavior;
|
|
80
56
|
/**
|
|
81
57
|
* The billing mode of the subscription.
|
|
82
58
|
*/
|
|
83
59
|
billing_mode: SubscriptionSchedule.BillingMode;
|
|
84
|
-
/**
|
|
85
|
-
* Billing schedules for this subscription schedule.
|
|
86
|
-
*/
|
|
87
|
-
billing_schedules?: Array<SubscriptionSchedule.BillingSchedule>;
|
|
88
60
|
/**
|
|
89
61
|
* Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
90
62
|
*/
|
|
@@ -114,14 +86,6 @@ export interface SubscriptionSchedule {
|
|
|
114
86
|
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
|
115
87
|
*/
|
|
116
88
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
117
|
-
/**
|
|
118
|
-
* Details of the most recent price migration that failed for the subscription schedule.
|
|
119
|
-
*/
|
|
120
|
-
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
121
|
-
/**
|
|
122
|
-
* The most recent invoice this subscription schedule has generated.
|
|
123
|
-
*/
|
|
124
|
-
latest_invoice?: string | Invoice | null;
|
|
125
89
|
/**
|
|
126
90
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
127
91
|
*/
|
|
@@ -134,10 +98,6 @@ export interface SubscriptionSchedule {
|
|
|
134
98
|
* Configuration for the subscription schedule's phases.
|
|
135
99
|
*/
|
|
136
100
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
137
|
-
/**
|
|
138
|
-
* Time period and invoice for a Subscription billed in advance.
|
|
139
|
-
*/
|
|
140
|
-
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
141
101
|
/**
|
|
142
102
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
143
103
|
*/
|
|
@@ -160,7 +120,6 @@ export interface SubscriptionSchedule {
|
|
|
160
120
|
test_clock: string | TestHelpers.TestClock | null;
|
|
161
121
|
}
|
|
162
122
|
export declare namespace SubscriptionSchedule {
|
|
163
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
164
123
|
interface BillingMode {
|
|
165
124
|
/**
|
|
166
125
|
* Configure behavior for flexible billing mode
|
|
@@ -175,20 +134,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
175
134
|
*/
|
|
176
135
|
updated_at?: number;
|
|
177
136
|
}
|
|
178
|
-
interface BillingSchedule {
|
|
179
|
-
/**
|
|
180
|
-
* Specifies which subscription items the billing schedule applies to.
|
|
181
|
-
*/
|
|
182
|
-
applies_to: Array<BillingSchedule.AppliesTo> | null;
|
|
183
|
-
/**
|
|
184
|
-
* Specifies the end of billing period.
|
|
185
|
-
*/
|
|
186
|
-
bill_until: BillingSchedule.BillUntil;
|
|
187
|
-
/**
|
|
188
|
-
* Unique identifier for the billing schedule.
|
|
189
|
-
*/
|
|
190
|
-
key: string;
|
|
191
|
-
}
|
|
192
137
|
interface CurrentPhase {
|
|
193
138
|
/**
|
|
194
139
|
* The end of this phase of the subscription schedule.
|
|
@@ -230,30 +175,12 @@ export declare namespace SubscriptionSchedule {
|
|
|
230
175
|
* The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
231
176
|
*/
|
|
232
177
|
on_behalf_of: string | Account | null;
|
|
233
|
-
/**
|
|
234
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
235
|
-
*/
|
|
236
|
-
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
237
178
|
/**
|
|
238
179
|
* The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
239
180
|
*/
|
|
240
181
|
transfer_data: DefaultSettings.TransferData | null;
|
|
241
182
|
}
|
|
242
183
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
243
|
-
interface LastPriceMigrationError {
|
|
244
|
-
/**
|
|
245
|
-
* The time at which the price migration encountered an error.
|
|
246
|
-
*/
|
|
247
|
-
errored_at: number;
|
|
248
|
-
/**
|
|
249
|
-
* The involved price pairs in each failed transition.
|
|
250
|
-
*/
|
|
251
|
-
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
252
|
-
/**
|
|
253
|
-
* The type of error encountered by the price migration.
|
|
254
|
-
*/
|
|
255
|
-
type: 'price_uniqueness_violation';
|
|
256
|
-
}
|
|
257
184
|
interface Phase {
|
|
258
185
|
/**
|
|
259
186
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -296,10 +223,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
296
223
|
* The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
|
297
224
|
*/
|
|
298
225
|
discounts: Array<Phase.Discount>;
|
|
299
|
-
/**
|
|
300
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
301
|
-
*/
|
|
302
|
-
effective_at?: Phase.EffectiveAt | null;
|
|
303
226
|
/**
|
|
304
227
|
* The end of this phase of the subscription schedule.
|
|
305
228
|
*/
|
|
@@ -320,10 +243,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
320
243
|
* The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
321
244
|
*/
|
|
322
245
|
on_behalf_of: string | Account | null;
|
|
323
|
-
/**
|
|
324
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
325
|
-
*/
|
|
326
|
-
pause_collection?: Phase.PauseCollection | null;
|
|
327
246
|
/**
|
|
328
247
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
329
248
|
*/
|
|
@@ -336,36 +255,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
336
255
|
* The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
337
256
|
*/
|
|
338
257
|
transfer_data: Phase.TransferData | null;
|
|
339
|
-
/**
|
|
340
|
-
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
341
|
-
*/
|
|
342
|
-
trial_continuation?: Phase.TrialContinuation | null;
|
|
343
258
|
/**
|
|
344
259
|
* When the trial ends within the phase.
|
|
345
260
|
*/
|
|
346
261
|
trial_end: number | null;
|
|
347
|
-
/**
|
|
348
|
-
* Settings related to any trials on the subscription during this phase.
|
|
349
|
-
*/
|
|
350
|
-
trial_settings?: Phase.TrialSettings | null;
|
|
351
|
-
}
|
|
352
|
-
interface Prebilling {
|
|
353
|
-
/**
|
|
354
|
-
* ID of the prebilling invoice.
|
|
355
|
-
*/
|
|
356
|
-
invoice: string | Invoice;
|
|
357
|
-
/**
|
|
358
|
-
* The end of the last period for which the invoice pre-bills.
|
|
359
|
-
*/
|
|
360
|
-
period_end: number;
|
|
361
|
-
/**
|
|
362
|
-
* The start of the first period for which the invoice pre-bills.
|
|
363
|
-
*/
|
|
364
|
-
period_start: number;
|
|
365
|
-
/**
|
|
366
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
367
|
-
*/
|
|
368
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
369
262
|
}
|
|
370
263
|
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released';
|
|
371
264
|
namespace BillingMode {
|
|
@@ -380,52 +273,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
380
273
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
381
274
|
}
|
|
382
275
|
}
|
|
383
|
-
namespace BillingSchedule {
|
|
384
|
-
interface AppliesTo {
|
|
385
|
-
/**
|
|
386
|
-
* The billing schedule will apply to the subscription item with the given price ID.
|
|
387
|
-
*/
|
|
388
|
-
price: string | Price | null;
|
|
389
|
-
/**
|
|
390
|
-
* Controls which subscription items the billing schedule applies to.
|
|
391
|
-
*/
|
|
392
|
-
type: 'price';
|
|
393
|
-
}
|
|
394
|
-
interface BillUntil {
|
|
395
|
-
/**
|
|
396
|
-
* The timestamp the billing schedule will apply until.
|
|
397
|
-
*/
|
|
398
|
-
computed_timestamp: number;
|
|
399
|
-
/**
|
|
400
|
-
* Specifies the billing period.
|
|
401
|
-
*/
|
|
402
|
-
duration: BillUntil.Duration | null;
|
|
403
|
-
/**
|
|
404
|
-
* If specified, the billing schedule will apply until the specified timestamp.
|
|
405
|
-
*/
|
|
406
|
-
timestamp: number | null;
|
|
407
|
-
/**
|
|
408
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
409
|
-
*/
|
|
410
|
-
type: BillUntil.Type;
|
|
411
|
-
}
|
|
412
|
-
namespace BillUntil {
|
|
413
|
-
interface Duration {
|
|
414
|
-
/**
|
|
415
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
416
|
-
*/
|
|
417
|
-
interval: Duration.Interval;
|
|
418
|
-
/**
|
|
419
|
-
* The multiplier applied to the interval.
|
|
420
|
-
*/
|
|
421
|
-
interval_count: number | null;
|
|
422
|
-
}
|
|
423
|
-
type Type = 'duration' | 'timestamp';
|
|
424
|
-
namespace Duration {
|
|
425
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
426
|
-
}
|
|
427
|
-
}
|
|
428
|
-
}
|
|
429
276
|
namespace DefaultSettings {
|
|
430
277
|
interface AutomaticTax {
|
|
431
278
|
/**
|
|
@@ -464,7 +311,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
464
311
|
days_until_due: number | null;
|
|
465
312
|
issuer: InvoiceSettings.Issuer;
|
|
466
313
|
}
|
|
467
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
468
314
|
interface TransferData {
|
|
469
315
|
/**
|
|
470
316
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -487,7 +333,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
487
333
|
type: Liability.Type;
|
|
488
334
|
}
|
|
489
335
|
namespace Liability {
|
|
490
|
-
type Type = 'account' | '
|
|
336
|
+
type Type = 'account' | 'self';
|
|
491
337
|
}
|
|
492
338
|
}
|
|
493
339
|
namespace InvoiceSettings {
|
|
@@ -502,22 +348,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
502
348
|
type: Issuer.Type;
|
|
503
349
|
}
|
|
504
350
|
namespace Issuer {
|
|
505
|
-
type Type = 'account' | '
|
|
351
|
+
type Type = 'account' | 'self';
|
|
506
352
|
}
|
|
507
353
|
}
|
|
508
354
|
}
|
|
509
|
-
namespace LastPriceMigrationError {
|
|
510
|
-
interface FailedTransition {
|
|
511
|
-
/**
|
|
512
|
-
* The original price to be migrated.
|
|
513
|
-
*/
|
|
514
|
-
source_price: string;
|
|
515
|
-
/**
|
|
516
|
-
* The intended resulting price of the migration.
|
|
517
|
-
*/
|
|
518
|
-
target_price: string;
|
|
519
|
-
}
|
|
520
|
-
}
|
|
521
355
|
namespace Phase {
|
|
522
356
|
interface AddInvoiceItem {
|
|
523
357
|
/**
|
|
@@ -580,18 +414,12 @@ export declare namespace SubscriptionSchedule {
|
|
|
580
414
|
/**
|
|
581
415
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
582
416
|
*/
|
|
583
|
-
discount: string |
|
|
584
|
-
/**
|
|
585
|
-
* Details to determine how long the discount should be applied for.
|
|
586
|
-
*/
|
|
587
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
417
|
+
discount: string | _Discount | null;
|
|
588
418
|
/**
|
|
589
419
|
* ID of the promotion code to create a new discount for.
|
|
590
420
|
*/
|
|
591
421
|
promotion_code: string | PromotionCode | null;
|
|
592
|
-
settings?: Discount.Settings;
|
|
593
422
|
}
|
|
594
|
-
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
595
423
|
interface InvoiceSettings {
|
|
596
424
|
/**
|
|
597
425
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -635,20 +463,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
635
463
|
* The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
|
636
464
|
*/
|
|
637
465
|
tax_rates?: Array<TaxRate> | null;
|
|
638
|
-
/**
|
|
639
|
-
* Options that configure the trial on the subscription item.
|
|
640
|
-
*/
|
|
641
|
-
trial?: Item.Trial | null;
|
|
642
|
-
/**
|
|
643
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
644
|
-
*/
|
|
645
|
-
trial_offer?: string | null;
|
|
646
|
-
}
|
|
647
|
-
interface PauseCollection {
|
|
648
|
-
/**
|
|
649
|
-
* The payment collection behavior for this subscription while paused.
|
|
650
|
-
*/
|
|
651
|
-
behavior: PauseCollection.Behavior;
|
|
652
466
|
}
|
|
653
467
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
654
468
|
interface TransferData {
|
|
@@ -661,13 +475,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
661
475
|
*/
|
|
662
476
|
destination: string | Account;
|
|
663
477
|
}
|
|
664
|
-
type TrialContinuation = 'continue' | 'none';
|
|
665
|
-
interface TrialSettings {
|
|
666
|
-
/**
|
|
667
|
-
* Defines how the subscription should behave when a trial ends.
|
|
668
|
-
*/
|
|
669
|
-
end_behavior: TrialSettings.EndBehavior | null;
|
|
670
|
-
}
|
|
671
478
|
namespace AddInvoiceItem {
|
|
672
479
|
interface Discount {
|
|
673
480
|
/**
|
|
@@ -677,11 +484,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
677
484
|
/**
|
|
678
485
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
679
486
|
*/
|
|
680
|
-
discount: string |
|
|
681
|
-
/**
|
|
682
|
-
* Details to determine how long the discount should be applied for.
|
|
683
|
-
*/
|
|
684
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
487
|
+
discount: string | _Discount | null;
|
|
685
488
|
/**
|
|
686
489
|
* ID of the promotion code to create a new discount for.
|
|
687
490
|
*/
|
|
@@ -691,18 +494,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
691
494
|
end: Period.End;
|
|
692
495
|
start: Period.Start;
|
|
693
496
|
}
|
|
694
|
-
namespace Discount {
|
|
695
|
-
interface DiscountEnd {
|
|
696
|
-
/**
|
|
697
|
-
* The discount end timestamp.
|
|
698
|
-
*/
|
|
699
|
-
timestamp: number | null;
|
|
700
|
-
/**
|
|
701
|
-
* The discount end type.
|
|
702
|
-
*/
|
|
703
|
-
type: 'timestamp';
|
|
704
|
-
}
|
|
705
|
-
}
|
|
706
497
|
namespace Period {
|
|
707
498
|
interface End {
|
|
708
499
|
/**
|
|
@@ -744,61 +535,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
744
535
|
type: Liability.Type;
|
|
745
536
|
}
|
|
746
537
|
namespace Liability {
|
|
747
|
-
type Type = 'account' | '
|
|
748
|
-
}
|
|
749
|
-
}
|
|
750
|
-
namespace Discount {
|
|
751
|
-
interface DiscountEnd {
|
|
752
|
-
/**
|
|
753
|
-
* The discount end timestamp.
|
|
754
|
-
*/
|
|
755
|
-
timestamp: number | null;
|
|
756
|
-
/**
|
|
757
|
-
* The discount end type.
|
|
758
|
-
*/
|
|
759
|
-
type: 'timestamp';
|
|
760
|
-
}
|
|
761
|
-
interface Settings {
|
|
762
|
-
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
763
|
-
/**
|
|
764
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
765
|
-
*/
|
|
766
|
-
start_date: Settings.StartDate;
|
|
767
|
-
}
|
|
768
|
-
namespace Settings {
|
|
769
|
-
interface ServicePeriodAnchorConfig {
|
|
770
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
771
|
-
/**
|
|
772
|
-
* The type of service period anchor config.
|
|
773
|
-
*/
|
|
774
|
-
type: ServicePeriodAnchorConfig.Type;
|
|
775
|
-
}
|
|
776
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
777
|
-
namespace ServicePeriodAnchorConfig {
|
|
778
|
-
interface Custom {
|
|
779
|
-
/**
|
|
780
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
781
|
-
*/
|
|
782
|
-
day_of_month: number;
|
|
783
|
-
/**
|
|
784
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
785
|
-
*/
|
|
786
|
-
hour: number | null;
|
|
787
|
-
/**
|
|
788
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
789
|
-
*/
|
|
790
|
-
minute: number | null;
|
|
791
|
-
/**
|
|
792
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
793
|
-
*/
|
|
794
|
-
month: number | null;
|
|
795
|
-
/**
|
|
796
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
797
|
-
*/
|
|
798
|
-
second: number | null;
|
|
799
|
-
}
|
|
800
|
-
type Type = 'custom' | 'inherit';
|
|
801
|
-
}
|
|
538
|
+
type Type = 'account' | 'self';
|
|
802
539
|
}
|
|
803
540
|
}
|
|
804
541
|
namespace InvoiceSettings {
|
|
@@ -813,7 +550,7 @@ export declare namespace SubscriptionSchedule {
|
|
|
813
550
|
type: Issuer.Type;
|
|
814
551
|
}
|
|
815
552
|
namespace Issuer {
|
|
816
|
-
type Type = 'account' | '
|
|
553
|
+
type Type = 'account' | 'self';
|
|
817
554
|
}
|
|
818
555
|
}
|
|
819
556
|
namespace Item {
|
|
@@ -831,117 +568,20 @@ export declare namespace SubscriptionSchedule {
|
|
|
831
568
|
/**
|
|
832
569
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
833
570
|
*/
|
|
834
|
-
discount: string |
|
|
835
|
-
/**
|
|
836
|
-
* Details to determine how long the discount should be applied for.
|
|
837
|
-
*/
|
|
838
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
571
|
+
discount: string | _Discount | null;
|
|
839
572
|
/**
|
|
840
573
|
* ID of the promotion code to create a new discount for.
|
|
841
574
|
*/
|
|
842
575
|
promotion_code: string | PromotionCode | null;
|
|
843
|
-
settings?: Discount.Settings;
|
|
844
|
-
}
|
|
845
|
-
interface Trial {
|
|
846
|
-
/**
|
|
847
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
848
|
-
*/
|
|
849
|
-
converts_to?: Array<string> | null;
|
|
850
|
-
/**
|
|
851
|
-
* Determines the type of trial for this item.
|
|
852
|
-
*/
|
|
853
|
-
type: Trial.Type;
|
|
854
|
-
}
|
|
855
|
-
namespace Discount {
|
|
856
|
-
interface DiscountEnd {
|
|
857
|
-
/**
|
|
858
|
-
* The discount end timestamp.
|
|
859
|
-
*/
|
|
860
|
-
timestamp: number | null;
|
|
861
|
-
/**
|
|
862
|
-
* The discount end type.
|
|
863
|
-
*/
|
|
864
|
-
type: 'timestamp';
|
|
865
|
-
}
|
|
866
|
-
interface Settings {
|
|
867
|
-
service_period_anchor_config: Settings.ServicePeriodAnchorConfig;
|
|
868
|
-
/**
|
|
869
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration.
|
|
870
|
-
*/
|
|
871
|
-
start_date: Settings.StartDate;
|
|
872
|
-
}
|
|
873
|
-
namespace Settings {
|
|
874
|
-
interface ServicePeriodAnchorConfig {
|
|
875
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
876
|
-
/**
|
|
877
|
-
* The type of service period anchor config.
|
|
878
|
-
*/
|
|
879
|
-
type: ServicePeriodAnchorConfig.Type;
|
|
880
|
-
}
|
|
881
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
882
|
-
namespace ServicePeriodAnchorConfig {
|
|
883
|
-
interface Custom {
|
|
884
|
-
/**
|
|
885
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
886
|
-
*/
|
|
887
|
-
day_of_month: number;
|
|
888
|
-
/**
|
|
889
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
890
|
-
*/
|
|
891
|
-
hour: number | null;
|
|
892
|
-
/**
|
|
893
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
894
|
-
*/
|
|
895
|
-
minute: number | null;
|
|
896
|
-
/**
|
|
897
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
898
|
-
*/
|
|
899
|
-
month: number | null;
|
|
900
|
-
/**
|
|
901
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
902
|
-
*/
|
|
903
|
-
second: number | null;
|
|
904
|
-
}
|
|
905
|
-
type Type = 'custom' | 'inherit';
|
|
906
|
-
}
|
|
907
|
-
}
|
|
908
|
-
}
|
|
909
|
-
namespace Trial {
|
|
910
|
-
type Type = 'free' | 'paid';
|
|
911
|
-
}
|
|
912
|
-
}
|
|
913
|
-
namespace PauseCollection {
|
|
914
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
915
|
-
}
|
|
916
|
-
namespace TrialSettings {
|
|
917
|
-
interface EndBehavior {
|
|
918
|
-
/**
|
|
919
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
920
|
-
*/
|
|
921
|
-
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
922
|
-
}
|
|
923
|
-
namespace EndBehavior {
|
|
924
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
925
576
|
}
|
|
926
577
|
}
|
|
927
578
|
}
|
|
928
|
-
namespace Prebilling {
|
|
929
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
930
|
-
}
|
|
931
579
|
}
|
|
932
580
|
export interface SubscriptionScheduleCreateParams {
|
|
933
|
-
/**
|
|
934
|
-
* 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.
|
|
935
|
-
*/
|
|
936
|
-
billing_behavior?: SubscriptionScheduleCreateParams.BillingBehavior;
|
|
937
581
|
/**
|
|
938
582
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
939
583
|
*/
|
|
940
584
|
billing_mode?: SubscriptionScheduleCreateParams.BillingMode;
|
|
941
|
-
/**
|
|
942
|
-
* Sets the billing schedules for the subscription schedule.
|
|
943
|
-
*/
|
|
944
|
-
billing_schedules?: Array<SubscriptionScheduleCreateParams.BillingSchedule>;
|
|
945
585
|
/**
|
|
946
586
|
* The identifier of the customer to create the subscription schedule for.
|
|
947
587
|
*/
|
|
@@ -974,17 +614,12 @@ export interface SubscriptionScheduleCreateParams {
|
|
|
974
614
|
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
|
|
975
615
|
*/
|
|
976
616
|
phases?: Array<SubscriptionScheduleCreateParams.Phase>;
|
|
977
|
-
/**
|
|
978
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
979
|
-
*/
|
|
980
|
-
prebilling?: SubscriptionScheduleCreateParams.Prebilling;
|
|
981
617
|
/**
|
|
982
618
|
* When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
|
|
983
619
|
*/
|
|
984
620
|
start_date?: number | 'now';
|
|
985
621
|
}
|
|
986
622
|
export declare namespace SubscriptionScheduleCreateParams {
|
|
987
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
988
623
|
interface BillingMode {
|
|
989
624
|
/**
|
|
990
625
|
* Configure behavior for flexible billing mode.
|
|
@@ -995,20 +630,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
995
630
|
*/
|
|
996
631
|
type: BillingMode.Type;
|
|
997
632
|
}
|
|
998
|
-
interface BillingSchedule {
|
|
999
|
-
/**
|
|
1000
|
-
* Configure billing schedule differently for individual subscription items.
|
|
1001
|
-
*/
|
|
1002
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1003
|
-
/**
|
|
1004
|
-
* The end date for the billing schedule.
|
|
1005
|
-
*/
|
|
1006
|
-
bill_until: BillingSchedule.BillUntil;
|
|
1007
|
-
/**
|
|
1008
|
-
* 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.
|
|
1009
|
-
*/
|
|
1010
|
-
key?: string;
|
|
1011
|
-
}
|
|
1012
633
|
interface DefaultSettings {
|
|
1013
634
|
/**
|
|
1014
635
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
|
@@ -1046,10 +667,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1046
667
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1047
668
|
*/
|
|
1048
669
|
on_behalf_of?: Emptyable<string>;
|
|
1049
|
-
/**
|
|
1050
|
-
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1051
|
-
*/
|
|
1052
|
-
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
1053
670
|
/**
|
|
1054
671
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
1055
672
|
*/
|
|
@@ -1105,10 +722,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1105
722
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
1106
723
|
*/
|
|
1107
724
|
duration?: Phase.Duration;
|
|
1108
|
-
/**
|
|
1109
|
-
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1110
|
-
*/
|
|
1111
|
-
effective_at?: Phase.EffectiveAt;
|
|
1112
725
|
/**
|
|
1113
726
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
1114
727
|
*/
|
|
@@ -1129,10 +742,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1129
742
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1130
743
|
*/
|
|
1131
744
|
on_behalf_of?: string;
|
|
1132
|
-
/**
|
|
1133
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
1134
|
-
*/
|
|
1135
|
-
pause_collection?: Phase.PauseCollection;
|
|
1136
745
|
/**
|
|
1137
746
|
* Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
1138
747
|
*/
|
|
@@ -1145,28 +754,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1145
754
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1146
755
|
*/
|
|
1147
756
|
trial?: boolean;
|
|
1148
|
-
/**
|
|
1149
|
-
* Specify trial behavior when crossing phase boundaries
|
|
1150
|
-
*/
|
|
1151
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
1152
757
|
/**
|
|
1153
758
|
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
|
1154
759
|
*/
|
|
1155
760
|
trial_end?: number;
|
|
1156
|
-
/**
|
|
1157
|
-
* Settings related to subscription trials.
|
|
1158
|
-
*/
|
|
1159
|
-
trial_settings?: Phase.TrialSettings;
|
|
1160
|
-
}
|
|
1161
|
-
interface Prebilling {
|
|
1162
|
-
/**
|
|
1163
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
1164
|
-
*/
|
|
1165
|
-
iterations: number;
|
|
1166
|
-
/**
|
|
1167
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1168
|
-
*/
|
|
1169
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
1170
761
|
}
|
|
1171
762
|
namespace BillingMode {
|
|
1172
763
|
interface Flexible {
|
|
@@ -1180,48 +771,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1180
771
|
type ProrationDiscounts = 'included' | 'itemized';
|
|
1181
772
|
}
|
|
1182
773
|
}
|
|
1183
|
-
namespace BillingSchedule {
|
|
1184
|
-
interface AppliesTo {
|
|
1185
|
-
/**
|
|
1186
|
-
* The ID of the price object.
|
|
1187
|
-
*/
|
|
1188
|
-
price?: string;
|
|
1189
|
-
/**
|
|
1190
|
-
* Controls which subscription items the billing schedule applies to.
|
|
1191
|
-
*/
|
|
1192
|
-
type: 'price';
|
|
1193
|
-
}
|
|
1194
|
-
interface BillUntil {
|
|
1195
|
-
/**
|
|
1196
|
-
* Specifies the billing period.
|
|
1197
|
-
*/
|
|
1198
|
-
duration?: BillUntil.Duration;
|
|
1199
|
-
/**
|
|
1200
|
-
* The end date of the billing schedule.
|
|
1201
|
-
*/
|
|
1202
|
-
timestamp?: number;
|
|
1203
|
-
/**
|
|
1204
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1205
|
-
*/
|
|
1206
|
-
type: BillUntil.Type;
|
|
1207
|
-
}
|
|
1208
|
-
namespace BillUntil {
|
|
1209
|
-
interface Duration {
|
|
1210
|
-
/**
|
|
1211
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1212
|
-
*/
|
|
1213
|
-
interval: Duration.Interval;
|
|
1214
|
-
/**
|
|
1215
|
-
* The multiplier applied to the interval.
|
|
1216
|
-
*/
|
|
1217
|
-
interval_count?: number;
|
|
1218
|
-
}
|
|
1219
|
-
type Type = 'duration' | 'timestamp';
|
|
1220
|
-
namespace Duration {
|
|
1221
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1222
|
-
}
|
|
1223
|
-
}
|
|
1224
|
-
}
|
|
1225
774
|
namespace DefaultSettings {
|
|
1226
775
|
interface AutomaticTax {
|
|
1227
776
|
/**
|
|
@@ -1259,7 +808,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1259
808
|
*/
|
|
1260
809
|
issuer?: InvoiceSettings.Issuer;
|
|
1261
810
|
}
|
|
1262
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1263
811
|
interface TransferData {
|
|
1264
812
|
/**
|
|
1265
813
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -1282,7 +830,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1282
830
|
type: Liability.Type;
|
|
1283
831
|
}
|
|
1284
832
|
namespace Liability {
|
|
1285
|
-
type Type = 'account' | '
|
|
833
|
+
type Type = 'account' | 'self';
|
|
1286
834
|
}
|
|
1287
835
|
}
|
|
1288
836
|
namespace InvoiceSettings {
|
|
@@ -1297,7 +845,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1297
845
|
type: Issuer.Type;
|
|
1298
846
|
}
|
|
1299
847
|
namespace Issuer {
|
|
1300
|
-
type Type = 'account' | '
|
|
848
|
+
type Type = 'account' | 'self';
|
|
1301
849
|
}
|
|
1302
850
|
}
|
|
1303
851
|
}
|
|
@@ -1367,18 +915,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1367
915
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1368
916
|
*/
|
|
1369
917
|
discount?: string;
|
|
1370
|
-
/**
|
|
1371
|
-
* Details to determine how long the discount should be applied for.
|
|
1372
|
-
*/
|
|
1373
|
-
discount_end?: Discount.DiscountEnd;
|
|
1374
918
|
/**
|
|
1375
919
|
* ID of the promotion code to create a new discount for.
|
|
1376
920
|
*/
|
|
1377
921
|
promotion_code?: string;
|
|
1378
|
-
/**
|
|
1379
|
-
* Settings for discount application including service period anchoring.
|
|
1380
|
-
*/
|
|
1381
|
-
settings?: Discount.Settings;
|
|
1382
922
|
}
|
|
1383
923
|
interface Duration {
|
|
1384
924
|
/**
|
|
@@ -1390,7 +930,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1390
930
|
*/
|
|
1391
931
|
interval_count?: number;
|
|
1392
932
|
}
|
|
1393
|
-
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
1394
933
|
interface InvoiceSettings {
|
|
1395
934
|
/**
|
|
1396
935
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -1438,20 +977,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1438
977
|
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
1439
978
|
*/
|
|
1440
979
|
tax_rates?: Emptyable<Array<string>>;
|
|
1441
|
-
/**
|
|
1442
|
-
* Options that configure the trial on the subscription item.
|
|
1443
|
-
*/
|
|
1444
|
-
trial?: Item.Trial;
|
|
1445
|
-
/**
|
|
1446
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
1447
|
-
*/
|
|
1448
|
-
trial_offer?: string;
|
|
1449
|
-
}
|
|
1450
|
-
interface PauseCollection {
|
|
1451
|
-
/**
|
|
1452
|
-
* The payment collection behavior for this subscription while paused.
|
|
1453
|
-
*/
|
|
1454
|
-
behavior: PauseCollection.Behavior;
|
|
1455
980
|
}
|
|
1456
981
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1457
982
|
interface TransferData {
|
|
@@ -1464,13 +989,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1464
989
|
*/
|
|
1465
990
|
destination: string;
|
|
1466
991
|
}
|
|
1467
|
-
type TrialContinuation = 'continue' | 'none';
|
|
1468
|
-
interface TrialSettings {
|
|
1469
|
-
/**
|
|
1470
|
-
* Defines how the subscription should behave when a trial ends.
|
|
1471
|
-
*/
|
|
1472
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
1473
|
-
}
|
|
1474
992
|
namespace AddInvoiceItem {
|
|
1475
993
|
interface Discount {
|
|
1476
994
|
/**
|
|
@@ -1481,10 +999,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1481
999
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1482
1000
|
*/
|
|
1483
1001
|
discount?: string;
|
|
1484
|
-
/**
|
|
1485
|
-
* Details to determine how long the discount should be applied for.
|
|
1486
|
-
*/
|
|
1487
|
-
discount_end?: Discount.DiscountEnd;
|
|
1488
1002
|
/**
|
|
1489
1003
|
* ID of the promotion code to create a new discount for.
|
|
1490
1004
|
*/
|
|
@@ -1522,38 +1036,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1522
1036
|
*/
|
|
1523
1037
|
unit_amount_decimal?: Decimal;
|
|
1524
1038
|
}
|
|
1525
|
-
namespace Discount {
|
|
1526
|
-
interface DiscountEnd {
|
|
1527
|
-
/**
|
|
1528
|
-
* Time span for the redeemed discount.
|
|
1529
|
-
*/
|
|
1530
|
-
duration?: DiscountEnd.Duration;
|
|
1531
|
-
/**
|
|
1532
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1533
|
-
*/
|
|
1534
|
-
timestamp?: number;
|
|
1535
|
-
/**
|
|
1536
|
-
* The type of calculation made to determine when the discount ends.
|
|
1537
|
-
*/
|
|
1538
|
-
type: DiscountEnd.Type;
|
|
1539
|
-
}
|
|
1540
|
-
namespace DiscountEnd {
|
|
1541
|
-
interface Duration {
|
|
1542
|
-
/**
|
|
1543
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1544
|
-
*/
|
|
1545
|
-
interval: Duration.Interval;
|
|
1546
|
-
/**
|
|
1547
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1548
|
-
*/
|
|
1549
|
-
interval_count: number;
|
|
1550
|
-
}
|
|
1551
|
-
type Type = 'duration' | 'timestamp';
|
|
1552
|
-
namespace Duration {
|
|
1553
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1554
|
-
}
|
|
1555
|
-
}
|
|
1556
|
-
}
|
|
1557
1039
|
namespace Period {
|
|
1558
1040
|
interface End {
|
|
1559
1041
|
/**
|
|
@@ -1598,87 +1080,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1598
1080
|
type: Liability.Type;
|
|
1599
1081
|
}
|
|
1600
1082
|
namespace Liability {
|
|
1601
|
-
type Type = 'account' | '
|
|
1602
|
-
}
|
|
1603
|
-
}
|
|
1604
|
-
namespace Discount {
|
|
1605
|
-
interface DiscountEnd {
|
|
1606
|
-
/**
|
|
1607
|
-
* Time span for the redeemed discount.
|
|
1608
|
-
*/
|
|
1609
|
-
duration?: DiscountEnd.Duration;
|
|
1610
|
-
/**
|
|
1611
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1612
|
-
*/
|
|
1613
|
-
timestamp?: number;
|
|
1614
|
-
/**
|
|
1615
|
-
* The type of calculation made to determine when the discount ends.
|
|
1616
|
-
*/
|
|
1617
|
-
type: DiscountEnd.Type;
|
|
1618
|
-
}
|
|
1619
|
-
interface Settings {
|
|
1620
|
-
/**
|
|
1621
|
-
* Configures service period cycle anchoring.
|
|
1622
|
-
*/
|
|
1623
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1624
|
-
/**
|
|
1625
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
1626
|
-
*/
|
|
1627
|
-
start_date?: Settings.StartDate;
|
|
1628
|
-
}
|
|
1629
|
-
namespace DiscountEnd {
|
|
1630
|
-
interface Duration {
|
|
1631
|
-
/**
|
|
1632
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1633
|
-
*/
|
|
1634
|
-
interval: Duration.Interval;
|
|
1635
|
-
/**
|
|
1636
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1637
|
-
*/
|
|
1638
|
-
interval_count: number;
|
|
1639
|
-
}
|
|
1640
|
-
type Type = 'duration' | 'timestamp';
|
|
1641
|
-
namespace Duration {
|
|
1642
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1643
|
-
}
|
|
1644
|
-
}
|
|
1645
|
-
namespace Settings {
|
|
1646
|
-
interface ServicePeriodAnchorConfig {
|
|
1647
|
-
/**
|
|
1648
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1649
|
-
*/
|
|
1650
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1651
|
-
/**
|
|
1652
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1653
|
-
*/
|
|
1654
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
1655
|
-
}
|
|
1656
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1657
|
-
namespace ServicePeriodAnchorConfig {
|
|
1658
|
-
interface Custom {
|
|
1659
|
-
/**
|
|
1660
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1661
|
-
*/
|
|
1662
|
-
day_of_month: number;
|
|
1663
|
-
/**
|
|
1664
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1665
|
-
*/
|
|
1666
|
-
hour?: number;
|
|
1667
|
-
/**
|
|
1668
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1669
|
-
*/
|
|
1670
|
-
minute?: number;
|
|
1671
|
-
/**
|
|
1672
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1673
|
-
*/
|
|
1674
|
-
month?: number;
|
|
1675
|
-
/**
|
|
1676
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1677
|
-
*/
|
|
1678
|
-
second?: number;
|
|
1679
|
-
}
|
|
1680
|
-
type Type = 'custom' | 'inherit';
|
|
1681
|
-
}
|
|
1083
|
+
type Type = 'account' | 'self';
|
|
1682
1084
|
}
|
|
1683
1085
|
}
|
|
1684
1086
|
namespace Duration {
|
|
@@ -1696,7 +1098,7 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1696
1098
|
type: Issuer.Type;
|
|
1697
1099
|
}
|
|
1698
1100
|
namespace Issuer {
|
|
1699
|
-
type Type = 'account' | '
|
|
1101
|
+
type Type = 'account' | 'self';
|
|
1700
1102
|
}
|
|
1701
1103
|
}
|
|
1702
1104
|
namespace Item {
|
|
@@ -1715,18 +1117,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1715
1117
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1716
1118
|
*/
|
|
1717
1119
|
discount?: string;
|
|
1718
|
-
/**
|
|
1719
|
-
* Details to determine how long the discount should be applied for.
|
|
1720
|
-
*/
|
|
1721
|
-
discount_end?: Discount.DiscountEnd;
|
|
1722
1120
|
/**
|
|
1723
1121
|
* ID of the promotion code to create a new discount for.
|
|
1724
1122
|
*/
|
|
1725
1123
|
promotion_code?: string;
|
|
1726
|
-
/**
|
|
1727
|
-
* Settings for discount application including service period anchoring.
|
|
1728
|
-
*/
|
|
1729
|
-
settings?: Discount.Settings;
|
|
1730
1124
|
}
|
|
1731
1125
|
interface PriceData {
|
|
1732
1126
|
/**
|
|
@@ -1754,133 +1148,23 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1754
1148
|
*/
|
|
1755
1149
|
unit_amount_decimal?: Decimal;
|
|
1756
1150
|
}
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
* 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.
|
|
1760
|
-
*/
|
|
1761
|
-
converts_to?: Array<string>;
|
|
1762
|
-
/**
|
|
1763
|
-
* Determines the type of trial for this item.
|
|
1764
|
-
*/
|
|
1765
|
-
type: Trial.Type;
|
|
1766
|
-
}
|
|
1767
|
-
namespace Discount {
|
|
1768
|
-
interface DiscountEnd {
|
|
1769
|
-
/**
|
|
1770
|
-
* Time span for the redeemed discount.
|
|
1771
|
-
*/
|
|
1772
|
-
duration?: DiscountEnd.Duration;
|
|
1151
|
+
namespace PriceData {
|
|
1152
|
+
interface Recurring {
|
|
1773
1153
|
/**
|
|
1774
|
-
*
|
|
1154
|
+
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
1775
1155
|
*/
|
|
1776
|
-
|
|
1156
|
+
interval: Recurring.Interval;
|
|
1777
1157
|
/**
|
|
1778
|
-
* The
|
|
1158
|
+
* 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).
|
|
1779
1159
|
*/
|
|
1780
|
-
|
|
1781
|
-
}
|
|
1782
|
-
interface Settings {
|
|
1783
|
-
/**
|
|
1784
|
-
* Configures service period cycle anchoring.
|
|
1785
|
-
*/
|
|
1786
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
1787
|
-
/**
|
|
1788
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
1789
|
-
*/
|
|
1790
|
-
start_date?: Settings.StartDate;
|
|
1791
|
-
}
|
|
1792
|
-
namespace DiscountEnd {
|
|
1793
|
-
interface Duration {
|
|
1794
|
-
/**
|
|
1795
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1796
|
-
*/
|
|
1797
|
-
interval: Duration.Interval;
|
|
1798
|
-
/**
|
|
1799
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1800
|
-
*/
|
|
1801
|
-
interval_count: number;
|
|
1802
|
-
}
|
|
1803
|
-
type Type = 'duration' | 'timestamp';
|
|
1804
|
-
namespace Duration {
|
|
1805
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1806
|
-
}
|
|
1807
|
-
}
|
|
1808
|
-
namespace Settings {
|
|
1809
|
-
interface ServicePeriodAnchorConfig {
|
|
1810
|
-
/**
|
|
1811
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
1812
|
-
*/
|
|
1813
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
1814
|
-
/**
|
|
1815
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
1816
|
-
*/
|
|
1817
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
1818
|
-
}
|
|
1819
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
1820
|
-
namespace ServicePeriodAnchorConfig {
|
|
1821
|
-
interface Custom {
|
|
1822
|
-
/**
|
|
1823
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
1824
|
-
*/
|
|
1825
|
-
day_of_month: number;
|
|
1826
|
-
/**
|
|
1827
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
1828
|
-
*/
|
|
1829
|
-
hour?: number;
|
|
1830
|
-
/**
|
|
1831
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
1832
|
-
*/
|
|
1833
|
-
minute?: number;
|
|
1834
|
-
/**
|
|
1835
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
1836
|
-
*/
|
|
1837
|
-
month?: number;
|
|
1838
|
-
/**
|
|
1839
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
1840
|
-
*/
|
|
1841
|
-
second?: number;
|
|
1842
|
-
}
|
|
1843
|
-
type Type = 'custom' | 'inherit';
|
|
1844
|
-
}
|
|
1845
|
-
}
|
|
1846
|
-
}
|
|
1847
|
-
namespace PriceData {
|
|
1848
|
-
interface Recurring {
|
|
1849
|
-
/**
|
|
1850
|
-
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
|
1851
|
-
*/
|
|
1852
|
-
interval: Recurring.Interval;
|
|
1853
|
-
/**
|
|
1854
|
-
* 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).
|
|
1855
|
-
*/
|
|
1856
|
-
interval_count?: number;
|
|
1160
|
+
interval_count?: number;
|
|
1857
1161
|
}
|
|
1858
1162
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
1859
1163
|
namespace Recurring {
|
|
1860
1164
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1861
1165
|
}
|
|
1862
1166
|
}
|
|
1863
|
-
namespace Trial {
|
|
1864
|
-
type Type = 'free' | 'paid';
|
|
1865
|
-
}
|
|
1866
|
-
}
|
|
1867
|
-
namespace PauseCollection {
|
|
1868
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1869
1167
|
}
|
|
1870
|
-
namespace TrialSettings {
|
|
1871
|
-
interface EndBehavior {
|
|
1872
|
-
/**
|
|
1873
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1874
|
-
*/
|
|
1875
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
1876
|
-
}
|
|
1877
|
-
namespace EndBehavior {
|
|
1878
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
1879
|
-
}
|
|
1880
|
-
}
|
|
1881
|
-
}
|
|
1882
|
-
namespace Prebilling {
|
|
1883
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
1884
1168
|
}
|
|
1885
1169
|
}
|
|
1886
1170
|
export interface SubscriptionScheduleRetrieveParams {
|
|
@@ -1890,14 +1174,6 @@ export interface SubscriptionScheduleRetrieveParams {
|
|
|
1890
1174
|
expand?: Array<string>;
|
|
1891
1175
|
}
|
|
1892
1176
|
export interface SubscriptionScheduleUpdateParams {
|
|
1893
|
-
/**
|
|
1894
|
-
* 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.
|
|
1895
|
-
*/
|
|
1896
|
-
billing_behavior?: SubscriptionScheduleUpdateParams.BillingBehavior;
|
|
1897
|
-
/**
|
|
1898
|
-
* Sets the billing schedules for the subscription schedule.
|
|
1899
|
-
*/
|
|
1900
|
-
billing_schedules?: Emptyable<Array<SubscriptionScheduleUpdateParams.BillingSchedule>>;
|
|
1901
1177
|
/**
|
|
1902
1178
|
* Object representing the subscription schedule's default settings.
|
|
1903
1179
|
*/
|
|
@@ -1918,31 +1194,12 @@ export interface SubscriptionScheduleUpdateParams {
|
|
|
1918
1194
|
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
|
|
1919
1195
|
*/
|
|
1920
1196
|
phases?: Array<SubscriptionScheduleUpdateParams.Phase>;
|
|
1921
|
-
/**
|
|
1922
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1923
|
-
*/
|
|
1924
|
-
prebilling?: SubscriptionScheduleUpdateParams.Prebilling;
|
|
1925
1197
|
/**
|
|
1926
1198
|
* If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
|
|
1927
1199
|
*/
|
|
1928
1200
|
proration_behavior?: SubscriptionScheduleUpdateParams.ProrationBehavior;
|
|
1929
1201
|
}
|
|
1930
1202
|
export declare namespace SubscriptionScheduleUpdateParams {
|
|
1931
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1932
|
-
interface BillingSchedule {
|
|
1933
|
-
/**
|
|
1934
|
-
* Configure billing schedule differently for individual subscription items.
|
|
1935
|
-
*/
|
|
1936
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
1937
|
-
/**
|
|
1938
|
-
* The end date for the billing schedule.
|
|
1939
|
-
*/
|
|
1940
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
1941
|
-
/**
|
|
1942
|
-
* 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.
|
|
1943
|
-
*/
|
|
1944
|
-
key?: string;
|
|
1945
|
-
}
|
|
1946
1203
|
interface DefaultSettings {
|
|
1947
1204
|
/**
|
|
1948
1205
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
|
@@ -1980,10 +1237,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1980
1237
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1981
1238
|
*/
|
|
1982
1239
|
on_behalf_of?: Emptyable<string>;
|
|
1983
|
-
/**
|
|
1984
|
-
* Configures how the subscription schedule handles billing for phase transitions.
|
|
1985
|
-
*/
|
|
1986
|
-
phase_effective_at?: DefaultSettings.PhaseEffectiveAt;
|
|
1987
1240
|
/**
|
|
1988
1241
|
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
1989
1242
|
*/
|
|
@@ -2039,10 +1292,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2039
1292
|
* The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
2040
1293
|
*/
|
|
2041
1294
|
duration?: Phase.Duration;
|
|
2042
|
-
/**
|
|
2043
|
-
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2044
|
-
*/
|
|
2045
|
-
effective_at?: Phase.EffectiveAt;
|
|
2046
1295
|
/**
|
|
2047
1296
|
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
2048
1297
|
*/
|
|
@@ -2063,10 +1312,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2063
1312
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
2064
1313
|
*/
|
|
2065
1314
|
on_behalf_of?: string;
|
|
2066
|
-
/**
|
|
2067
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
2068
|
-
*/
|
|
2069
|
-
pause_collection?: Phase.PauseCollection;
|
|
2070
1315
|
/**
|
|
2071
1316
|
* Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
2072
1317
|
*/
|
|
@@ -2083,72 +1328,12 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2083
1328
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
2084
1329
|
*/
|
|
2085
1330
|
trial?: boolean;
|
|
2086
|
-
/**
|
|
2087
|
-
* Specify trial behavior when crossing phase boundaries
|
|
2088
|
-
*/
|
|
2089
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
2090
1331
|
/**
|
|
2091
1332
|
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
|
2092
1333
|
*/
|
|
2093
1334
|
trial_end?: number | 'now';
|
|
2094
|
-
/**
|
|
2095
|
-
* Settings related to subscription trials.
|
|
2096
|
-
*/
|
|
2097
|
-
trial_settings?: Phase.TrialSettings;
|
|
2098
|
-
}
|
|
2099
|
-
interface Prebilling {
|
|
2100
|
-
/**
|
|
2101
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
2102
|
-
*/
|
|
2103
|
-
iterations: number;
|
|
2104
|
-
/**
|
|
2105
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2106
|
-
*/
|
|
2107
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
2108
1335
|
}
|
|
2109
1336
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2110
|
-
namespace BillingSchedule {
|
|
2111
|
-
interface AppliesTo {
|
|
2112
|
-
/**
|
|
2113
|
-
* The ID of the price object.
|
|
2114
|
-
*/
|
|
2115
|
-
price?: string;
|
|
2116
|
-
/**
|
|
2117
|
-
* Controls which subscription items the billing schedule applies to.
|
|
2118
|
-
*/
|
|
2119
|
-
type: 'price';
|
|
2120
|
-
}
|
|
2121
|
-
interface BillUntil {
|
|
2122
|
-
/**
|
|
2123
|
-
* Specifies the billing period.
|
|
2124
|
-
*/
|
|
2125
|
-
duration?: BillUntil.Duration;
|
|
2126
|
-
/**
|
|
2127
|
-
* The end date of the billing schedule.
|
|
2128
|
-
*/
|
|
2129
|
-
timestamp?: number;
|
|
2130
|
-
/**
|
|
2131
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
2132
|
-
*/
|
|
2133
|
-
type: BillUntil.Type;
|
|
2134
|
-
}
|
|
2135
|
-
namespace BillUntil {
|
|
2136
|
-
interface Duration {
|
|
2137
|
-
/**
|
|
2138
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
2139
|
-
*/
|
|
2140
|
-
interval: Duration.Interval;
|
|
2141
|
-
/**
|
|
2142
|
-
* The multiplier applied to the interval.
|
|
2143
|
-
*/
|
|
2144
|
-
interval_count?: number;
|
|
2145
|
-
}
|
|
2146
|
-
type Type = 'duration' | 'timestamp';
|
|
2147
|
-
namespace Duration {
|
|
2148
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2149
|
-
}
|
|
2150
|
-
}
|
|
2151
|
-
}
|
|
2152
1337
|
namespace DefaultSettings {
|
|
2153
1338
|
interface AutomaticTax {
|
|
2154
1339
|
/**
|
|
@@ -2186,7 +1371,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2186
1371
|
*/
|
|
2187
1372
|
issuer?: InvoiceSettings.Issuer;
|
|
2188
1373
|
}
|
|
2189
|
-
type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
|
|
2190
1374
|
interface TransferData {
|
|
2191
1375
|
/**
|
|
2192
1376
|
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
|
@@ -2209,7 +1393,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2209
1393
|
type: Liability.Type;
|
|
2210
1394
|
}
|
|
2211
1395
|
namespace Liability {
|
|
2212
|
-
type Type = 'account' | '
|
|
1396
|
+
type Type = 'account' | 'self';
|
|
2213
1397
|
}
|
|
2214
1398
|
}
|
|
2215
1399
|
namespace InvoiceSettings {
|
|
@@ -2224,7 +1408,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2224
1408
|
type: Issuer.Type;
|
|
2225
1409
|
}
|
|
2226
1410
|
namespace Issuer {
|
|
2227
|
-
type Type = 'account' | '
|
|
1411
|
+
type Type = 'account' | 'self';
|
|
2228
1412
|
}
|
|
2229
1413
|
}
|
|
2230
1414
|
}
|
|
@@ -2294,18 +1478,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2294
1478
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2295
1479
|
*/
|
|
2296
1480
|
discount?: string;
|
|
2297
|
-
/**
|
|
2298
|
-
* Details to determine how long the discount should be applied for.
|
|
2299
|
-
*/
|
|
2300
|
-
discount_end?: Discount.DiscountEnd;
|
|
2301
1481
|
/**
|
|
2302
1482
|
* ID of the promotion code to create a new discount for.
|
|
2303
1483
|
*/
|
|
2304
1484
|
promotion_code?: string;
|
|
2305
|
-
/**
|
|
2306
|
-
* Settings for discount application including service period anchoring.
|
|
2307
|
-
*/
|
|
2308
|
-
settings?: Discount.Settings;
|
|
2309
1485
|
}
|
|
2310
1486
|
interface Duration {
|
|
2311
1487
|
/**
|
|
@@ -2317,7 +1493,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2317
1493
|
*/
|
|
2318
1494
|
interval_count?: number;
|
|
2319
1495
|
}
|
|
2320
|
-
type EffectiveAt = 'billing_period_start' | 'phase_start';
|
|
2321
1496
|
interface InvoiceSettings {
|
|
2322
1497
|
/**
|
|
2323
1498
|
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
|
@@ -2365,20 +1540,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2365
1540
|
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
2366
1541
|
*/
|
|
2367
1542
|
tax_rates?: Emptyable<Array<string>>;
|
|
2368
|
-
/**
|
|
2369
|
-
* Options that configure the trial on the subscription item.
|
|
2370
|
-
*/
|
|
2371
|
-
trial?: Item.Trial;
|
|
2372
|
-
/**
|
|
2373
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
2374
|
-
*/
|
|
2375
|
-
trial_offer?: string;
|
|
2376
|
-
}
|
|
2377
|
-
interface PauseCollection {
|
|
2378
|
-
/**
|
|
2379
|
-
* The payment collection behavior for this subscription while paused.
|
|
2380
|
-
*/
|
|
2381
|
-
behavior: PauseCollection.Behavior;
|
|
2382
1543
|
}
|
|
2383
1544
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2384
1545
|
interface TransferData {
|
|
@@ -2391,13 +1552,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2391
1552
|
*/
|
|
2392
1553
|
destination: string;
|
|
2393
1554
|
}
|
|
2394
|
-
type TrialContinuation = 'continue' | 'none';
|
|
2395
|
-
interface TrialSettings {
|
|
2396
|
-
/**
|
|
2397
|
-
* Defines how the subscription should behave when a trial ends.
|
|
2398
|
-
*/
|
|
2399
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
2400
|
-
}
|
|
2401
1555
|
namespace AddInvoiceItem {
|
|
2402
1556
|
interface Discount {
|
|
2403
1557
|
/**
|
|
@@ -2408,10 +1562,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2408
1562
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2409
1563
|
*/
|
|
2410
1564
|
discount?: string;
|
|
2411
|
-
/**
|
|
2412
|
-
* Details to determine how long the discount should be applied for.
|
|
2413
|
-
*/
|
|
2414
|
-
discount_end?: Discount.DiscountEnd;
|
|
2415
1565
|
/**
|
|
2416
1566
|
* ID of the promotion code to create a new discount for.
|
|
2417
1567
|
*/
|
|
@@ -2449,38 +1599,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2449
1599
|
*/
|
|
2450
1600
|
unit_amount_decimal?: Decimal;
|
|
2451
1601
|
}
|
|
2452
|
-
namespace Discount {
|
|
2453
|
-
interface DiscountEnd {
|
|
2454
|
-
/**
|
|
2455
|
-
* Time span for the redeemed discount.
|
|
2456
|
-
*/
|
|
2457
|
-
duration?: DiscountEnd.Duration;
|
|
2458
|
-
/**
|
|
2459
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2460
|
-
*/
|
|
2461
|
-
timestamp?: number;
|
|
2462
|
-
/**
|
|
2463
|
-
* The type of calculation made to determine when the discount ends.
|
|
2464
|
-
*/
|
|
2465
|
-
type: DiscountEnd.Type;
|
|
2466
|
-
}
|
|
2467
|
-
namespace DiscountEnd {
|
|
2468
|
-
interface Duration {
|
|
2469
|
-
/**
|
|
2470
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2471
|
-
*/
|
|
2472
|
-
interval: Duration.Interval;
|
|
2473
|
-
/**
|
|
2474
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2475
|
-
*/
|
|
2476
|
-
interval_count: number;
|
|
2477
|
-
}
|
|
2478
|
-
type Type = 'duration' | 'timestamp';
|
|
2479
|
-
namespace Duration {
|
|
2480
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2481
|
-
}
|
|
2482
|
-
}
|
|
2483
|
-
}
|
|
2484
1602
|
namespace Period {
|
|
2485
1603
|
interface End {
|
|
2486
1604
|
/**
|
|
@@ -2525,87 +1643,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2525
1643
|
type: Liability.Type;
|
|
2526
1644
|
}
|
|
2527
1645
|
namespace Liability {
|
|
2528
|
-
type Type = 'account' | '
|
|
2529
|
-
}
|
|
2530
|
-
}
|
|
2531
|
-
namespace Discount {
|
|
2532
|
-
interface DiscountEnd {
|
|
2533
|
-
/**
|
|
2534
|
-
* Time span for the redeemed discount.
|
|
2535
|
-
*/
|
|
2536
|
-
duration?: DiscountEnd.Duration;
|
|
2537
|
-
/**
|
|
2538
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2539
|
-
*/
|
|
2540
|
-
timestamp?: number;
|
|
2541
|
-
/**
|
|
2542
|
-
* The type of calculation made to determine when the discount ends.
|
|
2543
|
-
*/
|
|
2544
|
-
type: DiscountEnd.Type;
|
|
2545
|
-
}
|
|
2546
|
-
interface Settings {
|
|
2547
|
-
/**
|
|
2548
|
-
* Configures service period cycle anchoring.
|
|
2549
|
-
*/
|
|
2550
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2551
|
-
/**
|
|
2552
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
2553
|
-
*/
|
|
2554
|
-
start_date?: Settings.StartDate;
|
|
2555
|
-
}
|
|
2556
|
-
namespace DiscountEnd {
|
|
2557
|
-
interface Duration {
|
|
2558
|
-
/**
|
|
2559
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2560
|
-
*/
|
|
2561
|
-
interval: Duration.Interval;
|
|
2562
|
-
/**
|
|
2563
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2564
|
-
*/
|
|
2565
|
-
interval_count: number;
|
|
2566
|
-
}
|
|
2567
|
-
type Type = 'duration' | 'timestamp';
|
|
2568
|
-
namespace Duration {
|
|
2569
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2570
|
-
}
|
|
2571
|
-
}
|
|
2572
|
-
namespace Settings {
|
|
2573
|
-
interface ServicePeriodAnchorConfig {
|
|
2574
|
-
/**
|
|
2575
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2576
|
-
*/
|
|
2577
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2578
|
-
/**
|
|
2579
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2580
|
-
*/
|
|
2581
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
2582
|
-
}
|
|
2583
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2584
|
-
namespace ServicePeriodAnchorConfig {
|
|
2585
|
-
interface Custom {
|
|
2586
|
-
/**
|
|
2587
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2588
|
-
*/
|
|
2589
|
-
day_of_month: number;
|
|
2590
|
-
/**
|
|
2591
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2592
|
-
*/
|
|
2593
|
-
hour?: number;
|
|
2594
|
-
/**
|
|
2595
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2596
|
-
*/
|
|
2597
|
-
minute?: number;
|
|
2598
|
-
/**
|
|
2599
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2600
|
-
*/
|
|
2601
|
-
month?: number;
|
|
2602
|
-
/**
|
|
2603
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2604
|
-
*/
|
|
2605
|
-
second?: number;
|
|
2606
|
-
}
|
|
2607
|
-
type Type = 'custom' | 'inherit';
|
|
2608
|
-
}
|
|
1646
|
+
type Type = 'account' | 'self';
|
|
2609
1647
|
}
|
|
2610
1648
|
}
|
|
2611
1649
|
namespace Duration {
|
|
@@ -2623,7 +1661,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2623
1661
|
type: Issuer.Type;
|
|
2624
1662
|
}
|
|
2625
1663
|
namespace Issuer {
|
|
2626
|
-
type Type = 'account' | '
|
|
1664
|
+
type Type = 'account' | 'self';
|
|
2627
1665
|
}
|
|
2628
1666
|
}
|
|
2629
1667
|
namespace Item {
|
|
@@ -2642,18 +1680,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2642
1680
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2643
1681
|
*/
|
|
2644
1682
|
discount?: string;
|
|
2645
|
-
/**
|
|
2646
|
-
* Details to determine how long the discount should be applied for.
|
|
2647
|
-
*/
|
|
2648
|
-
discount_end?: Discount.DiscountEnd;
|
|
2649
1683
|
/**
|
|
2650
1684
|
* ID of the promotion code to create a new discount for.
|
|
2651
1685
|
*/
|
|
2652
1686
|
promotion_code?: string;
|
|
2653
|
-
/**
|
|
2654
|
-
* Settings for discount application including service period anchoring.
|
|
2655
|
-
*/
|
|
2656
|
-
settings?: Discount.Settings;
|
|
2657
1687
|
}
|
|
2658
1688
|
interface PriceData {
|
|
2659
1689
|
/**
|
|
@@ -2681,96 +1711,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2681
1711
|
*/
|
|
2682
1712
|
unit_amount_decimal?: Decimal;
|
|
2683
1713
|
}
|
|
2684
|
-
interface Trial {
|
|
2685
|
-
/**
|
|
2686
|
-
* 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.
|
|
2687
|
-
*/
|
|
2688
|
-
converts_to?: Array<string>;
|
|
2689
|
-
/**
|
|
2690
|
-
* Determines the type of trial for this item.
|
|
2691
|
-
*/
|
|
2692
|
-
type: Trial.Type;
|
|
2693
|
-
}
|
|
2694
|
-
namespace Discount {
|
|
2695
|
-
interface DiscountEnd {
|
|
2696
|
-
/**
|
|
2697
|
-
* Time span for the redeemed discount.
|
|
2698
|
-
*/
|
|
2699
|
-
duration?: DiscountEnd.Duration;
|
|
2700
|
-
/**
|
|
2701
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2702
|
-
*/
|
|
2703
|
-
timestamp?: number;
|
|
2704
|
-
/**
|
|
2705
|
-
* The type of calculation made to determine when the discount ends.
|
|
2706
|
-
*/
|
|
2707
|
-
type: DiscountEnd.Type;
|
|
2708
|
-
}
|
|
2709
|
-
interface Settings {
|
|
2710
|
-
/**
|
|
2711
|
-
* Configures service period cycle anchoring.
|
|
2712
|
-
*/
|
|
2713
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
2714
|
-
/**
|
|
2715
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `phase_start` if omitted.
|
|
2716
|
-
*/
|
|
2717
|
-
start_date?: Settings.StartDate;
|
|
2718
|
-
}
|
|
2719
|
-
namespace DiscountEnd {
|
|
2720
|
-
interface Duration {
|
|
2721
|
-
/**
|
|
2722
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2723
|
-
*/
|
|
2724
|
-
interval: Duration.Interval;
|
|
2725
|
-
/**
|
|
2726
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2727
|
-
*/
|
|
2728
|
-
interval_count: number;
|
|
2729
|
-
}
|
|
2730
|
-
type Type = 'duration' | 'timestamp';
|
|
2731
|
-
namespace Duration {
|
|
2732
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2733
|
-
}
|
|
2734
|
-
}
|
|
2735
|
-
namespace Settings {
|
|
2736
|
-
interface ServicePeriodAnchorConfig {
|
|
2737
|
-
/**
|
|
2738
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
2739
|
-
*/
|
|
2740
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
2741
|
-
/**
|
|
2742
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
2743
|
-
*/
|
|
2744
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
2745
|
-
}
|
|
2746
|
-
type StartDate = 'current_period_end' | 'current_period_start' | 'phase_start';
|
|
2747
|
-
namespace ServicePeriodAnchorConfig {
|
|
2748
|
-
interface Custom {
|
|
2749
|
-
/**
|
|
2750
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
2751
|
-
*/
|
|
2752
|
-
day_of_month: number;
|
|
2753
|
-
/**
|
|
2754
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
2755
|
-
*/
|
|
2756
|
-
hour?: number;
|
|
2757
|
-
/**
|
|
2758
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
2759
|
-
*/
|
|
2760
|
-
minute?: number;
|
|
2761
|
-
/**
|
|
2762
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
2763
|
-
*/
|
|
2764
|
-
month?: number;
|
|
2765
|
-
/**
|
|
2766
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
2767
|
-
*/
|
|
2768
|
-
second?: number;
|
|
2769
|
-
}
|
|
2770
|
-
type Type = 'custom' | 'inherit';
|
|
2771
|
-
}
|
|
2772
|
-
}
|
|
2773
|
-
}
|
|
2774
1714
|
namespace PriceData {
|
|
2775
1715
|
interface Recurring {
|
|
2776
1716
|
/**
|
|
@@ -2787,27 +1727,7 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2787
1727
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2788
1728
|
}
|
|
2789
1729
|
}
|
|
2790
|
-
namespace Trial {
|
|
2791
|
-
type Type = 'free' | 'paid';
|
|
2792
|
-
}
|
|
2793
1730
|
}
|
|
2794
|
-
namespace PauseCollection {
|
|
2795
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2796
|
-
}
|
|
2797
|
-
namespace TrialSettings {
|
|
2798
|
-
interface EndBehavior {
|
|
2799
|
-
/**
|
|
2800
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2801
|
-
*/
|
|
2802
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2803
|
-
}
|
|
2804
|
-
namespace EndBehavior {
|
|
2805
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
2806
|
-
}
|
|
2807
|
-
}
|
|
2808
|
-
}
|
|
2809
|
-
namespace Prebilling {
|
|
2810
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
2811
1731
|
}
|
|
2812
1732
|
}
|
|
2813
1733
|
export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
@@ -2844,847 +1764,6 @@ export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
|
2844
1764
|
*/
|
|
2845
1765
|
scheduled?: boolean;
|
|
2846
1766
|
}
|
|
2847
|
-
export interface SubscriptionScheduleAmendParams {
|
|
2848
|
-
/**
|
|
2849
|
-
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2850
|
-
*/
|
|
2851
|
-
amendments?: Array<SubscriptionScheduleAmendParams.Amendment>;
|
|
2852
|
-
/**
|
|
2853
|
-
* Specifies which fields in the response should be expanded.
|
|
2854
|
-
*/
|
|
2855
|
-
expand?: Array<string>;
|
|
2856
|
-
/**
|
|
2857
|
-
* Provide any time periods to bill in advance.
|
|
2858
|
-
*/
|
|
2859
|
-
prebilling?: Emptyable<Array<SubscriptionScheduleAmendParams.Prebilling>>;
|
|
2860
|
-
/**
|
|
2861
|
-
* In cases where the amendment changes the currently active phase,
|
|
2862
|
-
* specifies if and how to prorate at the time of the request.
|
|
2863
|
-
*/
|
|
2864
|
-
proration_behavior?: SubscriptionScheduleAmendParams.ProrationBehavior;
|
|
2865
|
-
/**
|
|
2866
|
-
* Changes to apply to the subscription schedule.
|
|
2867
|
-
*/
|
|
2868
|
-
schedule_settings?: SubscriptionScheduleAmendParams.ScheduleSettings;
|
|
2869
|
-
}
|
|
2870
|
-
export declare namespace SubscriptionScheduleAmendParams {
|
|
2871
|
-
interface Amendment {
|
|
2872
|
-
/**
|
|
2873
|
-
* Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
|
2874
|
-
*/
|
|
2875
|
-
amendment_end?: Amendment.AmendmentEnd;
|
|
2876
|
-
/**
|
|
2877
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2878
|
-
*/
|
|
2879
|
-
amendment_start: Amendment.AmendmentStart;
|
|
2880
|
-
/**
|
|
2881
|
-
* For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
|
2882
|
-
*/
|
|
2883
|
-
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2884
|
-
/**
|
|
2885
|
-
* Actions to apply to the billing schedules.
|
|
2886
|
-
*/
|
|
2887
|
-
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
2888
|
-
/**
|
|
2889
|
-
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2890
|
-
*/
|
|
2891
|
-
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2892
|
-
/**
|
|
2893
|
-
* Configures how the subscription schedule handles billing for phase transitions.
|
|
2894
|
-
*/
|
|
2895
|
-
effective_at?: Amendment.EffectiveAt;
|
|
2896
|
-
/**
|
|
2897
|
-
* Changes to the subscription items during the amendment time span.
|
|
2898
|
-
*/
|
|
2899
|
-
item_actions?: Array<Amendment.ItemAction>;
|
|
2900
|
-
/**
|
|
2901
|
-
* Instructions for how to modify phase metadata
|
|
2902
|
-
*/
|
|
2903
|
-
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2904
|
-
/**
|
|
2905
|
-
* Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
|
2906
|
-
*/
|
|
2907
|
-
proration_behavior?: Amendment.ProrationBehavior;
|
|
2908
|
-
/**
|
|
2909
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2910
|
-
*/
|
|
2911
|
-
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2912
|
-
/**
|
|
2913
|
-
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2914
|
-
*/
|
|
2915
|
-
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2916
|
-
/**
|
|
2917
|
-
* Settings related to subscription trials.
|
|
2918
|
-
*/
|
|
2919
|
-
trial_settings?: Amendment.TrialSettings;
|
|
2920
|
-
}
|
|
2921
|
-
interface Prebilling {
|
|
2922
|
-
/**
|
|
2923
|
-
* The beginning of the prebilled time period. The default value is `now`.
|
|
2924
|
-
*/
|
|
2925
|
-
bill_from?: Prebilling.BillFrom;
|
|
2926
|
-
/**
|
|
2927
|
-
* The end of the prebilled time period.
|
|
2928
|
-
*/
|
|
2929
|
-
bill_until?: Prebilling.BillUntil;
|
|
2930
|
-
/**
|
|
2931
|
-
* When the prebilling invoice should be created. The default value is `now`.
|
|
2932
|
-
*/
|
|
2933
|
-
invoice_at?: 'now';
|
|
2934
|
-
/**
|
|
2935
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2936
|
-
*/
|
|
2937
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
2938
|
-
}
|
|
2939
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2940
|
-
interface ScheduleSettings {
|
|
2941
|
-
/**
|
|
2942
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
2943
|
-
*/
|
|
2944
|
-
end_behavior?: ScheduleSettings.EndBehavior;
|
|
2945
|
-
}
|
|
2946
|
-
namespace Amendment {
|
|
2947
|
-
interface AmendmentEnd {
|
|
2948
|
-
/**
|
|
2949
|
-
* Use the `end` time of a given discount.
|
|
2950
|
-
*/
|
|
2951
|
-
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2952
|
-
/**
|
|
2953
|
-
* Time span for the amendment starting from the `amendment_start`.
|
|
2954
|
-
*/
|
|
2955
|
-
duration?: AmendmentEnd.Duration;
|
|
2956
|
-
/**
|
|
2957
|
-
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2958
|
-
*/
|
|
2959
|
-
timestamp?: number;
|
|
2960
|
-
/**
|
|
2961
|
-
* Select one of three ways to pass the `amendment_end`.
|
|
2962
|
-
*/
|
|
2963
|
-
type: AmendmentEnd.Type;
|
|
2964
|
-
}
|
|
2965
|
-
interface AmendmentStart {
|
|
2966
|
-
/**
|
|
2967
|
-
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2968
|
-
*/
|
|
2969
|
-
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2970
|
-
/**
|
|
2971
|
-
* Use the `end` time of a given discount.
|
|
2972
|
-
*/
|
|
2973
|
-
discount_end?: AmendmentStart.DiscountEnd;
|
|
2974
|
-
/**
|
|
2975
|
-
* A precise Unix timestamp for the amendment to start.
|
|
2976
|
-
*/
|
|
2977
|
-
timestamp?: number;
|
|
2978
|
-
/**
|
|
2979
|
-
* Select one of three ways to pass the `amendment_start`.
|
|
2980
|
-
*/
|
|
2981
|
-
type: AmendmentStart.Type;
|
|
2982
|
-
}
|
|
2983
|
-
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
2984
|
-
interface BillingSchedulesAction {
|
|
2985
|
-
/**
|
|
2986
|
-
* Specify which subscription items the billing schedule applies to.
|
|
2987
|
-
*/
|
|
2988
|
-
applies_to?: Array<BillingSchedulesAction.AppliesTo>;
|
|
2989
|
-
/**
|
|
2990
|
-
* Select the action.
|
|
2991
|
-
*/
|
|
2992
|
-
type: BillingSchedulesAction.Type;
|
|
2993
|
-
}
|
|
2994
|
-
interface DiscountAction {
|
|
2995
|
-
/**
|
|
2996
|
-
* Details of the discount to add.
|
|
2997
|
-
*/
|
|
2998
|
-
add?: DiscountAction.Add;
|
|
2999
|
-
/**
|
|
3000
|
-
* Details of the discount to remove.
|
|
3001
|
-
*/
|
|
3002
|
-
remove?: DiscountAction.Remove;
|
|
3003
|
-
/**
|
|
3004
|
-
* Details of the discount to replace the existing discounts with.
|
|
3005
|
-
*/
|
|
3006
|
-
set?: DiscountAction.Set;
|
|
3007
|
-
/**
|
|
3008
|
-
* Determines the type of discount action.
|
|
3009
|
-
*/
|
|
3010
|
-
type: DiscountAction.Type;
|
|
3011
|
-
}
|
|
3012
|
-
type EffectiveAt = 'amendment_start' | 'billing_period_start';
|
|
3013
|
-
interface ItemAction {
|
|
3014
|
-
/**
|
|
3015
|
-
* Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
|
3016
|
-
*/
|
|
3017
|
-
add?: ItemAction.Add;
|
|
3018
|
-
/**
|
|
3019
|
-
* Details of the subscription item to remove.
|
|
3020
|
-
*/
|
|
3021
|
-
remove?: ItemAction.Remove;
|
|
3022
|
-
/**
|
|
3023
|
-
* Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
|
3024
|
-
*/
|
|
3025
|
-
set?: ItemAction.Set;
|
|
3026
|
-
/**
|
|
3027
|
-
* Determines the type of item action.
|
|
3028
|
-
*/
|
|
3029
|
-
type: ItemAction.Type;
|
|
3030
|
-
}
|
|
3031
|
-
interface MetadataAction {
|
|
3032
|
-
/**
|
|
3033
|
-
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3034
|
-
*/
|
|
3035
|
-
add?: {
|
|
3036
|
-
[key: string]: string;
|
|
3037
|
-
};
|
|
3038
|
-
/**
|
|
3039
|
-
* Keys to remove from schedule phase metadata.
|
|
3040
|
-
*/
|
|
3041
|
-
remove?: Array<string>;
|
|
3042
|
-
/**
|
|
3043
|
-
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3044
|
-
*/
|
|
3045
|
-
set?: Emptyable<{
|
|
3046
|
-
[key: string]: string;
|
|
3047
|
-
}>;
|
|
3048
|
-
/**
|
|
3049
|
-
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3050
|
-
*/
|
|
3051
|
-
type: MetadataAction.Type;
|
|
3052
|
-
}
|
|
3053
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3054
|
-
interface SetPauseCollection {
|
|
3055
|
-
/**
|
|
3056
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
3057
|
-
*/
|
|
3058
|
-
set?: SetPauseCollection.Set;
|
|
3059
|
-
/**
|
|
3060
|
-
* Determines the type of the pause_collection amendment.
|
|
3061
|
-
*/
|
|
3062
|
-
type: SetPauseCollection.Type;
|
|
3063
|
-
}
|
|
3064
|
-
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3065
|
-
interface TrialSettings {
|
|
3066
|
-
/**
|
|
3067
|
-
* Defines how the subscription should behave when a trial ends.
|
|
3068
|
-
*/
|
|
3069
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
3070
|
-
}
|
|
3071
|
-
namespace AmendmentEnd {
|
|
3072
|
-
interface DiscountEnd {
|
|
3073
|
-
/**
|
|
3074
|
-
* The ID of a specific discount.
|
|
3075
|
-
*/
|
|
3076
|
-
discount: string;
|
|
3077
|
-
}
|
|
3078
|
-
interface Duration {
|
|
3079
|
-
/**
|
|
3080
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3081
|
-
*/
|
|
3082
|
-
interval: Duration.Interval;
|
|
3083
|
-
/**
|
|
3084
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3085
|
-
*/
|
|
3086
|
-
interval_count: number;
|
|
3087
|
-
}
|
|
3088
|
-
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3089
|
-
namespace Duration {
|
|
3090
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3091
|
-
}
|
|
3092
|
-
}
|
|
3093
|
-
namespace AmendmentStart {
|
|
3094
|
-
interface AmendmentEnd {
|
|
3095
|
-
/**
|
|
3096
|
-
* The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
|
|
3097
|
-
*/
|
|
3098
|
-
index: number;
|
|
3099
|
-
}
|
|
3100
|
-
interface DiscountEnd {
|
|
3101
|
-
/**
|
|
3102
|
-
* The ID of a specific discount.
|
|
3103
|
-
*/
|
|
3104
|
-
discount: string;
|
|
3105
|
-
}
|
|
3106
|
-
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3107
|
-
}
|
|
3108
|
-
namespace BillingSchedulesAction {
|
|
3109
|
-
interface AppliesTo {
|
|
3110
|
-
/**
|
|
3111
|
-
* The ID of the price object.
|
|
3112
|
-
*/
|
|
3113
|
-
price?: string;
|
|
3114
|
-
/**
|
|
3115
|
-
* Controls which subscription items the billing schedule applies to.
|
|
3116
|
-
*/
|
|
3117
|
-
type: 'price';
|
|
3118
|
-
}
|
|
3119
|
-
type Type = 'remove' | 'set';
|
|
3120
|
-
}
|
|
3121
|
-
namespace DiscountAction {
|
|
3122
|
-
interface Add {
|
|
3123
|
-
/**
|
|
3124
|
-
* The coupon code to redeem.
|
|
3125
|
-
*/
|
|
3126
|
-
coupon?: string;
|
|
3127
|
-
/**
|
|
3128
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3129
|
-
*/
|
|
3130
|
-
discount?: string;
|
|
3131
|
-
/**
|
|
3132
|
-
* Details to determine how long the discount should be applied for.
|
|
3133
|
-
*/
|
|
3134
|
-
discount_end?: Add.DiscountEnd;
|
|
3135
|
-
/**
|
|
3136
|
-
* 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.
|
|
3137
|
-
*/
|
|
3138
|
-
index?: number;
|
|
3139
|
-
/**
|
|
3140
|
-
* The promotion code to redeem.
|
|
3141
|
-
*/
|
|
3142
|
-
promotion_code?: string;
|
|
3143
|
-
/**
|
|
3144
|
-
* Settings for discount application including service period anchoring.
|
|
3145
|
-
*/
|
|
3146
|
-
settings?: Add.Settings;
|
|
3147
|
-
}
|
|
3148
|
-
interface Remove {
|
|
3149
|
-
/**
|
|
3150
|
-
* The coupon code to remove from the `discounts` array.
|
|
3151
|
-
*/
|
|
3152
|
-
coupon?: string;
|
|
3153
|
-
/**
|
|
3154
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
3155
|
-
*/
|
|
3156
|
-
discount?: string;
|
|
3157
|
-
/**
|
|
3158
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
3159
|
-
*/
|
|
3160
|
-
promotion_code?: string;
|
|
3161
|
-
}
|
|
3162
|
-
interface Set {
|
|
3163
|
-
/**
|
|
3164
|
-
* The coupon code to replace the `discounts` array with.
|
|
3165
|
-
*/
|
|
3166
|
-
coupon?: string;
|
|
3167
|
-
/**
|
|
3168
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
3169
|
-
*/
|
|
3170
|
-
discount?: string;
|
|
3171
|
-
/**
|
|
3172
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3173
|
-
*/
|
|
3174
|
-
promotion_code?: string;
|
|
3175
|
-
/**
|
|
3176
|
-
* Settings for discount application including service period anchoring.
|
|
3177
|
-
*/
|
|
3178
|
-
settings?: Set.Settings;
|
|
3179
|
-
}
|
|
3180
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3181
|
-
namespace Add {
|
|
3182
|
-
interface DiscountEnd {
|
|
3183
|
-
/**
|
|
3184
|
-
* The type of calculation made to determine when the discount ends.
|
|
3185
|
-
*/
|
|
3186
|
-
type: 'amendment_end';
|
|
3187
|
-
}
|
|
3188
|
-
interface Settings {
|
|
3189
|
-
/**
|
|
3190
|
-
* Configures service period cycle anchoring.
|
|
3191
|
-
*/
|
|
3192
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3193
|
-
/**
|
|
3194
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3195
|
-
*/
|
|
3196
|
-
start_date?: Settings.StartDate;
|
|
3197
|
-
}
|
|
3198
|
-
namespace Settings {
|
|
3199
|
-
interface ServicePeriodAnchorConfig {
|
|
3200
|
-
/**
|
|
3201
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3202
|
-
*/
|
|
3203
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3204
|
-
/**
|
|
3205
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3206
|
-
*/
|
|
3207
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3208
|
-
}
|
|
3209
|
-
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3210
|
-
namespace ServicePeriodAnchorConfig {
|
|
3211
|
-
interface Custom {
|
|
3212
|
-
/**
|
|
3213
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3214
|
-
*/
|
|
3215
|
-
day_of_month: number;
|
|
3216
|
-
/**
|
|
3217
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3218
|
-
*/
|
|
3219
|
-
hour?: number;
|
|
3220
|
-
/**
|
|
3221
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3222
|
-
*/
|
|
3223
|
-
minute?: number;
|
|
3224
|
-
/**
|
|
3225
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3226
|
-
*/
|
|
3227
|
-
month?: number;
|
|
3228
|
-
/**
|
|
3229
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3230
|
-
*/
|
|
3231
|
-
second?: number;
|
|
3232
|
-
}
|
|
3233
|
-
type Type = 'custom' | 'inherit';
|
|
3234
|
-
}
|
|
3235
|
-
}
|
|
3236
|
-
}
|
|
3237
|
-
namespace Set {
|
|
3238
|
-
interface Settings {
|
|
3239
|
-
/**
|
|
3240
|
-
* Configures service period cycle anchoring.
|
|
3241
|
-
*/
|
|
3242
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3243
|
-
/**
|
|
3244
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3245
|
-
*/
|
|
3246
|
-
start_date?: Settings.StartDate;
|
|
3247
|
-
}
|
|
3248
|
-
namespace Settings {
|
|
3249
|
-
interface ServicePeriodAnchorConfig {
|
|
3250
|
-
/**
|
|
3251
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3252
|
-
*/
|
|
3253
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3254
|
-
/**
|
|
3255
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3256
|
-
*/
|
|
3257
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3258
|
-
}
|
|
3259
|
-
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3260
|
-
namespace ServicePeriodAnchorConfig {
|
|
3261
|
-
interface Custom {
|
|
3262
|
-
/**
|
|
3263
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3264
|
-
*/
|
|
3265
|
-
day_of_month: number;
|
|
3266
|
-
/**
|
|
3267
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3268
|
-
*/
|
|
3269
|
-
hour?: number;
|
|
3270
|
-
/**
|
|
3271
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3272
|
-
*/
|
|
3273
|
-
minute?: number;
|
|
3274
|
-
/**
|
|
3275
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3276
|
-
*/
|
|
3277
|
-
month?: number;
|
|
3278
|
-
/**
|
|
3279
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3280
|
-
*/
|
|
3281
|
-
second?: number;
|
|
3282
|
-
}
|
|
3283
|
-
type Type = 'custom' | 'inherit';
|
|
3284
|
-
}
|
|
3285
|
-
}
|
|
3286
|
-
}
|
|
3287
|
-
}
|
|
3288
|
-
namespace ItemAction {
|
|
3289
|
-
interface Add {
|
|
3290
|
-
/**
|
|
3291
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3292
|
-
*/
|
|
3293
|
-
discounts?: Array<Add.Discount>;
|
|
3294
|
-
/**
|
|
3295
|
-
* 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`.
|
|
3296
|
-
*/
|
|
3297
|
-
metadata?: MetadataParam;
|
|
3298
|
-
/**
|
|
3299
|
-
* The ID of the price object.
|
|
3300
|
-
*/
|
|
3301
|
-
price: string;
|
|
3302
|
-
/**
|
|
3303
|
-
* Quantity for this item.
|
|
3304
|
-
*/
|
|
3305
|
-
quantity?: number;
|
|
3306
|
-
/**
|
|
3307
|
-
* 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`.
|
|
3308
|
-
*/
|
|
3309
|
-
tax_rates?: Array<string>;
|
|
3310
|
-
/**
|
|
3311
|
-
* Options that configure the trial on the subscription item.
|
|
3312
|
-
*/
|
|
3313
|
-
trial?: Add.Trial;
|
|
3314
|
-
/**
|
|
3315
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3316
|
-
*/
|
|
3317
|
-
trial_offer?: string;
|
|
3318
|
-
}
|
|
3319
|
-
interface Remove {
|
|
3320
|
-
/**
|
|
3321
|
-
* ID of a price to remove.
|
|
3322
|
-
*/
|
|
3323
|
-
price: string;
|
|
3324
|
-
}
|
|
3325
|
-
interface Set {
|
|
3326
|
-
/**
|
|
3327
|
-
* 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`.
|
|
3328
|
-
*/
|
|
3329
|
-
discounts?: Array<Set.Discount>;
|
|
3330
|
-
/**
|
|
3331
|
-
* 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`.
|
|
3332
|
-
*/
|
|
3333
|
-
metadata?: MetadataParam;
|
|
3334
|
-
/**
|
|
3335
|
-
* The ID of the price object.
|
|
3336
|
-
*/
|
|
3337
|
-
price: string;
|
|
3338
|
-
/**
|
|
3339
|
-
* 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`.
|
|
3340
|
-
*/
|
|
3341
|
-
quantity?: number;
|
|
3342
|
-
/**
|
|
3343
|
-
* 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`.
|
|
3344
|
-
*/
|
|
3345
|
-
tax_rates?: Array<string>;
|
|
3346
|
-
/**
|
|
3347
|
-
* 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`.
|
|
3348
|
-
*/
|
|
3349
|
-
trial?: Set.Trial;
|
|
3350
|
-
/**
|
|
3351
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3352
|
-
*/
|
|
3353
|
-
trial_offer?: string;
|
|
3354
|
-
}
|
|
3355
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3356
|
-
namespace Add {
|
|
3357
|
-
interface Discount {
|
|
3358
|
-
/**
|
|
3359
|
-
* ID of the coupon to create a new discount for.
|
|
3360
|
-
*/
|
|
3361
|
-
coupon?: string;
|
|
3362
|
-
/**
|
|
3363
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3364
|
-
*/
|
|
3365
|
-
discount?: string;
|
|
3366
|
-
/**
|
|
3367
|
-
* Details to determine how long the discount should be applied for.
|
|
3368
|
-
*/
|
|
3369
|
-
discount_end?: Discount.DiscountEnd;
|
|
3370
|
-
/**
|
|
3371
|
-
* ID of the promotion code to create a new discount for.
|
|
3372
|
-
*/
|
|
3373
|
-
promotion_code?: string;
|
|
3374
|
-
/**
|
|
3375
|
-
* Settings for discount application including service period anchoring.
|
|
3376
|
-
*/
|
|
3377
|
-
settings?: Discount.Settings;
|
|
3378
|
-
}
|
|
3379
|
-
interface Trial {
|
|
3380
|
-
/**
|
|
3381
|
-
* 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.
|
|
3382
|
-
*/
|
|
3383
|
-
converts_to?: Array<string>;
|
|
3384
|
-
/**
|
|
3385
|
-
* Determines the type of trial for this item.
|
|
3386
|
-
*/
|
|
3387
|
-
type: Trial.Type;
|
|
3388
|
-
}
|
|
3389
|
-
namespace Discount {
|
|
3390
|
-
interface DiscountEnd {
|
|
3391
|
-
/**
|
|
3392
|
-
* Time span for the redeemed discount.
|
|
3393
|
-
*/
|
|
3394
|
-
duration?: DiscountEnd.Duration;
|
|
3395
|
-
/**
|
|
3396
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3397
|
-
*/
|
|
3398
|
-
timestamp?: number;
|
|
3399
|
-
/**
|
|
3400
|
-
* The type of calculation made to determine when the discount ends.
|
|
3401
|
-
*/
|
|
3402
|
-
type: DiscountEnd.Type;
|
|
3403
|
-
}
|
|
3404
|
-
interface Settings {
|
|
3405
|
-
/**
|
|
3406
|
-
* Configures service period cycle anchoring.
|
|
3407
|
-
*/
|
|
3408
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3409
|
-
/**
|
|
3410
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3411
|
-
*/
|
|
3412
|
-
start_date?: Settings.StartDate;
|
|
3413
|
-
}
|
|
3414
|
-
namespace DiscountEnd {
|
|
3415
|
-
interface Duration {
|
|
3416
|
-
/**
|
|
3417
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3418
|
-
*/
|
|
3419
|
-
interval: Duration.Interval;
|
|
3420
|
-
/**
|
|
3421
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3422
|
-
*/
|
|
3423
|
-
interval_count: number;
|
|
3424
|
-
}
|
|
3425
|
-
type Type = 'duration' | 'timestamp';
|
|
3426
|
-
namespace Duration {
|
|
3427
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3428
|
-
}
|
|
3429
|
-
}
|
|
3430
|
-
namespace Settings {
|
|
3431
|
-
interface ServicePeriodAnchorConfig {
|
|
3432
|
-
/**
|
|
3433
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3434
|
-
*/
|
|
3435
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3436
|
-
/**
|
|
3437
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3438
|
-
*/
|
|
3439
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3440
|
-
}
|
|
3441
|
-
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3442
|
-
namespace ServicePeriodAnchorConfig {
|
|
3443
|
-
interface Custom {
|
|
3444
|
-
/**
|
|
3445
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3446
|
-
*/
|
|
3447
|
-
day_of_month: number;
|
|
3448
|
-
/**
|
|
3449
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3450
|
-
*/
|
|
3451
|
-
hour?: number;
|
|
3452
|
-
/**
|
|
3453
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3454
|
-
*/
|
|
3455
|
-
minute?: number;
|
|
3456
|
-
/**
|
|
3457
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3458
|
-
*/
|
|
3459
|
-
month?: number;
|
|
3460
|
-
/**
|
|
3461
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3462
|
-
*/
|
|
3463
|
-
second?: number;
|
|
3464
|
-
}
|
|
3465
|
-
type Type = 'custom' | 'inherit';
|
|
3466
|
-
}
|
|
3467
|
-
}
|
|
3468
|
-
}
|
|
3469
|
-
namespace Trial {
|
|
3470
|
-
type Type = 'free' | 'paid';
|
|
3471
|
-
}
|
|
3472
|
-
}
|
|
3473
|
-
namespace Set {
|
|
3474
|
-
interface Discount {
|
|
3475
|
-
/**
|
|
3476
|
-
* ID of the coupon to create a new discount for.
|
|
3477
|
-
*/
|
|
3478
|
-
coupon?: string;
|
|
3479
|
-
/**
|
|
3480
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3481
|
-
*/
|
|
3482
|
-
discount?: string;
|
|
3483
|
-
/**
|
|
3484
|
-
* Details to determine how long the discount should be applied for.
|
|
3485
|
-
*/
|
|
3486
|
-
discount_end?: Discount.DiscountEnd;
|
|
3487
|
-
/**
|
|
3488
|
-
* ID of the promotion code to create a new discount for.
|
|
3489
|
-
*/
|
|
3490
|
-
promotion_code?: string;
|
|
3491
|
-
/**
|
|
3492
|
-
* Settings for discount application including service period anchoring.
|
|
3493
|
-
*/
|
|
3494
|
-
settings?: Discount.Settings;
|
|
3495
|
-
}
|
|
3496
|
-
interface Trial {
|
|
3497
|
-
/**
|
|
3498
|
-
* 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.
|
|
3499
|
-
*/
|
|
3500
|
-
converts_to?: Array<string>;
|
|
3501
|
-
/**
|
|
3502
|
-
* Determines the type of trial for this item.
|
|
3503
|
-
*/
|
|
3504
|
-
type: Trial.Type;
|
|
3505
|
-
}
|
|
3506
|
-
namespace Discount {
|
|
3507
|
-
interface DiscountEnd {
|
|
3508
|
-
/**
|
|
3509
|
-
* Time span for the redeemed discount.
|
|
3510
|
-
*/
|
|
3511
|
-
duration?: DiscountEnd.Duration;
|
|
3512
|
-
/**
|
|
3513
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3514
|
-
*/
|
|
3515
|
-
timestamp?: number;
|
|
3516
|
-
/**
|
|
3517
|
-
* The type of calculation made to determine when the discount ends.
|
|
3518
|
-
*/
|
|
3519
|
-
type: DiscountEnd.Type;
|
|
3520
|
-
}
|
|
3521
|
-
interface Settings {
|
|
3522
|
-
/**
|
|
3523
|
-
* Configures service period cycle anchoring.
|
|
3524
|
-
*/
|
|
3525
|
-
service_period_anchor_config?: Settings.ServicePeriodAnchorConfig;
|
|
3526
|
-
/**
|
|
3527
|
-
* The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `amendment_start` if omitted.
|
|
3528
|
-
*/
|
|
3529
|
-
start_date?: Settings.StartDate;
|
|
3530
|
-
}
|
|
3531
|
-
namespace DiscountEnd {
|
|
3532
|
-
interface Duration {
|
|
3533
|
-
/**
|
|
3534
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3535
|
-
*/
|
|
3536
|
-
interval: Duration.Interval;
|
|
3537
|
-
/**
|
|
3538
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3539
|
-
*/
|
|
3540
|
-
interval_count: number;
|
|
3541
|
-
}
|
|
3542
|
-
type Type = 'duration' | 'timestamp';
|
|
3543
|
-
namespace Duration {
|
|
3544
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3545
|
-
}
|
|
3546
|
-
}
|
|
3547
|
-
namespace Settings {
|
|
3548
|
-
interface ServicePeriodAnchorConfig {
|
|
3549
|
-
/**
|
|
3550
|
-
* Anchor the service period to a custom date. Type must be `custom` to specify.
|
|
3551
|
-
*/
|
|
3552
|
-
custom?: ServicePeriodAnchorConfig.Custom;
|
|
3553
|
-
/**
|
|
3554
|
-
* The type of service period anchor config. Defaults to `inherit` if omitted.
|
|
3555
|
-
*/
|
|
3556
|
-
type?: ServicePeriodAnchorConfig.Type;
|
|
3557
|
-
}
|
|
3558
|
-
type StartDate = 'amendment_start' | 'current_period_end' | 'current_period_start';
|
|
3559
|
-
namespace ServicePeriodAnchorConfig {
|
|
3560
|
-
interface Custom {
|
|
3561
|
-
/**
|
|
3562
|
-
* The day of the month the anchor should be. Ranges from 1 to 31.
|
|
3563
|
-
*/
|
|
3564
|
-
day_of_month: number;
|
|
3565
|
-
/**
|
|
3566
|
-
* The hour of the day the anchor should be. Ranges from 0 to 23.
|
|
3567
|
-
*/
|
|
3568
|
-
hour?: number;
|
|
3569
|
-
/**
|
|
3570
|
-
* The minute of the hour the anchor should be. Ranges from 0 to 59.
|
|
3571
|
-
*/
|
|
3572
|
-
minute?: number;
|
|
3573
|
-
/**
|
|
3574
|
-
* The month to start full cycle periods. Ranges from 1 to 12.
|
|
3575
|
-
*/
|
|
3576
|
-
month?: number;
|
|
3577
|
-
/**
|
|
3578
|
-
* The second of the minute the anchor should be. Ranges from 0 to 59.
|
|
3579
|
-
*/
|
|
3580
|
-
second?: number;
|
|
3581
|
-
}
|
|
3582
|
-
type Type = 'custom' | 'inherit';
|
|
3583
|
-
}
|
|
3584
|
-
}
|
|
3585
|
-
}
|
|
3586
|
-
namespace Trial {
|
|
3587
|
-
type Type = 'free' | 'paid';
|
|
3588
|
-
}
|
|
3589
|
-
}
|
|
3590
|
-
}
|
|
3591
|
-
namespace MetadataAction {
|
|
3592
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3593
|
-
}
|
|
3594
|
-
namespace SetPauseCollection {
|
|
3595
|
-
interface Set {
|
|
3596
|
-
/**
|
|
3597
|
-
* The payment collection behavior for this subscription while paused.
|
|
3598
|
-
*/
|
|
3599
|
-
behavior: Set.Behavior;
|
|
3600
|
-
}
|
|
3601
|
-
type Type = 'remove' | 'set';
|
|
3602
|
-
namespace Set {
|
|
3603
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3604
|
-
}
|
|
3605
|
-
}
|
|
3606
|
-
namespace TrialSettings {
|
|
3607
|
-
interface EndBehavior {
|
|
3608
|
-
/**
|
|
3609
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3610
|
-
*/
|
|
3611
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3612
|
-
}
|
|
3613
|
-
namespace EndBehavior {
|
|
3614
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
3615
|
-
}
|
|
3616
|
-
}
|
|
3617
|
-
}
|
|
3618
|
-
namespace Prebilling {
|
|
3619
|
-
interface BillFrom {
|
|
3620
|
-
/**
|
|
3621
|
-
* Start the prebilled period when a specified amendment begins.
|
|
3622
|
-
*/
|
|
3623
|
-
amendment_start?: BillFrom.AmendmentStart;
|
|
3624
|
-
/**
|
|
3625
|
-
* Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3626
|
-
*/
|
|
3627
|
-
timestamp?: number;
|
|
3628
|
-
/**
|
|
3629
|
-
* Select one of several ways to pass the `bill_from` value.
|
|
3630
|
-
*/
|
|
3631
|
-
type: BillFrom.Type;
|
|
3632
|
-
}
|
|
3633
|
-
interface BillUntil {
|
|
3634
|
-
/**
|
|
3635
|
-
* End the prebilled period when a specified amendment ends.
|
|
3636
|
-
*/
|
|
3637
|
-
amendment_end?: BillUntil.AmendmentEnd;
|
|
3638
|
-
/**
|
|
3639
|
-
* Time span for prebilling, starting from `bill_from`.
|
|
3640
|
-
*/
|
|
3641
|
-
duration?: BillUntil.Duration;
|
|
3642
|
-
/**
|
|
3643
|
-
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
3644
|
-
*/
|
|
3645
|
-
timestamp?: number;
|
|
3646
|
-
/**
|
|
3647
|
-
* Select one of several ways to pass the `bill_until` value.
|
|
3648
|
-
*/
|
|
3649
|
-
type: BillUntil.Type;
|
|
3650
|
-
}
|
|
3651
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
3652
|
-
namespace BillFrom {
|
|
3653
|
-
interface AmendmentStart {
|
|
3654
|
-
/**
|
|
3655
|
-
* The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
3656
|
-
*/
|
|
3657
|
-
index: number;
|
|
3658
|
-
}
|
|
3659
|
-
type Type = 'amendment_start' | 'now' | 'timestamp';
|
|
3660
|
-
}
|
|
3661
|
-
namespace BillUntil {
|
|
3662
|
-
interface AmendmentEnd {
|
|
3663
|
-
/**
|
|
3664
|
-
* The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
3665
|
-
*/
|
|
3666
|
-
index: number;
|
|
3667
|
-
}
|
|
3668
|
-
interface Duration {
|
|
3669
|
-
/**
|
|
3670
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3671
|
-
*/
|
|
3672
|
-
interval: Duration.Interval;
|
|
3673
|
-
/**
|
|
3674
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3675
|
-
*/
|
|
3676
|
-
interval_count: number;
|
|
3677
|
-
}
|
|
3678
|
-
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
3679
|
-
namespace Duration {
|
|
3680
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3681
|
-
}
|
|
3682
|
-
}
|
|
3683
|
-
}
|
|
3684
|
-
namespace ScheduleSettings {
|
|
3685
|
-
type EndBehavior = 'cancel' | 'release';
|
|
3686
|
-
}
|
|
3687
|
-
}
|
|
3688
1767
|
export interface SubscriptionScheduleCancelParams {
|
|
3689
1768
|
/**
|
|
3690
1769
|
* Specifies which fields in the response should be expanded.
|
|
@@ -3709,11 +1788,3 @@ export interface SubscriptionScheduleReleaseParams {
|
|
|
3709
1788
|
*/
|
|
3710
1789
|
preserve_cancel_date?: boolean;
|
|
3711
1790
|
}
|
|
3712
|
-
export interface SubscriptionScheduleSerializeBatchCancelParams {
|
|
3713
|
-
}
|
|
3714
|
-
export interface SubscriptionScheduleSerializeBatchCreateParams {
|
|
3715
|
-
}
|
|
3716
|
-
export interface SubscriptionScheduleSerializeBatchReleaseParams {
|
|
3717
|
-
}
|
|
3718
|
-
export interface SubscriptionScheduleSerializeBatchUpdateParams {
|
|
3719
|
-
}
|