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
|
@@ -4,7 +4,6 @@ import { Discount, DeletedDiscount } from './Discounts.js';
|
|
|
4
4
|
import { TaxId, DeletedTaxId } from './TaxIds.js';
|
|
5
5
|
import { Application, DeletedApplication } from './Applications.js';
|
|
6
6
|
import { Customer, DeletedCustomer } from './Customers.js';
|
|
7
|
-
import { Margin } from './Margins.js';
|
|
8
7
|
import { PaymentMethod } from './PaymentMethods.js';
|
|
9
8
|
import { CustomerSource } from './CustomerSources.js';
|
|
10
9
|
import { TaxRate } from './TaxRates.js';
|
|
@@ -68,10 +67,6 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
68
67
|
* See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
|
|
69
68
|
*/
|
|
70
69
|
attachPayment(id: string, params?: InvoiceAttachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
71
|
-
/**
|
|
72
|
-
* Detaches a payment from the invoice, removing it from the list of payments
|
|
73
|
-
*/
|
|
74
|
-
detachPayment(id: string, params?: InvoiceDetachPaymentParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
75
70
|
/**
|
|
76
71
|
* Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
|
|
77
72
|
*/
|
|
@@ -116,14 +111,6 @@ export declare class InvoiceResource extends StripeResource {
|
|
|
116
111
|
* Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
|
|
117
112
|
*/
|
|
118
113
|
createPreview(params?: InvoiceCreatePreviewParams, options?: RequestOptions): Promise<Response<Invoice>>;
|
|
119
|
-
serializeBatchUpdate(invoice: string, params?: Record<string, unknown>, options?: {
|
|
120
|
-
apiVersion?: string;
|
|
121
|
-
stripeContext?: string;
|
|
122
|
-
}): string;
|
|
123
|
-
serializeBatchPay(invoice: string, params?: Record<string, unknown>, options?: {
|
|
124
|
-
apiVersion?: string;
|
|
125
|
-
stripeContext?: string;
|
|
126
|
-
}): string;
|
|
127
114
|
/**
|
|
128
115
|
* When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
|
|
129
116
|
*/
|
|
@@ -169,6 +156,10 @@ export interface Invoice {
|
|
|
169
156
|
* The amount, in cents (or local equivalent), that was paid.
|
|
170
157
|
*/
|
|
171
158
|
amount_paid: number;
|
|
159
|
+
/**
|
|
160
|
+
* Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
|
|
161
|
+
*/
|
|
162
|
+
amount_paid_off_stripe?: number;
|
|
172
163
|
/**
|
|
173
164
|
* The difference between amount_due and amount_paid, in cents (or local equivalent).
|
|
174
165
|
*/
|
|
@@ -177,10 +168,6 @@ export interface Invoice {
|
|
|
177
168
|
* This is the sum of all the shipping amounts.
|
|
178
169
|
*/
|
|
179
170
|
amount_shipping: number;
|
|
180
|
-
/**
|
|
181
|
-
* List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
|
|
182
|
-
*/
|
|
183
|
-
amounts_due?: Array<Invoice.AmountsDue> | null;
|
|
184
171
|
/**
|
|
185
172
|
* ID of the Connect Application that created the invoice.
|
|
186
173
|
*/
|
|
@@ -270,10 +257,6 @@ export interface Invoice {
|
|
|
270
257
|
* The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
|
|
271
258
|
*/
|
|
272
259
|
customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
|
|
273
|
-
/**
|
|
274
|
-
* The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
|
|
275
|
-
*/
|
|
276
|
-
default_margins?: Array<string | Margin> | null;
|
|
277
260
|
/**
|
|
278
261
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
279
262
|
*/
|
|
@@ -438,10 +421,6 @@ export interface Invoice {
|
|
|
438
421
|
* The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
|
|
439
422
|
*/
|
|
440
423
|
total_excluding_tax: number | null;
|
|
441
|
-
/**
|
|
442
|
-
* The aggregate amounts calculated per margin across all line items.
|
|
443
|
-
*/
|
|
444
|
-
total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
|
|
445
424
|
/**
|
|
446
425
|
* Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
|
|
447
426
|
*/
|
|
@@ -470,40 +449,6 @@ export interface DeletedInvoice {
|
|
|
470
449
|
deleted: true;
|
|
471
450
|
}
|
|
472
451
|
export declare namespace Invoice {
|
|
473
|
-
interface AmountsDue {
|
|
474
|
-
/**
|
|
475
|
-
* Incremental amount due for this payment in cents (or local equivalent).
|
|
476
|
-
*/
|
|
477
|
-
amount: number;
|
|
478
|
-
/**
|
|
479
|
-
* The amount in cents (or local equivalent) that was paid for this payment.
|
|
480
|
-
*/
|
|
481
|
-
amount_paid: number;
|
|
482
|
-
/**
|
|
483
|
-
* The difference between the payment's amount and amount_paid, in cents (or local equivalent).
|
|
484
|
-
*/
|
|
485
|
-
amount_remaining: number;
|
|
486
|
-
/**
|
|
487
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
488
|
-
*/
|
|
489
|
-
days_until_due: number | null;
|
|
490
|
-
/**
|
|
491
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
492
|
-
*/
|
|
493
|
-
description: string | null;
|
|
494
|
-
/**
|
|
495
|
-
* Date on which a payment plan's payment is due.
|
|
496
|
-
*/
|
|
497
|
-
due_date: number | null;
|
|
498
|
-
/**
|
|
499
|
-
* Timestamp when the payment was paid.
|
|
500
|
-
*/
|
|
501
|
-
paid_at: number | null;
|
|
502
|
-
/**
|
|
503
|
-
* The status of the payment, one of `open`, `paid`, or `past_due`
|
|
504
|
-
*/
|
|
505
|
-
status: AmountsDue.Status;
|
|
506
|
-
}
|
|
507
452
|
interface AutomaticTax {
|
|
508
453
|
/**
|
|
509
454
|
* If Stripe disabled automatic tax, this enum describes why.
|
|
@@ -821,16 +766,6 @@ export declare namespace Invoice {
|
|
|
821
766
|
*/
|
|
822
767
|
discount: string | Discount | DeletedDiscount;
|
|
823
768
|
}
|
|
824
|
-
interface TotalMarginAmount {
|
|
825
|
-
/**
|
|
826
|
-
* The amount, in cents (or local equivalent), of the reduction in line item amount.
|
|
827
|
-
*/
|
|
828
|
-
amount: number;
|
|
829
|
-
/**
|
|
830
|
-
* The margin that was applied to get this margin amount.
|
|
831
|
-
*/
|
|
832
|
-
margin: string | Margin;
|
|
833
|
-
}
|
|
834
769
|
interface TotalPretaxCreditAmount {
|
|
835
770
|
/**
|
|
836
771
|
* The amount, in cents (or local equivalent), of the pretax credit amount.
|
|
@@ -844,10 +779,6 @@ export declare namespace Invoice {
|
|
|
844
779
|
* The discount that was applied to get this pretax credit amount.
|
|
845
780
|
*/
|
|
846
781
|
discount?: string | Discount | DeletedDiscount;
|
|
847
|
-
/**
|
|
848
|
-
* The margin that was applied to get this pretax credit amount.
|
|
849
|
-
*/
|
|
850
|
-
margin?: string | Margin;
|
|
851
782
|
/**
|
|
852
783
|
* Type of the pretax credit amount referenced.
|
|
853
784
|
*/
|
|
@@ -879,9 +810,6 @@ export declare namespace Invoice {
|
|
|
879
810
|
*/
|
|
880
811
|
type: 'tax_rate_details';
|
|
881
812
|
}
|
|
882
|
-
namespace AmountsDue {
|
|
883
|
-
type Status = 'open' | 'paid' | 'past_due';
|
|
884
|
-
}
|
|
885
813
|
namespace AutomaticTax {
|
|
886
814
|
type DisabledReason = 'finalization_requires_location_inputs' | 'finalization_system_error';
|
|
887
815
|
interface Liability {
|
|
@@ -906,7 +834,7 @@ export declare namespace Invoice {
|
|
|
906
834
|
type Type = 'account' | 'self';
|
|
907
835
|
}
|
|
908
836
|
namespace LastFinalizationError {
|
|
909
|
-
type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | '
|
|
837
|
+
type Code = 'account_closed' | 'account_country_invalid_address' | 'account_error_country_change_requires_additional_steps' | 'account_information_mismatch' | 'account_invalid' | 'account_number_invalid' | 'account_token_required_for_v2_account' | 'acss_debit_session_incomplete' | 'action_blocked' | 'alipay_upgrade_required' | 'amount_too_large' | 'amount_too_small' | 'api_key_expired' | 'application_fees_not_allowed' | 'approval_required' | 'authentication_required' | 'balance_insufficient' | 'balance_invalid_parameter' | 'bank_account_bad_routing_numbers' | 'bank_account_declined' | 'bank_account_exists' | 'bank_account_restricted' | 'bank_account_unusable' | 'bank_account_unverified' | 'bank_account_verification_failed' | 'billing_invalid_mandate' | 'bitcoin_upgrade_required' | 'capture_charge_authorization_expired' | 'capture_unauthorized_payment' | 'card_decline_rate_limit_exceeded' | 'card_declined' | 'cardholder_phone_number_required' | 'charge_already_captured' | 'charge_already_refunded' | 'charge_disputed' | 'charge_exceeds_source_limit' | 'charge_exceeds_transaction_limit' | 'charge_expired_for_capture' | 'charge_invalid_parameter' | 'charge_not_refundable' | 'clearing_code_unsupported' | 'country_code_invalid' | 'country_unsupported' | 'coupon_expired' | 'customer_max_payment_methods' | 'customer_max_subscriptions' | 'customer_session_expired' | 'customer_tax_location_invalid' | 'debit_not_authorized' | 'email_invalid' | 'expired_card' | 'financial_connections_account_inactive' | 'financial_connections_account_pending_account_numbers' | 'financial_connections_account_unavailable_account_numbers' | 'financial_connections_no_successful_transaction_refresh' | 'forwarding_api_inactive' | 'forwarding_api_invalid_parameter' | 'forwarding_api_retryable_upstream_error' | 'forwarding_api_upstream_connection_error' | 'forwarding_api_upstream_connection_timeout' | 'forwarding_api_upstream_error' | 'idempotency_key_in_use' | 'incorrect_address' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_zip' | 'india_recurring_payment_mandate_canceled' | 'instant_payouts_config_disabled' | 'instant_payouts_currency_disabled' | 'instant_payouts_limit_exceeded' | 'instant_payouts_unsupported' | 'insufficient_funds' | 'intent_invalid_state' | 'intent_verification_method_missing' | 'invalid_card_type' | 'invalid_characters' | 'invalid_charge_amount' | 'invalid_cvc' | 'invalid_expiry_month' | 'invalid_expiry_year' | 'invalid_mandate_reference_prefix_format' | 'invalid_number' | 'invalid_source_usage' | 'invalid_tax_location' | 'invoice_no_customer_line_items' | 'invoice_no_payment_method_types' | 'invoice_no_subscription_line_items' | 'invoice_not_editable' | 'invoice_on_behalf_of_not_editable' | 'invoice_payment_intent_requires_action' | 'invoice_upcoming_none' | 'livemode_mismatch' | 'lock_timeout' | 'missing' | 'no_account' | 'not_allowed_on_standard_account' | 'out_of_inventory' | 'ownership_declaration_not_allowed' | 'parameter_invalid_empty' | 'parameter_invalid_integer' | 'parameter_invalid_string_blank' | 'parameter_invalid_string_empty' | 'parameter_missing' | 'parameter_unknown' | 'parameters_exclusive' | 'payment_intent_action_required' | 'payment_intent_authentication_failure' | 'payment_intent_incompatible_payment_method' | 'payment_intent_invalid_parameter' | 'payment_intent_konbini_rejected_confirmation_number' | 'payment_intent_mandate_invalid' | 'payment_intent_payment_attempt_expired' | 'payment_intent_payment_attempt_failed' | 'payment_intent_rate_limit_exceeded' | 'payment_intent_unexpected_state' | 'payment_method_bank_account_already_verified' | 'payment_method_bank_account_blocked' | 'payment_method_billing_details_address_missing' | 'payment_method_configuration_failures' | 'payment_method_currency_mismatch' | 'payment_method_customer_decline' | 'payment_method_invalid_parameter' | 'payment_method_invalid_parameter_testmode' | 'payment_method_microdeposit_failed' | 'payment_method_microdeposit_processing_error' | 'payment_method_microdeposit_verification_amounts_invalid' | 'payment_method_microdeposit_verification_amounts_mismatch' | 'payment_method_microdeposit_verification_attempts_exceeded' | 'payment_method_microdeposit_verification_descriptor_code_mismatch' | 'payment_method_microdeposit_verification_timeout' | 'payment_method_not_available' | 'payment_method_provider_decline' | 'payment_method_provider_timeout' | 'payment_method_unactivated' | 'payment_method_unexpected_state' | 'payment_method_unsupported_type' | 'payout_reconciliation_not_ready' | 'payouts_limit_exceeded' | 'payouts_not_allowed' | 'platform_account_required' | 'platform_api_key_expired' | 'postal_code_invalid' | 'processing_error' | 'product_inactive' | 'progressive_onboarding_limit_exceeded' | 'rate_limit' | 'refer_to_customer' | 'refund_disputed_payment' | 'request_blocked' | 'resource_already_exists' | 'resource_missing' | 'return_intent_already_processed' | 'routing_number_invalid' | 'secret_key_required' | 'sepa_unsupported_account' | 'service_period_coupon_with_metered_tiered_item_unsupported' | 'setup_attempt_failed' | 'setup_intent_authentication_failure' | 'setup_intent_invalid_parameter' | 'setup_intent_mandate_invalid' | 'setup_intent_mobile_wallet_unsupported' | 'setup_intent_setup_attempt_expired' | 'setup_intent_unexpected_state' | 'shipping_address_invalid' | 'shipping_calculation_failed' | 'siret_invalid' | 'sku_inactive' | 'state_unsupported' | 'status_transition_invalid' | 'storer_capability_missing' | 'storer_capability_not_active' | 'stripe_tax_inactive' | 'tax_id_invalid' | 'tax_id_prohibited' | 'taxes_calculation_failed' | 'terminal_location_country_unsupported' | 'terminal_reader_busy' | 'terminal_reader_hardware_fault' | 'terminal_reader_invalid_location_for_activation' | 'terminal_reader_invalid_location_for_payment' | 'terminal_reader_offline' | 'terminal_reader_timeout' | 'testmode_charges_only' | 'tls_version_unsupported' | 'token_already_used' | 'token_card_network_invalid' | 'token_in_use' | 'transfer_source_balance_parameters_mismatch' | 'transfers_not_allowed' | 'url_invalid';
|
|
910
838
|
type Type = 'api_error' | 'card_error' | 'idempotency_error' | 'invalid_request_error';
|
|
911
839
|
}
|
|
912
840
|
namespace Parent {
|
|
@@ -922,10 +850,6 @@ export declare namespace Invoice {
|
|
|
922
850
|
* *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
|
|
923
851
|
*/
|
|
924
852
|
metadata: Metadata | null;
|
|
925
|
-
/**
|
|
926
|
-
* 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).
|
|
927
|
-
*/
|
|
928
|
-
pause_collection?: SubscriptionDetails.PauseCollection | null;
|
|
929
853
|
/**
|
|
930
854
|
* The subscription that generated this invoice
|
|
931
855
|
*/
|
|
@@ -936,21 +860,6 @@ export declare namespace Invoice {
|
|
|
936
860
|
subscription_proration_date?: number;
|
|
937
861
|
}
|
|
938
862
|
type Type = 'quote_details' | 'subscription_details';
|
|
939
|
-
namespace SubscriptionDetails {
|
|
940
|
-
interface PauseCollection {
|
|
941
|
-
/**
|
|
942
|
-
* The payment collection behavior for this subscription while paused.
|
|
943
|
-
*/
|
|
944
|
-
behavior: PauseCollection.Behavior | null;
|
|
945
|
-
/**
|
|
946
|
-
* The time after which the subscription will resume collecting payments.
|
|
947
|
-
*/
|
|
948
|
-
resumes_at: number | null;
|
|
949
|
-
}
|
|
950
|
-
namespace PauseCollection {
|
|
951
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
952
|
-
}
|
|
953
|
-
}
|
|
954
863
|
}
|
|
955
864
|
namespace PaymentSettings {
|
|
956
865
|
interface PaymentMethodOptions {
|
|
@@ -962,10 +871,6 @@ export declare namespace Invoice {
|
|
|
962
871
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
963
872
|
*/
|
|
964
873
|
bancontact: PaymentMethodOptions.Bancontact | null;
|
|
965
|
-
/**
|
|
966
|
-
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
967
|
-
*/
|
|
968
|
-
blik?: PaymentMethodOptions.Blik | null;
|
|
969
874
|
/**
|
|
970
875
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
971
876
|
*/
|
|
@@ -974,10 +879,6 @@ export declare namespace Invoice {
|
|
|
974
879
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
975
880
|
*/
|
|
976
881
|
customer_balance: PaymentMethodOptions.CustomerBalance | null;
|
|
977
|
-
/**
|
|
978
|
-
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
979
|
-
*/
|
|
980
|
-
id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
|
|
981
882
|
/**
|
|
982
883
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
983
884
|
*/
|
|
@@ -1003,7 +904,7 @@ export declare namespace Invoice {
|
|
|
1003
904
|
*/
|
|
1004
905
|
us_bank_account: PaymentMethodOptions.UsBankAccount | null;
|
|
1005
906
|
}
|
|
1006
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | '
|
|
907
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
1007
908
|
namespace PaymentMethodOptions {
|
|
1008
909
|
interface AcssDebit {
|
|
1009
910
|
mandate_options?: AcssDebit.MandateOptions;
|
|
@@ -1018,8 +919,6 @@ export declare namespace Invoice {
|
|
|
1018
919
|
*/
|
|
1019
920
|
preferred_language: Bancontact.PreferredLanguage;
|
|
1020
921
|
}
|
|
1021
|
-
interface Blik {
|
|
1022
|
-
}
|
|
1023
922
|
interface Card {
|
|
1024
923
|
installments?: Card.Installments;
|
|
1025
924
|
/**
|
|
@@ -1034,8 +933,6 @@ export declare namespace Invoice {
|
|
|
1034
933
|
*/
|
|
1035
934
|
funding_type: 'bank_transfer' | null;
|
|
1036
935
|
}
|
|
1037
|
-
interface IdBankTransfer {
|
|
1038
|
-
}
|
|
1039
936
|
interface Konbini {
|
|
1040
937
|
}
|
|
1041
938
|
interface Payto {
|
|
@@ -1172,13 +1069,9 @@ export declare namespace Invoice {
|
|
|
1172
1069
|
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
|
1173
1070
|
*/
|
|
1174
1071
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1175
|
-
/**
|
|
1176
|
-
* The institution to use to filter for possible accounts to link.
|
|
1177
|
-
*/
|
|
1178
|
-
institution?: string;
|
|
1179
1072
|
}
|
|
1180
1073
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1181
|
-
type Prefetch = 'balances' | '
|
|
1074
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1182
1075
|
namespace Filters {
|
|
1183
1076
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1184
1077
|
}
|
|
@@ -1235,7 +1128,7 @@ export declare namespace Invoice {
|
|
|
1235
1128
|
}
|
|
1236
1129
|
}
|
|
1237
1130
|
namespace TotalPretaxCreditAmount {
|
|
1238
|
-
type Type = 'credit_balance_transaction' | 'discount'
|
|
1131
|
+
type Type = 'credit_balance_transaction' | 'discount';
|
|
1239
1132
|
}
|
|
1240
1133
|
namespace TotalTax {
|
|
1241
1134
|
type TaxBehavior = 'exclusive' | 'inclusive';
|
|
@@ -1243,7 +1136,7 @@ export declare namespace Invoice {
|
|
|
1243
1136
|
/**
|
|
1244
1137
|
* ID of the tax rate
|
|
1245
1138
|
*/
|
|
1246
|
-
tax_rate: string
|
|
1139
|
+
tax_rate: string;
|
|
1247
1140
|
}
|
|
1248
1141
|
type TaxabilityReason = 'customer_exempt' | 'not_available' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
|
|
1249
1142
|
}
|
|
@@ -1253,10 +1146,6 @@ export interface InvoiceCreateParams {
|
|
|
1253
1146
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1254
1147
|
*/
|
|
1255
1148
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
1256
|
-
/**
|
|
1257
|
-
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
1258
|
-
*/
|
|
1259
|
-
amounts_due?: Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
1260
1149
|
/**
|
|
1261
1150
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
|
|
1262
1151
|
*/
|
|
@@ -1297,10 +1186,6 @@ export interface InvoiceCreateParams {
|
|
|
1297
1186
|
* The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
|
1298
1187
|
*/
|
|
1299
1188
|
days_until_due?: number;
|
|
1300
|
-
/**
|
|
1301
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
1302
|
-
*/
|
|
1303
|
-
default_margins?: Array<string>;
|
|
1304
1189
|
/**
|
|
1305
1190
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
1306
1191
|
*/
|
|
@@ -1391,24 +1276,6 @@ export interface InvoiceCreateParams {
|
|
|
1391
1276
|
transfer_data?: InvoiceCreateParams.TransferData;
|
|
1392
1277
|
}
|
|
1393
1278
|
export declare namespace InvoiceCreateParams {
|
|
1394
|
-
interface AmountsDue {
|
|
1395
|
-
/**
|
|
1396
|
-
* The amount in cents (or local equivalent).
|
|
1397
|
-
*/
|
|
1398
|
-
amount: number;
|
|
1399
|
-
/**
|
|
1400
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
1401
|
-
*/
|
|
1402
|
-
days_until_due?: number;
|
|
1403
|
-
/**
|
|
1404
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1405
|
-
*/
|
|
1406
|
-
description: string;
|
|
1407
|
-
/**
|
|
1408
|
-
* Date on which a payment plan's payment is due.
|
|
1409
|
-
*/
|
|
1410
|
-
due_date?: number;
|
|
1411
|
-
}
|
|
1412
1279
|
interface AutomaticTax {
|
|
1413
1280
|
/**
|
|
1414
1281
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -1439,10 +1306,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1439
1306
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1440
1307
|
*/
|
|
1441
1308
|
discount?: string;
|
|
1442
|
-
/**
|
|
1443
|
-
* Details to determine how long the discount should be applied for.
|
|
1444
|
-
*/
|
|
1445
|
-
discount_end?: Discount.DiscountEnd;
|
|
1446
1309
|
/**
|
|
1447
1310
|
* ID of the promotion code to create a new discount for.
|
|
1448
1311
|
*/
|
|
@@ -1550,38 +1413,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1550
1413
|
type Type = 'account' | 'self';
|
|
1551
1414
|
}
|
|
1552
1415
|
}
|
|
1553
|
-
namespace Discount {
|
|
1554
|
-
interface DiscountEnd {
|
|
1555
|
-
/**
|
|
1556
|
-
* Time span for the redeemed discount.
|
|
1557
|
-
*/
|
|
1558
|
-
duration?: DiscountEnd.Duration;
|
|
1559
|
-
/**
|
|
1560
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1561
|
-
*/
|
|
1562
|
-
timestamp?: number;
|
|
1563
|
-
/**
|
|
1564
|
-
* The type of calculation made to determine when the discount ends.
|
|
1565
|
-
*/
|
|
1566
|
-
type: DiscountEnd.Type;
|
|
1567
|
-
}
|
|
1568
|
-
namespace DiscountEnd {
|
|
1569
|
-
interface Duration {
|
|
1570
|
-
/**
|
|
1571
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1572
|
-
*/
|
|
1573
|
-
interval: Duration.Interval;
|
|
1574
|
-
/**
|
|
1575
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1576
|
-
*/
|
|
1577
|
-
interval_count: number;
|
|
1578
|
-
}
|
|
1579
|
-
type Type = 'duration' | 'timestamp';
|
|
1580
|
-
namespace Duration {
|
|
1581
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1582
|
-
}
|
|
1583
|
-
}
|
|
1584
|
-
}
|
|
1585
1416
|
namespace Issuer {
|
|
1586
1417
|
type Type = 'account' | 'self';
|
|
1587
1418
|
}
|
|
@@ -1595,10 +1426,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1595
1426
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
1596
1427
|
*/
|
|
1597
1428
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
1598
|
-
/**
|
|
1599
|
-
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
1600
|
-
*/
|
|
1601
|
-
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
1602
1429
|
/**
|
|
1603
1430
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
1604
1431
|
*/
|
|
@@ -1607,10 +1434,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1607
1434
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1608
1435
|
*/
|
|
1609
1436
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
1610
|
-
/**
|
|
1611
|
-
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
1612
|
-
*/
|
|
1613
|
-
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
1614
1437
|
/**
|
|
1615
1438
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1616
1439
|
*/
|
|
@@ -1636,7 +1459,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
1636
1459
|
*/
|
|
1637
1460
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
1638
1461
|
}
|
|
1639
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | '
|
|
1462
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
1640
1463
|
namespace PaymentMethodOptions {
|
|
1641
1464
|
interface AcssDebit {
|
|
1642
1465
|
/**
|
|
@@ -1654,8 +1477,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1654
1477
|
*/
|
|
1655
1478
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
1656
1479
|
}
|
|
1657
|
-
interface Blik {
|
|
1658
|
-
}
|
|
1659
1480
|
interface Card {
|
|
1660
1481
|
/**
|
|
1661
1482
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -1678,8 +1499,6 @@ export declare namespace InvoiceCreateParams {
|
|
|
1678
1499
|
*/
|
|
1679
1500
|
funding_type?: string;
|
|
1680
1501
|
}
|
|
1681
|
-
interface IdBankTransfer {
|
|
1682
|
-
}
|
|
1683
1502
|
interface Konbini {
|
|
1684
1503
|
}
|
|
1685
1504
|
interface Payto {
|
|
@@ -1848,13 +1667,9 @@ export declare namespace InvoiceCreateParams {
|
|
|
1848
1667
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1849
1668
|
*/
|
|
1850
1669
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1851
|
-
/**
|
|
1852
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
1853
|
-
*/
|
|
1854
|
-
institution?: string;
|
|
1855
1670
|
}
|
|
1856
1671
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
1857
|
-
type Prefetch = 'balances' | '
|
|
1672
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1858
1673
|
namespace Filters {
|
|
1859
1674
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1860
1675
|
}
|
|
@@ -1992,10 +1807,6 @@ export interface InvoiceUpdateParams {
|
|
|
1992
1807
|
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
|
1993
1808
|
*/
|
|
1994
1809
|
account_tax_ids?: Emptyable<Array<string>>;
|
|
1995
|
-
/**
|
|
1996
|
-
* List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
|
1997
|
-
*/
|
|
1998
|
-
amounts_due?: Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
1999
1810
|
/**
|
|
2000
1811
|
* A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees).
|
|
2001
1812
|
*/
|
|
@@ -2024,10 +1835,6 @@ export interface InvoiceUpdateParams {
|
|
|
2024
1835
|
* The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
|
|
2025
1836
|
*/
|
|
2026
1837
|
days_until_due?: number;
|
|
2027
|
-
/**
|
|
2028
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
2029
|
-
*/
|
|
2030
|
-
default_margins?: Emptyable<Array<string>>;
|
|
2031
1838
|
/**
|
|
2032
1839
|
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
|
2033
1840
|
*/
|
|
@@ -2106,24 +1913,6 @@ export interface InvoiceUpdateParams {
|
|
|
2106
1913
|
transfer_data?: Emptyable<InvoiceUpdateParams.TransferData>;
|
|
2107
1914
|
}
|
|
2108
1915
|
export declare namespace InvoiceUpdateParams {
|
|
2109
|
-
interface AmountsDue {
|
|
2110
|
-
/**
|
|
2111
|
-
* The amount in cents (or local equivalent).
|
|
2112
|
-
*/
|
|
2113
|
-
amount: number;
|
|
2114
|
-
/**
|
|
2115
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
2116
|
-
*/
|
|
2117
|
-
days_until_due?: number;
|
|
2118
|
-
/**
|
|
2119
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
2120
|
-
*/
|
|
2121
|
-
description: string;
|
|
2122
|
-
/**
|
|
2123
|
-
* Date on which a payment plan's payment is due.
|
|
2124
|
-
*/
|
|
2125
|
-
due_date?: number;
|
|
2126
|
-
}
|
|
2127
1916
|
interface AutomaticTax {
|
|
2128
1917
|
/**
|
|
2129
1918
|
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
@@ -2154,10 +1943,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2154
1943
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2155
1944
|
*/
|
|
2156
1945
|
discount?: string;
|
|
2157
|
-
/**
|
|
2158
|
-
* Details to determine how long the discount should be applied for.
|
|
2159
|
-
*/
|
|
2160
|
-
discount_end?: Discount.DiscountEnd;
|
|
2161
1946
|
/**
|
|
2162
1947
|
* ID of the promotion code to create a new discount for.
|
|
2163
1948
|
*/
|
|
@@ -2254,38 +2039,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2254
2039
|
type Type = 'account' | 'self';
|
|
2255
2040
|
}
|
|
2256
2041
|
}
|
|
2257
|
-
namespace Discount {
|
|
2258
|
-
interface DiscountEnd {
|
|
2259
|
-
/**
|
|
2260
|
-
* Time span for the redeemed discount.
|
|
2261
|
-
*/
|
|
2262
|
-
duration?: DiscountEnd.Duration;
|
|
2263
|
-
/**
|
|
2264
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2265
|
-
*/
|
|
2266
|
-
timestamp?: number;
|
|
2267
|
-
/**
|
|
2268
|
-
* The type of calculation made to determine when the discount ends.
|
|
2269
|
-
*/
|
|
2270
|
-
type: DiscountEnd.Type;
|
|
2271
|
-
}
|
|
2272
|
-
namespace DiscountEnd {
|
|
2273
|
-
interface Duration {
|
|
2274
|
-
/**
|
|
2275
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2276
|
-
*/
|
|
2277
|
-
interval: Duration.Interval;
|
|
2278
|
-
/**
|
|
2279
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2280
|
-
*/
|
|
2281
|
-
interval_count: number;
|
|
2282
|
-
}
|
|
2283
|
-
type Type = 'duration' | 'timestamp';
|
|
2284
|
-
namespace Duration {
|
|
2285
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2286
|
-
}
|
|
2287
|
-
}
|
|
2288
|
-
}
|
|
2289
2042
|
namespace Issuer {
|
|
2290
2043
|
type Type = 'account' | 'self';
|
|
2291
2044
|
}
|
|
@@ -2299,10 +2052,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2299
2052
|
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
|
|
2300
2053
|
*/
|
|
2301
2054
|
bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
|
|
2302
|
-
/**
|
|
2303
|
-
* If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
|
|
2304
|
-
*/
|
|
2305
|
-
blik?: Emptyable<PaymentMethodOptions.Blik>;
|
|
2306
2055
|
/**
|
|
2307
2056
|
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
|
|
2308
2057
|
*/
|
|
@@ -2311,10 +2060,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2311
2060
|
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
2312
2061
|
*/
|
|
2313
2062
|
customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
|
|
2314
|
-
/**
|
|
2315
|
-
* If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
|
|
2316
|
-
*/
|
|
2317
|
-
id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
|
|
2318
2063
|
/**
|
|
2319
2064
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
2320
2065
|
*/
|
|
@@ -2340,7 +2085,7 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2340
2085
|
*/
|
|
2341
2086
|
us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
|
|
2342
2087
|
}
|
|
2343
|
-
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | '
|
|
2088
|
+
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
|
|
2344
2089
|
namespace PaymentMethodOptions {
|
|
2345
2090
|
interface AcssDebit {
|
|
2346
2091
|
/**
|
|
@@ -2358,8 +2103,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2358
2103
|
*/
|
|
2359
2104
|
preferred_language?: Bancontact.PreferredLanguage;
|
|
2360
2105
|
}
|
|
2361
|
-
interface Blik {
|
|
2362
|
-
}
|
|
2363
2106
|
interface Card {
|
|
2364
2107
|
/**
|
|
2365
2108
|
* Installment configuration for payments attempted on this invoice.
|
|
@@ -2382,8 +2125,6 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2382
2125
|
*/
|
|
2383
2126
|
funding_type?: string;
|
|
2384
2127
|
}
|
|
2385
|
-
interface IdBankTransfer {
|
|
2386
|
-
}
|
|
2387
2128
|
interface Konbini {
|
|
2388
2129
|
}
|
|
2389
2130
|
interface Payto {
|
|
@@ -2552,13 +2293,9 @@ export declare namespace InvoiceUpdateParams {
|
|
|
2552
2293
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2553
2294
|
*/
|
|
2554
2295
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
2555
|
-
/**
|
|
2556
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
2557
|
-
*/
|
|
2558
|
-
institution?: string;
|
|
2559
2296
|
}
|
|
2560
2297
|
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
|
|
2561
|
-
type Prefetch = 'balances' | '
|
|
2298
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
2562
2299
|
namespace Filters {
|
|
2563
2300
|
type AccountSubcategory = 'checking' | 'savings';
|
|
2564
2301
|
}
|
|
@@ -2760,10 +2497,6 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2760
2497
|
* ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
|
2761
2498
|
*/
|
|
2762
2499
|
invoice_item?: string;
|
|
2763
|
-
/**
|
|
2764
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
2765
|
-
*/
|
|
2766
|
-
margins?: Emptyable<Array<string>>;
|
|
2767
2500
|
/**
|
|
2768
2501
|
* 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`.
|
|
2769
2502
|
*/
|
|
@@ -2807,10 +2540,6 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2807
2540
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
2808
2541
|
*/
|
|
2809
2542
|
discount?: string;
|
|
2810
|
-
/**
|
|
2811
|
-
* Details to determine how long the discount should be applied for.
|
|
2812
|
-
*/
|
|
2813
|
-
discount_end?: Discount.DiscountEnd;
|
|
2814
2543
|
/**
|
|
2815
2544
|
* ID of the promotion code to create a new discount for.
|
|
2816
2545
|
*/
|
|
@@ -2878,38 +2607,6 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2878
2607
|
*/
|
|
2879
2608
|
taxable_amount: number;
|
|
2880
2609
|
}
|
|
2881
|
-
namespace Discount {
|
|
2882
|
-
interface DiscountEnd {
|
|
2883
|
-
/**
|
|
2884
|
-
* Time span for the redeemed discount.
|
|
2885
|
-
*/
|
|
2886
|
-
duration?: DiscountEnd.Duration;
|
|
2887
|
-
/**
|
|
2888
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2889
|
-
*/
|
|
2890
|
-
timestamp?: number;
|
|
2891
|
-
/**
|
|
2892
|
-
* The type of calculation made to determine when the discount ends.
|
|
2893
|
-
*/
|
|
2894
|
-
type: DiscountEnd.Type;
|
|
2895
|
-
}
|
|
2896
|
-
namespace DiscountEnd {
|
|
2897
|
-
interface Duration {
|
|
2898
|
-
/**
|
|
2899
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2900
|
-
*/
|
|
2901
|
-
interval: Duration.Interval;
|
|
2902
|
-
/**
|
|
2903
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2904
|
-
*/
|
|
2905
|
-
interval_count: number;
|
|
2906
|
-
}
|
|
2907
|
-
type Type = 'duration' | 'timestamp';
|
|
2908
|
-
namespace Duration {
|
|
2909
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2910
|
-
}
|
|
2911
|
-
}
|
|
2912
|
-
}
|
|
2913
2610
|
namespace PriceData {
|
|
2914
2611
|
interface ProductData {
|
|
2915
2612
|
/**
|
|
@@ -2932,28 +2629,12 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
2932
2629
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2933
2630
|
*/
|
|
2934
2631
|
tax_code?: string;
|
|
2935
|
-
/**
|
|
2936
|
-
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
2937
|
-
*/
|
|
2938
|
-
tax_details?: ProductData.TaxDetails;
|
|
2939
2632
|
/**
|
|
2940
2633
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
2941
2634
|
*/
|
|
2942
2635
|
unit_label?: string;
|
|
2943
2636
|
}
|
|
2944
2637
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
2945
|
-
namespace ProductData {
|
|
2946
|
-
interface TaxDetails {
|
|
2947
|
-
/**
|
|
2948
|
-
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
2949
|
-
*/
|
|
2950
|
-
performance_location?: string;
|
|
2951
|
-
/**
|
|
2952
|
-
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2953
|
-
*/
|
|
2954
|
-
tax_code?: Emptyable<string>;
|
|
2955
|
-
}
|
|
2956
|
-
}
|
|
2957
2638
|
}
|
|
2958
2639
|
namespace TaxAmount {
|
|
2959
2640
|
interface TaxRateData {
|
|
@@ -3003,10 +2684,6 @@ export declare namespace InvoiceAddLinesParams {
|
|
|
3003
2684
|
}
|
|
3004
2685
|
}
|
|
3005
2686
|
export interface InvoiceAttachPaymentParams {
|
|
3006
|
-
/**
|
|
3007
|
-
* The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
|
3008
|
-
*/
|
|
3009
|
-
amount_requested?: number;
|
|
3010
2687
|
/**
|
|
3011
2688
|
* Specifies which fields in the response should be expanded.
|
|
3012
2689
|
*/
|
|
@@ -3019,38 +2696,6 @@ export interface InvoiceAttachPaymentParams {
|
|
|
3019
2696
|
* The ID of the PaymentRecord to attach to the invoice.
|
|
3020
2697
|
*/
|
|
3021
2698
|
payment_record?: string;
|
|
3022
|
-
/**
|
|
3023
|
-
* The PaymentRecord data for attaching an out of band payment to the invoice.
|
|
3024
|
-
*/
|
|
3025
|
-
payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
|
|
3026
|
-
}
|
|
3027
|
-
export declare namespace InvoiceAttachPaymentParams {
|
|
3028
|
-
interface PaymentRecordData {
|
|
3029
|
-
/**
|
|
3030
|
-
* The amount that was paid out of band.
|
|
3031
|
-
*/
|
|
3032
|
-
amount: number;
|
|
3033
|
-
/**
|
|
3034
|
-
* The currency that was paid out of band.
|
|
3035
|
-
*/
|
|
3036
|
-
currency: string;
|
|
3037
|
-
/**
|
|
3038
|
-
* 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`.
|
|
3039
|
-
*/
|
|
3040
|
-
metadata?: Emptyable<MetadataParam>;
|
|
3041
|
-
/**
|
|
3042
|
-
* The type of money movement for this out of band payment record.
|
|
3043
|
-
*/
|
|
3044
|
-
money_movement_type: string;
|
|
3045
|
-
/**
|
|
3046
|
-
* The timestamp when this out of band payment was paid.
|
|
3047
|
-
*/
|
|
3048
|
-
paid_at?: number;
|
|
3049
|
-
/**
|
|
3050
|
-
* The reference for this out of band payment record.
|
|
3051
|
-
*/
|
|
3052
|
-
payment_reference?: string;
|
|
3053
|
-
}
|
|
3054
2699
|
}
|
|
3055
2700
|
export interface InvoiceCreatePreviewParams {
|
|
3056
2701
|
/**
|
|
@@ -3156,10 +2801,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3156
2801
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3157
2802
|
*/
|
|
3158
2803
|
discount?: string;
|
|
3159
|
-
/**
|
|
3160
|
-
* Details to determine how long the discount should be applied for.
|
|
3161
|
-
*/
|
|
3162
|
-
discount_end?: Discount.DiscountEnd;
|
|
3163
2804
|
/**
|
|
3164
2805
|
* ID of the promotion code to create a new discount for.
|
|
3165
2806
|
*/
|
|
@@ -3247,14 +2888,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3247
2888
|
}
|
|
3248
2889
|
type PreviewMode = 'next' | 'recurring';
|
|
3249
2890
|
interface ScheduleDetails {
|
|
3250
|
-
/**
|
|
3251
|
-
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
3252
|
-
*/
|
|
3253
|
-
amendments?: Array<ScheduleDetails.Amendment>;
|
|
3254
|
-
/**
|
|
3255
|
-
* 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.
|
|
3256
|
-
*/
|
|
3257
|
-
billing_behavior?: ScheduleDetails.BillingBehavior;
|
|
3258
2891
|
/**
|
|
3259
2892
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
3260
2893
|
*/
|
|
@@ -3267,10 +2900,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3267
2900
|
* 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.
|
|
3268
2901
|
*/
|
|
3269
2902
|
phases?: Array<ScheduleDetails.Phase>;
|
|
3270
|
-
/**
|
|
3271
|
-
* Provide any time periods to bill in advance.
|
|
3272
|
-
*/
|
|
3273
|
-
prebilling?: Emptyable<Array<ScheduleDetails.Prebilling>>;
|
|
3274
2903
|
/**
|
|
3275
2904
|
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
3276
2905
|
*/
|
|
@@ -3309,10 +2938,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3309
2938
|
* A list of up to 20 subscription items, each with an attached price.
|
|
3310
2939
|
*/
|
|
3311
2940
|
items?: Array<SubscriptionDetails.Item>;
|
|
3312
|
-
/**
|
|
3313
|
-
* The pre-billing to apply to the subscription as a preview.
|
|
3314
|
-
*/
|
|
3315
|
-
prebilling?: SubscriptionDetails.Prebilling;
|
|
3316
2941
|
/**
|
|
3317
2942
|
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
3318
2943
|
*/
|
|
@@ -3385,38 +3010,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3385
3010
|
type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
|
|
3386
3011
|
}
|
|
3387
3012
|
}
|
|
3388
|
-
namespace Discount {
|
|
3389
|
-
interface DiscountEnd {
|
|
3390
|
-
/**
|
|
3391
|
-
* Time span for the redeemed discount.
|
|
3392
|
-
*/
|
|
3393
|
-
duration?: DiscountEnd.Duration;
|
|
3394
|
-
/**
|
|
3395
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3396
|
-
*/
|
|
3397
|
-
timestamp?: number;
|
|
3398
|
-
/**
|
|
3399
|
-
* The type of calculation made to determine when the discount ends.
|
|
3400
|
-
*/
|
|
3401
|
-
type: DiscountEnd.Type;
|
|
3402
|
-
}
|
|
3403
|
-
namespace DiscountEnd {
|
|
3404
|
-
interface Duration {
|
|
3405
|
-
/**
|
|
3406
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3407
|
-
*/
|
|
3408
|
-
interval: Duration.Interval;
|
|
3409
|
-
/**
|
|
3410
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3411
|
-
*/
|
|
3412
|
-
interval_count: number;
|
|
3413
|
-
}
|
|
3414
|
-
type Type = 'duration' | 'timestamp';
|
|
3415
|
-
namespace Duration {
|
|
3416
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3417
|
-
}
|
|
3418
|
-
}
|
|
3419
|
-
}
|
|
3420
3013
|
namespace InvoiceItem {
|
|
3421
3014
|
interface Discount {
|
|
3422
3015
|
/**
|
|
@@ -3427,10 +3020,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3427
3020
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3428
3021
|
*/
|
|
3429
3022
|
discount?: string;
|
|
3430
|
-
/**
|
|
3431
|
-
* Details to determine how long the discount should be applied for.
|
|
3432
|
-
*/
|
|
3433
|
-
discount_end?: Discount.DiscountEnd;
|
|
3434
3023
|
/**
|
|
3435
3024
|
* ID of the promotion code to create a new discount for.
|
|
3436
3025
|
*/
|
|
@@ -3469,38 +3058,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3469
3058
|
unit_amount_decimal?: Decimal;
|
|
3470
3059
|
}
|
|
3471
3060
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3472
|
-
namespace Discount {
|
|
3473
|
-
interface DiscountEnd {
|
|
3474
|
-
/**
|
|
3475
|
-
* Time span for the redeemed discount.
|
|
3476
|
-
*/
|
|
3477
|
-
duration?: DiscountEnd.Duration;
|
|
3478
|
-
/**
|
|
3479
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3480
|
-
*/
|
|
3481
|
-
timestamp?: number;
|
|
3482
|
-
/**
|
|
3483
|
-
* The type of calculation made to determine when the discount ends.
|
|
3484
|
-
*/
|
|
3485
|
-
type: DiscountEnd.Type;
|
|
3486
|
-
}
|
|
3487
|
-
namespace DiscountEnd {
|
|
3488
|
-
interface Duration {
|
|
3489
|
-
/**
|
|
3490
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3491
|
-
*/
|
|
3492
|
-
interval: Duration.Interval;
|
|
3493
|
-
/**
|
|
3494
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3495
|
-
*/
|
|
3496
|
-
interval_count: number;
|
|
3497
|
-
}
|
|
3498
|
-
type Type = 'duration' | 'timestamp';
|
|
3499
|
-
namespace Duration {
|
|
3500
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3501
|
-
}
|
|
3502
|
-
}
|
|
3503
|
-
}
|
|
3504
3061
|
namespace PriceData {
|
|
3505
3062
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
3506
3063
|
}
|
|
@@ -3509,61 +3066,18 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3509
3066
|
type Type = 'account' | 'self';
|
|
3510
3067
|
}
|
|
3511
3068
|
namespace ScheduleDetails {
|
|
3512
|
-
interface
|
|
3069
|
+
interface BillingMode {
|
|
3513
3070
|
/**
|
|
3514
|
-
*
|
|
3071
|
+
* Configure behavior for flexible billing mode.
|
|
3515
3072
|
*/
|
|
3516
|
-
|
|
3073
|
+
flexible?: BillingMode.Flexible;
|
|
3517
3074
|
/**
|
|
3518
|
-
*
|
|
3075
|
+
* Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
|
|
3519
3076
|
*/
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
3525
|
-
/**
|
|
3526
|
-
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
3527
|
-
*/
|
|
3528
|
-
discount_actions?: Array<Amendment.DiscountAction>;
|
|
3529
|
-
/**
|
|
3530
|
-
* Changes to the subscription items during the amendment time span.
|
|
3531
|
-
*/
|
|
3532
|
-
item_actions?: Array<Amendment.ItemAction>;
|
|
3533
|
-
/**
|
|
3534
|
-
* Instructions for how to modify phase metadata
|
|
3535
|
-
*/
|
|
3536
|
-
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
3537
|
-
/**
|
|
3538
|
-
* 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`.
|
|
3539
|
-
*/
|
|
3540
|
-
proration_behavior?: Amendment.ProrationBehavior;
|
|
3541
|
-
/**
|
|
3542
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
3543
|
-
*/
|
|
3544
|
-
set_pause_collection?: Amendment.SetPauseCollection;
|
|
3545
|
-
/**
|
|
3546
|
-
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
3547
|
-
*/
|
|
3548
|
-
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
3549
|
-
/**
|
|
3550
|
-
* Settings related to subscription trials.
|
|
3551
|
-
*/
|
|
3552
|
-
trial_settings?: Amendment.TrialSettings;
|
|
3553
|
-
}
|
|
3554
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3555
|
-
interface BillingMode {
|
|
3556
|
-
/**
|
|
3557
|
-
* Configure behavior for flexible billing mode.
|
|
3558
|
-
*/
|
|
3559
|
-
flexible?: BillingMode.Flexible;
|
|
3560
|
-
/**
|
|
3561
|
-
* Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
|
|
3562
|
-
*/
|
|
3563
|
-
type: BillingMode.Type;
|
|
3564
|
-
}
|
|
3565
|
-
type EndBehavior = 'cancel' | 'release';
|
|
3566
|
-
interface Phase {
|
|
3077
|
+
type: BillingMode.Type;
|
|
3078
|
+
}
|
|
3079
|
+
type EndBehavior = 'cancel' | 'release';
|
|
3080
|
+
interface Phase {
|
|
3567
3081
|
/**
|
|
3568
3082
|
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
|
3569
3083
|
*/
|
|
@@ -3632,10 +3146,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3632
3146
|
* The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
3633
3147
|
*/
|
|
3634
3148
|
on_behalf_of?: string;
|
|
3635
|
-
/**
|
|
3636
|
-
* 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).
|
|
3637
|
-
*/
|
|
3638
|
-
pause_collection?: Phase.PauseCollection;
|
|
3639
3149
|
/**
|
|
3640
3150
|
* 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.
|
|
3641
3151
|
*/
|
|
@@ -3652,468 +3162,12 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
3652
3162
|
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
3653
3163
|
*/
|
|
3654
3164
|
trial?: boolean;
|
|
3655
|
-
/**
|
|
3656
|
-
* Specify trial behavior when crossing phase boundaries
|
|
3657
|
-
*/
|
|
3658
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
3659
3165
|
/**
|
|
3660
3166
|
* 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`
|
|
3661
3167
|
*/
|
|
3662
3168
|
trial_end?: number | 'now';
|
|
3663
|
-
/**
|
|
3664
|
-
* Settings related to subscription trials.
|
|
3665
|
-
*/
|
|
3666
|
-
trial_settings?: Phase.TrialSettings;
|
|
3667
|
-
}
|
|
3668
|
-
interface Prebilling {
|
|
3669
|
-
/**
|
|
3670
|
-
* The end of the prebilled time period.
|
|
3671
|
-
*/
|
|
3672
|
-
bill_until?: Prebilling.BillUntil;
|
|
3673
|
-
/**
|
|
3674
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
3675
|
-
*/
|
|
3676
|
-
iterations?: number;
|
|
3677
3169
|
}
|
|
3678
3170
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3679
|
-
namespace Amendment {
|
|
3680
|
-
interface AmendmentEnd {
|
|
3681
|
-
/**
|
|
3682
|
-
* Use the `end` time of a given discount.
|
|
3683
|
-
*/
|
|
3684
|
-
discount_end?: AmendmentEnd.DiscountEnd;
|
|
3685
|
-
/**
|
|
3686
|
-
* Time span for the amendment starting from the `amendment_start`.
|
|
3687
|
-
*/
|
|
3688
|
-
duration?: AmendmentEnd.Duration;
|
|
3689
|
-
/**
|
|
3690
|
-
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
3691
|
-
*/
|
|
3692
|
-
timestamp?: number;
|
|
3693
|
-
/**
|
|
3694
|
-
* Select one of three ways to pass the `amendment_end`.
|
|
3695
|
-
*/
|
|
3696
|
-
type: AmendmentEnd.Type;
|
|
3697
|
-
}
|
|
3698
|
-
interface AmendmentStart {
|
|
3699
|
-
/**
|
|
3700
|
-
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
3701
|
-
*/
|
|
3702
|
-
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
3703
|
-
/**
|
|
3704
|
-
* Use the `end` time of a given discount.
|
|
3705
|
-
*/
|
|
3706
|
-
discount_end?: AmendmentStart.DiscountEnd;
|
|
3707
|
-
/**
|
|
3708
|
-
* A precise Unix timestamp for the amendment to start.
|
|
3709
|
-
*/
|
|
3710
|
-
timestamp?: number;
|
|
3711
|
-
/**
|
|
3712
|
-
* Select one of three ways to pass the `amendment_start`.
|
|
3713
|
-
*/
|
|
3714
|
-
type: AmendmentStart.Type;
|
|
3715
|
-
}
|
|
3716
|
-
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
3717
|
-
interface DiscountAction {
|
|
3718
|
-
/**
|
|
3719
|
-
* Details of the discount to add.
|
|
3720
|
-
*/
|
|
3721
|
-
add?: DiscountAction.Add;
|
|
3722
|
-
/**
|
|
3723
|
-
* Details of the discount to remove.
|
|
3724
|
-
*/
|
|
3725
|
-
remove?: DiscountAction.Remove;
|
|
3726
|
-
/**
|
|
3727
|
-
* Details of the discount to replace the existing discounts with.
|
|
3728
|
-
*/
|
|
3729
|
-
set?: DiscountAction.Set;
|
|
3730
|
-
/**
|
|
3731
|
-
* Determines the type of discount action.
|
|
3732
|
-
*/
|
|
3733
|
-
type: DiscountAction.Type;
|
|
3734
|
-
}
|
|
3735
|
-
interface ItemAction {
|
|
3736
|
-
/**
|
|
3737
|
-
* 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.
|
|
3738
|
-
*/
|
|
3739
|
-
add?: ItemAction.Add;
|
|
3740
|
-
/**
|
|
3741
|
-
* Details of the subscription item to remove.
|
|
3742
|
-
*/
|
|
3743
|
-
remove?: ItemAction.Remove;
|
|
3744
|
-
/**
|
|
3745
|
-
* 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.
|
|
3746
|
-
*/
|
|
3747
|
-
set?: ItemAction.Set;
|
|
3748
|
-
/**
|
|
3749
|
-
* Determines the type of item action.
|
|
3750
|
-
*/
|
|
3751
|
-
type: ItemAction.Type;
|
|
3752
|
-
}
|
|
3753
|
-
interface MetadataAction {
|
|
3754
|
-
/**
|
|
3755
|
-
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3756
|
-
*/
|
|
3757
|
-
add?: {
|
|
3758
|
-
[key: string]: string;
|
|
3759
|
-
};
|
|
3760
|
-
/**
|
|
3761
|
-
* Keys to remove from schedule phase metadata.
|
|
3762
|
-
*/
|
|
3763
|
-
remove?: Array<string>;
|
|
3764
|
-
/**
|
|
3765
|
-
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3766
|
-
*/
|
|
3767
|
-
set?: Emptyable<{
|
|
3768
|
-
[key: string]: string;
|
|
3769
|
-
}>;
|
|
3770
|
-
/**
|
|
3771
|
-
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3772
|
-
*/
|
|
3773
|
-
type: MetadataAction.Type;
|
|
3774
|
-
}
|
|
3775
|
-
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
3776
|
-
interface SetPauseCollection {
|
|
3777
|
-
/**
|
|
3778
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
3779
|
-
*/
|
|
3780
|
-
set?: SetPauseCollection.Set;
|
|
3781
|
-
/**
|
|
3782
|
-
* Determines the type of the pause_collection amendment.
|
|
3783
|
-
*/
|
|
3784
|
-
type: SetPauseCollection.Type;
|
|
3785
|
-
}
|
|
3786
|
-
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3787
|
-
interface TrialSettings {
|
|
3788
|
-
/**
|
|
3789
|
-
* Defines how the subscription should behave when a trial ends.
|
|
3790
|
-
*/
|
|
3791
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
3792
|
-
}
|
|
3793
|
-
namespace AmendmentEnd {
|
|
3794
|
-
interface DiscountEnd {
|
|
3795
|
-
/**
|
|
3796
|
-
* The ID of a specific discount.
|
|
3797
|
-
*/
|
|
3798
|
-
discount: string;
|
|
3799
|
-
}
|
|
3800
|
-
interface Duration {
|
|
3801
|
-
/**
|
|
3802
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3803
|
-
*/
|
|
3804
|
-
interval: Duration.Interval;
|
|
3805
|
-
/**
|
|
3806
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3807
|
-
*/
|
|
3808
|
-
interval_count: number;
|
|
3809
|
-
}
|
|
3810
|
-
type Type = 'discount_end' | 'duration' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3811
|
-
namespace Duration {
|
|
3812
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3813
|
-
}
|
|
3814
|
-
}
|
|
3815
|
-
namespace AmendmentStart {
|
|
3816
|
-
interface AmendmentEnd {
|
|
3817
|
-
/**
|
|
3818
|
-
* 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.
|
|
3819
|
-
*/
|
|
3820
|
-
index: number;
|
|
3821
|
-
}
|
|
3822
|
-
interface DiscountEnd {
|
|
3823
|
-
/**
|
|
3824
|
-
* The ID of a specific discount.
|
|
3825
|
-
*/
|
|
3826
|
-
discount: string;
|
|
3827
|
-
}
|
|
3828
|
-
type Type = 'amendment_end' | 'discount_end' | 'now' | 'schedule_end' | 'timestamp' | 'trial_end' | 'trial_start' | 'upcoming_invoice';
|
|
3829
|
-
}
|
|
3830
|
-
namespace DiscountAction {
|
|
3831
|
-
interface Add {
|
|
3832
|
-
/**
|
|
3833
|
-
* The coupon code to redeem.
|
|
3834
|
-
*/
|
|
3835
|
-
coupon?: string;
|
|
3836
|
-
/**
|
|
3837
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3838
|
-
*/
|
|
3839
|
-
discount?: string;
|
|
3840
|
-
/**
|
|
3841
|
-
* Details to determine how long the discount should be applied for.
|
|
3842
|
-
*/
|
|
3843
|
-
discount_end?: Add.DiscountEnd;
|
|
3844
|
-
/**
|
|
3845
|
-
* 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.
|
|
3846
|
-
*/
|
|
3847
|
-
index?: number;
|
|
3848
|
-
/**
|
|
3849
|
-
* The promotion code to redeem.
|
|
3850
|
-
*/
|
|
3851
|
-
promotion_code?: string;
|
|
3852
|
-
}
|
|
3853
|
-
interface Remove {
|
|
3854
|
-
/**
|
|
3855
|
-
* The coupon code to remove from the `discounts` array.
|
|
3856
|
-
*/
|
|
3857
|
-
coupon?: string;
|
|
3858
|
-
/**
|
|
3859
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
3860
|
-
*/
|
|
3861
|
-
discount?: string;
|
|
3862
|
-
/**
|
|
3863
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
3864
|
-
*/
|
|
3865
|
-
promotion_code?: string;
|
|
3866
|
-
}
|
|
3867
|
-
interface Set {
|
|
3868
|
-
/**
|
|
3869
|
-
* The coupon code to replace the `discounts` array with.
|
|
3870
|
-
*/
|
|
3871
|
-
coupon?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
3874
|
-
*/
|
|
3875
|
-
discount?: string;
|
|
3876
|
-
/**
|
|
3877
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3878
|
-
*/
|
|
3879
|
-
promotion_code?: string;
|
|
3880
|
-
}
|
|
3881
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3882
|
-
namespace Add {
|
|
3883
|
-
interface DiscountEnd {
|
|
3884
|
-
/**
|
|
3885
|
-
* The type of calculation made to determine when the discount ends.
|
|
3886
|
-
*/
|
|
3887
|
-
type: 'amendment_end';
|
|
3888
|
-
}
|
|
3889
|
-
}
|
|
3890
|
-
}
|
|
3891
|
-
namespace ItemAction {
|
|
3892
|
-
interface Add {
|
|
3893
|
-
/**
|
|
3894
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3895
|
-
*/
|
|
3896
|
-
discounts?: Array<Add.Discount>;
|
|
3897
|
-
/**
|
|
3898
|
-
* 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`.
|
|
3899
|
-
*/
|
|
3900
|
-
metadata?: MetadataParam;
|
|
3901
|
-
/**
|
|
3902
|
-
* The ID of the price object.
|
|
3903
|
-
*/
|
|
3904
|
-
price: string;
|
|
3905
|
-
/**
|
|
3906
|
-
* Quantity for this item.
|
|
3907
|
-
*/
|
|
3908
|
-
quantity?: number;
|
|
3909
|
-
/**
|
|
3910
|
-
* 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`.
|
|
3911
|
-
*/
|
|
3912
|
-
tax_rates?: Array<string>;
|
|
3913
|
-
/**
|
|
3914
|
-
* Options that configure the trial on the subscription item.
|
|
3915
|
-
*/
|
|
3916
|
-
trial?: Add.Trial;
|
|
3917
|
-
/**
|
|
3918
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3919
|
-
*/
|
|
3920
|
-
trial_offer?: string;
|
|
3921
|
-
}
|
|
3922
|
-
interface Remove {
|
|
3923
|
-
/**
|
|
3924
|
-
* ID of a price to remove.
|
|
3925
|
-
*/
|
|
3926
|
-
price: string;
|
|
3927
|
-
}
|
|
3928
|
-
interface Set {
|
|
3929
|
-
/**
|
|
3930
|
-
* 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`.
|
|
3931
|
-
*/
|
|
3932
|
-
discounts?: Array<Set.Discount>;
|
|
3933
|
-
/**
|
|
3934
|
-
* 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`.
|
|
3935
|
-
*/
|
|
3936
|
-
metadata?: MetadataParam;
|
|
3937
|
-
/**
|
|
3938
|
-
* The ID of the price object.
|
|
3939
|
-
*/
|
|
3940
|
-
price: string;
|
|
3941
|
-
/**
|
|
3942
|
-
* 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`.
|
|
3943
|
-
*/
|
|
3944
|
-
quantity?: number;
|
|
3945
|
-
/**
|
|
3946
|
-
* 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`.
|
|
3947
|
-
*/
|
|
3948
|
-
tax_rates?: Array<string>;
|
|
3949
|
-
/**
|
|
3950
|
-
* 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`.
|
|
3951
|
-
*/
|
|
3952
|
-
trial?: Set.Trial;
|
|
3953
|
-
/**
|
|
3954
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
3955
|
-
*/
|
|
3956
|
-
trial_offer?: string;
|
|
3957
|
-
}
|
|
3958
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3959
|
-
namespace Add {
|
|
3960
|
-
interface Discount {
|
|
3961
|
-
/**
|
|
3962
|
-
* ID of the coupon to create a new discount for.
|
|
3963
|
-
*/
|
|
3964
|
-
coupon?: string;
|
|
3965
|
-
/**
|
|
3966
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3967
|
-
*/
|
|
3968
|
-
discount?: string;
|
|
3969
|
-
/**
|
|
3970
|
-
* Details to determine how long the discount should be applied for.
|
|
3971
|
-
*/
|
|
3972
|
-
discount_end?: Discount.DiscountEnd;
|
|
3973
|
-
/**
|
|
3974
|
-
* ID of the promotion code to create a new discount for.
|
|
3975
|
-
*/
|
|
3976
|
-
promotion_code?: string;
|
|
3977
|
-
}
|
|
3978
|
-
interface Trial {
|
|
3979
|
-
/**
|
|
3980
|
-
* 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.
|
|
3981
|
-
*/
|
|
3982
|
-
converts_to?: Array<string>;
|
|
3983
|
-
/**
|
|
3984
|
-
* Determines the type of trial for this item.
|
|
3985
|
-
*/
|
|
3986
|
-
type: Trial.Type;
|
|
3987
|
-
}
|
|
3988
|
-
namespace Discount {
|
|
3989
|
-
interface DiscountEnd {
|
|
3990
|
-
/**
|
|
3991
|
-
* Time span for the redeemed discount.
|
|
3992
|
-
*/
|
|
3993
|
-
duration?: DiscountEnd.Duration;
|
|
3994
|
-
/**
|
|
3995
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3996
|
-
*/
|
|
3997
|
-
timestamp?: number;
|
|
3998
|
-
/**
|
|
3999
|
-
* The type of calculation made to determine when the discount ends.
|
|
4000
|
-
*/
|
|
4001
|
-
type: DiscountEnd.Type;
|
|
4002
|
-
}
|
|
4003
|
-
namespace DiscountEnd {
|
|
4004
|
-
interface Duration {
|
|
4005
|
-
/**
|
|
4006
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4007
|
-
*/
|
|
4008
|
-
interval: Duration.Interval;
|
|
4009
|
-
/**
|
|
4010
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4011
|
-
*/
|
|
4012
|
-
interval_count: number;
|
|
4013
|
-
}
|
|
4014
|
-
type Type = 'duration' | 'timestamp';
|
|
4015
|
-
namespace Duration {
|
|
4016
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4017
|
-
}
|
|
4018
|
-
}
|
|
4019
|
-
}
|
|
4020
|
-
namespace Trial {
|
|
4021
|
-
type Type = 'free' | 'paid';
|
|
4022
|
-
}
|
|
4023
|
-
}
|
|
4024
|
-
namespace Set {
|
|
4025
|
-
interface Discount {
|
|
4026
|
-
/**
|
|
4027
|
-
* ID of the coupon to create a new discount for.
|
|
4028
|
-
*/
|
|
4029
|
-
coupon?: string;
|
|
4030
|
-
/**
|
|
4031
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4032
|
-
*/
|
|
4033
|
-
discount?: string;
|
|
4034
|
-
/**
|
|
4035
|
-
* Details to determine how long the discount should be applied for.
|
|
4036
|
-
*/
|
|
4037
|
-
discount_end?: Discount.DiscountEnd;
|
|
4038
|
-
/**
|
|
4039
|
-
* ID of the promotion code to create a new discount for.
|
|
4040
|
-
*/
|
|
4041
|
-
promotion_code?: string;
|
|
4042
|
-
}
|
|
4043
|
-
interface Trial {
|
|
4044
|
-
/**
|
|
4045
|
-
* 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.
|
|
4046
|
-
*/
|
|
4047
|
-
converts_to?: Array<string>;
|
|
4048
|
-
/**
|
|
4049
|
-
* Determines the type of trial for this item.
|
|
4050
|
-
*/
|
|
4051
|
-
type: Trial.Type;
|
|
4052
|
-
}
|
|
4053
|
-
namespace Discount {
|
|
4054
|
-
interface DiscountEnd {
|
|
4055
|
-
/**
|
|
4056
|
-
* Time span for the redeemed discount.
|
|
4057
|
-
*/
|
|
4058
|
-
duration?: DiscountEnd.Duration;
|
|
4059
|
-
/**
|
|
4060
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4061
|
-
*/
|
|
4062
|
-
timestamp?: number;
|
|
4063
|
-
/**
|
|
4064
|
-
* The type of calculation made to determine when the discount ends.
|
|
4065
|
-
*/
|
|
4066
|
-
type: DiscountEnd.Type;
|
|
4067
|
-
}
|
|
4068
|
-
namespace DiscountEnd {
|
|
4069
|
-
interface Duration {
|
|
4070
|
-
/**
|
|
4071
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4072
|
-
*/
|
|
4073
|
-
interval: Duration.Interval;
|
|
4074
|
-
/**
|
|
4075
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4076
|
-
*/
|
|
4077
|
-
interval_count: number;
|
|
4078
|
-
}
|
|
4079
|
-
type Type = 'duration' | 'timestamp';
|
|
4080
|
-
namespace Duration {
|
|
4081
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4082
|
-
}
|
|
4083
|
-
}
|
|
4084
|
-
}
|
|
4085
|
-
namespace Trial {
|
|
4086
|
-
type Type = 'free' | 'paid';
|
|
4087
|
-
}
|
|
4088
|
-
}
|
|
4089
|
-
}
|
|
4090
|
-
namespace MetadataAction {
|
|
4091
|
-
type Type = 'add' | 'remove' | 'set';
|
|
4092
|
-
}
|
|
4093
|
-
namespace SetPauseCollection {
|
|
4094
|
-
interface Set {
|
|
4095
|
-
/**
|
|
4096
|
-
* The payment collection behavior for this subscription while paused.
|
|
4097
|
-
*/
|
|
4098
|
-
behavior: Set.Behavior;
|
|
4099
|
-
}
|
|
4100
|
-
type Type = 'remove' | 'set';
|
|
4101
|
-
namespace Set {
|
|
4102
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
4103
|
-
}
|
|
4104
|
-
}
|
|
4105
|
-
namespace TrialSettings {
|
|
4106
|
-
interface EndBehavior {
|
|
4107
|
-
/**
|
|
4108
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4109
|
-
*/
|
|
4110
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4111
|
-
}
|
|
4112
|
-
namespace EndBehavior {
|
|
4113
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
4114
|
-
}
|
|
4115
|
-
}
|
|
4116
|
-
}
|
|
4117
3171
|
namespace BillingMode {
|
|
4118
3172
|
interface Flexible {
|
|
4119
3173
|
/**
|
|
@@ -4128,6 +3182,10 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4128
3182
|
}
|
|
4129
3183
|
namespace Phase {
|
|
4130
3184
|
interface AddInvoiceItem {
|
|
3185
|
+
/**
|
|
3186
|
+
* Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
|
|
3187
|
+
*/
|
|
3188
|
+
discountable?: boolean;
|
|
4131
3189
|
/**
|
|
4132
3190
|
* The coupons to redeem into discounts for the item.
|
|
4133
3191
|
*/
|
|
@@ -4188,10 +3246,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4188
3246
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4189
3247
|
*/
|
|
4190
3248
|
discount?: string;
|
|
4191
|
-
/**
|
|
4192
|
-
* Details to determine how long the discount should be applied for.
|
|
4193
|
-
*/
|
|
4194
|
-
discount_end?: Discount.DiscountEnd;
|
|
4195
3249
|
/**
|
|
4196
3250
|
* ID of the promotion code to create a new discount for.
|
|
4197
3251
|
*/
|
|
@@ -4254,20 +3308,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4254
3308
|
* 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.
|
|
4255
3309
|
*/
|
|
4256
3310
|
tax_rates?: Emptyable<Array<string>>;
|
|
4257
|
-
/**
|
|
4258
|
-
* Options that configure the trial on the subscription item.
|
|
4259
|
-
*/
|
|
4260
|
-
trial?: Item.Trial;
|
|
4261
|
-
/**
|
|
4262
|
-
* The ID of the trial offer to apply to the configuration item.
|
|
4263
|
-
*/
|
|
4264
|
-
trial_offer?: string;
|
|
4265
|
-
}
|
|
4266
|
-
interface PauseCollection {
|
|
4267
|
-
/**
|
|
4268
|
-
* The payment collection behavior for this subscription while paused.
|
|
4269
|
-
*/
|
|
4270
|
-
behavior: PauseCollection.Behavior;
|
|
4271
3311
|
}
|
|
4272
3312
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4273
3313
|
interface TransferData {
|
|
@@ -4280,13 +3320,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4280
3320
|
*/
|
|
4281
3321
|
destination: string;
|
|
4282
3322
|
}
|
|
4283
|
-
type TrialContinuation = 'continue' | 'none';
|
|
4284
|
-
interface TrialSettings {
|
|
4285
|
-
/**
|
|
4286
|
-
* Defines how the subscription should behave when a trial ends.
|
|
4287
|
-
*/
|
|
4288
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
4289
|
-
}
|
|
4290
3323
|
namespace AddInvoiceItem {
|
|
4291
3324
|
interface Discount {
|
|
4292
3325
|
/**
|
|
@@ -4297,10 +3330,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4297
3330
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4298
3331
|
*/
|
|
4299
3332
|
discount?: string;
|
|
4300
|
-
/**
|
|
4301
|
-
* Details to determine how long the discount should be applied for.
|
|
4302
|
-
*/
|
|
4303
|
-
discount_end?: Discount.DiscountEnd;
|
|
4304
3333
|
/**
|
|
4305
3334
|
* ID of the promotion code to create a new discount for.
|
|
4306
3335
|
*/
|
|
@@ -4338,38 +3367,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4338
3367
|
*/
|
|
4339
3368
|
unit_amount_decimal?: Decimal;
|
|
4340
3369
|
}
|
|
4341
|
-
namespace Discount {
|
|
4342
|
-
interface DiscountEnd {
|
|
4343
|
-
/**
|
|
4344
|
-
* Time span for the redeemed discount.
|
|
4345
|
-
*/
|
|
4346
|
-
duration?: DiscountEnd.Duration;
|
|
4347
|
-
/**
|
|
4348
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4349
|
-
*/
|
|
4350
|
-
timestamp?: number;
|
|
4351
|
-
/**
|
|
4352
|
-
* The type of calculation made to determine when the discount ends.
|
|
4353
|
-
*/
|
|
4354
|
-
type: DiscountEnd.Type;
|
|
4355
|
-
}
|
|
4356
|
-
namespace DiscountEnd {
|
|
4357
|
-
interface Duration {
|
|
4358
|
-
/**
|
|
4359
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4360
|
-
*/
|
|
4361
|
-
interval: Duration.Interval;
|
|
4362
|
-
/**
|
|
4363
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4364
|
-
*/
|
|
4365
|
-
interval_count: number;
|
|
4366
|
-
}
|
|
4367
|
-
type Type = 'duration' | 'timestamp';
|
|
4368
|
-
namespace Duration {
|
|
4369
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4370
|
-
}
|
|
4371
|
-
}
|
|
4372
|
-
}
|
|
4373
3370
|
namespace Period {
|
|
4374
3371
|
interface End {
|
|
4375
3372
|
/**
|
|
@@ -4417,38 +3414,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4417
3414
|
type Type = 'account' | 'self';
|
|
4418
3415
|
}
|
|
4419
3416
|
}
|
|
4420
|
-
namespace Discount {
|
|
4421
|
-
interface DiscountEnd {
|
|
4422
|
-
/**
|
|
4423
|
-
* Time span for the redeemed discount.
|
|
4424
|
-
*/
|
|
4425
|
-
duration?: DiscountEnd.Duration;
|
|
4426
|
-
/**
|
|
4427
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4428
|
-
*/
|
|
4429
|
-
timestamp?: number;
|
|
4430
|
-
/**
|
|
4431
|
-
* The type of calculation made to determine when the discount ends.
|
|
4432
|
-
*/
|
|
4433
|
-
type: DiscountEnd.Type;
|
|
4434
|
-
}
|
|
4435
|
-
namespace DiscountEnd {
|
|
4436
|
-
interface Duration {
|
|
4437
|
-
/**
|
|
4438
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4439
|
-
*/
|
|
4440
|
-
interval: Duration.Interval;
|
|
4441
|
-
/**
|
|
4442
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4443
|
-
*/
|
|
4444
|
-
interval_count: number;
|
|
4445
|
-
}
|
|
4446
|
-
type Type = 'duration' | 'timestamp';
|
|
4447
|
-
namespace Duration {
|
|
4448
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4449
|
-
}
|
|
4450
|
-
}
|
|
4451
|
-
}
|
|
4452
3417
|
namespace Duration {
|
|
4453
3418
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4454
3419
|
}
|
|
@@ -4483,10 +3448,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4483
3448
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4484
3449
|
*/
|
|
4485
3450
|
discount?: string;
|
|
4486
|
-
/**
|
|
4487
|
-
* Details to determine how long the discount should be applied for.
|
|
4488
|
-
*/
|
|
4489
|
-
discount_end?: Discount.DiscountEnd;
|
|
4490
3451
|
/**
|
|
4491
3452
|
* ID of the promotion code to create a new discount for.
|
|
4492
3453
|
*/
|
|
@@ -4518,48 +3479,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4518
3479
|
*/
|
|
4519
3480
|
unit_amount_decimal?: Decimal;
|
|
4520
3481
|
}
|
|
4521
|
-
interface Trial {
|
|
4522
|
-
/**
|
|
4523
|
-
* 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.
|
|
4524
|
-
*/
|
|
4525
|
-
converts_to?: Array<string>;
|
|
4526
|
-
/**
|
|
4527
|
-
* Determines the type of trial for this item.
|
|
4528
|
-
*/
|
|
4529
|
-
type: Trial.Type;
|
|
4530
|
-
}
|
|
4531
|
-
namespace Discount {
|
|
4532
|
-
interface DiscountEnd {
|
|
4533
|
-
/**
|
|
4534
|
-
* Time span for the redeemed discount.
|
|
4535
|
-
*/
|
|
4536
|
-
duration?: DiscountEnd.Duration;
|
|
4537
|
-
/**
|
|
4538
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4539
|
-
*/
|
|
4540
|
-
timestamp?: number;
|
|
4541
|
-
/**
|
|
4542
|
-
* The type of calculation made to determine when the discount ends.
|
|
4543
|
-
*/
|
|
4544
|
-
type: DiscountEnd.Type;
|
|
4545
|
-
}
|
|
4546
|
-
namespace DiscountEnd {
|
|
4547
|
-
interface Duration {
|
|
4548
|
-
/**
|
|
4549
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4550
|
-
*/
|
|
4551
|
-
interval: Duration.Interval;
|
|
4552
|
-
/**
|
|
4553
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4554
|
-
*/
|
|
4555
|
-
interval_count: number;
|
|
4556
|
-
}
|
|
4557
|
-
type Type = 'duration' | 'timestamp';
|
|
4558
|
-
namespace Duration {
|
|
4559
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4560
|
-
}
|
|
4561
|
-
}
|
|
4562
|
-
}
|
|
4563
3482
|
namespace PriceData {
|
|
4564
3483
|
interface Recurring {
|
|
4565
3484
|
/**
|
|
@@ -4576,65 +3495,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4576
3495
|
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4577
3496
|
}
|
|
4578
3497
|
}
|
|
4579
|
-
namespace Trial {
|
|
4580
|
-
type Type = 'free' | 'paid';
|
|
4581
|
-
}
|
|
4582
|
-
}
|
|
4583
|
-
namespace PauseCollection {
|
|
4584
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
4585
|
-
}
|
|
4586
|
-
namespace TrialSettings {
|
|
4587
|
-
interface EndBehavior {
|
|
4588
|
-
/**
|
|
4589
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4590
|
-
*/
|
|
4591
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4592
|
-
}
|
|
4593
|
-
namespace EndBehavior {
|
|
4594
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
4595
|
-
}
|
|
4596
|
-
}
|
|
4597
|
-
}
|
|
4598
|
-
namespace Prebilling {
|
|
4599
|
-
interface BillUntil {
|
|
4600
|
-
/**
|
|
4601
|
-
* End the prebilled period when a specified amendment ends.
|
|
4602
|
-
*/
|
|
4603
|
-
amendment_end?: BillUntil.AmendmentEnd;
|
|
4604
|
-
/**
|
|
4605
|
-
* Time span for prebilling, starting from `bill_from`.
|
|
4606
|
-
*/
|
|
4607
|
-
duration?: BillUntil.Duration;
|
|
4608
|
-
/**
|
|
4609
|
-
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
4610
|
-
*/
|
|
4611
|
-
timestamp?: number;
|
|
4612
|
-
/**
|
|
4613
|
-
* Select one of several ways to pass the `bill_until` value.
|
|
4614
|
-
*/
|
|
4615
|
-
type: BillUntil.Type;
|
|
4616
|
-
}
|
|
4617
|
-
namespace BillUntil {
|
|
4618
|
-
interface AmendmentEnd {
|
|
4619
|
-
/**
|
|
4620
|
-
* 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.
|
|
4621
|
-
*/
|
|
4622
|
-
index: number;
|
|
4623
|
-
}
|
|
4624
|
-
interface Duration {
|
|
4625
|
-
/**
|
|
4626
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4627
|
-
*/
|
|
4628
|
-
interval: Duration.Interval;
|
|
4629
|
-
/**
|
|
4630
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4631
|
-
*/
|
|
4632
|
-
interval_count: number;
|
|
4633
|
-
}
|
|
4634
|
-
type Type = 'amendment_end' | 'duration' | 'schedule_end' | 'timestamp';
|
|
4635
|
-
namespace Duration {
|
|
4636
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4637
|
-
}
|
|
4638
3498
|
}
|
|
4639
3499
|
}
|
|
4640
3500
|
}
|
|
@@ -4664,7 +3524,7 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4664
3524
|
*/
|
|
4665
3525
|
key?: string;
|
|
4666
3526
|
}
|
|
4667
|
-
type CancelAt = 'max_period_end' | 'min_period_end';
|
|
3527
|
+
type CancelAt = 'max_billed_until' | 'max_period_end' | 'min_period_end';
|
|
4668
3528
|
interface Item {
|
|
4669
3529
|
/**
|
|
4670
3530
|
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
|
@@ -4674,10 +3534,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4674
3534
|
* Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
|
4675
3535
|
*/
|
|
4676
3536
|
clear_usage?: boolean;
|
|
4677
|
-
/**
|
|
4678
|
-
* The trial offer to apply to this subscription item.
|
|
4679
|
-
*/
|
|
4680
|
-
current_trial?: Item.CurrentTrial;
|
|
4681
3537
|
/**
|
|
4682
3538
|
* A flag that, if set to `true`, will delete the specified item.
|
|
4683
3539
|
*/
|
|
@@ -4715,12 +3571,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4715
3571
|
*/
|
|
4716
3572
|
tax_rates?: Emptyable<Array<string>>;
|
|
4717
3573
|
}
|
|
4718
|
-
interface Prebilling {
|
|
4719
|
-
/**
|
|
4720
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4721
|
-
*/
|
|
4722
|
-
iterations: number;
|
|
4723
|
-
}
|
|
4724
3574
|
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
|
|
4725
3575
|
namespace BillingMode {
|
|
4726
3576
|
interface Flexible {
|
|
@@ -4783,16 +3633,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4783
3633
|
*/
|
|
4784
3634
|
usage_gte: number;
|
|
4785
3635
|
}
|
|
4786
|
-
interface CurrentTrial {
|
|
4787
|
-
/**
|
|
4788
|
-
* Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
|
|
4789
|
-
*/
|
|
4790
|
-
trial_end?: number;
|
|
4791
|
-
/**
|
|
4792
|
-
* The ID of the trial offer to apply to the subscription item.
|
|
4793
|
-
*/
|
|
4794
|
-
trial_offer: string;
|
|
4795
|
-
}
|
|
4796
3636
|
interface Discount {
|
|
4797
3637
|
/**
|
|
4798
3638
|
* ID of the coupon to create a new discount for.
|
|
@@ -4802,10 +3642,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4802
3642
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
4803
3643
|
*/
|
|
4804
3644
|
discount?: string;
|
|
4805
|
-
/**
|
|
4806
|
-
* Details to determine how long the discount should be applied for.
|
|
4807
|
-
*/
|
|
4808
|
-
discount_end?: Discount.DiscountEnd;
|
|
4809
3645
|
/**
|
|
4810
3646
|
* ID of the promotion code to create a new discount for.
|
|
4811
3647
|
*/
|
|
@@ -4837,38 +3673,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4837
3673
|
*/
|
|
4838
3674
|
unit_amount_decimal?: Decimal;
|
|
4839
3675
|
}
|
|
4840
|
-
namespace Discount {
|
|
4841
|
-
interface DiscountEnd {
|
|
4842
|
-
/**
|
|
4843
|
-
* Time span for the redeemed discount.
|
|
4844
|
-
*/
|
|
4845
|
-
duration?: DiscountEnd.Duration;
|
|
4846
|
-
/**
|
|
4847
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4848
|
-
*/
|
|
4849
|
-
timestamp?: number;
|
|
4850
|
-
/**
|
|
4851
|
-
* The type of calculation made to determine when the discount ends.
|
|
4852
|
-
*/
|
|
4853
|
-
type: DiscountEnd.Type;
|
|
4854
|
-
}
|
|
4855
|
-
namespace DiscountEnd {
|
|
4856
|
-
interface Duration {
|
|
4857
|
-
/**
|
|
4858
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4859
|
-
*/
|
|
4860
|
-
interval: Duration.Interval;
|
|
4861
|
-
/**
|
|
4862
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4863
|
-
*/
|
|
4864
|
-
interval_count: number;
|
|
4865
|
-
}
|
|
4866
|
-
type Type = 'duration' | 'timestamp';
|
|
4867
|
-
namespace Duration {
|
|
4868
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4869
|
-
}
|
|
4870
|
-
}
|
|
4871
|
-
}
|
|
4872
3676
|
namespace PriceData {
|
|
4873
3677
|
interface Recurring {
|
|
4874
3678
|
/**
|
|
@@ -4888,16 +3692,6 @@ export declare namespace InvoiceCreatePreviewParams {
|
|
|
4888
3692
|
}
|
|
4889
3693
|
}
|
|
4890
3694
|
}
|
|
4891
|
-
export interface InvoiceDetachPaymentParams {
|
|
4892
|
-
/**
|
|
4893
|
-
* Specifies which fields in the response should be expanded.
|
|
4894
|
-
*/
|
|
4895
|
-
expand?: Array<string>;
|
|
4896
|
-
/**
|
|
4897
|
-
* The ID of the PaymentIntent to detach from the invoice.
|
|
4898
|
-
*/
|
|
4899
|
-
payment_intent?: string;
|
|
4900
|
-
}
|
|
4901
3695
|
export interface InvoiceFinalizeInvoiceParams {
|
|
4902
3696
|
/**
|
|
4903
3697
|
* Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
|
|
@@ -5007,10 +3801,6 @@ export interface InvoiceSendInvoiceParams {
|
|
|
5007
3801
|
*/
|
|
5008
3802
|
expand?: Array<string>;
|
|
5009
3803
|
}
|
|
5010
|
-
export interface InvoiceSerializeBatchPayParams {
|
|
5011
|
-
}
|
|
5012
|
-
export interface InvoiceSerializeBatchUpdateParams {
|
|
5013
|
-
}
|
|
5014
3804
|
export interface InvoiceUpdateLinesParams {
|
|
5015
3805
|
/**
|
|
5016
3806
|
* The line items to update.
|
|
@@ -5049,10 +3839,6 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
5049
3839
|
* ID of an existing line item on the invoice.
|
|
5050
3840
|
*/
|
|
5051
3841
|
id: string;
|
|
5052
|
-
/**
|
|
5053
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
5054
|
-
*/
|
|
5055
|
-
margins?: Emptyable<Array<string>>;
|
|
5056
3842
|
/**
|
|
5057
3843
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
5058
3844
|
*/
|
|
@@ -5096,10 +3882,6 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
5096
3882
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
5097
3883
|
*/
|
|
5098
3884
|
discount?: string;
|
|
5099
|
-
/**
|
|
5100
|
-
* Details to determine how long the discount should be applied for.
|
|
5101
|
-
*/
|
|
5102
|
-
discount_end?: Discount.DiscountEnd;
|
|
5103
3885
|
/**
|
|
5104
3886
|
* ID of the promotion code to create a new discount for.
|
|
5105
3887
|
*/
|
|
@@ -5167,38 +3949,6 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
5167
3949
|
*/
|
|
5168
3950
|
taxable_amount: number;
|
|
5169
3951
|
}
|
|
5170
|
-
namespace Discount {
|
|
5171
|
-
interface DiscountEnd {
|
|
5172
|
-
/**
|
|
5173
|
-
* Time span for the redeemed discount.
|
|
5174
|
-
*/
|
|
5175
|
-
duration?: DiscountEnd.Duration;
|
|
5176
|
-
/**
|
|
5177
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5178
|
-
*/
|
|
5179
|
-
timestamp?: number;
|
|
5180
|
-
/**
|
|
5181
|
-
* The type of calculation made to determine when the discount ends.
|
|
5182
|
-
*/
|
|
5183
|
-
type: DiscountEnd.Type;
|
|
5184
|
-
}
|
|
5185
|
-
namespace DiscountEnd {
|
|
5186
|
-
interface Duration {
|
|
5187
|
-
/**
|
|
5188
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5189
|
-
*/
|
|
5190
|
-
interval: Duration.Interval;
|
|
5191
|
-
/**
|
|
5192
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5193
|
-
*/
|
|
5194
|
-
interval_count: number;
|
|
5195
|
-
}
|
|
5196
|
-
type Type = 'duration' | 'timestamp';
|
|
5197
|
-
namespace Duration {
|
|
5198
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5199
|
-
}
|
|
5200
|
-
}
|
|
5201
|
-
}
|
|
5202
3952
|
namespace PriceData {
|
|
5203
3953
|
interface ProductData {
|
|
5204
3954
|
/**
|
|
@@ -5221,28 +3971,12 @@ export declare namespace InvoiceUpdateLinesParams {
|
|
|
5221
3971
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5222
3972
|
*/
|
|
5223
3973
|
tax_code?: string;
|
|
5224
|
-
/**
|
|
5225
|
-
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
5226
|
-
*/
|
|
5227
|
-
tax_details?: ProductData.TaxDetails;
|
|
5228
3974
|
/**
|
|
5229
3975
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
5230
3976
|
*/
|
|
5231
3977
|
unit_label?: string;
|
|
5232
3978
|
}
|
|
5233
3979
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
5234
|
-
namespace ProductData {
|
|
5235
|
-
interface TaxDetails {
|
|
5236
|
-
/**
|
|
5237
|
-
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
5238
|
-
*/
|
|
5239
|
-
performance_location?: string;
|
|
5240
|
-
/**
|
|
5241
|
-
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5242
|
-
*/
|
|
5243
|
-
tax_code?: Emptyable<string>;
|
|
5244
|
-
}
|
|
5245
|
-
}
|
|
5246
3980
|
}
|
|
5247
3981
|
namespace TaxAmount {
|
|
5248
3982
|
interface TaxRateData {
|
|
@@ -5312,10 +4046,6 @@ export interface InvoiceUpdateLineItemParams {
|
|
|
5312
4046
|
* Specifies which fields in the response should be expanded.
|
|
5313
4047
|
*/
|
|
5314
4048
|
expand?: Array<string>;
|
|
5315
|
-
/**
|
|
5316
|
-
* The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
|
5317
|
-
*/
|
|
5318
|
-
margins?: Emptyable<Array<string>>;
|
|
5319
4049
|
/**
|
|
5320
4050
|
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](https://docs.stripe.com/api/invoices/line_item) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
|
5321
4051
|
*/
|
|
@@ -5359,10 +4089,6 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
5359
4089
|
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
5360
4090
|
*/
|
|
5361
4091
|
discount?: string;
|
|
5362
|
-
/**
|
|
5363
|
-
* Details to determine how long the discount should be applied for.
|
|
5364
|
-
*/
|
|
5365
|
-
discount_end?: Discount.DiscountEnd;
|
|
5366
4092
|
/**
|
|
5367
4093
|
* ID of the promotion code to create a new discount for.
|
|
5368
4094
|
*/
|
|
@@ -5430,38 +4156,6 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
5430
4156
|
*/
|
|
5431
4157
|
taxable_amount: number;
|
|
5432
4158
|
}
|
|
5433
|
-
namespace Discount {
|
|
5434
|
-
interface DiscountEnd {
|
|
5435
|
-
/**
|
|
5436
|
-
* Time span for the redeemed discount.
|
|
5437
|
-
*/
|
|
5438
|
-
duration?: DiscountEnd.Duration;
|
|
5439
|
-
/**
|
|
5440
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5441
|
-
*/
|
|
5442
|
-
timestamp?: number;
|
|
5443
|
-
/**
|
|
5444
|
-
* The type of calculation made to determine when the discount ends.
|
|
5445
|
-
*/
|
|
5446
|
-
type: DiscountEnd.Type;
|
|
5447
|
-
}
|
|
5448
|
-
namespace DiscountEnd {
|
|
5449
|
-
interface Duration {
|
|
5450
|
-
/**
|
|
5451
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5452
|
-
*/
|
|
5453
|
-
interval: Duration.Interval;
|
|
5454
|
-
/**
|
|
5455
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5456
|
-
*/
|
|
5457
|
-
interval_count: number;
|
|
5458
|
-
}
|
|
5459
|
-
type Type = 'duration' | 'timestamp';
|
|
5460
|
-
namespace Duration {
|
|
5461
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5462
|
-
}
|
|
5463
|
-
}
|
|
5464
|
-
}
|
|
5465
4159
|
namespace PriceData {
|
|
5466
4160
|
interface ProductData {
|
|
5467
4161
|
/**
|
|
@@ -5484,28 +4178,12 @@ export declare namespace InvoiceUpdateLineItemParams {
|
|
|
5484
4178
|
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5485
4179
|
*/
|
|
5486
4180
|
tax_code?: string;
|
|
5487
|
-
/**
|
|
5488
|
-
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
5489
|
-
*/
|
|
5490
|
-
tax_details?: ProductData.TaxDetails;
|
|
5491
4181
|
/**
|
|
5492
4182
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
5493
4183
|
*/
|
|
5494
4184
|
unit_label?: string;
|
|
5495
4185
|
}
|
|
5496
4186
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
5497
|
-
namespace ProductData {
|
|
5498
|
-
interface TaxDetails {
|
|
5499
|
-
/**
|
|
5500
|
-
* A tax location ID. Depending on the [tax code](https://docs.stripe.com/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
|
|
5501
|
-
*/
|
|
5502
|
-
performance_location?: string;
|
|
5503
|
-
/**
|
|
5504
|
-
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5505
|
-
*/
|
|
5506
|
-
tax_code?: Emptyable<string>;
|
|
5507
|
-
}
|
|
5508
|
-
}
|
|
5509
4187
|
}
|
|
5510
4188
|
namespace TaxAmount {
|
|
5511
4189
|
interface TaxRateData {
|