stripe 22.2.0-beta.3 → 22.2.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 +84 -1730
- package/OPENAPI_VERSION +1 -1
- package/README.md +65 -57
- package/VERSION +1 -1
- package/cjs/Error.d.ts +0 -50
- package/cjs/Error.js +1 -125
- package/cjs/Error.js.map +1 -1
- package/cjs/RequestSender.d.ts +1 -0
- package/cjs/RequestSender.js +10 -2
- package/cjs/RequestSender.js.map +1 -1
- package/cjs/Types.d.ts +2 -4
- package/cjs/Types.js.map +1 -1
- package/cjs/apiVersion.d.ts +2 -1
- package/cjs/apiVersion.js +3 -2
- package/cjs/apiVersion.js.map +1 -1
- package/cjs/lib.d.ts +48 -3
- package/cjs/net/FetchHttpClient.js.map +1 -1
- package/cjs/net/HttpClient.js.map +1 -1
- package/cjs/platform/NodePlatformFunctions.d.ts +6 -0
- package/cjs/platform/NodePlatformFunctions.js +17 -0
- package/cjs/platform/NodePlatformFunctions.js.map +1 -1
- package/cjs/platform/PlatformFunctions.d.ts +13 -0
- package/cjs/platform/PlatformFunctions.js +21 -0
- package/cjs/platform/PlatformFunctions.js.map +1 -1
- package/cjs/resources/AccountLinks.d.ts +1 -1
- package/cjs/resources/AccountSessions.d.ts +0 -262
- package/cjs/resources/AccountSessions.js.map +1 -1
- package/cjs/resources/Accounts.d.ts +45 -819
- package/cjs/resources/Accounts.js +0 -15
- package/cjs/resources/Accounts.js.map +1 -1
- package/cjs/resources/Apps/index.d.ts +4 -4
- package/cjs/resources/Balance.d.ts +0 -67
- package/cjs/resources/BalanceSettings.d.ts +86 -0
- package/cjs/resources/BankAccounts.d.ts +2 -2
- package/cjs/resources/Billing/AlertTriggereds.d.ts +1 -2
- package/cjs/resources/Billing/index.d.ts +24 -27
- package/cjs/resources/Billing/index.js +0 -2
- package/cjs/resources/Billing/index.js.map +1 -1
- package/cjs/resources/BillingPortal/index.d.ts +5 -5
- package/cjs/resources/Capabilities.d.ts +2 -2
- package/cjs/resources/Cards.d.ts +0 -4
- package/cjs/resources/Charges.d.ts +92 -3064
- package/cjs/resources/Checkout/Sessions.d.ts +51 -414
- package/cjs/resources/Checkout/index.d.ts +6 -6
- package/cjs/resources/Climate/index.d.ts +9 -9
- package/cjs/resources/ConfirmationTokens.d.ts +7 -67
- package/cjs/resources/Coupons.d.ts +0 -47
- package/cjs/resources/CreditNoteLineItems.d.ts +1 -15
- package/cjs/resources/CreditNotes.d.ts +1 -7
- package/cjs/resources/CreditNotes.js +0 -14
- package/cjs/resources/CreditNotes.js.map +1 -1
- package/cjs/resources/CustomerSessions.d.ts +0 -68
- package/cjs/resources/Customers.d.ts +1 -7
- package/cjs/resources/Customers.js +0 -15
- package/cjs/resources/Customers.js.map +1 -1
- package/cjs/resources/Discounts.d.ts +4 -4
- package/cjs/resources/Disputes.d.ts +0 -29
- package/cjs/resources/Entitlements/index.d.ts +6 -6
- package/cjs/resources/Events.d.ts +2 -547
- package/cjs/resources/ExternalAccounts.d.ts +1 -212
- package/cjs/resources/ExternalAccounts.js +0 -44
- package/cjs/resources/ExternalAccounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Accounts.d.ts +4 -74
- package/cjs/resources/FinancialConnections/Accounts.js +0 -8
- package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
- package/cjs/resources/FinancialConnections/Sessions.d.ts +7 -155
- package/cjs/resources/FinancialConnections/index.d.ts +13 -28
- package/cjs/resources/FinancialConnections/index.js +0 -4
- package/cjs/resources/FinancialConnections/index.js.map +1 -1
- package/cjs/resources/Forwarding/index.d.ts +3 -3
- package/cjs/resources/Identity/index.d.ts +8 -8
- package/cjs/resources/InvoiceItems.d.ts +28 -85
- package/cjs/resources/InvoiceItems.js.map +1 -1
- package/cjs/resources/InvoiceLineItems.d.ts +2 -40
- package/cjs/resources/Invoices.d.ts +26 -1348
- package/cjs/resources/Invoices.js +0 -70
- package/cjs/resources/Invoices.js.map +1 -1
- package/cjs/resources/Issuing/Cardholders.d.ts +1 -2
- package/cjs/resources/Issuing/Disputes.d.ts +1 -1
- package/cjs/resources/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/cjs/resources/Issuing/Transactions.d.ts +0 -9
- package/cjs/resources/Issuing/Transactions.js.map +1 -1
- package/cjs/resources/Issuing/index.d.ts +35 -60
- package/cjs/resources/Issuing/index.js +0 -6
- package/cjs/resources/Issuing/index.js.map +1 -1
- package/cjs/resources/LineItems.d.ts +2 -29
- package/cjs/resources/Mandates.d.ts +4 -33
- package/cjs/resources/Mandates.js +0 -8
- package/cjs/resources/Mandates.js.map +1 -1
- package/cjs/resources/OAuth.d.ts +7 -8
- package/cjs/resources/PaymentAttemptRecords.d.ts +23 -92
- package/cjs/resources/PaymentIntents.d.ts +6510 -17236
- package/cjs/resources/PaymentIntents.js +3 -28
- package/cjs/resources/PaymentIntents.js.map +1 -1
- package/cjs/resources/PaymentLinks.d.ts +88 -20
- package/cjs/resources/PaymentMethodConfigurations.d.ts +93 -299
- package/cjs/resources/PaymentMethods.d.ts +22 -152
- package/cjs/resources/PaymentMethods.js.map +1 -1
- package/cjs/resources/PaymentRecords.d.ts +23 -92
- package/cjs/resources/Payouts.d.ts +1 -1
- package/cjs/resources/Persons.d.ts +2 -2
- package/cjs/resources/Plans.d.ts +0 -16
- package/cjs/resources/Prices.d.ts +0 -52
- package/cjs/resources/Products.d.ts +0 -42
- package/cjs/resources/PromotionCodes.d.ts +0 -12
- package/cjs/resources/PromotionCodes.js +0 -28
- package/cjs/resources/PromotionCodes.js.map +1 -1
- package/cjs/resources/Quotes.d.ts +160 -2369
- package/cjs/resources/Quotes.js +13 -1181
- package/cjs/resources/Quotes.js.map +1 -1
- package/cjs/resources/Radar/PaymentEvaluations.d.ts +2 -2
- package/cjs/resources/Radar/index.d.ts +12 -12
- package/cjs/resources/Refunds.d.ts +3 -11
- package/cjs/resources/Reporting/index.d.ts +5 -5
- package/cjs/resources/Reserve/Holds.d.ts +1 -53
- package/cjs/resources/Reserve/Holds.js +0 -19
- package/cjs/resources/Reserve/Holds.js.map +1 -1
- package/cjs/resources/Reserve/Plans.d.ts +0 -16
- package/cjs/resources/Reserve/Plans.js +0 -11
- package/cjs/resources/Reserve/Plans.js.map +1 -1
- package/cjs/resources/Reserve/Releases.d.ts +1 -41
- package/cjs/resources/Reserve/Releases.js +0 -19
- package/cjs/resources/Reserve/Releases.js.map +1 -1
- package/cjs/resources/Reserve/index.d.ts +3 -14
- package/cjs/resources/Reserve/index.js +2 -10
- package/cjs/resources/Reserve/index.js.map +1 -1
- package/cjs/resources/SetupAttempts.d.ts +3 -25
- package/cjs/resources/SetupIntents.d.ts +77 -336
- package/cjs/resources/Sigma/index.d.ts +2 -2
- package/cjs/resources/Sources.d.ts +1 -16
- package/cjs/resources/SubscriptionItems.d.ts +4 -165
- package/cjs/resources/SubscriptionSchedules.d.ts +16 -1174
- package/cjs/resources/SubscriptionSchedules.js +0 -48
- package/cjs/resources/SubscriptionSchedules.js.map +1 -1
- package/cjs/resources/Subscriptions.d.ts +32 -490
- package/cjs/resources/Subscriptions.js +2 -31
- package/cjs/resources/Subscriptions.js.map +1 -1
- package/cjs/resources/Tax/CalculationLineItems.d.ts +2 -6
- package/cjs/resources/Tax/Calculations.d.ts +3 -7
- package/cjs/resources/Tax/Registrations.d.ts +2 -138
- package/cjs/resources/Tax/Transactions.d.ts +2 -2
- package/cjs/resources/Tax/index.d.ts +17 -31
- 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/Terminal/Configurations.d.ts +108 -27
- package/cjs/resources/Terminal/Readers.d.ts +143 -19
- package/cjs/resources/Terminal/Readers.js.map +1 -1
- package/cjs/resources/Terminal/index.d.ts +25 -30
- package/cjs/resources/Terminal/index.js +0 -2
- package/cjs/resources/Terminal/index.js.map +1 -1
- package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +14 -79
- package/cjs/resources/TestHelpers/TestClocks.d.ts +4 -0
- 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 +5 -8
- package/cjs/resources/TestHelpers/index.js +4 -6
- package/cjs/resources/TestHelpers/index.js.map +1 -1
- package/cjs/resources/Transfers.d.ts +0 -8
- package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +0 -5
- package/cjs/resources/Treasury/FinancialAccounts.d.ts +1 -34
- package/cjs/resources/Treasury/OutboundPayments.d.ts +0 -8
- package/cjs/resources/Treasury/OutboundTransfers.d.ts +0 -44
- package/cjs/resources/Treasury/ReceivedCredits.d.ts +0 -22
- package/cjs/resources/Treasury/ReceivedDebits.d.ts +0 -26
- package/cjs/resources/Treasury/index.d.ts +33 -33
- package/cjs/resources/V2/Billing/index.d.ts +6 -45
- package/cjs/resources/V2/Billing/index.js +0 -8
- package/cjs/resources/V2/Billing/index.js.map +1 -1
- package/cjs/resources/V2/Commerce/ProductCatalog/Imports.d.ts +2 -2
- package/cjs/resources/V2/Core/AccountLinks.d.ts +4 -4
- package/cjs/resources/V2/Core/AccountTokens.d.ts +32 -14
- package/cjs/resources/V2/Core/AccountTokens.js +5 -1
- package/cjs/resources/V2/Core/AccountTokens.js.map +1 -1
- package/cjs/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/cjs/resources/V2/Core/Accounts.d.ts +233 -1171
- package/cjs/resources/V2/Core/Accounts.js +1 -1
- package/cjs/resources/V2/Core/EventDestinations.d.ts +2 -2
- package/cjs/resources/V2/Core/Events.d.ts +8 -1126
- package/cjs/resources/V2/Core/Events.js +2 -1
- package/cjs/resources/V2/Core/Events.js.map +1 -1
- package/cjs/resources/V2/Core/index.d.ts +19 -29
- package/cjs/resources/V2/Core/index.js +0 -4
- package/cjs/resources/V2/Core/index.js.map +1 -1
- package/cjs/resources/V2/index.d.ts +0 -27
- package/cjs/resources/V2/index.js +0 -14
- package/cjs/resources/V2/index.js.map +1 -1
- package/cjs/resources/WebhookEndpoints.d.ts +3 -3
- package/cjs/resources.d.ts +0 -10
- package/cjs/resources.js +10 -146
- package/cjs/resources.js.map +1 -1
- package/cjs/stripe.core.d.ts +29 -69
- package/cjs/stripe.core.js +44 -61
- package/cjs/stripe.core.js.map +1 -1
- package/cjs/utils.d.ts +0 -2
- package/cjs/utils.js +1 -16
- package/cjs/utils.js.map +1 -1
- package/esm/Error.d.ts +0 -50
- package/esm/Error.js +0 -109
- package/esm/Error.js.map +1 -1
- package/esm/RequestSender.d.ts +1 -0
- package/esm/RequestSender.js +11 -3
- package/esm/RequestSender.js.map +1 -1
- package/esm/Types.d.ts +2 -4
- package/esm/Types.js.map +1 -1
- package/esm/apiVersion.d.ts +2 -1
- package/esm/apiVersion.js +2 -1
- package/esm/apiVersion.js.map +1 -1
- package/esm/lib.d.ts +48 -3
- package/esm/net/FetchHttpClient.js.map +1 -1
- package/esm/net/HttpClient.js.map +1 -1
- package/esm/platform/NodePlatformFunctions.d.ts +6 -0
- package/esm/platform/NodePlatformFunctions.js +17 -0
- package/esm/platform/NodePlatformFunctions.js.map +1 -1
- package/esm/platform/PlatformFunctions.d.ts +13 -0
- package/esm/platform/PlatformFunctions.js +21 -0
- package/esm/platform/PlatformFunctions.js.map +1 -1
- package/esm/resources/AccountLinks.d.ts +1 -1
- package/esm/resources/AccountSessions.d.ts +0 -262
- package/esm/resources/AccountSessions.js.map +1 -1
- package/esm/resources/Accounts.d.ts +45 -819
- package/esm/resources/Accounts.js +0 -15
- package/esm/resources/Accounts.js.map +1 -1
- package/esm/resources/Apps/index.d.ts +4 -4
- package/esm/resources/Balance.d.ts +0 -67
- package/esm/resources/BalanceSettings.d.ts +86 -0
- package/esm/resources/BankAccounts.d.ts +2 -2
- package/esm/resources/Billing/AlertTriggereds.d.ts +1 -2
- package/esm/resources/Billing/index.d.ts +24 -27
- package/esm/resources/Billing/index.js +0 -2
- package/esm/resources/Billing/index.js.map +1 -1
- package/esm/resources/BillingPortal/index.d.ts +5 -5
- package/esm/resources/Capabilities.d.ts +2 -2
- package/esm/resources/Cards.d.ts +0 -4
- package/esm/resources/Charges.d.ts +92 -3064
- package/esm/resources/Checkout/Sessions.d.ts +51 -414
- package/esm/resources/Checkout/index.d.ts +6 -6
- package/esm/resources/Climate/index.d.ts +9 -9
- package/esm/resources/ConfirmationTokens.d.ts +7 -67
- package/esm/resources/Coupons.d.ts +0 -47
- package/esm/resources/CreditNoteLineItems.d.ts +1 -15
- package/esm/resources/CreditNotes.d.ts +1 -7
- package/esm/resources/CreditNotes.js +0 -14
- package/esm/resources/CreditNotes.js.map +1 -1
- package/esm/resources/CustomerSessions.d.ts +0 -68
- package/esm/resources/Customers.d.ts +1 -7
- package/esm/resources/Customers.js +0 -15
- package/esm/resources/Customers.js.map +1 -1
- package/esm/resources/Discounts.d.ts +4 -4
- package/esm/resources/Disputes.d.ts +0 -29
- package/esm/resources/Entitlements/index.d.ts +6 -6
- package/esm/resources/Events.d.ts +2 -547
- package/esm/resources/ExternalAccounts.d.ts +1 -212
- package/esm/resources/ExternalAccounts.js +1 -42
- package/esm/resources/ExternalAccounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Accounts.d.ts +4 -74
- package/esm/resources/FinancialConnections/Accounts.js +0 -8
- package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
- package/esm/resources/FinancialConnections/Sessions.d.ts +7 -155
- package/esm/resources/FinancialConnections/index.d.ts +13 -28
- package/esm/resources/FinancialConnections/index.js +0 -4
- package/esm/resources/FinancialConnections/index.js.map +1 -1
- package/esm/resources/Forwarding/index.d.ts +3 -3
- package/esm/resources/Identity/index.d.ts +8 -8
- package/esm/resources/InvoiceItems.d.ts +28 -85
- package/esm/resources/InvoiceItems.js.map +1 -1
- package/esm/resources/InvoiceLineItems.d.ts +2 -40
- package/esm/resources/Invoices.d.ts +26 -1348
- package/esm/resources/Invoices.js +0 -70
- package/esm/resources/Invoices.js.map +1 -1
- package/esm/resources/Issuing/Cardholders.d.ts +1 -2
- package/esm/resources/Issuing/Disputes.d.ts +1 -1
- package/esm/resources/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/esm/resources/Issuing/Transactions.d.ts +0 -9
- package/esm/resources/Issuing/Transactions.js.map +1 -1
- package/esm/resources/Issuing/index.d.ts +35 -60
- package/esm/resources/Issuing/index.js +0 -6
- package/esm/resources/Issuing/index.js.map +1 -1
- package/esm/resources/LineItems.d.ts +2 -29
- package/esm/resources/Mandates.d.ts +4 -33
- package/esm/resources/Mandates.js +0 -8
- package/esm/resources/Mandates.js.map +1 -1
- package/esm/resources/OAuth.d.ts +7 -8
- package/esm/resources/PaymentAttemptRecords.d.ts +23 -92
- package/esm/resources/PaymentIntents.d.ts +6510 -17236
- package/esm/resources/PaymentIntents.js +3 -28
- package/esm/resources/PaymentIntents.js.map +1 -1
- package/esm/resources/PaymentLinks.d.ts +88 -20
- package/esm/resources/PaymentMethodConfigurations.d.ts +93 -299
- package/esm/resources/PaymentMethods.d.ts +22 -152
- package/esm/resources/PaymentMethods.js.map +1 -1
- package/esm/resources/PaymentRecords.d.ts +23 -92
- package/esm/resources/Payouts.d.ts +1 -1
- package/esm/resources/Persons.d.ts +2 -2
- package/esm/resources/Plans.d.ts +0 -16
- package/esm/resources/Prices.d.ts +0 -52
- package/esm/resources/Products.d.ts +0 -42
- package/esm/resources/PromotionCodes.d.ts +0 -12
- package/esm/resources/PromotionCodes.js +0 -28
- package/esm/resources/PromotionCodes.js.map +1 -1
- package/esm/resources/Quotes.d.ts +160 -2369
- package/esm/resources/Quotes.js +13 -1181
- package/esm/resources/Quotes.js.map +1 -1
- package/esm/resources/Radar/PaymentEvaluations.d.ts +2 -2
- package/esm/resources/Radar/index.d.ts +12 -12
- package/esm/resources/Refunds.d.ts +3 -11
- package/esm/resources/Reporting/index.d.ts +5 -5
- package/esm/resources/Reserve/Holds.d.ts +1 -53
- package/esm/resources/Reserve/Holds.js +1 -17
- package/esm/resources/Reserve/Holds.js.map +1 -1
- package/esm/resources/Reserve/Plans.d.ts +0 -16
- package/esm/resources/Reserve/Plans.js +1 -9
- package/esm/resources/Reserve/Plans.js.map +1 -1
- package/esm/resources/Reserve/Releases.d.ts +1 -41
- package/esm/resources/Reserve/Releases.js +1 -17
- package/esm/resources/Reserve/Releases.js.map +1 -1
- package/esm/resources/Reserve/index.d.ts +3 -14
- package/esm/resources/Reserve/index.js +2 -10
- package/esm/resources/Reserve/index.js.map +1 -1
- package/esm/resources/SetupAttempts.d.ts +3 -25
- package/esm/resources/SetupIntents.d.ts +77 -336
- package/esm/resources/Sigma/index.d.ts +2 -2
- package/esm/resources/Sources.d.ts +1 -16
- package/esm/resources/SubscriptionItems.d.ts +4 -165
- package/esm/resources/SubscriptionSchedules.d.ts +16 -1174
- package/esm/resources/SubscriptionSchedules.js +0 -48
- package/esm/resources/SubscriptionSchedules.js.map +1 -1
- package/esm/resources/Subscriptions.d.ts +32 -490
- package/esm/resources/Subscriptions.js +2 -31
- package/esm/resources/Subscriptions.js.map +1 -1
- package/esm/resources/Tax/CalculationLineItems.d.ts +2 -6
- package/esm/resources/Tax/Calculations.d.ts +3 -7
- package/esm/resources/Tax/Registrations.d.ts +2 -138
- package/esm/resources/Tax/Transactions.d.ts +2 -2
- package/esm/resources/Tax/index.d.ts +17 -31
- 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/Terminal/Configurations.d.ts +108 -27
- package/esm/resources/Terminal/Readers.d.ts +143 -19
- package/esm/resources/Terminal/Readers.js.map +1 -1
- package/esm/resources/Terminal/index.d.ts +25 -30
- package/esm/resources/Terminal/index.js +0 -2
- package/esm/resources/Terminal/index.js.map +1 -1
- package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +14 -79
- package/esm/resources/TestHelpers/TestClocks.d.ts +4 -0
- 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 +5 -8
- package/esm/resources/TestHelpers/index.js +0 -2
- package/esm/resources/TestHelpers/index.js.map +1 -1
- package/esm/resources/Transfers.d.ts +0 -8
- package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +0 -5
- package/esm/resources/Treasury/FinancialAccounts.d.ts +1 -34
- package/esm/resources/Treasury/OutboundPayments.d.ts +0 -8
- package/esm/resources/Treasury/OutboundTransfers.d.ts +0 -44
- package/esm/resources/Treasury/ReceivedCredits.d.ts +0 -22
- package/esm/resources/Treasury/ReceivedDebits.d.ts +0 -26
- package/esm/resources/Treasury/index.d.ts +33 -33
- package/esm/resources/V2/Billing/index.d.ts +6 -45
- package/esm/resources/V2/Billing/index.js +0 -8
- package/esm/resources/V2/Billing/index.js.map +1 -1
- package/esm/resources/V2/Commerce/ProductCatalog/Imports.d.ts +2 -2
- package/esm/resources/V2/Core/AccountLinks.d.ts +4 -4
- package/esm/resources/V2/Core/AccountTokens.d.ts +32 -14
- package/esm/resources/V2/Core/AccountTokens.js +5 -1
- package/esm/resources/V2/Core/AccountTokens.js.map +1 -1
- package/esm/resources/V2/Core/Accounts/Persons.d.ts +2 -2
- package/esm/resources/V2/Core/Accounts.d.ts +233 -1171
- package/esm/resources/V2/Core/Accounts.js +1 -1
- package/esm/resources/V2/Core/EventDestinations.d.ts +2 -2
- package/esm/resources/V2/Core/Events.d.ts +8 -1126
- package/esm/resources/V2/Core/Events.js +2 -1
- package/esm/resources/V2/Core/Events.js.map +1 -1
- package/esm/resources/V2/Core/index.d.ts +19 -29
- package/esm/resources/V2/Core/index.js +0 -4
- package/esm/resources/V2/Core/index.js.map +1 -1
- package/esm/resources/V2/index.d.ts +0 -27
- package/esm/resources/V2/index.js +0 -14
- package/esm/resources/V2/index.js.map +1 -1
- package/esm/resources/WebhookEndpoints.d.ts +3 -3
- package/esm/resources.d.ts +0 -10
- package/esm/resources.js +0 -131
- package/esm/resources.js.map +1 -1
- package/esm/stripe.core.d.ts +29 -69
- package/esm/stripe.core.js +15 -32
- package/esm/stripe.core.js.map +1 -1
- package/esm/stripe.esm.node.d.ts +29 -70
- package/esm/stripe.esm.node.js +15 -32
- package/esm/stripe.esm.node.js.map +1 -1
- package/esm/utils.d.ts +0 -2
- package/esm/utils.js +0 -13
- package/esm/utils.js.map +1 -1
- package/package.json +1 -1
- package/cjs/StripeEventNotificationHandler.d.ts +0 -22
- package/cjs/StripeEventNotificationHandler.js +0 -147
- 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/Billing/Analytics/MeterUsage.d.ts +0 -84
- 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 -32
- 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/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/FxQuotes.d.ts +0 -212
- package/cjs/resources/FxQuotes.js +0 -29
- package/cjs/resources/FxQuotes.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/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/Orders.d.ts +0 -4693
- package/cjs/resources/Orders.js +0 -457
- package/cjs/resources/Orders.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/QuoteLines.d.ts +0 -507
- package/cjs/resources/QuoteLines.js +0 -4
- package/cjs/resources/QuoteLines.js.map +0 -1
- package/cjs/resources/QuotePreviewInvoices.d.ts +0 -1116
- package/cjs/resources/QuotePreviewInvoices.js +0 -4
- package/cjs/resources/QuotePreviewInvoices.js.map +0 -1
- package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -733
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js +0 -4
- package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/cjs/resources/SharedPayment/GrantedTokens.d.ts +0 -1089
- 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 -308
- 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/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/SharedPayment/GrantedTokens.d.ts +0 -68
- 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/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/Cadences.d.ts +0 -951
- package/cjs/resources/V2/Billing/Cadences.js +0 -198
- 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/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/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/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 -254
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -62
- 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/Reporting/QueryRuns.d.ts +0 -156
- 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 -10
- package/cjs/resources/V2/Data/index.js +0 -13
- package/cjs/resources/V2/Data/index.js.map +0 -1
- package/cjs/resources/V2/EventMisc.d.ts +0 -0
- package/cjs/resources/V2/EventMisc.js +0 -2
- package/cjs/resources/V2/EventMisc.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 -204
- package/cjs/resources/V2/Iam/ActivityLogs.js +0 -17
- package/cjs/resources/V2/Iam/ActivityLogs.js.map +0 -1
- package/cjs/resources/V2/Iam/index.d.ts +0 -12
- package/cjs/resources/V2/Iam/index.js +0 -13
- package/cjs/resources/V2/Iam/index.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +0 -135
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -23
- package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -244
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -44
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -215
- 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 -212
- 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 -388
- 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 -299
- 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 -330
- 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 -243
- 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 -292
- 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 -161
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -23
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -165
- 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 -196
- 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 -104
- package/cjs/resources/V2/MoneyManagement/index.js +0 -39
- 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/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/index.d.ts +0 -8
- package/cjs/resources/V2/TestHelpers/index.js +0 -13
- package/cjs/resources/V2/TestHelpers/index.js.map +0 -1
- package/esm/StripeEventNotificationHandler.d.ts +0 -22
- package/esm/StripeEventNotificationHandler.js +0 -143
- 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/Billing/Analytics/MeterUsage.d.ts +0 -84
- 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 -32
- 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/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/FxQuotes.d.ts +0 -212
- package/esm/resources/FxQuotes.js +0 -25
- package/esm/resources/FxQuotes.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/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/Orders.d.ts +0 -4693
- package/esm/resources/Orders.js +0 -453
- package/esm/resources/Orders.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/QuoteLines.d.ts +0 -507
- package/esm/resources/QuoteLines.js +0 -3
- package/esm/resources/QuoteLines.js.map +0 -1
- package/esm/resources/QuotePreviewInvoices.d.ts +0 -1116
- package/esm/resources/QuotePreviewInvoices.js +0 -3
- package/esm/resources/QuotePreviewInvoices.js.map +0 -1
- package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -733
- package/esm/resources/QuotePreviewSubscriptionSchedules.js +0 -3
- package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
- package/esm/resources/SharedPayment/GrantedTokens.d.ts +0 -1089
- 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 -308
- 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/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/SharedPayment/GrantedTokens.d.ts +0 -68
- 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/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/Cadences.d.ts +0 -951
- package/esm/resources/V2/Billing/Cadences.js +0 -194
- 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/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/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/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 -254
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -58
- 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/Reporting/QueryRuns.d.ts +0 -156
- 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 -10
- package/esm/resources/V2/Data/index.js +0 -9
- package/esm/resources/V2/Data/index.js.map +0 -1
- package/esm/resources/V2/EventMisc.d.ts +0 -0
- package/esm/resources/V2/EventMisc.js +0 -2
- package/esm/resources/V2/EventMisc.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 -204
- package/esm/resources/V2/Iam/ActivityLogs.js +0 -13
- package/esm/resources/V2/Iam/ActivityLogs.js.map +0 -1
- package/esm/resources/V2/Iam/index.d.ts +0 -12
- package/esm/resources/V2/Iam/index.js +0 -9
- package/esm/resources/V2/Iam/index.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +0 -135
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -19
- package/esm/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -244
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -40
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -215
- 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 -212
- 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 -388
- 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 -299
- 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 -330
- 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 -243
- 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 -292
- 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 -161
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -19
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
- package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -165
- 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 -196
- 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 -104
- package/esm/resources/V2/MoneyManagement/index.js +0 -35
- 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/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/index.d.ts +0 -8
- package/esm/resources/V2/TestHelpers/index.js +0 -9
- package/esm/resources/V2/TestHelpers/index.js.map +0 -1
|
@@ -10,7 +10,6 @@ import { Price, DeletedPrice } from './Prices.js';
|
|
|
10
10
|
import { Coupon } from './Coupons.js';
|
|
11
11
|
import { PromotionCode } from './PromotionCodes.js';
|
|
12
12
|
import { Plan, DeletedPlan } from './Plans.js';
|
|
13
|
-
import { Invoice } from './Invoices.js';
|
|
14
13
|
import * as TestHelpers from './TestHelpers/index.js';
|
|
15
14
|
import { Emptyable, MetadataParam, Decimal, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
|
|
16
15
|
import { RequestOptions, ApiListPromise, Response } from '../lib.js';
|
|
@@ -31,10 +30,6 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
31
30
|
* Updates an existing subscription schedule.
|
|
32
31
|
*/
|
|
33
32
|
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
33
|
/**
|
|
39
34
|
* 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
35
|
*/
|
|
@@ -43,18 +38,6 @@ export declare class SubscriptionScheduleResource extends StripeResource {
|
|
|
43
38
|
* 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
39
|
*/
|
|
45
40
|
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
41
|
}
|
|
59
42
|
export interface SubscriptionSchedule {
|
|
60
43
|
/**
|
|
@@ -69,10 +52,6 @@ export interface SubscriptionSchedule {
|
|
|
69
52
|
* ID of the Connect Application that created the schedule.
|
|
70
53
|
*/
|
|
71
54
|
application: string | Application | DeletedApplication | null;
|
|
72
|
-
/**
|
|
73
|
-
* 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.
|
|
74
|
-
*/
|
|
75
|
-
billing_behavior?: SubscriptionSchedule.BillingBehavior;
|
|
76
55
|
/**
|
|
77
56
|
* The billing mode of the subscription.
|
|
78
57
|
*/
|
|
@@ -106,10 +85,6 @@ export interface SubscriptionSchedule {
|
|
|
106
85
|
* 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.
|
|
107
86
|
*/
|
|
108
87
|
end_behavior: SubscriptionSchedule.EndBehavior;
|
|
109
|
-
/**
|
|
110
|
-
* Details of the most recent price migration that failed for the subscription schedule.
|
|
111
|
-
*/
|
|
112
|
-
last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
|
|
113
88
|
/**
|
|
114
89
|
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
115
90
|
*/
|
|
@@ -122,10 +97,6 @@ export interface SubscriptionSchedule {
|
|
|
122
97
|
* Configuration for the subscription schedule's phases.
|
|
123
98
|
*/
|
|
124
99
|
phases: Array<SubscriptionSchedule.Phase>;
|
|
125
|
-
/**
|
|
126
|
-
* Time period and invoice for a Subscription billed in advance.
|
|
127
|
-
*/
|
|
128
|
-
prebilling?: SubscriptionSchedule.Prebilling | null;
|
|
129
100
|
/**
|
|
130
101
|
* Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
|
131
102
|
*/
|
|
@@ -148,7 +119,6 @@ export interface SubscriptionSchedule {
|
|
|
148
119
|
test_clock: string | TestHelpers.TestClock | null;
|
|
149
120
|
}
|
|
150
121
|
export declare namespace SubscriptionSchedule {
|
|
151
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
152
122
|
interface BillingMode {
|
|
153
123
|
/**
|
|
154
124
|
* Configure behavior for flexible billing mode
|
|
@@ -210,20 +180,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
210
180
|
transfer_data: DefaultSettings.TransferData | null;
|
|
211
181
|
}
|
|
212
182
|
type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
|
|
213
|
-
interface LastPriceMigrationError {
|
|
214
|
-
/**
|
|
215
|
-
* The time at which the price migration encountered an error.
|
|
216
|
-
*/
|
|
217
|
-
errored_at: number;
|
|
218
|
-
/**
|
|
219
|
-
* The involved price pairs in each failed transition.
|
|
220
|
-
*/
|
|
221
|
-
failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
|
|
222
|
-
/**
|
|
223
|
-
* The type of error encountered by the price migration.
|
|
224
|
-
*/
|
|
225
|
-
type: 'price_uniqueness_violation';
|
|
226
|
-
}
|
|
227
183
|
interface Phase {
|
|
228
184
|
/**
|
|
229
185
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
|
@@ -286,10 +242,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
286
242
|
* 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.
|
|
287
243
|
*/
|
|
288
244
|
on_behalf_of: string | Account | null;
|
|
289
|
-
/**
|
|
290
|
-
* 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).
|
|
291
|
-
*/
|
|
292
|
-
pause_collection?: Phase.PauseCollection | null;
|
|
293
245
|
/**
|
|
294
246
|
* When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
295
247
|
*/
|
|
@@ -302,36 +254,10 @@ export declare namespace SubscriptionSchedule {
|
|
|
302
254
|
* 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.
|
|
303
255
|
*/
|
|
304
256
|
transfer_data: Phase.TransferData | null;
|
|
305
|
-
/**
|
|
306
|
-
* Specify behavior of the trial when crossing schedule phase boundaries
|
|
307
|
-
*/
|
|
308
|
-
trial_continuation?: Phase.TrialContinuation | null;
|
|
309
257
|
/**
|
|
310
258
|
* When the trial ends within the phase.
|
|
311
259
|
*/
|
|
312
260
|
trial_end: number | null;
|
|
313
|
-
/**
|
|
314
|
-
* Settings related to any trials on the subscription during this phase.
|
|
315
|
-
*/
|
|
316
|
-
trial_settings?: Phase.TrialSettings | null;
|
|
317
|
-
}
|
|
318
|
-
interface Prebilling {
|
|
319
|
-
/**
|
|
320
|
-
* ID of the prebilling invoice.
|
|
321
|
-
*/
|
|
322
|
-
invoice: string | Invoice;
|
|
323
|
-
/**
|
|
324
|
-
* The end of the last period for which the invoice pre-bills.
|
|
325
|
-
*/
|
|
326
|
-
period_end: number;
|
|
327
|
-
/**
|
|
328
|
-
* The start of the first period for which the invoice pre-bills.
|
|
329
|
-
*/
|
|
330
|
-
period_start: number;
|
|
331
|
-
/**
|
|
332
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
|
333
|
-
*/
|
|
334
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
335
261
|
}
|
|
336
262
|
type Status = 'active' | 'canceled' | 'completed' | 'not_started' | 'released';
|
|
337
263
|
namespace BillingMode {
|
|
@@ -425,20 +351,12 @@ export declare namespace SubscriptionSchedule {
|
|
|
425
351
|
}
|
|
426
352
|
}
|
|
427
353
|
}
|
|
428
|
-
namespace LastPriceMigrationError {
|
|
429
|
-
interface FailedTransition {
|
|
430
|
-
/**
|
|
431
|
-
* The original price to be migrated.
|
|
432
|
-
*/
|
|
433
|
-
source_price: string;
|
|
434
|
-
/**
|
|
435
|
-
* The intended resulting price of the migration.
|
|
436
|
-
*/
|
|
437
|
-
target_price: string;
|
|
438
|
-
}
|
|
439
|
-
}
|
|
440
354
|
namespace Phase {
|
|
441
355
|
interface AddInvoiceItem {
|
|
356
|
+
/**
|
|
357
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
358
|
+
*/
|
|
359
|
+
discountable: boolean | null;
|
|
442
360
|
/**
|
|
443
361
|
* The stackable discounts that will be applied to the item.
|
|
444
362
|
*/
|
|
@@ -496,10 +414,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
496
414
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
497
415
|
*/
|
|
498
416
|
discount: string | Discount | null;
|
|
499
|
-
/**
|
|
500
|
-
* Details to determine how long the discount should be applied for.
|
|
501
|
-
*/
|
|
502
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
503
417
|
/**
|
|
504
418
|
* ID of the promotion code to create a new discount for.
|
|
505
419
|
*/
|
|
@@ -548,20 +462,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
548
462
|
* 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`.
|
|
549
463
|
*/
|
|
550
464
|
tax_rates?: Array<TaxRate> | null;
|
|
551
|
-
/**
|
|
552
|
-
* Options that configure the trial on the subscription item.
|
|
553
|
-
*/
|
|
554
|
-
trial?: Item.Trial | null;
|
|
555
|
-
/**
|
|
556
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
557
|
-
*/
|
|
558
|
-
trial_offer?: string | null;
|
|
559
|
-
}
|
|
560
|
-
interface PauseCollection {
|
|
561
|
-
/**
|
|
562
|
-
* The payment collection behavior for this subscription while paused.
|
|
563
|
-
*/
|
|
564
|
-
behavior: PauseCollection.Behavior;
|
|
565
465
|
}
|
|
566
466
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
567
467
|
interface TransferData {
|
|
@@ -574,13 +474,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
574
474
|
*/
|
|
575
475
|
destination: string | Account;
|
|
576
476
|
}
|
|
577
|
-
type TrialContinuation = 'continue' | 'none';
|
|
578
|
-
interface TrialSettings {
|
|
579
|
-
/**
|
|
580
|
-
* Defines how the subscription should behave when a trial ends.
|
|
581
|
-
*/
|
|
582
|
-
end_behavior: TrialSettings.EndBehavior | null;
|
|
583
|
-
}
|
|
584
477
|
namespace AddInvoiceItem {
|
|
585
478
|
interface Discount {
|
|
586
479
|
/**
|
|
@@ -591,10 +484,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
591
484
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
592
485
|
*/
|
|
593
486
|
discount: string | Discount | null;
|
|
594
|
-
/**
|
|
595
|
-
* Details to determine how long the discount should be applied for.
|
|
596
|
-
*/
|
|
597
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
598
487
|
/**
|
|
599
488
|
* ID of the promotion code to create a new discount for.
|
|
600
489
|
*/
|
|
@@ -604,18 +493,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
604
493
|
end: Period.End;
|
|
605
494
|
start: Period.Start;
|
|
606
495
|
}
|
|
607
|
-
namespace Discount {
|
|
608
|
-
interface DiscountEnd {
|
|
609
|
-
/**
|
|
610
|
-
* The discount end timestamp.
|
|
611
|
-
*/
|
|
612
|
-
timestamp: number | null;
|
|
613
|
-
/**
|
|
614
|
-
* The discount end type.
|
|
615
|
-
*/
|
|
616
|
-
type: 'timestamp';
|
|
617
|
-
}
|
|
618
|
-
}
|
|
619
496
|
namespace Period {
|
|
620
497
|
interface End {
|
|
621
498
|
/**
|
|
@@ -660,18 +537,6 @@ export declare namespace SubscriptionSchedule {
|
|
|
660
537
|
type Type = 'account' | 'self';
|
|
661
538
|
}
|
|
662
539
|
}
|
|
663
|
-
namespace Discount {
|
|
664
|
-
interface DiscountEnd {
|
|
665
|
-
/**
|
|
666
|
-
* The discount end timestamp.
|
|
667
|
-
*/
|
|
668
|
-
timestamp: number | null;
|
|
669
|
-
/**
|
|
670
|
-
* The discount end type.
|
|
671
|
-
*/
|
|
672
|
-
type: 'timestamp';
|
|
673
|
-
}
|
|
674
|
-
}
|
|
675
540
|
namespace InvoiceSettings {
|
|
676
541
|
interface Issuer {
|
|
677
542
|
/**
|
|
@@ -703,65 +568,15 @@ export declare namespace SubscriptionSchedule {
|
|
|
703
568
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
704
569
|
*/
|
|
705
570
|
discount: string | Discount | null;
|
|
706
|
-
/**
|
|
707
|
-
* Details to determine how long the discount should be applied for.
|
|
708
|
-
*/
|
|
709
|
-
discount_end?: Discount.DiscountEnd | null;
|
|
710
571
|
/**
|
|
711
572
|
* ID of the promotion code to create a new discount for.
|
|
712
573
|
*/
|
|
713
574
|
promotion_code: string | PromotionCode | null;
|
|
714
575
|
}
|
|
715
|
-
interface Trial {
|
|
716
|
-
/**
|
|
717
|
-
* List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
718
|
-
*/
|
|
719
|
-
converts_to?: Array<string> | null;
|
|
720
|
-
/**
|
|
721
|
-
* Determines the type of trial for this item.
|
|
722
|
-
*/
|
|
723
|
-
type: Trial.Type;
|
|
724
|
-
}
|
|
725
|
-
namespace Discount {
|
|
726
|
-
interface DiscountEnd {
|
|
727
|
-
/**
|
|
728
|
-
* The discount end timestamp.
|
|
729
|
-
*/
|
|
730
|
-
timestamp: number | null;
|
|
731
|
-
/**
|
|
732
|
-
* The discount end type.
|
|
733
|
-
*/
|
|
734
|
-
type: 'timestamp';
|
|
735
|
-
}
|
|
736
|
-
}
|
|
737
|
-
namespace Trial {
|
|
738
|
-
type Type = 'free' | 'paid';
|
|
739
|
-
}
|
|
740
|
-
}
|
|
741
|
-
namespace PauseCollection {
|
|
742
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
743
|
-
}
|
|
744
|
-
namespace TrialSettings {
|
|
745
|
-
interface EndBehavior {
|
|
746
|
-
/**
|
|
747
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
748
|
-
*/
|
|
749
|
-
prorate_up_front: EndBehavior.ProrateUpFront | null;
|
|
750
|
-
}
|
|
751
|
-
namespace EndBehavior {
|
|
752
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
753
|
-
}
|
|
754
576
|
}
|
|
755
577
|
}
|
|
756
|
-
namespace Prebilling {
|
|
757
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
758
|
-
}
|
|
759
578
|
}
|
|
760
579
|
export interface SubscriptionScheduleCreateParams {
|
|
761
|
-
/**
|
|
762
|
-
* 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.
|
|
763
|
-
*/
|
|
764
|
-
billing_behavior?: SubscriptionScheduleCreateParams.BillingBehavior;
|
|
765
580
|
/**
|
|
766
581
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
767
582
|
*/
|
|
@@ -798,17 +613,12 @@ export interface SubscriptionScheduleCreateParams {
|
|
|
798
613
|
* 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.
|
|
799
614
|
*/
|
|
800
615
|
phases?: Array<SubscriptionScheduleCreateParams.Phase>;
|
|
801
|
-
/**
|
|
802
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
803
|
-
*/
|
|
804
|
-
prebilling?: SubscriptionScheduleCreateParams.Prebilling;
|
|
805
616
|
/**
|
|
806
617
|
* 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.
|
|
807
618
|
*/
|
|
808
619
|
start_date?: number | 'now';
|
|
809
620
|
}
|
|
810
621
|
export declare namespace SubscriptionScheduleCreateParams {
|
|
811
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
812
622
|
interface BillingMode {
|
|
813
623
|
/**
|
|
814
624
|
* Configure behavior for flexible billing mode.
|
|
@@ -931,10 +741,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
931
741
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
932
742
|
*/
|
|
933
743
|
on_behalf_of?: string;
|
|
934
|
-
/**
|
|
935
|
-
* 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).
|
|
936
|
-
*/
|
|
937
|
-
pause_collection?: Phase.PauseCollection;
|
|
938
744
|
/**
|
|
939
745
|
* 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.
|
|
940
746
|
*/
|
|
@@ -947,28 +753,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
947
753
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
948
754
|
*/
|
|
949
755
|
trial?: boolean;
|
|
950
|
-
/**
|
|
951
|
-
* Specify trial behavior when crossing phase boundaries
|
|
952
|
-
*/
|
|
953
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
954
756
|
/**
|
|
955
757
|
* 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`
|
|
956
758
|
*/
|
|
957
759
|
trial_end?: number;
|
|
958
|
-
/**
|
|
959
|
-
* Settings related to subscription trials.
|
|
960
|
-
*/
|
|
961
|
-
trial_settings?: Phase.TrialSettings;
|
|
962
|
-
}
|
|
963
|
-
interface Prebilling {
|
|
964
|
-
/**
|
|
965
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
966
|
-
*/
|
|
967
|
-
iterations: number;
|
|
968
|
-
/**
|
|
969
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
970
|
-
*/
|
|
971
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
972
760
|
}
|
|
973
761
|
namespace BillingMode {
|
|
974
762
|
interface Flexible {
|
|
@@ -1062,6 +850,10 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1062
850
|
}
|
|
1063
851
|
namespace Phase {
|
|
1064
852
|
interface AddInvoiceItem {
|
|
853
|
+
/**
|
|
854
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
855
|
+
*/
|
|
856
|
+
discountable?: boolean;
|
|
1065
857
|
/**
|
|
1066
858
|
* The coupons to redeem into discounts for the item.
|
|
1067
859
|
*/
|
|
@@ -1122,10 +914,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1122
914
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1123
915
|
*/
|
|
1124
916
|
discount?: string;
|
|
1125
|
-
/**
|
|
1126
|
-
* Details to determine how long the discount should be applied for.
|
|
1127
|
-
*/
|
|
1128
|
-
discount_end?: Discount.DiscountEnd;
|
|
1129
917
|
/**
|
|
1130
918
|
* ID of the promotion code to create a new discount for.
|
|
1131
919
|
*/
|
|
@@ -1188,20 +976,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1188
976
|
* 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.
|
|
1189
977
|
*/
|
|
1190
978
|
tax_rates?: Emptyable<Array<string>>;
|
|
1191
|
-
/**
|
|
1192
|
-
* Options that configure the trial on the subscription item.
|
|
1193
|
-
*/
|
|
1194
|
-
trial?: Item.Trial;
|
|
1195
|
-
/**
|
|
1196
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
1197
|
-
*/
|
|
1198
|
-
trial_offer?: string;
|
|
1199
|
-
}
|
|
1200
|
-
interface PauseCollection {
|
|
1201
|
-
/**
|
|
1202
|
-
* The payment collection behavior for this subscription while paused.
|
|
1203
|
-
*/
|
|
1204
|
-
behavior: PauseCollection.Behavior;
|
|
1205
979
|
}
|
|
1206
980
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1207
981
|
interface TransferData {
|
|
@@ -1214,13 +988,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1214
988
|
*/
|
|
1215
989
|
destination: string;
|
|
1216
990
|
}
|
|
1217
|
-
type TrialContinuation = 'continue' | 'none';
|
|
1218
|
-
interface TrialSettings {
|
|
1219
|
-
/**
|
|
1220
|
-
* Defines how the subscription should behave when a trial ends.
|
|
1221
|
-
*/
|
|
1222
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
1223
|
-
}
|
|
1224
991
|
namespace AddInvoiceItem {
|
|
1225
992
|
interface Discount {
|
|
1226
993
|
/**
|
|
@@ -1231,10 +998,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1231
998
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1232
999
|
*/
|
|
1233
1000
|
discount?: string;
|
|
1234
|
-
/**
|
|
1235
|
-
* Details to determine how long the discount should be applied for.
|
|
1236
|
-
*/
|
|
1237
|
-
discount_end?: Discount.DiscountEnd;
|
|
1238
1001
|
/**
|
|
1239
1002
|
* ID of the promotion code to create a new discount for.
|
|
1240
1003
|
*/
|
|
@@ -1272,38 +1035,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1272
1035
|
*/
|
|
1273
1036
|
unit_amount_decimal?: Decimal;
|
|
1274
1037
|
}
|
|
1275
|
-
namespace Discount {
|
|
1276
|
-
interface DiscountEnd {
|
|
1277
|
-
/**
|
|
1278
|
-
* Time span for the redeemed discount.
|
|
1279
|
-
*/
|
|
1280
|
-
duration?: DiscountEnd.Duration;
|
|
1281
|
-
/**
|
|
1282
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1283
|
-
*/
|
|
1284
|
-
timestamp?: number;
|
|
1285
|
-
/**
|
|
1286
|
-
* The type of calculation made to determine when the discount ends.
|
|
1287
|
-
*/
|
|
1288
|
-
type: DiscountEnd.Type;
|
|
1289
|
-
}
|
|
1290
|
-
namespace DiscountEnd {
|
|
1291
|
-
interface Duration {
|
|
1292
|
-
/**
|
|
1293
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1294
|
-
*/
|
|
1295
|
-
interval: Duration.Interval;
|
|
1296
|
-
/**
|
|
1297
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1298
|
-
*/
|
|
1299
|
-
interval_count: number;
|
|
1300
|
-
}
|
|
1301
|
-
type Type = 'duration' | 'timestamp';
|
|
1302
|
-
namespace Duration {
|
|
1303
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1304
|
-
}
|
|
1305
|
-
}
|
|
1306
|
-
}
|
|
1307
1038
|
namespace Period {
|
|
1308
1039
|
interface End {
|
|
1309
1040
|
/**
|
|
@@ -1351,38 +1082,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1351
1082
|
type Type = 'account' | 'self';
|
|
1352
1083
|
}
|
|
1353
1084
|
}
|
|
1354
|
-
namespace Discount {
|
|
1355
|
-
interface DiscountEnd {
|
|
1356
|
-
/**
|
|
1357
|
-
* Time span for the redeemed discount.
|
|
1358
|
-
*/
|
|
1359
|
-
duration?: DiscountEnd.Duration;
|
|
1360
|
-
/**
|
|
1361
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1362
|
-
*/
|
|
1363
|
-
timestamp?: number;
|
|
1364
|
-
/**
|
|
1365
|
-
* The type of calculation made to determine when the discount ends.
|
|
1366
|
-
*/
|
|
1367
|
-
type: DiscountEnd.Type;
|
|
1368
|
-
}
|
|
1369
|
-
namespace DiscountEnd {
|
|
1370
|
-
interface Duration {
|
|
1371
|
-
/**
|
|
1372
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1373
|
-
*/
|
|
1374
|
-
interval: Duration.Interval;
|
|
1375
|
-
/**
|
|
1376
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1377
|
-
*/
|
|
1378
|
-
interval_count: number;
|
|
1379
|
-
}
|
|
1380
|
-
type Type = 'duration' | 'timestamp';
|
|
1381
|
-
namespace Duration {
|
|
1382
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1383
|
-
}
|
|
1384
|
-
}
|
|
1385
|
-
}
|
|
1386
1085
|
namespace Duration {
|
|
1387
1086
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1388
1087
|
}
|
|
@@ -1417,10 +1116,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1417
1116
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1418
1117
|
*/
|
|
1419
1118
|
discount?: string;
|
|
1420
|
-
/**
|
|
1421
|
-
* Details to determine how long the discount should be applied for.
|
|
1422
|
-
*/
|
|
1423
|
-
discount_end?: Discount.DiscountEnd;
|
|
1424
1119
|
/**
|
|
1425
1120
|
* ID of the promotion code to create a new discount for.
|
|
1426
1121
|
*/
|
|
@@ -1452,48 +1147,6 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1452
1147
|
*/
|
|
1453
1148
|
unit_amount_decimal?: Decimal;
|
|
1454
1149
|
}
|
|
1455
|
-
interface Trial {
|
|
1456
|
-
/**
|
|
1457
|
-
* 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.
|
|
1458
|
-
*/
|
|
1459
|
-
converts_to?: Array<string>;
|
|
1460
|
-
/**
|
|
1461
|
-
* Determines the type of trial for this item.
|
|
1462
|
-
*/
|
|
1463
|
-
type: Trial.Type;
|
|
1464
|
-
}
|
|
1465
|
-
namespace Discount {
|
|
1466
|
-
interface DiscountEnd {
|
|
1467
|
-
/**
|
|
1468
|
-
* Time span for the redeemed discount.
|
|
1469
|
-
*/
|
|
1470
|
-
duration?: DiscountEnd.Duration;
|
|
1471
|
-
/**
|
|
1472
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1473
|
-
*/
|
|
1474
|
-
timestamp?: number;
|
|
1475
|
-
/**
|
|
1476
|
-
* The type of calculation made to determine when the discount ends.
|
|
1477
|
-
*/
|
|
1478
|
-
type: DiscountEnd.Type;
|
|
1479
|
-
}
|
|
1480
|
-
namespace DiscountEnd {
|
|
1481
|
-
interface Duration {
|
|
1482
|
-
/**
|
|
1483
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1484
|
-
*/
|
|
1485
|
-
interval: Duration.Interval;
|
|
1486
|
-
/**
|
|
1487
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1488
|
-
*/
|
|
1489
|
-
interval_count: number;
|
|
1490
|
-
}
|
|
1491
|
-
type Type = 'duration' | 'timestamp';
|
|
1492
|
-
namespace Duration {
|
|
1493
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1494
|
-
}
|
|
1495
|
-
}
|
|
1496
|
-
}
|
|
1497
1150
|
namespace PriceData {
|
|
1498
1151
|
interface Recurring {
|
|
1499
1152
|
/**
|
|
@@ -1510,28 +1163,8 @@ export declare namespace SubscriptionScheduleCreateParams {
|
|
|
1510
1163
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1511
1164
|
}
|
|
1512
1165
|
}
|
|
1513
|
-
namespace Trial {
|
|
1514
|
-
type Type = 'free' | 'paid';
|
|
1515
|
-
}
|
|
1516
|
-
}
|
|
1517
|
-
namespace PauseCollection {
|
|
1518
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
1519
|
-
}
|
|
1520
|
-
namespace TrialSettings {
|
|
1521
|
-
interface EndBehavior {
|
|
1522
|
-
/**
|
|
1523
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1524
|
-
*/
|
|
1525
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
1526
|
-
}
|
|
1527
|
-
namespace EndBehavior {
|
|
1528
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
1529
|
-
}
|
|
1530
1166
|
}
|
|
1531
1167
|
}
|
|
1532
|
-
namespace Prebilling {
|
|
1533
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
1534
|
-
}
|
|
1535
1168
|
}
|
|
1536
1169
|
export interface SubscriptionScheduleRetrieveParams {
|
|
1537
1170
|
/**
|
|
@@ -1540,10 +1173,6 @@ export interface SubscriptionScheduleRetrieveParams {
|
|
|
1540
1173
|
expand?: Array<string>;
|
|
1541
1174
|
}
|
|
1542
1175
|
export interface SubscriptionScheduleUpdateParams {
|
|
1543
|
-
/**
|
|
1544
|
-
* 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.
|
|
1545
|
-
*/
|
|
1546
|
-
billing_behavior?: SubscriptionScheduleUpdateParams.BillingBehavior;
|
|
1547
1176
|
/**
|
|
1548
1177
|
* Object representing the subscription schedule's default settings.
|
|
1549
1178
|
*/
|
|
@@ -1564,17 +1193,12 @@ export interface SubscriptionScheduleUpdateParams {
|
|
|
1564
1193
|
* 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.
|
|
1565
1194
|
*/
|
|
1566
1195
|
phases?: Array<SubscriptionScheduleUpdateParams.Phase>;
|
|
1567
|
-
/**
|
|
1568
|
-
* If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
1569
|
-
*/
|
|
1570
|
-
prebilling?: SubscriptionScheduleUpdateParams.Prebilling;
|
|
1571
1196
|
/**
|
|
1572
1197
|
* 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`.
|
|
1573
1198
|
*/
|
|
1574
1199
|
proration_behavior?: SubscriptionScheduleUpdateParams.ProrationBehavior;
|
|
1575
1200
|
}
|
|
1576
1201
|
export declare namespace SubscriptionScheduleUpdateParams {
|
|
1577
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
1578
1202
|
interface DefaultSettings {
|
|
1579
1203
|
/**
|
|
1580
1204
|
* 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).
|
|
@@ -1687,10 +1311,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1687
1311
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1688
1312
|
*/
|
|
1689
1313
|
on_behalf_of?: string;
|
|
1690
|
-
/**
|
|
1691
|
-
* 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).
|
|
1692
|
-
*/
|
|
1693
|
-
pause_collection?: Phase.PauseCollection;
|
|
1694
1314
|
/**
|
|
1695
1315
|
* 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.
|
|
1696
1316
|
*/
|
|
@@ -1707,28 +1327,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1707
1327
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1708
1328
|
*/
|
|
1709
1329
|
trial?: boolean;
|
|
1710
|
-
/**
|
|
1711
|
-
* Specify trial behavior when crossing phase boundaries
|
|
1712
|
-
*/
|
|
1713
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
1714
1330
|
/**
|
|
1715
1331
|
* 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`
|
|
1716
1332
|
*/
|
|
1717
1333
|
trial_end?: number | 'now';
|
|
1718
|
-
/**
|
|
1719
|
-
* Settings related to subscription trials.
|
|
1720
|
-
*/
|
|
1721
|
-
trial_settings?: Phase.TrialSettings;
|
|
1722
|
-
}
|
|
1723
|
-
interface Prebilling {
|
|
1724
|
-
/**
|
|
1725
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
1726
|
-
*/
|
|
1727
|
-
iterations: number;
|
|
1728
|
-
/**
|
|
1729
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
1730
|
-
*/
|
|
1731
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
1732
1334
|
}
|
|
1733
1335
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1734
1336
|
namespace DefaultSettings {
|
|
@@ -1811,6 +1413,10 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1811
1413
|
}
|
|
1812
1414
|
namespace Phase {
|
|
1813
1415
|
interface AddInvoiceItem {
|
|
1416
|
+
/**
|
|
1417
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
1418
|
+
*/
|
|
1419
|
+
discountable?: boolean;
|
|
1814
1420
|
/**
|
|
1815
1421
|
* The coupons to redeem into discounts for the item.
|
|
1816
1422
|
*/
|
|
@@ -1871,10 +1477,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1871
1477
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1872
1478
|
*/
|
|
1873
1479
|
discount?: string;
|
|
1874
|
-
/**
|
|
1875
|
-
* Details to determine how long the discount should be applied for.
|
|
1876
|
-
*/
|
|
1877
|
-
discount_end?: Discount.DiscountEnd;
|
|
1878
1480
|
/**
|
|
1879
1481
|
* ID of the promotion code to create a new discount for.
|
|
1880
1482
|
*/
|
|
@@ -1937,20 +1539,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1937
1539
|
* 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.
|
|
1938
1540
|
*/
|
|
1939
1541
|
tax_rates?: Emptyable<Array<string>>;
|
|
1940
|
-
/**
|
|
1941
|
-
* Options that configure the trial on the subscription item.
|
|
1942
|
-
*/
|
|
1943
|
-
trial?: Item.Trial;
|
|
1944
|
-
/**
|
|
1945
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
1946
|
-
*/
|
|
1947
|
-
trial_offer?: string;
|
|
1948
|
-
}
|
|
1949
|
-
interface PauseCollection {
|
|
1950
|
-
/**
|
|
1951
|
-
* The payment collection behavior for this subscription while paused.
|
|
1952
|
-
*/
|
|
1953
|
-
behavior: PauseCollection.Behavior;
|
|
1954
1542
|
}
|
|
1955
1543
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
1956
1544
|
interface TransferData {
|
|
@@ -1963,13 +1551,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1963
1551
|
*/
|
|
1964
1552
|
destination: string;
|
|
1965
1553
|
}
|
|
1966
|
-
type TrialContinuation = 'continue' | 'none';
|
|
1967
|
-
interface TrialSettings {
|
|
1968
|
-
/**
|
|
1969
|
-
* Defines how the subscription should behave when a trial ends.
|
|
1970
|
-
*/
|
|
1971
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
1972
|
-
}
|
|
1973
1554
|
namespace AddInvoiceItem {
|
|
1974
1555
|
interface Discount {
|
|
1975
1556
|
/**
|
|
@@ -1980,10 +1561,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
1980
1561
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1981
1562
|
*/
|
|
1982
1563
|
discount?: string;
|
|
1983
|
-
/**
|
|
1984
|
-
* Details to determine how long the discount should be applied for.
|
|
1985
|
-
*/
|
|
1986
|
-
discount_end?: Discount.DiscountEnd;
|
|
1987
1564
|
/**
|
|
1988
1565
|
* ID of the promotion code to create a new discount for.
|
|
1989
1566
|
*/
|
|
@@ -2021,38 +1598,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2021
1598
|
*/
|
|
2022
1599
|
unit_amount_decimal?: Decimal;
|
|
2023
1600
|
}
|
|
2024
|
-
namespace Discount {
|
|
2025
|
-
interface DiscountEnd {
|
|
2026
|
-
/**
|
|
2027
|
-
* Time span for the redeemed discount.
|
|
2028
|
-
*/
|
|
2029
|
-
duration?: DiscountEnd.Duration;
|
|
2030
|
-
/**
|
|
2031
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2032
|
-
*/
|
|
2033
|
-
timestamp?: number;
|
|
2034
|
-
/**
|
|
2035
|
-
* The type of calculation made to determine when the discount ends.
|
|
2036
|
-
*/
|
|
2037
|
-
type: DiscountEnd.Type;
|
|
2038
|
-
}
|
|
2039
|
-
namespace DiscountEnd {
|
|
2040
|
-
interface Duration {
|
|
2041
|
-
/**
|
|
2042
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2043
|
-
*/
|
|
2044
|
-
interval: Duration.Interval;
|
|
2045
|
-
/**
|
|
2046
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2047
|
-
*/
|
|
2048
|
-
interval_count: number;
|
|
2049
|
-
}
|
|
2050
|
-
type Type = 'duration' | 'timestamp';
|
|
2051
|
-
namespace Duration {
|
|
2052
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2053
|
-
}
|
|
2054
|
-
}
|
|
2055
|
-
}
|
|
2056
1601
|
namespace Period {
|
|
2057
1602
|
interface End {
|
|
2058
1603
|
/**
|
|
@@ -2100,38 +1645,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2100
1645
|
type Type = 'account' | 'self';
|
|
2101
1646
|
}
|
|
2102
1647
|
}
|
|
2103
|
-
namespace Discount {
|
|
2104
|
-
interface DiscountEnd {
|
|
2105
|
-
/**
|
|
2106
|
-
* Time span for the redeemed discount.
|
|
2107
|
-
*/
|
|
2108
|
-
duration?: DiscountEnd.Duration;
|
|
2109
|
-
/**
|
|
2110
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2111
|
-
*/
|
|
2112
|
-
timestamp?: number;
|
|
2113
|
-
/**
|
|
2114
|
-
* The type of calculation made to determine when the discount ends.
|
|
2115
|
-
*/
|
|
2116
|
-
type: DiscountEnd.Type;
|
|
2117
|
-
}
|
|
2118
|
-
namespace DiscountEnd {
|
|
2119
|
-
interface Duration {
|
|
2120
|
-
/**
|
|
2121
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2122
|
-
*/
|
|
2123
|
-
interval: Duration.Interval;
|
|
2124
|
-
/**
|
|
2125
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2126
|
-
*/
|
|
2127
|
-
interval_count: number;
|
|
2128
|
-
}
|
|
2129
|
-
type Type = 'duration' | 'timestamp';
|
|
2130
|
-
namespace Duration {
|
|
2131
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2132
|
-
}
|
|
2133
|
-
}
|
|
2134
|
-
}
|
|
2135
1648
|
namespace Duration {
|
|
2136
1649
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2137
1650
|
}
|
|
@@ -2166,10 +1679,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2166
1679
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2167
1680
|
*/
|
|
2168
1681
|
discount?: string;
|
|
2169
|
-
/**
|
|
2170
|
-
* Details to determine how long the discount should be applied for.
|
|
2171
|
-
*/
|
|
2172
|
-
discount_end?: Discount.DiscountEnd;
|
|
2173
1682
|
/**
|
|
2174
1683
|
* ID of the promotion code to create a new discount for.
|
|
2175
1684
|
*/
|
|
@@ -2201,48 +1710,6 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2201
1710
|
*/
|
|
2202
1711
|
unit_amount_decimal?: Decimal;
|
|
2203
1712
|
}
|
|
2204
|
-
interface Trial {
|
|
2205
|
-
/**
|
|
2206
|
-
* 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.
|
|
2207
|
-
*/
|
|
2208
|
-
converts_to?: Array<string>;
|
|
2209
|
-
/**
|
|
2210
|
-
* Determines the type of trial for this item.
|
|
2211
|
-
*/
|
|
2212
|
-
type: Trial.Type;
|
|
2213
|
-
}
|
|
2214
|
-
namespace Discount {
|
|
2215
|
-
interface DiscountEnd {
|
|
2216
|
-
/**
|
|
2217
|
-
* Time span for the redeemed discount.
|
|
2218
|
-
*/
|
|
2219
|
-
duration?: DiscountEnd.Duration;
|
|
2220
|
-
/**
|
|
2221
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2222
|
-
*/
|
|
2223
|
-
timestamp?: number;
|
|
2224
|
-
/**
|
|
2225
|
-
* The type of calculation made to determine when the discount ends.
|
|
2226
|
-
*/
|
|
2227
|
-
type: DiscountEnd.Type;
|
|
2228
|
-
}
|
|
2229
|
-
namespace DiscountEnd {
|
|
2230
|
-
interface Duration {
|
|
2231
|
-
/**
|
|
2232
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2233
|
-
*/
|
|
2234
|
-
interval: Duration.Interval;
|
|
2235
|
-
/**
|
|
2236
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2237
|
-
*/
|
|
2238
|
-
interval_count: number;
|
|
2239
|
-
}
|
|
2240
|
-
type Type = 'duration' | 'timestamp';
|
|
2241
|
-
namespace Duration {
|
|
2242
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2243
|
-
}
|
|
2244
|
-
}
|
|
2245
|
-
}
|
|
2246
1713
|
namespace PriceData {
|
|
2247
1714
|
interface Recurring {
|
|
2248
1715
|
/**
|
|
@@ -2259,28 +1726,8 @@ export declare namespace SubscriptionScheduleUpdateParams {
|
|
|
2259
1726
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2260
1727
|
}
|
|
2261
1728
|
}
|
|
2262
|
-
namespace Trial {
|
|
2263
|
-
type Type = 'free' | 'paid';
|
|
2264
|
-
}
|
|
2265
|
-
}
|
|
2266
|
-
namespace PauseCollection {
|
|
2267
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2268
|
-
}
|
|
2269
|
-
namespace TrialSettings {
|
|
2270
|
-
interface EndBehavior {
|
|
2271
|
-
/**
|
|
2272
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2273
|
-
*/
|
|
2274
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2275
|
-
}
|
|
2276
|
-
namespace EndBehavior {
|
|
2277
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
2278
|
-
}
|
|
2279
1729
|
}
|
|
2280
1730
|
}
|
|
2281
|
-
namespace Prebilling {
|
|
2282
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
2283
|
-
}
|
|
2284
1731
|
}
|
|
2285
1732
|
export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
2286
1733
|
/**
|
|
@@ -2316,616 +1763,17 @@ export interface SubscriptionScheduleListParams extends PaginationParams {
|
|
|
2316
1763
|
*/
|
|
2317
1764
|
scheduled?: boolean;
|
|
2318
1765
|
}
|
|
2319
|
-
export interface
|
|
2320
|
-
/**
|
|
2321
|
-
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2322
|
-
*/
|
|
2323
|
-
amendments?: Array<SubscriptionScheduleAmendParams.Amendment>;
|
|
1766
|
+
export interface SubscriptionScheduleCancelParams {
|
|
2324
1767
|
/**
|
|
2325
1768
|
* Specifies which fields in the response should be expanded.
|
|
2326
1769
|
*/
|
|
2327
1770
|
expand?: Array<string>;
|
|
2328
1771
|
/**
|
|
2329
|
-
*
|
|
1772
|
+
* If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
|
|
2330
1773
|
*/
|
|
2331
|
-
|
|
1774
|
+
invoice_now?: boolean;
|
|
2332
1775
|
/**
|
|
2333
|
-
*
|
|
2334
|
-
* specifies if and how to prorate at the time of the request.
|
|
2335
|
-
*/
|
|
2336
|
-
proration_behavior?: SubscriptionScheduleAmendParams.ProrationBehavior;
|
|
2337
|
-
/**
|
|
2338
|
-
* Changes to apply to the subscription schedule.
|
|
2339
|
-
*/
|
|
2340
|
-
schedule_settings?: SubscriptionScheduleAmendParams.ScheduleSettings;
|
|
2341
|
-
}
|
|
2342
|
-
export declare namespace SubscriptionScheduleAmendParams {
|
|
2343
|
-
interface Amendment {
|
|
2344
|
-
/**
|
|
2345
|
-
* 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.
|
|
2346
|
-
*/
|
|
2347
|
-
amendment_end?: Amendment.AmendmentEnd;
|
|
2348
|
-
/**
|
|
2349
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2350
|
-
*/
|
|
2351
|
-
amendment_start: Amendment.AmendmentStart;
|
|
2352
|
-
/**
|
|
2353
|
-
* 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.
|
|
2354
|
-
*/
|
|
2355
|
-
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2356
|
-
/**
|
|
2357
|
-
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2358
|
-
*/
|
|
2359
|
-
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2360
|
-
/**
|
|
2361
|
-
* Changes to the subscription items during the amendment time span.
|
|
2362
|
-
*/
|
|
2363
|
-
item_actions?: Array<Amendment.ItemAction>;
|
|
2364
|
-
/**
|
|
2365
|
-
* Instructions for how to modify phase metadata
|
|
2366
|
-
*/
|
|
2367
|
-
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2368
|
-
/**
|
|
2369
|
-
* 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`.
|
|
2370
|
-
*/
|
|
2371
|
-
proration_behavior?: Amendment.ProrationBehavior;
|
|
2372
|
-
/**
|
|
2373
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2374
|
-
*/
|
|
2375
|
-
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2376
|
-
/**
|
|
2377
|
-
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2378
|
-
*/
|
|
2379
|
-
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2380
|
-
/**
|
|
2381
|
-
* Settings related to subscription trials.
|
|
2382
|
-
*/
|
|
2383
|
-
trial_settings?: Amendment.TrialSettings;
|
|
2384
|
-
}
|
|
2385
|
-
interface Prebilling {
|
|
2386
|
-
/**
|
|
2387
|
-
* The beginning of the prebilled time period. The default value is `now`.
|
|
2388
|
-
*/
|
|
2389
|
-
bill_from?: Prebilling.BillFrom;
|
|
2390
|
-
/**
|
|
2391
|
-
* The end of the prebilled time period.
|
|
2392
|
-
*/
|
|
2393
|
-
bill_until?: Prebilling.BillUntil;
|
|
2394
|
-
/**
|
|
2395
|
-
* When the prebilling invoice should be created. The default value is `now`.
|
|
2396
|
-
*/
|
|
2397
|
-
invoice_at?: 'now';
|
|
2398
|
-
/**
|
|
2399
|
-
* Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
|
2400
|
-
*/
|
|
2401
|
-
update_behavior?: Prebilling.UpdateBehavior;
|
|
2402
|
-
}
|
|
2403
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2404
|
-
interface ScheduleSettings {
|
|
2405
|
-
/**
|
|
2406
|
-
* Behavior of the subscription schedule and underlying subscription when it ends.
|
|
2407
|
-
*/
|
|
2408
|
-
end_behavior?: ScheduleSettings.EndBehavior;
|
|
2409
|
-
}
|
|
2410
|
-
namespace Amendment {
|
|
2411
|
-
interface AmendmentEnd {
|
|
2412
|
-
/**
|
|
2413
|
-
* Use the `end` time of a given discount.
|
|
2414
|
-
*/
|
|
2415
|
-
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2416
|
-
/**
|
|
2417
|
-
* Time span for the amendment starting from the `amendment_start`.
|
|
2418
|
-
*/
|
|
2419
|
-
duration?: AmendmentEnd.Duration;
|
|
2420
|
-
/**
|
|
2421
|
-
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2422
|
-
*/
|
|
2423
|
-
timestamp?: number;
|
|
2424
|
-
/**
|
|
2425
|
-
* Select one of three ways to pass the `amendment_end`.
|
|
2426
|
-
*/
|
|
2427
|
-
type: AmendmentEnd.Type;
|
|
2428
|
-
}
|
|
2429
|
-
interface AmendmentStart {
|
|
2430
|
-
/**
|
|
2431
|
-
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2432
|
-
*/
|
|
2433
|
-
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2434
|
-
/**
|
|
2435
|
-
* Use the `end` time of a given discount.
|
|
2436
|
-
*/
|
|
2437
|
-
discount_end?: AmendmentStart.DiscountEnd;
|
|
2438
|
-
/**
|
|
2439
|
-
* A precise Unix timestamp for the amendment to start.
|
|
2440
|
-
*/
|
|
2441
|
-
timestamp?: number;
|
|
2442
|
-
/**
|
|
2443
|
-
* Select one of three ways to pass the `amendment_start`.
|
|
2444
|
-
*/
|
|
2445
|
-
type: AmendmentStart.Type;
|
|
2446
|
-
}
|
|
2447
|
-
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
2448
|
-
interface DiscountAction {
|
|
2449
|
-
/**
|
|
2450
|
-
* Details of the discount to add.
|
|
2451
|
-
*/
|
|
2452
|
-
add?: DiscountAction.Add;
|
|
2453
|
-
/**
|
|
2454
|
-
* Details of the discount to remove.
|
|
2455
|
-
*/
|
|
2456
|
-
remove?: DiscountAction.Remove;
|
|
2457
|
-
/**
|
|
2458
|
-
* Details of the discount to replace the existing discounts with.
|
|
2459
|
-
*/
|
|
2460
|
-
set?: DiscountAction.Set;
|
|
2461
|
-
/**
|
|
2462
|
-
* Determines the type of discount action.
|
|
2463
|
-
*/
|
|
2464
|
-
type: DiscountAction.Type;
|
|
2465
|
-
}
|
|
2466
|
-
interface ItemAction {
|
|
2467
|
-
/**
|
|
2468
|
-
* 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.
|
|
2469
|
-
*/
|
|
2470
|
-
add?: ItemAction.Add;
|
|
2471
|
-
/**
|
|
2472
|
-
* Details of the subscription item to remove.
|
|
2473
|
-
*/
|
|
2474
|
-
remove?: ItemAction.Remove;
|
|
2475
|
-
/**
|
|
2476
|
-
* 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.
|
|
2477
|
-
*/
|
|
2478
|
-
set?: ItemAction.Set;
|
|
2479
|
-
/**
|
|
2480
|
-
* Determines the type of item action.
|
|
2481
|
-
*/
|
|
2482
|
-
type: ItemAction.Type;
|
|
2483
|
-
}
|
|
2484
|
-
interface MetadataAction {
|
|
2485
|
-
/**
|
|
2486
|
-
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
2487
|
-
*/
|
|
2488
|
-
add?: {
|
|
2489
|
-
[key: string]: string;
|
|
2490
|
-
};
|
|
2491
|
-
/**
|
|
2492
|
-
* Keys to remove from schedule phase metadata.
|
|
2493
|
-
*/
|
|
2494
|
-
remove?: Array<string>;
|
|
2495
|
-
/**
|
|
2496
|
-
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
2497
|
-
*/
|
|
2498
|
-
set?: Emptyable<{
|
|
2499
|
-
[key: string]: string;
|
|
2500
|
-
}>;
|
|
2501
|
-
/**
|
|
2502
|
-
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
2503
|
-
*/
|
|
2504
|
-
type: MetadataAction.Type;
|
|
2505
|
-
}
|
|
2506
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
2507
|
-
interface SetPauseCollection {
|
|
2508
|
-
/**
|
|
2509
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
2510
|
-
*/
|
|
2511
|
-
set?: SetPauseCollection.Set;
|
|
2512
|
-
/**
|
|
2513
|
-
* Determines the type of the pause_collection amendment.
|
|
2514
|
-
*/
|
|
2515
|
-
type: SetPauseCollection.Type;
|
|
2516
|
-
}
|
|
2517
|
-
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
2518
|
-
interface TrialSettings {
|
|
2519
|
-
/**
|
|
2520
|
-
* Defines how the subscription should behave when a trial ends.
|
|
2521
|
-
*/
|
|
2522
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
2523
|
-
}
|
|
2524
|
-
namespace AmendmentEnd {
|
|
2525
|
-
interface DiscountEnd {
|
|
2526
|
-
/**
|
|
2527
|
-
* The ID of a specific discount.
|
|
2528
|
-
*/
|
|
2529
|
-
discount: string;
|
|
2530
|
-
}
|
|
2531
|
-
interface Duration {
|
|
2532
|
-
/**
|
|
2533
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2534
|
-
*/
|
|
2535
|
-
interval: Duration.Interval;
|
|
2536
|
-
/**
|
|
2537
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2538
|
-
*/
|
|
2539
|
-
interval_count: number;
|
|
2540
|
-
}
|
|
2541
|
-
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
2542
|
-
namespace Duration {
|
|
2543
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2544
|
-
}
|
|
2545
|
-
}
|
|
2546
|
-
namespace AmendmentStart {
|
|
2547
|
-
interface AmendmentEnd {
|
|
2548
|
-
/**
|
|
2549
|
-
* 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.
|
|
2550
|
-
*/
|
|
2551
|
-
index: number;
|
|
2552
|
-
}
|
|
2553
|
-
interface DiscountEnd {
|
|
2554
|
-
/**
|
|
2555
|
-
* The ID of a specific discount.
|
|
2556
|
-
*/
|
|
2557
|
-
discount: string;
|
|
2558
|
-
}
|
|
2559
|
-
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
2560
|
-
}
|
|
2561
|
-
namespace DiscountAction {
|
|
2562
|
-
interface Add {
|
|
2563
|
-
/**
|
|
2564
|
-
* The coupon code to redeem.
|
|
2565
|
-
*/
|
|
2566
|
-
coupon?: string;
|
|
2567
|
-
/**
|
|
2568
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
2569
|
-
*/
|
|
2570
|
-
discount?: string;
|
|
2571
|
-
/**
|
|
2572
|
-
* Details to determine how long the discount should be applied for.
|
|
2573
|
-
*/
|
|
2574
|
-
discount_end?: Add.DiscountEnd;
|
|
2575
|
-
/**
|
|
2576
|
-
* 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.
|
|
2577
|
-
*/
|
|
2578
|
-
index?: number;
|
|
2579
|
-
/**
|
|
2580
|
-
* The promotion code to redeem.
|
|
2581
|
-
*/
|
|
2582
|
-
promotion_code?: string;
|
|
2583
|
-
}
|
|
2584
|
-
interface Remove {
|
|
2585
|
-
/**
|
|
2586
|
-
* The coupon code to remove from the `discounts` array.
|
|
2587
|
-
*/
|
|
2588
|
-
coupon?: string;
|
|
2589
|
-
/**
|
|
2590
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
2591
|
-
*/
|
|
2592
|
-
discount?: string;
|
|
2593
|
-
/**
|
|
2594
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
2595
|
-
*/
|
|
2596
|
-
promotion_code?: string;
|
|
2597
|
-
}
|
|
2598
|
-
interface Set {
|
|
2599
|
-
/**
|
|
2600
|
-
* The coupon code to replace the `discounts` array with.
|
|
2601
|
-
*/
|
|
2602
|
-
coupon?: string;
|
|
2603
|
-
/**
|
|
2604
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
2605
|
-
*/
|
|
2606
|
-
discount?: string;
|
|
2607
|
-
/**
|
|
2608
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
2609
|
-
*/
|
|
2610
|
-
promotion_code?: string;
|
|
2611
|
-
}
|
|
2612
|
-
type Type = 'add' | 'remove' | 'set';
|
|
2613
|
-
namespace Add {
|
|
2614
|
-
interface DiscountEnd {
|
|
2615
|
-
/**
|
|
2616
|
-
* The type of calculation made to determine when the discount ends.
|
|
2617
|
-
*/
|
|
2618
|
-
type: 'amendment_end';
|
|
2619
|
-
}
|
|
2620
|
-
}
|
|
2621
|
-
}
|
|
2622
|
-
namespace ItemAction {
|
|
2623
|
-
interface Add {
|
|
2624
|
-
/**
|
|
2625
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
2626
|
-
*/
|
|
2627
|
-
discounts?: Array<Add.Discount>;
|
|
2628
|
-
/**
|
|
2629
|
-
* 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`.
|
|
2630
|
-
*/
|
|
2631
|
-
metadata?: MetadataParam;
|
|
2632
|
-
/**
|
|
2633
|
-
* The ID of the price object.
|
|
2634
|
-
*/
|
|
2635
|
-
price: string;
|
|
2636
|
-
/**
|
|
2637
|
-
* Quantity for this item.
|
|
2638
|
-
*/
|
|
2639
|
-
quantity?: number;
|
|
2640
|
-
/**
|
|
2641
|
-
* 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`.
|
|
2642
|
-
*/
|
|
2643
|
-
tax_rates?: Array<string>;
|
|
2644
|
-
/**
|
|
2645
|
-
* Options that configure the trial on the subscription item.
|
|
2646
|
-
*/
|
|
2647
|
-
trial?: Add.Trial;
|
|
2648
|
-
/**
|
|
2649
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
2650
|
-
*/
|
|
2651
|
-
trial_offer?: string;
|
|
2652
|
-
}
|
|
2653
|
-
interface Remove {
|
|
2654
|
-
/**
|
|
2655
|
-
* ID of a price to remove.
|
|
2656
|
-
*/
|
|
2657
|
-
price: string;
|
|
2658
|
-
}
|
|
2659
|
-
interface Set {
|
|
2660
|
-
/**
|
|
2661
|
-
* 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`.
|
|
2662
|
-
*/
|
|
2663
|
-
discounts?: Array<Set.Discount>;
|
|
2664
|
-
/**
|
|
2665
|
-
* 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`.
|
|
2666
|
-
*/
|
|
2667
|
-
metadata?: MetadataParam;
|
|
2668
|
-
/**
|
|
2669
|
-
* The ID of the price object.
|
|
2670
|
-
*/
|
|
2671
|
-
price: string;
|
|
2672
|
-
/**
|
|
2673
|
-
* 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`.
|
|
2674
|
-
*/
|
|
2675
|
-
quantity?: number;
|
|
2676
|
-
/**
|
|
2677
|
-
* 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`.
|
|
2678
|
-
*/
|
|
2679
|
-
tax_rates?: Array<string>;
|
|
2680
|
-
/**
|
|
2681
|
-
* 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`.
|
|
2682
|
-
*/
|
|
2683
|
-
trial?: Set.Trial;
|
|
2684
|
-
/**
|
|
2685
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
2686
|
-
*/
|
|
2687
|
-
trial_offer?: string;
|
|
2688
|
-
}
|
|
2689
|
-
type Type = 'add' | 'remove' | 'set';
|
|
2690
|
-
namespace Add {
|
|
2691
|
-
interface Discount {
|
|
2692
|
-
/**
|
|
2693
|
-
* ID of the coupon to create a new discount for.
|
|
2694
|
-
*/
|
|
2695
|
-
coupon?: string;
|
|
2696
|
-
/**
|
|
2697
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2698
|
-
*/
|
|
2699
|
-
discount?: string;
|
|
2700
|
-
/**
|
|
2701
|
-
* Details to determine how long the discount should be applied for.
|
|
2702
|
-
*/
|
|
2703
|
-
discount_end?: Discount.DiscountEnd;
|
|
2704
|
-
/**
|
|
2705
|
-
* ID of the promotion code to create a new discount for.
|
|
2706
|
-
*/
|
|
2707
|
-
promotion_code?: string;
|
|
2708
|
-
}
|
|
2709
|
-
interface Trial {
|
|
2710
|
-
/**
|
|
2711
|
-
* 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.
|
|
2712
|
-
*/
|
|
2713
|
-
converts_to?: Array<string>;
|
|
2714
|
-
/**
|
|
2715
|
-
* Determines the type of trial for this item.
|
|
2716
|
-
*/
|
|
2717
|
-
type: Trial.Type;
|
|
2718
|
-
}
|
|
2719
|
-
namespace Discount {
|
|
2720
|
-
interface DiscountEnd {
|
|
2721
|
-
/**
|
|
2722
|
-
* Time span for the redeemed discount.
|
|
2723
|
-
*/
|
|
2724
|
-
duration?: DiscountEnd.Duration;
|
|
2725
|
-
/**
|
|
2726
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2727
|
-
*/
|
|
2728
|
-
timestamp?: number;
|
|
2729
|
-
/**
|
|
2730
|
-
* The type of calculation made to determine when the discount ends.
|
|
2731
|
-
*/
|
|
2732
|
-
type: DiscountEnd.Type;
|
|
2733
|
-
}
|
|
2734
|
-
namespace DiscountEnd {
|
|
2735
|
-
interface Duration {
|
|
2736
|
-
/**
|
|
2737
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2738
|
-
*/
|
|
2739
|
-
interval: Duration.Interval;
|
|
2740
|
-
/**
|
|
2741
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2742
|
-
*/
|
|
2743
|
-
interval_count: number;
|
|
2744
|
-
}
|
|
2745
|
-
type Type = 'duration' | 'timestamp';
|
|
2746
|
-
namespace Duration {
|
|
2747
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2748
|
-
}
|
|
2749
|
-
}
|
|
2750
|
-
}
|
|
2751
|
-
namespace Trial {
|
|
2752
|
-
type Type = 'free' | 'paid';
|
|
2753
|
-
}
|
|
2754
|
-
}
|
|
2755
|
-
namespace Set {
|
|
2756
|
-
interface Discount {
|
|
2757
|
-
/**
|
|
2758
|
-
* ID of the coupon to create a new discount for.
|
|
2759
|
-
*/
|
|
2760
|
-
coupon?: string;
|
|
2761
|
-
/**
|
|
2762
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2763
|
-
*/
|
|
2764
|
-
discount?: string;
|
|
2765
|
-
/**
|
|
2766
|
-
* Details to determine how long the discount should be applied for.
|
|
2767
|
-
*/
|
|
2768
|
-
discount_end?: Discount.DiscountEnd;
|
|
2769
|
-
/**
|
|
2770
|
-
* ID of the promotion code to create a new discount for.
|
|
2771
|
-
*/
|
|
2772
|
-
promotion_code?: string;
|
|
2773
|
-
}
|
|
2774
|
-
interface Trial {
|
|
2775
|
-
/**
|
|
2776
|
-
* 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.
|
|
2777
|
-
*/
|
|
2778
|
-
converts_to?: Array<string>;
|
|
2779
|
-
/**
|
|
2780
|
-
* Determines the type of trial for this item.
|
|
2781
|
-
*/
|
|
2782
|
-
type: Trial.Type;
|
|
2783
|
-
}
|
|
2784
|
-
namespace Discount {
|
|
2785
|
-
interface DiscountEnd {
|
|
2786
|
-
/**
|
|
2787
|
-
* Time span for the redeemed discount.
|
|
2788
|
-
*/
|
|
2789
|
-
duration?: DiscountEnd.Duration;
|
|
2790
|
-
/**
|
|
2791
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2792
|
-
*/
|
|
2793
|
-
timestamp?: number;
|
|
2794
|
-
/**
|
|
2795
|
-
* The type of calculation made to determine when the discount ends.
|
|
2796
|
-
*/
|
|
2797
|
-
type: DiscountEnd.Type;
|
|
2798
|
-
}
|
|
2799
|
-
namespace DiscountEnd {
|
|
2800
|
-
interface Duration {
|
|
2801
|
-
/**
|
|
2802
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2803
|
-
*/
|
|
2804
|
-
interval: Duration.Interval;
|
|
2805
|
-
/**
|
|
2806
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2807
|
-
*/
|
|
2808
|
-
interval_count: number;
|
|
2809
|
-
}
|
|
2810
|
-
type Type = 'duration' | 'timestamp';
|
|
2811
|
-
namespace Duration {
|
|
2812
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2813
|
-
}
|
|
2814
|
-
}
|
|
2815
|
-
}
|
|
2816
|
-
namespace Trial {
|
|
2817
|
-
type Type = 'free' | 'paid';
|
|
2818
|
-
}
|
|
2819
|
-
}
|
|
2820
|
-
}
|
|
2821
|
-
namespace MetadataAction {
|
|
2822
|
-
type Type = 'add' | 'remove' | 'set';
|
|
2823
|
-
}
|
|
2824
|
-
namespace SetPauseCollection {
|
|
2825
|
-
interface Set {
|
|
2826
|
-
/**
|
|
2827
|
-
* The payment collection behavior for this subscription while paused.
|
|
2828
|
-
*/
|
|
2829
|
-
behavior: Set.Behavior;
|
|
2830
|
-
}
|
|
2831
|
-
type Type = 'remove' | 'set';
|
|
2832
|
-
namespace Set {
|
|
2833
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
2834
|
-
}
|
|
2835
|
-
}
|
|
2836
|
-
namespace TrialSettings {
|
|
2837
|
-
interface EndBehavior {
|
|
2838
|
-
/**
|
|
2839
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
2840
|
-
*/
|
|
2841
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
2842
|
-
}
|
|
2843
|
-
namespace EndBehavior {
|
|
2844
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
2845
|
-
}
|
|
2846
|
-
}
|
|
2847
|
-
}
|
|
2848
|
-
namespace Prebilling {
|
|
2849
|
-
interface BillFrom {
|
|
2850
|
-
/**
|
|
2851
|
-
* Start the prebilled period when a specified amendment begins.
|
|
2852
|
-
*/
|
|
2853
|
-
amendment_start?: BillFrom.AmendmentStart;
|
|
2854
|
-
/**
|
|
2855
|
-
* Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
2856
|
-
*/
|
|
2857
|
-
timestamp?: number;
|
|
2858
|
-
/**
|
|
2859
|
-
* Select one of several ways to pass the `bill_from` value.
|
|
2860
|
-
*/
|
|
2861
|
-
type: BillFrom.Type;
|
|
2862
|
-
}
|
|
2863
|
-
interface BillUntil {
|
|
2864
|
-
/**
|
|
2865
|
-
* End the prebilled period when a specified amendment ends.
|
|
2866
|
-
*/
|
|
2867
|
-
amendment_end?: BillUntil.AmendmentEnd;
|
|
2868
|
-
/**
|
|
2869
|
-
* Time span for prebilling, starting from `bill_from`.
|
|
2870
|
-
*/
|
|
2871
|
-
duration?: BillUntil.Duration;
|
|
2872
|
-
/**
|
|
2873
|
-
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
2874
|
-
*/
|
|
2875
|
-
timestamp?: number;
|
|
2876
|
-
/**
|
|
2877
|
-
* Select one of several ways to pass the `bill_until` value.
|
|
2878
|
-
*/
|
|
2879
|
-
type: BillUntil.Type;
|
|
2880
|
-
}
|
|
2881
|
-
type UpdateBehavior = 'prebill' | 'reset';
|
|
2882
|
-
namespace BillFrom {
|
|
2883
|
-
interface AmendmentStart {
|
|
2884
|
-
/**
|
|
2885
|
-
* 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.
|
|
2886
|
-
*/
|
|
2887
|
-
index: number;
|
|
2888
|
-
}
|
|
2889
|
-
type Type = 'amendment_start' | 'now' | 'timestamp';
|
|
2890
|
-
}
|
|
2891
|
-
namespace BillUntil {
|
|
2892
|
-
interface AmendmentEnd {
|
|
2893
|
-
/**
|
|
2894
|
-
* 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.
|
|
2895
|
-
*/
|
|
2896
|
-
index: number;
|
|
2897
|
-
}
|
|
2898
|
-
interface Duration {
|
|
2899
|
-
/**
|
|
2900
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2901
|
-
*/
|
|
2902
|
-
interval: Duration.Interval;
|
|
2903
|
-
/**
|
|
2904
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2905
|
-
*/
|
|
2906
|
-
interval_count: number;
|
|
2907
|
-
}
|
|
2908
|
-
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
2909
|
-
namespace Duration {
|
|
2910
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2911
|
-
}
|
|
2912
|
-
}
|
|
2913
|
-
}
|
|
2914
|
-
namespace ScheduleSettings {
|
|
2915
|
-
type EndBehavior = 'cancel' | 'release';
|
|
2916
|
-
}
|
|
2917
|
-
}
|
|
2918
|
-
export interface SubscriptionScheduleCancelParams {
|
|
2919
|
-
/**
|
|
2920
|
-
* Specifies which fields in the response should be expanded.
|
|
2921
|
-
*/
|
|
2922
|
-
expand?: Array<string>;
|
|
2923
|
-
/**
|
|
2924
|
-
* If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
|
|
2925
|
-
*/
|
|
2926
|
-
invoice_now?: boolean;
|
|
2927
|
-
/**
|
|
2928
|
-
* If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
|
|
1776
|
+
* If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
|
|
2929
1777
|
*/
|
|
2930
1778
|
prorate?: boolean;
|
|
2931
1779
|
}
|
|
@@ -2939,9 +1787,3 @@ export interface SubscriptionScheduleReleaseParams {
|
|
|
2939
1787
|
*/
|
|
2940
1788
|
preserve_cancel_date?: boolean;
|
|
2941
1789
|
}
|
|
2942
|
-
export interface SubscriptionScheduleSerializeBatchCancelParams {
|
|
2943
|
-
}
|
|
2944
|
-
export interface SubscriptionScheduleSerializeBatchCreateParams {
|
|
2945
|
-
}
|
|
2946
|
-
export interface SubscriptionScheduleSerializeBatchUpdateParams {
|
|
2947
|
-
}
|