stripe 20.1.0-beta.1 → 20.1.1
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 +49 -1499
- package/OPENAPI_VERSION +1 -1
- package/README.md +0 -1
- package/VERSION +1 -1
- package/cjs/Error.js +1 -115
- package/cjs/apiVersion.js +3 -2
- package/cjs/resources/FinancialConnections/Accounts.js +0 -5
- package/cjs/resources/Mandates.js +0 -5
- package/cjs/resources/PaymentIntents.js +0 -8
- package/cjs/resources/Quotes.js +0 -32
- package/cjs/resources/SubscriptionSchedules.js +0 -4
- package/cjs/resources/Subscriptions.js +0 -4
- package/cjs/resources.js +2 -88
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +0 -100
- package/esm/apiVersion.js +2 -1
- package/esm/resources/FinancialConnections/Accounts.js +0 -5
- package/esm/resources/Mandates.js +0 -5
- package/esm/resources/PaymentIntents.js +0 -8
- package/esm/resources/Quotes.js +0 -32
- package/esm/resources/SubscriptionSchedules.js +0 -4
- package/esm/resources/Subscriptions.js +0 -4
- package/esm/resources.js +0 -81
- package/esm/stripe.core.js +1 -1
- package/package.json +3 -3
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountLinksResource.d.ts +1 -5
- package/types/AccountSessions.d.ts +2 -47
- package/types/AccountSessionsResource.d.ts +0 -264
- package/types/Accounts.d.ts +25 -249
- package/types/AccountsResource.d.ts +114 -620
- package/types/ApplicationFeesResource.d.ts +2 -2
- package/types/Apps/Secrets.d.ts +1 -1
- package/types/Balance.d.ts +2 -2
- package/types/BalanceSettings.d.ts +1 -1
- package/types/BalanceTransactions.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -12
- package/types/Billing/AlertTriggereds.d.ts +1 -1
- package/types/Billing/Alerts.d.ts +1 -1
- package/types/Billing/CreditBalanceSummary.d.ts +1 -1
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +3 -3
- package/types/Billing/CreditGrantsResource.d.ts +3 -3
- package/types/Billing/MeterEvents.d.ts +1 -1
- package/types/Billing/MeterEventsResource.d.ts +1 -1
- package/types/BillingPortal/Configurations.d.ts +10 -3
- package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
- package/types/BillingPortal/Sessions.d.ts +7 -7
- package/types/BillingPortal/SessionsResource.d.ts +7 -7
- package/types/Capabilities.d.ts +16 -18
- package/types/Cards.d.ts +2 -7
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -179
- package/types/ChargesResource.d.ts +88 -3868
- package/types/Checkout/Sessions.d.ts +20 -297
- package/types/Checkout/SessionsResource.d.ts +59 -417
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -109
- package/types/Coupons.d.ts +3 -38
- package/types/CouponsResource.d.ts +2 -25
- package/types/CreditNoteLineItems.d.ts +3 -17
- package/types/CreditNotes.d.ts +8 -5
- package/types/CreditNotesResource.d.ts +5 -5
- package/types/CustomerBalanceTransactions.d.ts +9 -6
- package/types/CustomerCashBalanceTransactions.d.ts +13 -10
- package/types/CustomerSessions.d.ts +1 -42
- package/types/CustomerSessionsResource.d.ts +0 -41
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -23
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -43
- package/types/DisputesResource.d.ts +1 -12
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +0 -85
- package/types/EventTypes.d.ts +0 -630
- package/types/Events.d.ts +1 -97
- package/types/ExchangeRates.d.ts +2 -2
- package/types/FeeRefunds.d.ts +2 -2
- package/types/FileLinks.d.ts +1 -1
- package/types/FileLinksResource.d.ts +2 -2
- package/types/Files.d.ts +4 -4
- package/types/FilesResource.d.ts +3 -3
- package/types/FinancialConnections/Accounts.d.ts +4 -37
- package/types/FinancialConnections/AccountsResource.d.ts +6 -38
- package/types/FinancialConnections/Sessions.d.ts +3 -51
- package/types/FinancialConnections/SessionsResource.d.ts +4 -41
- package/types/Forwarding/Requests.d.ts +1 -1
- package/types/Forwarding/RequestsResource.d.ts +1 -1
- package/types/FundingInstructions.d.ts +2 -2
- package/types/Identity/VerificationReports.d.ts +8 -8
- package/types/Identity/VerificationSessions.d.ts +11 -11
- package/types/Identity/VerificationSessionsResource.d.ts +18 -12
- package/types/InvoiceItems.d.ts +8 -13
- package/types/InvoiceItemsResource.d.ts +16 -114
- package/types/InvoiceLineItems.d.ts +10 -46
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +60 -204
- package/types/InvoicesResource.d.ts +132 -1651
- package/types/Issuing/Authorizations.d.ts +20 -20
- package/types/Issuing/AuthorizationsResource.d.ts +4 -4
- package/types/Issuing/Cardholders.d.ts +13 -13
- package/types/Issuing/CardholdersResource.d.ts +21 -22
- package/types/Issuing/Cards.d.ts +10 -10
- package/types/Issuing/CardsResource.d.ts +13 -13
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +12 -17
- package/types/Issuing/TransactionsResource.d.ts +1 -6
- package/types/LineItems.d.ts +4 -48
- package/types/LoginLinks.d.ts +1 -1
- package/types/Mandates.d.ts +1 -69
- package/types/MandatesResource.d.ts +0 -31
- package/types/PaymentAttemptRecords.d.ts +119 -135
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +48 -705
- package/types/PaymentIntentsResource.d.ts +6867 -19451
- package/types/PaymentLinks.d.ts +7 -12
- package/types/PaymentLinksResource.d.ts +28 -38
- package/types/PaymentMethodConfigurations.d.ts +4 -184
- package/types/PaymentMethodConfigurationsResource.d.ts +76 -326
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -116
- package/types/PaymentMethodsResource.d.ts +7 -116
- package/types/PaymentRecords.d.ts +126 -135
- package/types/PaymentRecordsResource.d.ts +7 -7
- package/types/Payouts.d.ts +7 -7
- package/types/PayoutsResource.d.ts +3 -3
- package/types/Persons.d.ts +21 -23
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -28
- package/types/PricesResource.d.ts +10 -32
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +14 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/Quotes.d.ts +14 -602
- package/types/QuotesResource.d.ts +298 -2628
- package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
- package/types/Radar/ValueListItems.d.ts +1 -1
- package/types/Radar/ValueLists.d.ts +2 -2
- package/types/Radar/ValueListsResource.d.ts +2 -2
- package/types/Refunds.d.ts +3 -17
- package/types/RefundsResource.d.ts +3 -3
- package/types/Reporting/ReportRuns.d.ts +3 -3
- package/types/Reporting/ReportRunsResource.d.ts +2 -2
- package/types/Reporting/ReportTypes.d.ts +3 -3
- package/types/Reviews.d.ts +1 -1
- package/types/SetupAttempts.d.ts +22 -60
- package/types/SetupIntents.d.ts +22 -157
- package/types/SetupIntentsResource.d.ts +50 -673
- package/types/ShippingRates.d.ts +3 -3
- package/types/ShippingRatesResource.d.ts +3 -3
- package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
- package/types/SourceMandateNotifications.d.ts +3 -3
- package/types/Sources.d.ts +5 -34
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -33
- package/types/SubscriptionItemsResource.d.ts +22 -131
- package/types/SubscriptionSchedules.d.ts +9 -209
- package/types/SubscriptionSchedulesResource.d.ts +39 -1257
- package/types/Subscriptions.d.ts +41 -251
- package/types/SubscriptionsResource.d.ts +94 -734
- package/types/Tax/Associations.d.ts +3 -3
- package/types/Tax/AssociationsResource.d.ts +1 -1
- package/types/Tax/CalculationLineItems.d.ts +7 -7
- package/types/Tax/Calculations.d.ts +12 -12
- package/types/Tax/CalculationsResource.d.ts +7 -7
- package/types/Tax/Registrations.d.ts +3 -3
- package/types/Tax/Settings.d.ts +1 -1
- package/types/Tax/SettingsResource.d.ts +1 -1
- package/types/Tax/TransactionLineItems.d.ts +5 -5
- package/types/Tax/Transactions.d.ts +9 -9
- package/types/Tax/TransactionsResource.d.ts +10 -10
- package/types/TaxIds.d.ts +6 -6
- package/types/TaxIdsResource.d.ts +4 -4
- package/types/TaxRates.d.ts +1 -1
- package/types/TaxRatesResource.d.ts +2 -2
- package/types/Terminal/Configurations.d.ts +0 -9
- package/types/Terminal/ConfigurationsResource.d.ts +0 -28
- package/types/Terminal/ConnectionTokens.d.ts +1 -1
- package/types/Terminal/Locations.d.ts +2 -2
- package/types/Terminal/LocationsResource.d.ts +3 -3
- package/types/Terminal/Readers.d.ts +10 -30
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -107
- package/types/TestHelpers/CustomersResource.d.ts +2 -2
- package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
- package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -27
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -27
- package/types/Tokens.d.ts +4 -4
- package/types/TokensResource.d.ts +17 -17
- package/types/Topups.d.ts +3 -3
- package/types/TopupsResource.d.ts +3 -3
- package/types/TransferReversals.d.ts +4 -4
- package/types/Transfers.d.ts +5 -10
- package/types/TransfersResource.d.ts +6 -11
- package/types/Treasury/CreditReversals.d.ts +3 -3
- package/types/Treasury/CreditReversalsResource.d.ts +1 -1
- package/types/Treasury/DebitReversals.d.ts +3 -3
- package/types/Treasury/DebitReversalsResource.d.ts +1 -1
- package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
- package/types/Treasury/FinancialAccounts.d.ts +1 -6
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -39
- package/types/Treasury/InboundTransfers.d.ts +4 -4
- package/types/Treasury/InboundTransfersResource.d.ts +2 -2
- package/types/Treasury/OutboundPayments.d.ts +5 -5
- package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
- package/types/Treasury/OutboundTransfers.d.ts +4 -30
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -29
- package/types/Treasury/ReceivedCredits.d.ts +9 -35
- package/types/Treasury/ReceivedDebits.d.ts +6 -37
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Core/AccountLinks.d.ts +13 -21
- package/types/V2/Core/AccountLinksResource.d.ts +8 -16
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +129 -24
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
- package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
- package/types/V2/Core/Accounts.d.ts +256 -1349
- package/types/V2/Core/AccountsResource.d.ts +282 -567
- package/types/V2/Core/EventTypes.d.ts +10 -1542
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +5 -79
- package/types/apiVersion.d.ts +2 -1
- package/types/index.d.ts +0 -134
- package/types/lib.d.ts +0 -10
- package/cjs/resources/AccountNotices.js +0 -21
- package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
- package/cjs/resources/Capital/FinancingOffers.js +0 -21
- package/cjs/resources/Capital/FinancingSummary.js +0 -12
- package/cjs/resources/Capital/FinancingTransactions.js +0 -17
- package/cjs/resources/ExternalAccounts.js +0 -23
- package/cjs/resources/FinancialConnections/Institutions.js +0 -17
- package/cjs/resources/FxQuotes.js +0 -15
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
- package/cjs/resources/Margins.js +0 -22
- package/cjs/resources/Orders.js +0 -24
- package/cjs/resources/Privacy/RedactionJobs.js +0 -42
- package/cjs/resources/Tax/Forms.js +0 -20
- package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/BillSettings.js +0 -27
- package/cjs/resources/V2/Billing/Cadences.js +0 -23
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
- package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
- package/cjs/resources/V2/Billing/Profiles.js +0 -19
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -33
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -37
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -29
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
- package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
- package/esm/resources/AccountNotices.js +0 -18
- package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
- package/esm/resources/Capital/FinancingOffers.js +0 -18
- package/esm/resources/Capital/FinancingSummary.js +0 -9
- package/esm/resources/Capital/FinancingTransactions.js +0 -14
- package/esm/resources/ExternalAccounts.js +0 -20
- package/esm/resources/FinancialConnections/Institutions.js +0 -14
- package/esm/resources/FxQuotes.js +0 -12
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
- package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
- package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
- package/esm/resources/Margins.js +0 -19
- package/esm/resources/Orders.js +0 -21
- package/esm/resources/Privacy/RedactionJobs.js +0 -39
- package/esm/resources/Tax/Forms.js +0 -17
- package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
- package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/BillSettings.js +0 -24
- package/esm/resources/V2/Billing/Cadences.js +0 -20
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
- package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
- package/esm/resources/V2/Billing/Profiles.js +0 -16
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -30
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -34
- package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -26
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
- package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
- package/types/AccountNotices.d.ts +0 -113
- package/types/AccountNoticesResource.d.ts +0 -98
- package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
- package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
- package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
- package/types/Capital/FinancingOffers.d.ts +0 -188
- package/types/Capital/FinancingOffersResource.d.ts +0 -97
- package/types/Capital/FinancingSummary.d.ts +0 -106
- package/types/Capital/FinancingSummaryResource.d.ts +0 -27
- package/types/Capital/FinancingTransactions.d.ts +0 -135
- package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
- package/types/ExternalAccountsResource.d.ts +0 -304
- package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
- package/types/FinancialConnections/Institutions.d.ts +0 -98
- package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
- package/types/FxQuotes.d.ts +0 -155
- package/types/FxQuotesResource.d.ts +0 -130
- package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
- package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
- package/types/Issuing/Settlements.d.ts +0 -113
- package/types/Margins.d.ts +0 -56
- package/types/MarginsResource.d.ts +0 -114
- package/types/Orders.d.ts +0 -1163
- package/types/OrdersResource.d.ts +0 -5505
- package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
- package/types/Privacy/RedactionJobs.d.ts +0 -111
- package/types/Privacy/RedactionJobsResource.d.ts +0 -230
- package/types/QuoteLines.d.ts +0 -634
- package/types/QuotePreviewInvoices.d.ts +0 -1771
- package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
- package/types/Tax/Forms.d.ts +0 -220
- package/types/Tax/FormsResource.d.ts +0 -107
- package/types/Terminal/ReaderCollectedData.d.ts +0 -51
- package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
- package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
- package/types/V2/Billing/BillSettings.d.ts +0 -120
- package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
- package/types/V2/Billing/Cadences.d.ts +0 -690
- package/types/V2/Billing/CadencesResource.d.ts +0 -487
- package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -318
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
- package/types/V2/Billing/CollectionSettings.d.ts +0 -341
- package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -683
- package/types/V2/Billing/Profiles.d.ts +0 -70
- package/types/V2/Billing/ProfilesResource.d.ts +0 -150
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -194
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -116
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -198
- package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
- package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -148
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -172
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -175
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -109
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -212
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
- package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
|
@@ -9,17 +9,12 @@ declare module 'stripe' {
|
|
|
9
9
|
account_tax_ids?: Stripe.Emptyable<Array<string>>;
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
13
|
-
*/
|
|
14
|
-
amounts_due?: Stripe.Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* 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://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
|
12
|
+
* 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).
|
|
18
13
|
*/
|
|
19
14
|
application_fee_amount?: number;
|
|
20
15
|
|
|
21
16
|
/**
|
|
22
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
17
|
+
* 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. Defaults to false.
|
|
23
18
|
*/
|
|
24
19
|
auto_advance?: boolean;
|
|
25
20
|
|
|
@@ -49,12 +44,12 @@ declare module 'stripe' {
|
|
|
49
44
|
custom_fields?: Stripe.Emptyable<Array<InvoiceCreateParams.CustomField>>;
|
|
50
45
|
|
|
51
46
|
/**
|
|
52
|
-
* The ID of the customer
|
|
47
|
+
* The ID of the customer to bill.
|
|
53
48
|
*/
|
|
54
49
|
customer?: string;
|
|
55
50
|
|
|
56
51
|
/**
|
|
57
|
-
* The ID of the account
|
|
52
|
+
* The ID of the account to bill.
|
|
58
53
|
*/
|
|
59
54
|
customer_account?: string;
|
|
60
55
|
|
|
@@ -63,11 +58,6 @@ declare module 'stripe' {
|
|
|
63
58
|
*/
|
|
64
59
|
days_until_due?: number;
|
|
65
60
|
|
|
66
|
-
/**
|
|
67
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
68
|
-
*/
|
|
69
|
-
default_margins?: Array<string>;
|
|
70
|
-
|
|
71
61
|
/**
|
|
72
62
|
* 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.
|
|
73
63
|
*/
|
|
@@ -114,7 +104,7 @@ declare module 'stripe' {
|
|
|
114
104
|
footer?: string;
|
|
115
105
|
|
|
116
106
|
/**
|
|
117
|
-
* Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/
|
|
107
|
+
* Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
|
|
118
108
|
*/
|
|
119
109
|
from_invoice?: InvoiceCreateParams.FromInvoice;
|
|
120
110
|
|
|
@@ -124,7 +114,7 @@ declare module 'stripe' {
|
|
|
124
114
|
issuer?: InvoiceCreateParams.Issuer;
|
|
125
115
|
|
|
126
116
|
/**
|
|
127
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
117
|
+
* 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`.
|
|
128
118
|
*/
|
|
129
119
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
130
120
|
|
|
@@ -134,7 +124,7 @@ declare module 'stripe' {
|
|
|
134
124
|
number?: string;
|
|
135
125
|
|
|
136
126
|
/**
|
|
137
|
-
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/
|
|
127
|
+
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
138
128
|
*/
|
|
139
129
|
on_behalf_of?: string;
|
|
140
130
|
|
|
@@ -180,31 +170,9 @@ declare module 'stripe' {
|
|
|
180
170
|
}
|
|
181
171
|
|
|
182
172
|
namespace InvoiceCreateParams {
|
|
183
|
-
interface AmountsDue {
|
|
184
|
-
/**
|
|
185
|
-
* The amount in cents (or local equivalent).
|
|
186
|
-
*/
|
|
187
|
-
amount: number;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
191
|
-
*/
|
|
192
|
-
days_until_due?: number;
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
196
|
-
*/
|
|
197
|
-
description: string;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* Date on which a payment plan's payment is due.
|
|
201
|
-
*/
|
|
202
|
-
due_date?: number;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
173
|
interface AutomaticTax {
|
|
206
174
|
/**
|
|
207
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
175
|
+
* 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.
|
|
208
176
|
*/
|
|
209
177
|
enabled: boolean;
|
|
210
178
|
|
|
@@ -257,56 +225,12 @@ declare module 'stripe' {
|
|
|
257
225
|
*/
|
|
258
226
|
discount?: string;
|
|
259
227
|
|
|
260
|
-
/**
|
|
261
|
-
* Details to determine how long the discount should be applied for.
|
|
262
|
-
*/
|
|
263
|
-
discount_end?: Discount.DiscountEnd;
|
|
264
|
-
|
|
265
228
|
/**
|
|
266
229
|
* ID of the promotion code to create a new discount for.
|
|
267
230
|
*/
|
|
268
231
|
promotion_code?: string;
|
|
269
232
|
}
|
|
270
233
|
|
|
271
|
-
namespace Discount {
|
|
272
|
-
interface DiscountEnd {
|
|
273
|
-
/**
|
|
274
|
-
* Time span for the redeemed discount.
|
|
275
|
-
*/
|
|
276
|
-
duration?: DiscountEnd.Duration;
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
280
|
-
*/
|
|
281
|
-
timestamp?: number;
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* The type of calculation made to determine when the discount ends.
|
|
285
|
-
*/
|
|
286
|
-
type: DiscountEnd.Type;
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
namespace DiscountEnd {
|
|
290
|
-
interface Duration {
|
|
291
|
-
/**
|
|
292
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
293
|
-
*/
|
|
294
|
-
interval: Duration.Interval;
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
298
|
-
*/
|
|
299
|
-
interval_count: number;
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
namespace Duration {
|
|
303
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
type Type = 'duration' | 'timestamp';
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
|
|
310
234
|
interface FromInvoice {
|
|
311
235
|
/**
|
|
312
236
|
* The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
|
|
@@ -378,33 +302,21 @@ declare module 'stripe' {
|
|
|
378
302
|
PaymentMethodOptions.CustomerBalance
|
|
379
303
|
>;
|
|
380
304
|
|
|
381
|
-
/**
|
|
382
|
-
* 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.
|
|
383
|
-
*/
|
|
384
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
385
|
-
PaymentMethodOptions.IdBankTransfer
|
|
386
|
-
>;
|
|
387
|
-
|
|
388
305
|
/**
|
|
389
306
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
390
307
|
*/
|
|
391
308
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
392
309
|
|
|
393
310
|
/**
|
|
394
|
-
* If paying by `
|
|
311
|
+
* If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
|
|
395
312
|
*/
|
|
396
|
-
|
|
313
|
+
payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
|
|
397
314
|
|
|
398
315
|
/**
|
|
399
316
|
* If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
400
317
|
*/
|
|
401
318
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
402
319
|
|
|
403
|
-
/**
|
|
404
|
-
* If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
405
|
-
*/
|
|
406
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
407
|
-
|
|
408
320
|
/**
|
|
409
321
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
410
322
|
*/
|
|
@@ -456,12 +368,12 @@ declare module 'stripe' {
|
|
|
456
368
|
/**
|
|
457
369
|
* Installment configuration for payments attempted on this invoice.
|
|
458
370
|
*
|
|
459
|
-
* For more information, see the [installments integration guide](https://stripe.com/
|
|
371
|
+
* For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
460
372
|
*/
|
|
461
373
|
installments?: Card.Installments;
|
|
462
374
|
|
|
463
375
|
/**
|
|
464
|
-
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/
|
|
376
|
+
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
465
377
|
*/
|
|
466
378
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
467
379
|
}
|
|
@@ -542,58 +454,46 @@ declare module 'stripe' {
|
|
|
542
454
|
}
|
|
543
455
|
}
|
|
544
456
|
|
|
545
|
-
interface IdBankTransfer {}
|
|
546
|
-
|
|
547
457
|
interface Konbini {}
|
|
548
458
|
|
|
549
|
-
interface
|
|
550
|
-
/**
|
|
551
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
552
|
-
*/
|
|
553
|
-
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
554
|
-
}
|
|
555
|
-
|
|
556
|
-
namespace Pix {
|
|
557
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
558
|
-
}
|
|
559
|
-
|
|
560
|
-
interface SepaDebit {}
|
|
561
|
-
|
|
562
|
-
interface Upi {
|
|
459
|
+
interface Payto {
|
|
563
460
|
/**
|
|
564
|
-
*
|
|
461
|
+
* Additional fields for Mandate creation.
|
|
565
462
|
*/
|
|
566
|
-
mandate_options?:
|
|
463
|
+
mandate_options?: Payto.MandateOptions;
|
|
567
464
|
}
|
|
568
465
|
|
|
569
|
-
namespace
|
|
466
|
+
namespace Payto {
|
|
570
467
|
interface MandateOptions {
|
|
571
468
|
/**
|
|
572
|
-
*
|
|
469
|
+
* The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
573
470
|
*/
|
|
574
471
|
amount?: number;
|
|
575
472
|
|
|
576
473
|
/**
|
|
577
|
-
*
|
|
578
|
-
*/
|
|
579
|
-
amount_type?: MandateOptions.AmountType;
|
|
580
|
-
|
|
581
|
-
/**
|
|
582
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
474
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
583
475
|
*/
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
588
|
-
*/
|
|
589
|
-
end_date?: number;
|
|
476
|
+
purpose?: MandateOptions.Purpose;
|
|
590
477
|
}
|
|
591
478
|
|
|
592
479
|
namespace MandateOptions {
|
|
593
|
-
type
|
|
480
|
+
type Purpose =
|
|
481
|
+
| 'dependant_support'
|
|
482
|
+
| 'government'
|
|
483
|
+
| 'loan'
|
|
484
|
+
| 'mortgage'
|
|
485
|
+
| 'other'
|
|
486
|
+
| 'pension'
|
|
487
|
+
| 'personal'
|
|
488
|
+
| 'retail'
|
|
489
|
+
| 'salary'
|
|
490
|
+
| 'tax'
|
|
491
|
+
| 'utility';
|
|
594
492
|
}
|
|
595
493
|
}
|
|
596
494
|
|
|
495
|
+
interface SepaDebit {}
|
|
496
|
+
|
|
597
497
|
interface UsBankAccount {
|
|
598
498
|
/**
|
|
599
499
|
* Additional fields for Financial Connections Session creation
|
|
@@ -630,11 +530,6 @@ declare module 'stripe' {
|
|
|
630
530
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
631
531
|
*/
|
|
632
532
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
633
|
-
|
|
634
|
-
/**
|
|
635
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
636
|
-
*/
|
|
637
|
-
institution?: string;
|
|
638
533
|
}
|
|
639
534
|
|
|
640
535
|
namespace Filters {
|
|
@@ -647,11 +542,7 @@ declare module 'stripe' {
|
|
|
647
542
|
| 'payment_method'
|
|
648
543
|
| 'transactions';
|
|
649
544
|
|
|
650
|
-
type Prefetch =
|
|
651
|
-
| 'balances'
|
|
652
|
-
| 'inferred_balances'
|
|
653
|
-
| 'ownership'
|
|
654
|
-
| 'transactions';
|
|
545
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
655
546
|
}
|
|
656
547
|
|
|
657
548
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -677,7 +568,6 @@ declare module 'stripe' {
|
|
|
677
568
|
| 'fpx'
|
|
678
569
|
| 'giropay'
|
|
679
570
|
| 'grabpay'
|
|
680
|
-
| 'id_bank_transfer'
|
|
681
571
|
| 'ideal'
|
|
682
572
|
| 'jp_credit_transfer'
|
|
683
573
|
| 'kakao_pay'
|
|
@@ -692,15 +582,13 @@ declare module 'stripe' {
|
|
|
692
582
|
| 'payco'
|
|
693
583
|
| 'paynow'
|
|
694
584
|
| 'paypal'
|
|
695
|
-
| '
|
|
585
|
+
| 'payto'
|
|
696
586
|
| 'promptpay'
|
|
697
587
|
| 'revolut_pay'
|
|
698
588
|
| 'sepa_credit_transfer'
|
|
699
589
|
| 'sepa_debit'
|
|
700
590
|
| 'sofort'
|
|
701
|
-
| 'stripe_balance'
|
|
702
591
|
| 'swish'
|
|
703
|
-
| 'upi'
|
|
704
592
|
| 'us_bank_account'
|
|
705
593
|
| 'wechat_pay';
|
|
706
594
|
}
|
|
@@ -776,7 +664,7 @@ declare module 'stripe' {
|
|
|
776
664
|
fixed_amount?: ShippingRateData.FixedAmount;
|
|
777
665
|
|
|
778
666
|
/**
|
|
779
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
667
|
+
* 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`.
|
|
780
668
|
*/
|
|
781
669
|
metadata?: Stripe.MetadataParam;
|
|
782
670
|
|
|
@@ -786,7 +674,7 @@ declare module 'stripe' {
|
|
|
786
674
|
tax_behavior?: ShippingRateData.TaxBehavior;
|
|
787
675
|
|
|
788
676
|
/**
|
|
789
|
-
* A [tax code](https://stripe.com/
|
|
677
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
790
678
|
*/
|
|
791
679
|
tax_code?: string;
|
|
792
680
|
|
|
@@ -928,17 +816,12 @@ declare module 'stripe' {
|
|
|
928
816
|
account_tax_ids?: Stripe.Emptyable<Array<string>>;
|
|
929
817
|
|
|
930
818
|
/**
|
|
931
|
-
*
|
|
932
|
-
*/
|
|
933
|
-
amounts_due?: Stripe.Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
934
|
-
|
|
935
|
-
/**
|
|
936
|
-
* 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://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
|
819
|
+
* 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).
|
|
937
820
|
*/
|
|
938
821
|
application_fee_amount?: number;
|
|
939
822
|
|
|
940
823
|
/**
|
|
941
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
824
|
+
* Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice.
|
|
942
825
|
*/
|
|
943
826
|
auto_advance?: boolean;
|
|
944
827
|
|
|
@@ -967,11 +850,6 @@ declare module 'stripe' {
|
|
|
967
850
|
*/
|
|
968
851
|
days_until_due?: number;
|
|
969
852
|
|
|
970
|
-
/**
|
|
971
|
-
* The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
|
972
|
-
*/
|
|
973
|
-
default_margins?: Stripe.Emptyable<Array<string>>;
|
|
974
|
-
|
|
975
853
|
/**
|
|
976
854
|
* 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.
|
|
977
855
|
*/
|
|
@@ -1023,7 +901,7 @@ declare module 'stripe' {
|
|
|
1023
901
|
issuer?: InvoiceUpdateParams.Issuer;
|
|
1024
902
|
|
|
1025
903
|
/**
|
|
1026
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
904
|
+
* 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`.
|
|
1027
905
|
*/
|
|
1028
906
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1029
907
|
|
|
@@ -1033,7 +911,7 @@ declare module 'stripe' {
|
|
|
1033
911
|
number?: Stripe.Emptyable<string>;
|
|
1034
912
|
|
|
1035
913
|
/**
|
|
1036
|
-
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/
|
|
914
|
+
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
1037
915
|
*/
|
|
1038
916
|
on_behalf_of?: Stripe.Emptyable<string>;
|
|
1039
917
|
|
|
@@ -1069,31 +947,9 @@ declare module 'stripe' {
|
|
|
1069
947
|
}
|
|
1070
948
|
|
|
1071
949
|
namespace InvoiceUpdateParams {
|
|
1072
|
-
interface AmountsDue {
|
|
1073
|
-
/**
|
|
1074
|
-
* The amount in cents (or local equivalent).
|
|
1075
|
-
*/
|
|
1076
|
-
amount: number;
|
|
1077
|
-
|
|
1078
|
-
/**
|
|
1079
|
-
* Number of days from when invoice is finalized until the payment is due.
|
|
1080
|
-
*/
|
|
1081
|
-
days_until_due?: number;
|
|
1082
|
-
|
|
1083
|
-
/**
|
|
1084
|
-
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1085
|
-
*/
|
|
1086
|
-
description: string;
|
|
1087
|
-
|
|
1088
|
-
/**
|
|
1089
|
-
* Date on which a payment plan's payment is due.
|
|
1090
|
-
*/
|
|
1091
|
-
due_date?: number;
|
|
1092
|
-
}
|
|
1093
|
-
|
|
1094
950
|
interface AutomaticTax {
|
|
1095
951
|
/**
|
|
1096
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
952
|
+
* 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.
|
|
1097
953
|
*/
|
|
1098
954
|
enabled: boolean;
|
|
1099
955
|
|
|
@@ -1146,56 +1002,12 @@ declare module 'stripe' {
|
|
|
1146
1002
|
*/
|
|
1147
1003
|
discount?: string;
|
|
1148
1004
|
|
|
1149
|
-
/**
|
|
1150
|
-
* Details to determine how long the discount should be applied for.
|
|
1151
|
-
*/
|
|
1152
|
-
discount_end?: Discount.DiscountEnd;
|
|
1153
|
-
|
|
1154
1005
|
/**
|
|
1155
1006
|
* ID of the promotion code to create a new discount for.
|
|
1156
1007
|
*/
|
|
1157
1008
|
promotion_code?: string;
|
|
1158
1009
|
}
|
|
1159
1010
|
|
|
1160
|
-
namespace Discount {
|
|
1161
|
-
interface DiscountEnd {
|
|
1162
|
-
/**
|
|
1163
|
-
* Time span for the redeemed discount.
|
|
1164
|
-
*/
|
|
1165
|
-
duration?: DiscountEnd.Duration;
|
|
1166
|
-
|
|
1167
|
-
/**
|
|
1168
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1169
|
-
*/
|
|
1170
|
-
timestamp?: number;
|
|
1171
|
-
|
|
1172
|
-
/**
|
|
1173
|
-
* The type of calculation made to determine when the discount ends.
|
|
1174
|
-
*/
|
|
1175
|
-
type: DiscountEnd.Type;
|
|
1176
|
-
}
|
|
1177
|
-
|
|
1178
|
-
namespace DiscountEnd {
|
|
1179
|
-
interface Duration {
|
|
1180
|
-
/**
|
|
1181
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1182
|
-
*/
|
|
1183
|
-
interval: Duration.Interval;
|
|
1184
|
-
|
|
1185
|
-
/**
|
|
1186
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1187
|
-
*/
|
|
1188
|
-
interval_count: number;
|
|
1189
|
-
}
|
|
1190
|
-
|
|
1191
|
-
namespace Duration {
|
|
1192
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1193
|
-
}
|
|
1194
|
-
|
|
1195
|
-
type Type = 'duration' | 'timestamp';
|
|
1196
|
-
}
|
|
1197
|
-
}
|
|
1198
|
-
|
|
1199
1011
|
interface Issuer {
|
|
1200
1012
|
/**
|
|
1201
1013
|
* The connected account being referenced when `type` is `account`.
|
|
@@ -1255,33 +1067,21 @@ declare module 'stripe' {
|
|
|
1255
1067
|
PaymentMethodOptions.CustomerBalance
|
|
1256
1068
|
>;
|
|
1257
1069
|
|
|
1258
|
-
/**
|
|
1259
|
-
* 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.
|
|
1260
|
-
*/
|
|
1261
|
-
id_bank_transfer?: Stripe.Emptyable<
|
|
1262
|
-
PaymentMethodOptions.IdBankTransfer
|
|
1263
|
-
>;
|
|
1264
|
-
|
|
1265
1070
|
/**
|
|
1266
1071
|
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
|
|
1267
1072
|
*/
|
|
1268
1073
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
1269
1074
|
|
|
1270
1075
|
/**
|
|
1271
|
-
* If paying by `
|
|
1076
|
+
* If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
|
|
1272
1077
|
*/
|
|
1273
|
-
|
|
1078
|
+
payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
|
|
1274
1079
|
|
|
1275
1080
|
/**
|
|
1276
1081
|
* If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
|
|
1277
1082
|
*/
|
|
1278
1083
|
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
|
|
1279
1084
|
|
|
1280
|
-
/**
|
|
1281
|
-
* If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
|
|
1282
|
-
*/
|
|
1283
|
-
upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
|
|
1284
|
-
|
|
1285
1085
|
/**
|
|
1286
1086
|
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
|
|
1287
1087
|
*/
|
|
@@ -1333,12 +1133,12 @@ declare module 'stripe' {
|
|
|
1333
1133
|
/**
|
|
1334
1134
|
* Installment configuration for payments attempted on this invoice.
|
|
1335
1135
|
*
|
|
1336
|
-
* For more information, see the [installments integration guide](https://stripe.com/
|
|
1136
|
+
* For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
1337
1137
|
*/
|
|
1338
1138
|
installments?: Card.Installments;
|
|
1339
1139
|
|
|
1340
1140
|
/**
|
|
1341
|
-
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/
|
|
1141
|
+
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
1342
1142
|
*/
|
|
1343
1143
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1344
1144
|
}
|
|
@@ -1419,58 +1219,46 @@ declare module 'stripe' {
|
|
|
1419
1219
|
}
|
|
1420
1220
|
}
|
|
1421
1221
|
|
|
1422
|
-
interface IdBankTransfer {}
|
|
1423
|
-
|
|
1424
1222
|
interface Konbini {}
|
|
1425
1223
|
|
|
1426
|
-
interface
|
|
1427
|
-
/**
|
|
1428
|
-
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1429
|
-
*/
|
|
1430
|
-
amount_includes_iof?: Pix.AmountIncludesIof;
|
|
1431
|
-
}
|
|
1432
|
-
|
|
1433
|
-
namespace Pix {
|
|
1434
|
-
type AmountIncludesIof = 'always' | 'never';
|
|
1435
|
-
}
|
|
1436
|
-
|
|
1437
|
-
interface SepaDebit {}
|
|
1438
|
-
|
|
1439
|
-
interface Upi {
|
|
1224
|
+
interface Payto {
|
|
1440
1225
|
/**
|
|
1441
|
-
*
|
|
1226
|
+
* Additional fields for Mandate creation.
|
|
1442
1227
|
*/
|
|
1443
|
-
mandate_options?:
|
|
1228
|
+
mandate_options?: Payto.MandateOptions;
|
|
1444
1229
|
}
|
|
1445
1230
|
|
|
1446
|
-
namespace
|
|
1231
|
+
namespace Payto {
|
|
1447
1232
|
interface MandateOptions {
|
|
1448
1233
|
/**
|
|
1449
|
-
*
|
|
1234
|
+
* The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
1450
1235
|
*/
|
|
1451
1236
|
amount?: number;
|
|
1452
1237
|
|
|
1453
1238
|
/**
|
|
1454
|
-
*
|
|
1239
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
1455
1240
|
*/
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
/**
|
|
1459
|
-
* A description of the mandate or subscription that is meant to be displayed to the customer.
|
|
1460
|
-
*/
|
|
1461
|
-
description?: string;
|
|
1462
|
-
|
|
1463
|
-
/**
|
|
1464
|
-
* End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
1465
|
-
*/
|
|
1466
|
-
end_date?: number;
|
|
1241
|
+
purpose?: MandateOptions.Purpose;
|
|
1467
1242
|
}
|
|
1468
1243
|
|
|
1469
1244
|
namespace MandateOptions {
|
|
1470
|
-
type
|
|
1245
|
+
type Purpose =
|
|
1246
|
+
| 'dependant_support'
|
|
1247
|
+
| 'government'
|
|
1248
|
+
| 'loan'
|
|
1249
|
+
| 'mortgage'
|
|
1250
|
+
| 'other'
|
|
1251
|
+
| 'pension'
|
|
1252
|
+
| 'personal'
|
|
1253
|
+
| 'retail'
|
|
1254
|
+
| 'salary'
|
|
1255
|
+
| 'tax'
|
|
1256
|
+
| 'utility';
|
|
1471
1257
|
}
|
|
1472
1258
|
}
|
|
1473
1259
|
|
|
1260
|
+
interface SepaDebit {}
|
|
1261
|
+
|
|
1474
1262
|
interface UsBankAccount {
|
|
1475
1263
|
/**
|
|
1476
1264
|
* Additional fields for Financial Connections Session creation
|
|
@@ -1507,11 +1295,6 @@ declare module 'stripe' {
|
|
|
1507
1295
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1508
1296
|
*/
|
|
1509
1297
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1510
|
-
|
|
1511
|
-
/**
|
|
1512
|
-
* ID of the institution to use to filter for selectable accounts.
|
|
1513
|
-
*/
|
|
1514
|
-
institution?: string;
|
|
1515
1298
|
}
|
|
1516
1299
|
|
|
1517
1300
|
namespace Filters {
|
|
@@ -1524,11 +1307,7 @@ declare module 'stripe' {
|
|
|
1524
1307
|
| 'payment_method'
|
|
1525
1308
|
| 'transactions';
|
|
1526
1309
|
|
|
1527
|
-
type Prefetch =
|
|
1528
|
-
| 'balances'
|
|
1529
|
-
| 'inferred_balances'
|
|
1530
|
-
| 'ownership'
|
|
1531
|
-
| 'transactions';
|
|
1310
|
+
type Prefetch = 'balances' | 'ownership' | 'transactions';
|
|
1532
1311
|
}
|
|
1533
1312
|
|
|
1534
1313
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
@@ -1554,7 +1333,6 @@ declare module 'stripe' {
|
|
|
1554
1333
|
| 'fpx'
|
|
1555
1334
|
| 'giropay'
|
|
1556
1335
|
| 'grabpay'
|
|
1557
|
-
| 'id_bank_transfer'
|
|
1558
1336
|
| 'ideal'
|
|
1559
1337
|
| 'jp_credit_transfer'
|
|
1560
1338
|
| 'kakao_pay'
|
|
@@ -1569,15 +1347,13 @@ declare module 'stripe' {
|
|
|
1569
1347
|
| 'payco'
|
|
1570
1348
|
| 'paynow'
|
|
1571
1349
|
| 'paypal'
|
|
1572
|
-
| '
|
|
1350
|
+
| 'payto'
|
|
1573
1351
|
| 'promptpay'
|
|
1574
1352
|
| 'revolut_pay'
|
|
1575
1353
|
| 'sepa_credit_transfer'
|
|
1576
1354
|
| 'sepa_debit'
|
|
1577
1355
|
| 'sofort'
|
|
1578
|
-
| 'stripe_balance'
|
|
1579
1356
|
| 'swish'
|
|
1580
|
-
| 'upi'
|
|
1581
1357
|
| 'us_bank_account'
|
|
1582
1358
|
| 'wechat_pay';
|
|
1583
1359
|
}
|
|
@@ -1651,7 +1427,7 @@ declare module 'stripe' {
|
|
|
1651
1427
|
fixed_amount?: ShippingRateData.FixedAmount;
|
|
1652
1428
|
|
|
1653
1429
|
/**
|
|
1654
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1430
|
+
* 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`.
|
|
1655
1431
|
*/
|
|
1656
1432
|
metadata?: Stripe.MetadataParam;
|
|
1657
1433
|
|
|
@@ -1661,7 +1437,7 @@ declare module 'stripe' {
|
|
|
1661
1437
|
tax_behavior?: ShippingRateData.TaxBehavior;
|
|
1662
1438
|
|
|
1663
1439
|
/**
|
|
1664
|
-
* A [tax code](https://stripe.com/
|
|
1440
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
1665
1441
|
*/
|
|
1666
1442
|
tax_code?: string;
|
|
1667
1443
|
|
|
@@ -1806,7 +1582,7 @@ declare module 'stripe' {
|
|
|
1806
1582
|
customer?: string;
|
|
1807
1583
|
|
|
1808
1584
|
/**
|
|
1809
|
-
* Only return invoices for the account specified by this account ID.
|
|
1585
|
+
* Only return invoices for the account representing the customer specified by this account ID.
|
|
1810
1586
|
*/
|
|
1811
1587
|
customer_account?: string;
|
|
1812
1588
|
|
|
@@ -1818,7 +1594,7 @@ declare module 'stripe' {
|
|
|
1818
1594
|
expand?: Array<string>;
|
|
1819
1595
|
|
|
1820
1596
|
/**
|
|
1821
|
-
* The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/
|
|
1597
|
+
* The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
|
|
1822
1598
|
*/
|
|
1823
1599
|
status?: InvoiceListParams.Status;
|
|
1824
1600
|
|
|
@@ -1848,7 +1624,7 @@ declare module 'stripe' {
|
|
|
1848
1624
|
expand?: Array<string>;
|
|
1849
1625
|
|
|
1850
1626
|
/**
|
|
1851
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1627
|
+
* 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`.
|
|
1852
1628
|
*/
|
|
1853
1629
|
invoice_metadata?: Stripe.Emptyable<{
|
|
1854
1630
|
[key: string]: string;
|
|
@@ -1883,22 +1659,17 @@ declare module 'stripe' {
|
|
|
1883
1659
|
invoice_item?: string;
|
|
1884
1660
|
|
|
1885
1661
|
/**
|
|
1886
|
-
*
|
|
1887
|
-
*/
|
|
1888
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
1889
|
-
|
|
1890
|
-
/**
|
|
1891
|
-
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
1662
|
+
* 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`.
|
|
1892
1663
|
*/
|
|
1893
1664
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1894
1665
|
|
|
1895
1666
|
/**
|
|
1896
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
1667
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
1897
1668
|
*/
|
|
1898
1669
|
period?: Line.Period;
|
|
1899
1670
|
|
|
1900
1671
|
/**
|
|
1901
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
1672
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
1902
1673
|
*/
|
|
1903
1674
|
price_data?: Line.PriceData;
|
|
1904
1675
|
|
|
@@ -1913,7 +1684,7 @@ declare module 'stripe' {
|
|
|
1913
1684
|
quantity?: number;
|
|
1914
1685
|
|
|
1915
1686
|
/**
|
|
1916
|
-
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/
|
|
1687
|
+
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
|
|
1917
1688
|
*/
|
|
1918
1689
|
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
|
|
1919
1690
|
|
|
@@ -1935,56 +1706,12 @@ declare module 'stripe' {
|
|
|
1935
1706
|
*/
|
|
1936
1707
|
discount?: string;
|
|
1937
1708
|
|
|
1938
|
-
/**
|
|
1939
|
-
* Details to determine how long the discount should be applied for.
|
|
1940
|
-
*/
|
|
1941
|
-
discount_end?: Discount.DiscountEnd;
|
|
1942
|
-
|
|
1943
1709
|
/**
|
|
1944
1710
|
* ID of the promotion code to create a new discount for.
|
|
1945
1711
|
*/
|
|
1946
1712
|
promotion_code?: string;
|
|
1947
1713
|
}
|
|
1948
1714
|
|
|
1949
|
-
namespace Discount {
|
|
1950
|
-
interface DiscountEnd {
|
|
1951
|
-
/**
|
|
1952
|
-
* Time span for the redeemed discount.
|
|
1953
|
-
*/
|
|
1954
|
-
duration?: DiscountEnd.Duration;
|
|
1955
|
-
|
|
1956
|
-
/**
|
|
1957
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1958
|
-
*/
|
|
1959
|
-
timestamp?: number;
|
|
1960
|
-
|
|
1961
|
-
/**
|
|
1962
|
-
* The type of calculation made to determine when the discount ends.
|
|
1963
|
-
*/
|
|
1964
|
-
type: DiscountEnd.Type;
|
|
1965
|
-
}
|
|
1966
|
-
|
|
1967
|
-
namespace DiscountEnd {
|
|
1968
|
-
interface Duration {
|
|
1969
|
-
/**
|
|
1970
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1971
|
-
*/
|
|
1972
|
-
interval: Duration.Interval;
|
|
1973
|
-
|
|
1974
|
-
/**
|
|
1975
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1976
|
-
*/
|
|
1977
|
-
interval_count: number;
|
|
1978
|
-
}
|
|
1979
|
-
|
|
1980
|
-
namespace Duration {
|
|
1981
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
1982
|
-
}
|
|
1983
|
-
|
|
1984
|
-
type Type = 'duration' | 'timestamp';
|
|
1985
|
-
}
|
|
1986
|
-
}
|
|
1987
|
-
|
|
1988
1715
|
interface Period {
|
|
1989
1716
|
/**
|
|
1990
1717
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -2014,7 +1741,7 @@ declare module 'stripe' {
|
|
|
2014
1741
|
product_data?: PriceData.ProductData;
|
|
2015
1742
|
|
|
2016
1743
|
/**
|
|
2017
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
1744
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
2018
1745
|
*/
|
|
2019
1746
|
tax_behavior?: PriceData.TaxBehavior;
|
|
2020
1747
|
|
|
@@ -2042,7 +1769,7 @@ declare module 'stripe' {
|
|
|
2042
1769
|
images?: Array<string>;
|
|
2043
1770
|
|
|
2044
1771
|
/**
|
|
2045
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1772
|
+
* 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`.
|
|
2046
1773
|
*/
|
|
2047
1774
|
metadata?: Stripe.MetadataParam;
|
|
2048
1775
|
|
|
@@ -2052,7 +1779,7 @@ declare module 'stripe' {
|
|
|
2052
1779
|
name: string;
|
|
2053
1780
|
|
|
2054
1781
|
/**
|
|
2055
|
-
* A [tax code](https://stripe.com/
|
|
1782
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2056
1783
|
*/
|
|
2057
1784
|
tax_code?: string;
|
|
2058
1785
|
|
|
@@ -2191,11 +1918,6 @@ declare module 'stripe' {
|
|
|
2191
1918
|
}
|
|
2192
1919
|
|
|
2193
1920
|
interface InvoiceAttachPaymentParams {
|
|
2194
|
-
/**
|
|
2195
|
-
* The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
|
2196
|
-
*/
|
|
2197
|
-
amount_requested?: number;
|
|
2198
|
-
|
|
2199
1921
|
/**
|
|
2200
1922
|
* Specifies which fields in the response should be expanded.
|
|
2201
1923
|
*/
|
|
@@ -2210,45 +1932,6 @@ declare module 'stripe' {
|
|
|
2210
1932
|
* The ID of the PaymentRecord to attach to the invoice.
|
|
2211
1933
|
*/
|
|
2212
1934
|
payment_record?: string;
|
|
2213
|
-
|
|
2214
|
-
/**
|
|
2215
|
-
* The PaymentRecord data for attaching an out of band payment to the invoice.
|
|
2216
|
-
*/
|
|
2217
|
-
payment_record_data?: InvoiceAttachPaymentParams.PaymentRecordData;
|
|
2218
|
-
}
|
|
2219
|
-
|
|
2220
|
-
namespace InvoiceAttachPaymentParams {
|
|
2221
|
-
interface PaymentRecordData {
|
|
2222
|
-
/**
|
|
2223
|
-
* The amount that was paid out of band.
|
|
2224
|
-
*/
|
|
2225
|
-
amount: number;
|
|
2226
|
-
|
|
2227
|
-
/**
|
|
2228
|
-
* The currency that was paid out of band.
|
|
2229
|
-
*/
|
|
2230
|
-
currency: string;
|
|
2231
|
-
|
|
2232
|
-
/**
|
|
2233
|
-
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
2234
|
-
*/
|
|
2235
|
-
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2236
|
-
|
|
2237
|
-
/**
|
|
2238
|
-
* The type of money movement for this out of band payment record.
|
|
2239
|
-
*/
|
|
2240
|
-
money_movement_type: string;
|
|
2241
|
-
|
|
2242
|
-
/**
|
|
2243
|
-
* The timestamp when this out of band payment was paid.
|
|
2244
|
-
*/
|
|
2245
|
-
paid_at?: number;
|
|
2246
|
-
|
|
2247
|
-
/**
|
|
2248
|
-
* The reference for this out of band payment record.
|
|
2249
|
-
*/
|
|
2250
|
-
payment_reference?: string;
|
|
2251
|
-
}
|
|
2252
1935
|
}
|
|
2253
1936
|
|
|
2254
1937
|
interface InvoiceCreatePreviewParams {
|
|
@@ -2257,23 +1940,18 @@ declare module 'stripe' {
|
|
|
2257
1940
|
*/
|
|
2258
1941
|
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
|
|
2259
1942
|
|
|
2260
|
-
/**
|
|
2261
|
-
* The identifier of the billing cadence for which you'd like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
|
|
2262
|
-
*/
|
|
2263
|
-
billing_cadence?: string;
|
|
2264
|
-
|
|
2265
1943
|
/**
|
|
2266
1944
|
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
|
2267
1945
|
*/
|
|
2268
1946
|
currency?: string;
|
|
2269
1947
|
|
|
2270
1948
|
/**
|
|
2271
|
-
* The identifier of the customer whose upcoming invoice you'
|
|
1949
|
+
* The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
2272
1950
|
*/
|
|
2273
1951
|
customer?: string;
|
|
2274
1952
|
|
|
2275
1953
|
/**
|
|
2276
|
-
* The identifier of the account whose upcoming invoice you'
|
|
1954
|
+
* The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
2277
1955
|
*/
|
|
2278
1956
|
customer_account?: string;
|
|
2279
1957
|
|
|
@@ -2303,7 +1981,7 @@ declare module 'stripe' {
|
|
|
2303
1981
|
issuer?: InvoiceCreatePreviewParams.Issuer;
|
|
2304
1982
|
|
|
2305
1983
|
/**
|
|
2306
|
-
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/
|
|
1984
|
+
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
2307
1985
|
*/
|
|
2308
1986
|
on_behalf_of?: Stripe.Emptyable<string>;
|
|
2309
1987
|
|
|
@@ -2336,7 +2014,7 @@ declare module 'stripe' {
|
|
|
2336
2014
|
namespace InvoiceCreatePreviewParams {
|
|
2337
2015
|
interface AutomaticTax {
|
|
2338
2016
|
/**
|
|
2339
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
2017
|
+
* 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.
|
|
2340
2018
|
*/
|
|
2341
2019
|
enabled: boolean;
|
|
2342
2020
|
|
|
@@ -2366,7 +2044,7 @@ declare module 'stripe' {
|
|
|
2366
2044
|
|
|
2367
2045
|
interface CustomerDetails {
|
|
2368
2046
|
/**
|
|
2369
|
-
* The customer's address.
|
|
2047
|
+
* The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).
|
|
2370
2048
|
*/
|
|
2371
2049
|
address?: Stripe.Emptyable<Stripe.AddressParam>;
|
|
2372
2050
|
|
|
@@ -2556,56 +2234,12 @@ declare module 'stripe' {
|
|
|
2556
2234
|
*/
|
|
2557
2235
|
discount?: string;
|
|
2558
2236
|
|
|
2559
|
-
/**
|
|
2560
|
-
* Details to determine how long the discount should be applied for.
|
|
2561
|
-
*/
|
|
2562
|
-
discount_end?: Discount.DiscountEnd;
|
|
2563
|
-
|
|
2564
2237
|
/**
|
|
2565
2238
|
* ID of the promotion code to create a new discount for.
|
|
2566
2239
|
*/
|
|
2567
2240
|
promotion_code?: string;
|
|
2568
2241
|
}
|
|
2569
2242
|
|
|
2570
|
-
namespace Discount {
|
|
2571
|
-
interface DiscountEnd {
|
|
2572
|
-
/**
|
|
2573
|
-
* Time span for the redeemed discount.
|
|
2574
|
-
*/
|
|
2575
|
-
duration?: DiscountEnd.Duration;
|
|
2576
|
-
|
|
2577
|
-
/**
|
|
2578
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2579
|
-
*/
|
|
2580
|
-
timestamp?: number;
|
|
2581
|
-
|
|
2582
|
-
/**
|
|
2583
|
-
* The type of calculation made to determine when the discount ends.
|
|
2584
|
-
*/
|
|
2585
|
-
type: DiscountEnd.Type;
|
|
2586
|
-
}
|
|
2587
|
-
|
|
2588
|
-
namespace DiscountEnd {
|
|
2589
|
-
interface Duration {
|
|
2590
|
-
/**
|
|
2591
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2592
|
-
*/
|
|
2593
|
-
interval: Duration.Interval;
|
|
2594
|
-
|
|
2595
|
-
/**
|
|
2596
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2597
|
-
*/
|
|
2598
|
-
interval_count: number;
|
|
2599
|
-
}
|
|
2600
|
-
|
|
2601
|
-
namespace Duration {
|
|
2602
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2603
|
-
}
|
|
2604
|
-
|
|
2605
|
-
type Type = 'duration' | 'timestamp';
|
|
2606
|
-
}
|
|
2607
|
-
}
|
|
2608
|
-
|
|
2609
2243
|
interface InvoiceItem {
|
|
2610
2244
|
/**
|
|
2611
2245
|
* The integer amount in cents (or local equivalent) of previewed invoice item.
|
|
@@ -2638,12 +2272,12 @@ declare module 'stripe' {
|
|
|
2638
2272
|
invoiceitem?: string;
|
|
2639
2273
|
|
|
2640
2274
|
/**
|
|
2641
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2275
|
+
* 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`.
|
|
2642
2276
|
*/
|
|
2643
2277
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2644
2278
|
|
|
2645
2279
|
/**
|
|
2646
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
2280
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
2647
2281
|
*/
|
|
2648
2282
|
period?: InvoiceItem.Period;
|
|
2649
2283
|
|
|
@@ -2653,7 +2287,7 @@ declare module 'stripe' {
|
|
|
2653
2287
|
price?: string;
|
|
2654
2288
|
|
|
2655
2289
|
/**
|
|
2656
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
2290
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
2657
2291
|
*/
|
|
2658
2292
|
price_data?: InvoiceItem.PriceData;
|
|
2659
2293
|
|
|
@@ -2663,12 +2297,12 @@ declare module 'stripe' {
|
|
|
2663
2297
|
quantity?: number;
|
|
2664
2298
|
|
|
2665
2299
|
/**
|
|
2666
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2300
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
2667
2301
|
*/
|
|
2668
2302
|
tax_behavior?: InvoiceItem.TaxBehavior;
|
|
2669
2303
|
|
|
2670
2304
|
/**
|
|
2671
|
-
* A [tax code](https://stripe.com/
|
|
2305
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2672
2306
|
*/
|
|
2673
2307
|
tax_code?: Stripe.Emptyable<string>;
|
|
2674
2308
|
|
|
@@ -2700,56 +2334,12 @@ declare module 'stripe' {
|
|
|
2700
2334
|
*/
|
|
2701
2335
|
discount?: string;
|
|
2702
2336
|
|
|
2703
|
-
/**
|
|
2704
|
-
* Details to determine how long the discount should be applied for.
|
|
2705
|
-
*/
|
|
2706
|
-
discount_end?: Discount.DiscountEnd;
|
|
2707
|
-
|
|
2708
2337
|
/**
|
|
2709
2338
|
* ID of the promotion code to create a new discount for.
|
|
2710
2339
|
*/
|
|
2711
2340
|
promotion_code?: string;
|
|
2712
2341
|
}
|
|
2713
2342
|
|
|
2714
|
-
namespace Discount {
|
|
2715
|
-
interface DiscountEnd {
|
|
2716
|
-
/**
|
|
2717
|
-
* Time span for the redeemed discount.
|
|
2718
|
-
*/
|
|
2719
|
-
duration?: DiscountEnd.Duration;
|
|
2720
|
-
|
|
2721
|
-
/**
|
|
2722
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
2723
|
-
*/
|
|
2724
|
-
timestamp?: number;
|
|
2725
|
-
|
|
2726
|
-
/**
|
|
2727
|
-
* The type of calculation made to determine when the discount ends.
|
|
2728
|
-
*/
|
|
2729
|
-
type: DiscountEnd.Type;
|
|
2730
|
-
}
|
|
2731
|
-
|
|
2732
|
-
namespace DiscountEnd {
|
|
2733
|
-
interface Duration {
|
|
2734
|
-
/**
|
|
2735
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2736
|
-
*/
|
|
2737
|
-
interval: Duration.Interval;
|
|
2738
|
-
|
|
2739
|
-
/**
|
|
2740
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2741
|
-
*/
|
|
2742
|
-
interval_count: number;
|
|
2743
|
-
}
|
|
2744
|
-
|
|
2745
|
-
namespace Duration {
|
|
2746
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2747
|
-
}
|
|
2748
|
-
|
|
2749
|
-
type Type = 'duration' | 'timestamp';
|
|
2750
|
-
}
|
|
2751
|
-
}
|
|
2752
|
-
|
|
2753
2343
|
interface Period {
|
|
2754
2344
|
/**
|
|
2755
2345
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -2774,7 +2364,7 @@ declare module 'stripe' {
|
|
|
2774
2364
|
product: string;
|
|
2775
2365
|
|
|
2776
2366
|
/**
|
|
2777
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2367
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
2778
2368
|
*/
|
|
2779
2369
|
tax_behavior?: PriceData.TaxBehavior;
|
|
2780
2370
|
|
|
@@ -2815,16 +2405,6 @@ declare module 'stripe' {
|
|
|
2815
2405
|
type PreviewMode = 'next' | 'recurring';
|
|
2816
2406
|
|
|
2817
2407
|
interface ScheduleDetails {
|
|
2818
|
-
/**
|
|
2819
|
-
* Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
2820
|
-
*/
|
|
2821
|
-
amendments?: Array<ScheduleDetails.Amendment>;
|
|
2822
|
-
|
|
2823
|
-
/**
|
|
2824
|
-
* 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.
|
|
2825
|
-
*/
|
|
2826
|
-
billing_behavior?: ScheduleDetails.BillingBehavior;
|
|
2827
|
-
|
|
2828
2408
|
/**
|
|
2829
2409
|
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
2830
2410
|
*/
|
|
@@ -2840,11 +2420,6 @@ declare module 'stripe' {
|
|
|
2840
2420
|
*/
|
|
2841
2421
|
phases?: Array<ScheduleDetails.Phase>;
|
|
2842
2422
|
|
|
2843
|
-
/**
|
|
2844
|
-
* Provide any time periods to bill in advance.
|
|
2845
|
-
*/
|
|
2846
|
-
prebilling?: Stripe.Emptyable<Array<ScheduleDetails.Prebilling>>;
|
|
2847
|
-
|
|
2848
2423
|
/**
|
|
2849
2424
|
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
2850
2425
|
*/
|
|
@@ -2852,603 +2427,6 @@ declare module 'stripe' {
|
|
|
2852
2427
|
}
|
|
2853
2428
|
|
|
2854
2429
|
namespace ScheduleDetails {
|
|
2855
|
-
interface Amendment {
|
|
2856
|
-
/**
|
|
2857
|
-
* Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
|
2858
|
-
*/
|
|
2859
|
-
amendment_end?: Amendment.AmendmentEnd;
|
|
2860
|
-
|
|
2861
|
-
/**
|
|
2862
|
-
* Details to identify the earliest timestamp where the proposed change should take effect.
|
|
2863
|
-
*/
|
|
2864
|
-
amendment_start: Amendment.AmendmentStart;
|
|
2865
|
-
|
|
2866
|
-
/**
|
|
2867
|
-
* For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
|
2868
|
-
*/
|
|
2869
|
-
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2870
|
-
|
|
2871
|
-
/**
|
|
2872
|
-
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2873
|
-
*/
|
|
2874
|
-
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2875
|
-
|
|
2876
|
-
/**
|
|
2877
|
-
* Changes to the subscription items during the amendment time span.
|
|
2878
|
-
*/
|
|
2879
|
-
item_actions?: Array<Amendment.ItemAction>;
|
|
2880
|
-
|
|
2881
|
-
/**
|
|
2882
|
-
* Instructions for how to modify phase metadata
|
|
2883
|
-
*/
|
|
2884
|
-
metadata_actions?: Array<Amendment.MetadataAction>;
|
|
2885
|
-
|
|
2886
|
-
/**
|
|
2887
|
-
* 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`.
|
|
2888
|
-
*/
|
|
2889
|
-
proration_behavior?: Amendment.ProrationBehavior;
|
|
2890
|
-
|
|
2891
|
-
/**
|
|
2892
|
-
* Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
2893
|
-
*/
|
|
2894
|
-
set_pause_collection?: Amendment.SetPauseCollection;
|
|
2895
|
-
|
|
2896
|
-
/**
|
|
2897
|
-
* Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
2898
|
-
*/
|
|
2899
|
-
set_schedule_end?: Amendment.SetScheduleEnd;
|
|
2900
|
-
|
|
2901
|
-
/**
|
|
2902
|
-
* Settings related to subscription trials.
|
|
2903
|
-
*/
|
|
2904
|
-
trial_settings?: Amendment.TrialSettings;
|
|
2905
|
-
}
|
|
2906
|
-
|
|
2907
|
-
namespace Amendment {
|
|
2908
|
-
interface AmendmentEnd {
|
|
2909
|
-
/**
|
|
2910
|
-
* Use the `end` time of a given discount.
|
|
2911
|
-
*/
|
|
2912
|
-
discount_end?: AmendmentEnd.DiscountEnd;
|
|
2913
|
-
|
|
2914
|
-
/**
|
|
2915
|
-
* Time span for the amendment starting from the `amendment_start`.
|
|
2916
|
-
*/
|
|
2917
|
-
duration?: AmendmentEnd.Duration;
|
|
2918
|
-
|
|
2919
|
-
/**
|
|
2920
|
-
* A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
2921
|
-
*/
|
|
2922
|
-
timestamp?: number;
|
|
2923
|
-
|
|
2924
|
-
/**
|
|
2925
|
-
* Select one of three ways to pass the `amendment_end`.
|
|
2926
|
-
*/
|
|
2927
|
-
type: AmendmentEnd.Type;
|
|
2928
|
-
}
|
|
2929
|
-
|
|
2930
|
-
namespace AmendmentEnd {
|
|
2931
|
-
interface DiscountEnd {
|
|
2932
|
-
/**
|
|
2933
|
-
* The ID of a specific discount.
|
|
2934
|
-
*/
|
|
2935
|
-
discount: string;
|
|
2936
|
-
}
|
|
2937
|
-
|
|
2938
|
-
interface Duration {
|
|
2939
|
-
/**
|
|
2940
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
2941
|
-
*/
|
|
2942
|
-
interval: Duration.Interval;
|
|
2943
|
-
|
|
2944
|
-
/**
|
|
2945
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
2946
|
-
*/
|
|
2947
|
-
interval_count: number;
|
|
2948
|
-
}
|
|
2949
|
-
|
|
2950
|
-
namespace Duration {
|
|
2951
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
2952
|
-
}
|
|
2953
|
-
|
|
2954
|
-
type Type =
|
|
2955
|
-
| 'discount_end'
|
|
2956
|
-
| 'duration'
|
|
2957
|
-
| 'schedule_end'
|
|
2958
|
-
| 'timestamp'
|
|
2959
|
-
| 'trial_end'
|
|
2960
|
-
| 'trial_start'
|
|
2961
|
-
| 'upcoming_invoice';
|
|
2962
|
-
}
|
|
2963
|
-
|
|
2964
|
-
interface AmendmentStart {
|
|
2965
|
-
/**
|
|
2966
|
-
* Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
2967
|
-
*/
|
|
2968
|
-
amendment_end?: AmendmentStart.AmendmentEnd;
|
|
2969
|
-
|
|
2970
|
-
/**
|
|
2971
|
-
* Use the `end` time of a given discount.
|
|
2972
|
-
*/
|
|
2973
|
-
discount_end?: AmendmentStart.DiscountEnd;
|
|
2974
|
-
|
|
2975
|
-
/**
|
|
2976
|
-
* A precise Unix timestamp for the amendment to start.
|
|
2977
|
-
*/
|
|
2978
|
-
timestamp?: number;
|
|
2979
|
-
|
|
2980
|
-
/**
|
|
2981
|
-
* Select one of three ways to pass the `amendment_start`.
|
|
2982
|
-
*/
|
|
2983
|
-
type: AmendmentStart.Type;
|
|
2984
|
-
}
|
|
2985
|
-
|
|
2986
|
-
namespace AmendmentStart {
|
|
2987
|
-
interface AmendmentEnd {
|
|
2988
|
-
/**
|
|
2989
|
-
* 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.
|
|
2990
|
-
*/
|
|
2991
|
-
index: number;
|
|
2992
|
-
}
|
|
2993
|
-
|
|
2994
|
-
interface DiscountEnd {
|
|
2995
|
-
/**
|
|
2996
|
-
* The ID of a specific discount.
|
|
2997
|
-
*/
|
|
2998
|
-
discount: string;
|
|
2999
|
-
}
|
|
3000
|
-
|
|
3001
|
-
type Type =
|
|
3002
|
-
| 'amendment_end'
|
|
3003
|
-
| 'discount_end'
|
|
3004
|
-
| 'now'
|
|
3005
|
-
| 'schedule_end'
|
|
3006
|
-
| 'timestamp'
|
|
3007
|
-
| 'trial_end'
|
|
3008
|
-
| 'trial_start'
|
|
3009
|
-
| 'upcoming_invoice';
|
|
3010
|
-
}
|
|
3011
|
-
|
|
3012
|
-
type BillingCycleAnchor = 'amendment_start' | 'automatic';
|
|
3013
|
-
|
|
3014
|
-
interface DiscountAction {
|
|
3015
|
-
/**
|
|
3016
|
-
* Details of the discount to add.
|
|
3017
|
-
*/
|
|
3018
|
-
add?: DiscountAction.Add;
|
|
3019
|
-
|
|
3020
|
-
/**
|
|
3021
|
-
* Details of the discount to remove.
|
|
3022
|
-
*/
|
|
3023
|
-
remove?: DiscountAction.Remove;
|
|
3024
|
-
|
|
3025
|
-
/**
|
|
3026
|
-
* Details of the discount to replace the existing discounts with.
|
|
3027
|
-
*/
|
|
3028
|
-
set?: DiscountAction.Set;
|
|
3029
|
-
|
|
3030
|
-
/**
|
|
3031
|
-
* Determines the type of discount action.
|
|
3032
|
-
*/
|
|
3033
|
-
type: DiscountAction.Type;
|
|
3034
|
-
}
|
|
3035
|
-
|
|
3036
|
-
namespace DiscountAction {
|
|
3037
|
-
interface Add {
|
|
3038
|
-
/**
|
|
3039
|
-
* The coupon code to redeem.
|
|
3040
|
-
*/
|
|
3041
|
-
coupon?: string;
|
|
3042
|
-
|
|
3043
|
-
/**
|
|
3044
|
-
* An ID of an existing discount for a coupon that was already redeemed.
|
|
3045
|
-
*/
|
|
3046
|
-
discount?: string;
|
|
3047
|
-
|
|
3048
|
-
/**
|
|
3049
|
-
* Details to determine how long the discount should be applied for.
|
|
3050
|
-
*/
|
|
3051
|
-
discount_end?: Add.DiscountEnd;
|
|
3052
|
-
|
|
3053
|
-
/**
|
|
3054
|
-
* 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.
|
|
3055
|
-
*/
|
|
3056
|
-
index?: number;
|
|
3057
|
-
|
|
3058
|
-
/**
|
|
3059
|
-
* The promotion code to redeem.
|
|
3060
|
-
*/
|
|
3061
|
-
promotion_code?: string;
|
|
3062
|
-
}
|
|
3063
|
-
|
|
3064
|
-
namespace Add {
|
|
3065
|
-
interface DiscountEnd {
|
|
3066
|
-
/**
|
|
3067
|
-
* The type of calculation made to determine when the discount ends.
|
|
3068
|
-
*/
|
|
3069
|
-
type: 'amendment_end';
|
|
3070
|
-
}
|
|
3071
|
-
}
|
|
3072
|
-
|
|
3073
|
-
interface Remove {
|
|
3074
|
-
/**
|
|
3075
|
-
* The coupon code to remove from the `discounts` array.
|
|
3076
|
-
*/
|
|
3077
|
-
coupon?: string;
|
|
3078
|
-
|
|
3079
|
-
/**
|
|
3080
|
-
* The ID of a discount to remove from the `discounts` array.
|
|
3081
|
-
*/
|
|
3082
|
-
discount?: string;
|
|
3083
|
-
|
|
3084
|
-
/**
|
|
3085
|
-
* The ID of a promotion code to remove from the `discounts` array.
|
|
3086
|
-
*/
|
|
3087
|
-
promotion_code?: string;
|
|
3088
|
-
}
|
|
3089
|
-
|
|
3090
|
-
interface Set {
|
|
3091
|
-
/**
|
|
3092
|
-
* The coupon code to replace the `discounts` array with.
|
|
3093
|
-
*/
|
|
3094
|
-
coupon?: string;
|
|
3095
|
-
|
|
3096
|
-
/**
|
|
3097
|
-
* An ID of an existing discount to replace the `discounts` array with.
|
|
3098
|
-
*/
|
|
3099
|
-
discount?: string;
|
|
3100
|
-
|
|
3101
|
-
/**
|
|
3102
|
-
* An ID of an existing promotion code to replace the `discounts` array with.
|
|
3103
|
-
*/
|
|
3104
|
-
promotion_code?: string;
|
|
3105
|
-
}
|
|
3106
|
-
|
|
3107
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3108
|
-
}
|
|
3109
|
-
|
|
3110
|
-
interface ItemAction {
|
|
3111
|
-
/**
|
|
3112
|
-
* 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.
|
|
3113
|
-
*/
|
|
3114
|
-
add?: ItemAction.Add;
|
|
3115
|
-
|
|
3116
|
-
/**
|
|
3117
|
-
* Details of the subscription item to remove.
|
|
3118
|
-
*/
|
|
3119
|
-
remove?: ItemAction.Remove;
|
|
3120
|
-
|
|
3121
|
-
/**
|
|
3122
|
-
* 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.
|
|
3123
|
-
*/
|
|
3124
|
-
set?: ItemAction.Set;
|
|
3125
|
-
|
|
3126
|
-
/**
|
|
3127
|
-
* Determines the type of item action.
|
|
3128
|
-
*/
|
|
3129
|
-
type: ItemAction.Type;
|
|
3130
|
-
}
|
|
3131
|
-
|
|
3132
|
-
namespace ItemAction {
|
|
3133
|
-
interface Add {
|
|
3134
|
-
/**
|
|
3135
|
-
* The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
3136
|
-
*/
|
|
3137
|
-
discounts?: Array<Add.Discount>;
|
|
3138
|
-
|
|
3139
|
-
/**
|
|
3140
|
-
* Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
3141
|
-
*/
|
|
3142
|
-
metadata?: Stripe.MetadataParam;
|
|
3143
|
-
|
|
3144
|
-
/**
|
|
3145
|
-
* The ID of the price object.
|
|
3146
|
-
*/
|
|
3147
|
-
price: string;
|
|
3148
|
-
|
|
3149
|
-
/**
|
|
3150
|
-
* Quantity for this item.
|
|
3151
|
-
*/
|
|
3152
|
-
quantity?: number;
|
|
3153
|
-
|
|
3154
|
-
/**
|
|
3155
|
-
* 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`.
|
|
3156
|
-
*/
|
|
3157
|
-
tax_rates?: Array<string>;
|
|
3158
|
-
|
|
3159
|
-
/**
|
|
3160
|
-
* Options that configure the trial on the subscription item.
|
|
3161
|
-
*/
|
|
3162
|
-
trial?: Add.Trial;
|
|
3163
|
-
}
|
|
3164
|
-
|
|
3165
|
-
namespace Add {
|
|
3166
|
-
interface Discount {
|
|
3167
|
-
/**
|
|
3168
|
-
* ID of the coupon to create a new discount for.
|
|
3169
|
-
*/
|
|
3170
|
-
coupon?: string;
|
|
3171
|
-
|
|
3172
|
-
/**
|
|
3173
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3174
|
-
*/
|
|
3175
|
-
discount?: string;
|
|
3176
|
-
|
|
3177
|
-
/**
|
|
3178
|
-
* Details to determine how long the discount should be applied for.
|
|
3179
|
-
*/
|
|
3180
|
-
discount_end?: Discount.DiscountEnd;
|
|
3181
|
-
|
|
3182
|
-
/**
|
|
3183
|
-
* ID of the promotion code to create a new discount for.
|
|
3184
|
-
*/
|
|
3185
|
-
promotion_code?: string;
|
|
3186
|
-
}
|
|
3187
|
-
|
|
3188
|
-
namespace Discount {
|
|
3189
|
-
interface DiscountEnd {
|
|
3190
|
-
/**
|
|
3191
|
-
* Time span for the redeemed discount.
|
|
3192
|
-
*/
|
|
3193
|
-
duration?: DiscountEnd.Duration;
|
|
3194
|
-
|
|
3195
|
-
/**
|
|
3196
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3197
|
-
*/
|
|
3198
|
-
timestamp?: number;
|
|
3199
|
-
|
|
3200
|
-
/**
|
|
3201
|
-
* The type of calculation made to determine when the discount ends.
|
|
3202
|
-
*/
|
|
3203
|
-
type: DiscountEnd.Type;
|
|
3204
|
-
}
|
|
3205
|
-
|
|
3206
|
-
namespace DiscountEnd {
|
|
3207
|
-
interface Duration {
|
|
3208
|
-
/**
|
|
3209
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3210
|
-
*/
|
|
3211
|
-
interval: Duration.Interval;
|
|
3212
|
-
|
|
3213
|
-
/**
|
|
3214
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3215
|
-
*/
|
|
3216
|
-
interval_count: number;
|
|
3217
|
-
}
|
|
3218
|
-
|
|
3219
|
-
namespace Duration {
|
|
3220
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3221
|
-
}
|
|
3222
|
-
|
|
3223
|
-
type Type = 'duration' | 'timestamp';
|
|
3224
|
-
}
|
|
3225
|
-
}
|
|
3226
|
-
|
|
3227
|
-
interface Trial {
|
|
3228
|
-
/**
|
|
3229
|
-
* 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.
|
|
3230
|
-
*/
|
|
3231
|
-
converts_to?: Array<string>;
|
|
3232
|
-
|
|
3233
|
-
/**
|
|
3234
|
-
* Determines the type of trial for this item.
|
|
3235
|
-
*/
|
|
3236
|
-
type: Trial.Type;
|
|
3237
|
-
}
|
|
3238
|
-
|
|
3239
|
-
namespace Trial {
|
|
3240
|
-
type Type = 'free' | 'paid';
|
|
3241
|
-
}
|
|
3242
|
-
}
|
|
3243
|
-
|
|
3244
|
-
interface Remove {
|
|
3245
|
-
/**
|
|
3246
|
-
* ID of a price to remove.
|
|
3247
|
-
*/
|
|
3248
|
-
price: string;
|
|
3249
|
-
}
|
|
3250
|
-
|
|
3251
|
-
interface Set {
|
|
3252
|
-
/**
|
|
3253
|
-
* 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`.
|
|
3254
|
-
*/
|
|
3255
|
-
discounts?: Array<Set.Discount>;
|
|
3256
|
-
|
|
3257
|
-
/**
|
|
3258
|
-
* 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`.
|
|
3259
|
-
*/
|
|
3260
|
-
metadata?: Stripe.MetadataParam;
|
|
3261
|
-
|
|
3262
|
-
/**
|
|
3263
|
-
* The ID of the price object.
|
|
3264
|
-
*/
|
|
3265
|
-
price: string;
|
|
3266
|
-
|
|
3267
|
-
/**
|
|
3268
|
-
* 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`.
|
|
3269
|
-
*/
|
|
3270
|
-
quantity?: number;
|
|
3271
|
-
|
|
3272
|
-
/**
|
|
3273
|
-
* 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`.
|
|
3274
|
-
*/
|
|
3275
|
-
tax_rates?: Array<string>;
|
|
3276
|
-
|
|
3277
|
-
/**
|
|
3278
|
-
* 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`.
|
|
3279
|
-
*/
|
|
3280
|
-
trial?: Set.Trial;
|
|
3281
|
-
}
|
|
3282
|
-
|
|
3283
|
-
namespace Set {
|
|
3284
|
-
interface Discount {
|
|
3285
|
-
/**
|
|
3286
|
-
* ID of the coupon to create a new discount for.
|
|
3287
|
-
*/
|
|
3288
|
-
coupon?: string;
|
|
3289
|
-
|
|
3290
|
-
/**
|
|
3291
|
-
* ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
3292
|
-
*/
|
|
3293
|
-
discount?: string;
|
|
3294
|
-
|
|
3295
|
-
/**
|
|
3296
|
-
* Details to determine how long the discount should be applied for.
|
|
3297
|
-
*/
|
|
3298
|
-
discount_end?: Discount.DiscountEnd;
|
|
3299
|
-
|
|
3300
|
-
/**
|
|
3301
|
-
* ID of the promotion code to create a new discount for.
|
|
3302
|
-
*/
|
|
3303
|
-
promotion_code?: string;
|
|
3304
|
-
}
|
|
3305
|
-
|
|
3306
|
-
namespace Discount {
|
|
3307
|
-
interface DiscountEnd {
|
|
3308
|
-
/**
|
|
3309
|
-
* Time span for the redeemed discount.
|
|
3310
|
-
*/
|
|
3311
|
-
duration?: DiscountEnd.Duration;
|
|
3312
|
-
|
|
3313
|
-
/**
|
|
3314
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3315
|
-
*/
|
|
3316
|
-
timestamp?: number;
|
|
3317
|
-
|
|
3318
|
-
/**
|
|
3319
|
-
* The type of calculation made to determine when the discount ends.
|
|
3320
|
-
*/
|
|
3321
|
-
type: DiscountEnd.Type;
|
|
3322
|
-
}
|
|
3323
|
-
|
|
3324
|
-
namespace DiscountEnd {
|
|
3325
|
-
interface Duration {
|
|
3326
|
-
/**
|
|
3327
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3328
|
-
*/
|
|
3329
|
-
interval: Duration.Interval;
|
|
3330
|
-
|
|
3331
|
-
/**
|
|
3332
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3333
|
-
*/
|
|
3334
|
-
interval_count: number;
|
|
3335
|
-
}
|
|
3336
|
-
|
|
3337
|
-
namespace Duration {
|
|
3338
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3339
|
-
}
|
|
3340
|
-
|
|
3341
|
-
type Type = 'duration' | 'timestamp';
|
|
3342
|
-
}
|
|
3343
|
-
}
|
|
3344
|
-
|
|
3345
|
-
interface Trial {
|
|
3346
|
-
/**
|
|
3347
|
-
* 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.
|
|
3348
|
-
*/
|
|
3349
|
-
converts_to?: Array<string>;
|
|
3350
|
-
|
|
3351
|
-
/**
|
|
3352
|
-
* Determines the type of trial for this item.
|
|
3353
|
-
*/
|
|
3354
|
-
type: Trial.Type;
|
|
3355
|
-
}
|
|
3356
|
-
|
|
3357
|
-
namespace Trial {
|
|
3358
|
-
type Type = 'free' | 'paid';
|
|
3359
|
-
}
|
|
3360
|
-
}
|
|
3361
|
-
|
|
3362
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3363
|
-
}
|
|
3364
|
-
|
|
3365
|
-
interface MetadataAction {
|
|
3366
|
-
/**
|
|
3367
|
-
* Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
3368
|
-
*/
|
|
3369
|
-
add?: {
|
|
3370
|
-
[key: string]: string;
|
|
3371
|
-
};
|
|
3372
|
-
|
|
3373
|
-
/**
|
|
3374
|
-
* Keys to remove from schedule phase metadata.
|
|
3375
|
-
*/
|
|
3376
|
-
remove?: Array<string>;
|
|
3377
|
-
|
|
3378
|
-
/**
|
|
3379
|
-
* Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
3380
|
-
*/
|
|
3381
|
-
set?: Stripe.Emptyable<{
|
|
3382
|
-
[key: string]: string;
|
|
3383
|
-
}>;
|
|
3384
|
-
|
|
3385
|
-
/**
|
|
3386
|
-
* Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
3387
|
-
*/
|
|
3388
|
-
type: MetadataAction.Type;
|
|
3389
|
-
}
|
|
3390
|
-
|
|
3391
|
-
namespace MetadataAction {
|
|
3392
|
-
type Type = 'add' | 'remove' | 'set';
|
|
3393
|
-
}
|
|
3394
|
-
|
|
3395
|
-
type ProrationBehavior =
|
|
3396
|
-
| 'always_invoice'
|
|
3397
|
-
| 'create_prorations'
|
|
3398
|
-
| 'none';
|
|
3399
|
-
|
|
3400
|
-
interface SetPauseCollection {
|
|
3401
|
-
/**
|
|
3402
|
-
* Details of the pause_collection behavior to apply to the amendment.
|
|
3403
|
-
*/
|
|
3404
|
-
set?: SetPauseCollection.Set;
|
|
3405
|
-
|
|
3406
|
-
/**
|
|
3407
|
-
* Determines the type of the pause_collection amendment.
|
|
3408
|
-
*/
|
|
3409
|
-
type: SetPauseCollection.Type;
|
|
3410
|
-
}
|
|
3411
|
-
|
|
3412
|
-
namespace SetPauseCollection {
|
|
3413
|
-
interface Set {
|
|
3414
|
-
/**
|
|
3415
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
3416
|
-
*/
|
|
3417
|
-
behavior: Set.Behavior;
|
|
3418
|
-
}
|
|
3419
|
-
|
|
3420
|
-
namespace Set {
|
|
3421
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
3422
|
-
}
|
|
3423
|
-
|
|
3424
|
-
type Type = 'remove' | 'set';
|
|
3425
|
-
}
|
|
3426
|
-
|
|
3427
|
-
type SetScheduleEnd = 'amendment_end' | 'amendment_start';
|
|
3428
|
-
|
|
3429
|
-
interface TrialSettings {
|
|
3430
|
-
/**
|
|
3431
|
-
* Defines how the subscription should behave when a trial ends.
|
|
3432
|
-
*/
|
|
3433
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
3434
|
-
}
|
|
3435
|
-
|
|
3436
|
-
namespace TrialSettings {
|
|
3437
|
-
interface EndBehavior {
|
|
3438
|
-
/**
|
|
3439
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
3440
|
-
*/
|
|
3441
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
3442
|
-
}
|
|
3443
|
-
|
|
3444
|
-
namespace EndBehavior {
|
|
3445
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
3446
|
-
}
|
|
3447
|
-
}
|
|
3448
|
-
}
|
|
3449
|
-
|
|
3450
|
-
type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
|
|
3451
|
-
|
|
3452
2430
|
interface BillingMode {
|
|
3453
2431
|
/**
|
|
3454
2432
|
* Configure behavior for flexible billing mode.
|
|
@@ -3495,7 +2473,7 @@ declare module 'stripe' {
|
|
|
3495
2473
|
automatic_tax?: Phase.AutomaticTax;
|
|
3496
2474
|
|
|
3497
2475
|
/**
|
|
3498
|
-
* Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
2476
|
+
* Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
3499
2477
|
*/
|
|
3500
2478
|
billing_cycle_anchor?: Phase.BillingCycleAnchor;
|
|
3501
2479
|
|
|
@@ -3520,7 +2498,7 @@ declare module 'stripe' {
|
|
|
3520
2498
|
default_payment_method?: string;
|
|
3521
2499
|
|
|
3522
2500
|
/**
|
|
3523
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
2501
|
+
* A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
|
3524
2502
|
*/
|
|
3525
2503
|
default_tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
3526
2504
|
|
|
@@ -3540,7 +2518,7 @@ declare module 'stripe' {
|
|
|
3540
2518
|
duration?: Phase.Duration;
|
|
3541
2519
|
|
|
3542
2520
|
/**
|
|
3543
|
-
* The date at which this phase of the subscription schedule ends. If set, `
|
|
2521
|
+
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
3544
2522
|
*/
|
|
3545
2523
|
end_date?: number | 'now';
|
|
3546
2524
|
|
|
@@ -3555,7 +2533,7 @@ declare module 'stripe' {
|
|
|
3555
2533
|
items: Array<Phase.Item>;
|
|
3556
2534
|
|
|
3557
2535
|
/**
|
|
3558
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2536
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
|
3559
2537
|
*/
|
|
3560
2538
|
metadata?: Stripe.MetadataParam;
|
|
3561
2539
|
|
|
@@ -3565,12 +2543,7 @@ declare module 'stripe' {
|
|
|
3565
2543
|
on_behalf_of?: string;
|
|
3566
2544
|
|
|
3567
2545
|
/**
|
|
3568
|
-
*
|
|
3569
|
-
*/
|
|
3570
|
-
pause_collection?: Phase.PauseCollection;
|
|
3571
|
-
|
|
3572
|
-
/**
|
|
3573
|
-
* Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/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://stripe.com/docs/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.
|
|
2546
|
+
* 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.
|
|
3574
2547
|
*/
|
|
3575
2548
|
proration_behavior?: Phase.ProrationBehavior;
|
|
3576
2549
|
|
|
@@ -3589,20 +2562,10 @@ declare module 'stripe' {
|
|
|
3589
2562
|
*/
|
|
3590
2563
|
trial?: boolean;
|
|
3591
2564
|
|
|
3592
|
-
/**
|
|
3593
|
-
* Specify trial behavior when crossing phase boundaries
|
|
3594
|
-
*/
|
|
3595
|
-
trial_continuation?: Phase.TrialContinuation;
|
|
3596
|
-
|
|
3597
2565
|
/**
|
|
3598
2566
|
* 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`
|
|
3599
2567
|
*/
|
|
3600
2568
|
trial_end?: number | 'now';
|
|
3601
|
-
|
|
3602
|
-
/**
|
|
3603
|
-
* Settings related to subscription trials.
|
|
3604
|
-
*/
|
|
3605
|
-
trial_settings?: Phase.TrialSettings;
|
|
3606
2569
|
}
|
|
3607
2570
|
|
|
3608
2571
|
namespace Phase {
|
|
@@ -3613,7 +2576,7 @@ declare module 'stripe' {
|
|
|
3613
2576
|
discounts?: Array<AddInvoiceItem.Discount>;
|
|
3614
2577
|
|
|
3615
2578
|
/**
|
|
3616
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2579
|
+
* 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`.
|
|
3617
2580
|
*/
|
|
3618
2581
|
metadata?: Stripe.MetadataParam;
|
|
3619
2582
|
|
|
@@ -3628,7 +2591,7 @@ declare module 'stripe' {
|
|
|
3628
2591
|
price?: string;
|
|
3629
2592
|
|
|
3630
2593
|
/**
|
|
3631
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
2594
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
3632
2595
|
*/
|
|
3633
2596
|
price_data?: AddInvoiceItem.PriceData;
|
|
3634
2597
|
|
|
@@ -3655,54 +2618,10 @@ declare module 'stripe' {
|
|
|
3655
2618
|
*/
|
|
3656
2619
|
discount?: string;
|
|
3657
2620
|
|
|
3658
|
-
/**
|
|
3659
|
-
* Details to determine how long the discount should be applied for.
|
|
3660
|
-
*/
|
|
3661
|
-
discount_end?: Discount.DiscountEnd;
|
|
3662
|
-
|
|
3663
2621
|
/**
|
|
3664
2622
|
* ID of the promotion code to create a new discount for.
|
|
3665
|
-
*/
|
|
3666
|
-
promotion_code?: string;
|
|
3667
|
-
}
|
|
3668
|
-
|
|
3669
|
-
namespace Discount {
|
|
3670
|
-
interface DiscountEnd {
|
|
3671
|
-
/**
|
|
3672
|
-
* Time span for the redeemed discount.
|
|
3673
|
-
*/
|
|
3674
|
-
duration?: DiscountEnd.Duration;
|
|
3675
|
-
|
|
3676
|
-
/**
|
|
3677
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3678
|
-
*/
|
|
3679
|
-
timestamp?: number;
|
|
3680
|
-
|
|
3681
|
-
/**
|
|
3682
|
-
* The type of calculation made to determine when the discount ends.
|
|
3683
|
-
*/
|
|
3684
|
-
type: DiscountEnd.Type;
|
|
3685
|
-
}
|
|
3686
|
-
|
|
3687
|
-
namespace DiscountEnd {
|
|
3688
|
-
interface Duration {
|
|
3689
|
-
/**
|
|
3690
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3691
|
-
*/
|
|
3692
|
-
interval: Duration.Interval;
|
|
3693
|
-
|
|
3694
|
-
/**
|
|
3695
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3696
|
-
*/
|
|
3697
|
-
interval_count: number;
|
|
3698
|
-
}
|
|
3699
|
-
|
|
3700
|
-
namespace Duration {
|
|
3701
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3702
|
-
}
|
|
3703
|
-
|
|
3704
|
-
type Type = 'duration' | 'timestamp';
|
|
3705
|
-
}
|
|
2623
|
+
*/
|
|
2624
|
+
promotion_code?: string;
|
|
3706
2625
|
}
|
|
3707
2626
|
|
|
3708
2627
|
interface Period {
|
|
@@ -3766,7 +2685,7 @@ declare module 'stripe' {
|
|
|
3766
2685
|
product: string;
|
|
3767
2686
|
|
|
3768
2687
|
/**
|
|
3769
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2688
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
3770
2689
|
*/
|
|
3771
2690
|
tax_behavior?: PriceData.TaxBehavior;
|
|
3772
2691
|
|
|
@@ -3843,56 +2762,12 @@ declare module 'stripe' {
|
|
|
3843
2762
|
*/
|
|
3844
2763
|
discount?: string;
|
|
3845
2764
|
|
|
3846
|
-
/**
|
|
3847
|
-
* Details to determine how long the discount should be applied for.
|
|
3848
|
-
*/
|
|
3849
|
-
discount_end?: Discount.DiscountEnd;
|
|
3850
|
-
|
|
3851
2765
|
/**
|
|
3852
2766
|
* ID of the promotion code to create a new discount for.
|
|
3853
2767
|
*/
|
|
3854
2768
|
promotion_code?: string;
|
|
3855
2769
|
}
|
|
3856
2770
|
|
|
3857
|
-
namespace Discount {
|
|
3858
|
-
interface DiscountEnd {
|
|
3859
|
-
/**
|
|
3860
|
-
* Time span for the redeemed discount.
|
|
3861
|
-
*/
|
|
3862
|
-
duration?: DiscountEnd.Duration;
|
|
3863
|
-
|
|
3864
|
-
/**
|
|
3865
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
3866
|
-
*/
|
|
3867
|
-
timestamp?: number;
|
|
3868
|
-
|
|
3869
|
-
/**
|
|
3870
|
-
* The type of calculation made to determine when the discount ends.
|
|
3871
|
-
*/
|
|
3872
|
-
type: DiscountEnd.Type;
|
|
3873
|
-
}
|
|
3874
|
-
|
|
3875
|
-
namespace DiscountEnd {
|
|
3876
|
-
interface Duration {
|
|
3877
|
-
/**
|
|
3878
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
3879
|
-
*/
|
|
3880
|
-
interval: Duration.Interval;
|
|
3881
|
-
|
|
3882
|
-
/**
|
|
3883
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
3884
|
-
*/
|
|
3885
|
-
interval_count: number;
|
|
3886
|
-
}
|
|
3887
|
-
|
|
3888
|
-
namespace Duration {
|
|
3889
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
3890
|
-
}
|
|
3891
|
-
|
|
3892
|
-
type Type = 'duration' | 'timestamp';
|
|
3893
|
-
}
|
|
3894
|
-
}
|
|
3895
|
-
|
|
3896
2771
|
interface Duration {
|
|
3897
2772
|
/**
|
|
3898
2773
|
* Specifies phase duration. Either `day`, `week`, `month` or `year`.
|
|
@@ -3956,7 +2831,7 @@ declare module 'stripe' {
|
|
|
3956
2831
|
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
|
|
3957
2832
|
|
|
3958
2833
|
/**
|
|
3959
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2834
|
+
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
|
|
3960
2835
|
*/
|
|
3961
2836
|
metadata?: Stripe.MetadataParam;
|
|
3962
2837
|
|
|
@@ -3971,7 +2846,7 @@ declare module 'stripe' {
|
|
|
3971
2846
|
price?: string;
|
|
3972
2847
|
|
|
3973
2848
|
/**
|
|
3974
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
2849
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
3975
2850
|
*/
|
|
3976
2851
|
price_data?: Item.PriceData;
|
|
3977
2852
|
|
|
@@ -3981,20 +2856,15 @@ declare module 'stripe' {
|
|
|
3981
2856
|
quantity?: number;
|
|
3982
2857
|
|
|
3983
2858
|
/**
|
|
3984
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
2859
|
+
* 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.
|
|
3985
2860
|
*/
|
|
3986
2861
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
3987
|
-
|
|
3988
|
-
/**
|
|
3989
|
-
* Options that configure the trial on the subscription item.
|
|
3990
|
-
*/
|
|
3991
|
-
trial?: Item.Trial;
|
|
3992
2862
|
}
|
|
3993
2863
|
|
|
3994
2864
|
namespace Item {
|
|
3995
2865
|
interface BillingThresholds {
|
|
3996
2866
|
/**
|
|
3997
|
-
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
2867
|
+
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
3998
2868
|
*/
|
|
3999
2869
|
usage_gte: number;
|
|
4000
2870
|
}
|
|
@@ -4010,56 +2880,12 @@ declare module 'stripe' {
|
|
|
4010
2880
|
*/
|
|
4011
2881
|
discount?: string;
|
|
4012
2882
|
|
|
4013
|
-
/**
|
|
4014
|
-
* Details to determine how long the discount should be applied for.
|
|
4015
|
-
*/
|
|
4016
|
-
discount_end?: Discount.DiscountEnd;
|
|
4017
|
-
|
|
4018
2883
|
/**
|
|
4019
2884
|
* ID of the promotion code to create a new discount for.
|
|
4020
2885
|
*/
|
|
4021
2886
|
promotion_code?: string;
|
|
4022
2887
|
}
|
|
4023
2888
|
|
|
4024
|
-
namespace Discount {
|
|
4025
|
-
interface DiscountEnd {
|
|
4026
|
-
/**
|
|
4027
|
-
* Time span for the redeemed discount.
|
|
4028
|
-
*/
|
|
4029
|
-
duration?: DiscountEnd.Duration;
|
|
4030
|
-
|
|
4031
|
-
/**
|
|
4032
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4033
|
-
*/
|
|
4034
|
-
timestamp?: number;
|
|
4035
|
-
|
|
4036
|
-
/**
|
|
4037
|
-
* The type of calculation made to determine when the discount ends.
|
|
4038
|
-
*/
|
|
4039
|
-
type: DiscountEnd.Type;
|
|
4040
|
-
}
|
|
4041
|
-
|
|
4042
|
-
namespace DiscountEnd {
|
|
4043
|
-
interface Duration {
|
|
4044
|
-
/**
|
|
4045
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4046
|
-
*/
|
|
4047
|
-
interval: Duration.Interval;
|
|
4048
|
-
|
|
4049
|
-
/**
|
|
4050
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4051
|
-
*/
|
|
4052
|
-
interval_count: number;
|
|
4053
|
-
}
|
|
4054
|
-
|
|
4055
|
-
namespace Duration {
|
|
4056
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4057
|
-
}
|
|
4058
|
-
|
|
4059
|
-
type Type = 'duration' | 'timestamp';
|
|
4060
|
-
}
|
|
4061
|
-
}
|
|
4062
|
-
|
|
4063
2889
|
interface PriceData {
|
|
4064
2890
|
/**
|
|
4065
2891
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -4077,7 +2903,7 @@ declare module 'stripe' {
|
|
|
4077
2903
|
recurring: PriceData.Recurring;
|
|
4078
2904
|
|
|
4079
2905
|
/**
|
|
4080
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2906
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
4081
2907
|
*/
|
|
4082
2908
|
tax_behavior?: PriceData.TaxBehavior;
|
|
4083
2909
|
|
|
@@ -4111,33 +2937,6 @@ declare module 'stripe' {
|
|
|
4111
2937
|
|
|
4112
2938
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
4113
2939
|
}
|
|
4114
|
-
|
|
4115
|
-
interface Trial {
|
|
4116
|
-
/**
|
|
4117
|
-
* 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.
|
|
4118
|
-
*/
|
|
4119
|
-
converts_to?: Array<string>;
|
|
4120
|
-
|
|
4121
|
-
/**
|
|
4122
|
-
* Determines the type of trial for this item.
|
|
4123
|
-
*/
|
|
4124
|
-
type: Trial.Type;
|
|
4125
|
-
}
|
|
4126
|
-
|
|
4127
|
-
namespace Trial {
|
|
4128
|
-
type Type = 'free' | 'paid';
|
|
4129
|
-
}
|
|
4130
|
-
}
|
|
4131
|
-
|
|
4132
|
-
interface PauseCollection {
|
|
4133
|
-
/**
|
|
4134
|
-
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
4135
|
-
*/
|
|
4136
|
-
behavior: PauseCollection.Behavior;
|
|
4137
|
-
}
|
|
4138
|
-
|
|
4139
|
-
namespace PauseCollection {
|
|
4140
|
-
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
|
|
4141
2940
|
}
|
|
4142
2941
|
|
|
4143
2942
|
type ProrationBehavior =
|
|
@@ -4156,95 +2955,6 @@ declare module 'stripe' {
|
|
|
4156
2955
|
*/
|
|
4157
2956
|
destination: string;
|
|
4158
2957
|
}
|
|
4159
|
-
|
|
4160
|
-
type TrialContinuation = 'continue' | 'none';
|
|
4161
|
-
|
|
4162
|
-
interface TrialSettings {
|
|
4163
|
-
/**
|
|
4164
|
-
* Defines how the subscription should behave when a trial ends.
|
|
4165
|
-
*/
|
|
4166
|
-
end_behavior?: TrialSettings.EndBehavior;
|
|
4167
|
-
}
|
|
4168
|
-
|
|
4169
|
-
namespace TrialSettings {
|
|
4170
|
-
interface EndBehavior {
|
|
4171
|
-
/**
|
|
4172
|
-
* Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
4173
|
-
*/
|
|
4174
|
-
prorate_up_front?: EndBehavior.ProrateUpFront;
|
|
4175
|
-
}
|
|
4176
|
-
|
|
4177
|
-
namespace EndBehavior {
|
|
4178
|
-
type ProrateUpFront = 'defer' | 'include';
|
|
4179
|
-
}
|
|
4180
|
-
}
|
|
4181
|
-
}
|
|
4182
|
-
|
|
4183
|
-
interface Prebilling {
|
|
4184
|
-
/**
|
|
4185
|
-
* The end of the prebilled time period.
|
|
4186
|
-
*/
|
|
4187
|
-
bill_until?: Prebilling.BillUntil;
|
|
4188
|
-
|
|
4189
|
-
/**
|
|
4190
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4191
|
-
*/
|
|
4192
|
-
iterations?: number;
|
|
4193
|
-
}
|
|
4194
|
-
|
|
4195
|
-
namespace Prebilling {
|
|
4196
|
-
interface BillUntil {
|
|
4197
|
-
/**
|
|
4198
|
-
* End the prebilled period when a specified amendment ends.
|
|
4199
|
-
*/
|
|
4200
|
-
amendment_end?: BillUntil.AmendmentEnd;
|
|
4201
|
-
|
|
4202
|
-
/**
|
|
4203
|
-
* Time span for prebilling, starting from `bill_from`.
|
|
4204
|
-
*/
|
|
4205
|
-
duration?: BillUntil.Duration;
|
|
4206
|
-
|
|
4207
|
-
/**
|
|
4208
|
-
* End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
4209
|
-
*/
|
|
4210
|
-
timestamp?: number;
|
|
4211
|
-
|
|
4212
|
-
/**
|
|
4213
|
-
* Select one of several ways to pass the `bill_until` value.
|
|
4214
|
-
*/
|
|
4215
|
-
type: BillUntil.Type;
|
|
4216
|
-
}
|
|
4217
|
-
|
|
4218
|
-
namespace BillUntil {
|
|
4219
|
-
interface AmendmentEnd {
|
|
4220
|
-
/**
|
|
4221
|
-
* 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.
|
|
4222
|
-
*/
|
|
4223
|
-
index: number;
|
|
4224
|
-
}
|
|
4225
|
-
|
|
4226
|
-
interface Duration {
|
|
4227
|
-
/**
|
|
4228
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4229
|
-
*/
|
|
4230
|
-
interval: Duration.Interval;
|
|
4231
|
-
|
|
4232
|
-
/**
|
|
4233
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4234
|
-
*/
|
|
4235
|
-
interval_count: number;
|
|
4236
|
-
}
|
|
4237
|
-
|
|
4238
|
-
namespace Duration {
|
|
4239
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4240
|
-
}
|
|
4241
|
-
|
|
4242
|
-
type Type =
|
|
4243
|
-
| 'amendment_end'
|
|
4244
|
-
| 'duration'
|
|
4245
|
-
| 'schedule_end'
|
|
4246
|
-
| 'timestamp';
|
|
4247
|
-
}
|
|
4248
2958
|
}
|
|
4249
2959
|
|
|
4250
2960
|
type ProrationBehavior =
|
|
@@ -4255,7 +2965,7 @@ declare module 'stripe' {
|
|
|
4255
2965
|
|
|
4256
2966
|
interface SubscriptionDetails {
|
|
4257
2967
|
/**
|
|
4258
|
-
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/
|
|
2968
|
+
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
|
|
4259
2969
|
*/
|
|
4260
2970
|
billing_cycle_anchor?: SubscriptionDetails.BillingCycleAnchor | number;
|
|
4261
2971
|
|
|
@@ -4264,13 +2974,6 @@ declare module 'stripe' {
|
|
|
4264
2974
|
*/
|
|
4265
2975
|
billing_mode?: SubscriptionDetails.BillingMode;
|
|
4266
2976
|
|
|
4267
|
-
/**
|
|
4268
|
-
* Sets the billing schedules for the subscription.
|
|
4269
|
-
*/
|
|
4270
|
-
billing_schedules?: Stripe.Emptyable<
|
|
4271
|
-
Array<SubscriptionDetails.BillingSchedule>
|
|
4272
|
-
>;
|
|
4273
|
-
|
|
4274
2977
|
/**
|
|
4275
2978
|
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
|
4276
2979
|
*/
|
|
@@ -4297,12 +3000,7 @@ declare module 'stripe' {
|
|
|
4297
3000
|
items?: Array<SubscriptionDetails.Item>;
|
|
4298
3001
|
|
|
4299
3002
|
/**
|
|
4300
|
-
*
|
|
4301
|
-
*/
|
|
4302
|
-
prebilling?: SubscriptionDetails.Prebilling;
|
|
4303
|
-
|
|
4304
|
-
/**
|
|
4305
|
-
* Determines how to handle [prorations](https://stripe.com/docs/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`.
|
|
3003
|
+
* 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`.
|
|
4306
3004
|
*/
|
|
4307
3005
|
proration_behavior?: SubscriptionDetails.ProrationBehavior;
|
|
4308
3006
|
|
|
@@ -4357,74 +3055,6 @@ declare module 'stripe' {
|
|
|
4357
3055
|
type Type = 'classic' | 'flexible';
|
|
4358
3056
|
}
|
|
4359
3057
|
|
|
4360
|
-
interface BillingSchedule {
|
|
4361
|
-
/**
|
|
4362
|
-
* Configure billing schedule differently for individual subscription items.
|
|
4363
|
-
*/
|
|
4364
|
-
applies_to?: Array<BillingSchedule.AppliesTo>;
|
|
4365
|
-
|
|
4366
|
-
/**
|
|
4367
|
-
* The end date for the billing schedule.
|
|
4368
|
-
*/
|
|
4369
|
-
bill_until?: BillingSchedule.BillUntil;
|
|
4370
|
-
|
|
4371
|
-
/**
|
|
4372
|
-
* Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
4373
|
-
*/
|
|
4374
|
-
key?: string;
|
|
4375
|
-
}
|
|
4376
|
-
|
|
4377
|
-
namespace BillingSchedule {
|
|
4378
|
-
interface AppliesTo {
|
|
4379
|
-
/**
|
|
4380
|
-
* The ID of the price object.
|
|
4381
|
-
*/
|
|
4382
|
-
price?: string;
|
|
4383
|
-
|
|
4384
|
-
/**
|
|
4385
|
-
* Controls which subscription items the billing schedule applies to.
|
|
4386
|
-
*/
|
|
4387
|
-
type: 'price';
|
|
4388
|
-
}
|
|
4389
|
-
|
|
4390
|
-
interface BillUntil {
|
|
4391
|
-
/**
|
|
4392
|
-
* Specifies the billing period.
|
|
4393
|
-
*/
|
|
4394
|
-
duration?: BillUntil.Duration;
|
|
4395
|
-
|
|
4396
|
-
/**
|
|
4397
|
-
* The end date of the billing schedule.
|
|
4398
|
-
*/
|
|
4399
|
-
timestamp?: number;
|
|
4400
|
-
|
|
4401
|
-
/**
|
|
4402
|
-
* Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
4403
|
-
*/
|
|
4404
|
-
type: BillUntil.Type;
|
|
4405
|
-
}
|
|
4406
|
-
|
|
4407
|
-
namespace BillUntil {
|
|
4408
|
-
interface Duration {
|
|
4409
|
-
/**
|
|
4410
|
-
* Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
4411
|
-
*/
|
|
4412
|
-
interval: Duration.Interval;
|
|
4413
|
-
|
|
4414
|
-
/**
|
|
4415
|
-
* The multiplier applied to the interval.
|
|
4416
|
-
*/
|
|
4417
|
-
interval_count?: number;
|
|
4418
|
-
}
|
|
4419
|
-
|
|
4420
|
-
namespace Duration {
|
|
4421
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4422
|
-
}
|
|
4423
|
-
|
|
4424
|
-
type Type = 'duration' | 'timestamp';
|
|
4425
|
-
}
|
|
4426
|
-
}
|
|
4427
|
-
|
|
4428
3058
|
type CancelAt = 'max_period_end' | 'min_period_end';
|
|
4429
3059
|
|
|
4430
3060
|
interface Item {
|
|
@@ -4454,7 +3084,7 @@ declare module 'stripe' {
|
|
|
4454
3084
|
id?: string;
|
|
4455
3085
|
|
|
4456
3086
|
/**
|
|
4457
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3087
|
+
* 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`.
|
|
4458
3088
|
*/
|
|
4459
3089
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
4460
3090
|
|
|
@@ -4469,7 +3099,7 @@ declare module 'stripe' {
|
|
|
4469
3099
|
price?: string;
|
|
4470
3100
|
|
|
4471
3101
|
/**
|
|
4472
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
3102
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
4473
3103
|
*/
|
|
4474
3104
|
price_data?: Item.PriceData;
|
|
4475
3105
|
|
|
@@ -4479,7 +3109,7 @@ declare module 'stripe' {
|
|
|
4479
3109
|
quantity?: number;
|
|
4480
3110
|
|
|
4481
3111
|
/**
|
|
4482
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
3112
|
+
* 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.
|
|
4483
3113
|
*/
|
|
4484
3114
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
4485
3115
|
}
|
|
@@ -4487,7 +3117,7 @@ declare module 'stripe' {
|
|
|
4487
3117
|
namespace Item {
|
|
4488
3118
|
interface BillingThresholds {
|
|
4489
3119
|
/**
|
|
4490
|
-
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
3120
|
+
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
4491
3121
|
*/
|
|
4492
3122
|
usage_gte: number;
|
|
4493
3123
|
}
|
|
@@ -4503,56 +3133,12 @@ declare module 'stripe' {
|
|
|
4503
3133
|
*/
|
|
4504
3134
|
discount?: string;
|
|
4505
3135
|
|
|
4506
|
-
/**
|
|
4507
|
-
* Details to determine how long the discount should be applied for.
|
|
4508
|
-
*/
|
|
4509
|
-
discount_end?: Discount.DiscountEnd;
|
|
4510
|
-
|
|
4511
3136
|
/**
|
|
4512
3137
|
* ID of the promotion code to create a new discount for.
|
|
4513
3138
|
*/
|
|
4514
3139
|
promotion_code?: string;
|
|
4515
3140
|
}
|
|
4516
3141
|
|
|
4517
|
-
namespace Discount {
|
|
4518
|
-
interface DiscountEnd {
|
|
4519
|
-
/**
|
|
4520
|
-
* Time span for the redeemed discount.
|
|
4521
|
-
*/
|
|
4522
|
-
duration?: DiscountEnd.Duration;
|
|
4523
|
-
|
|
4524
|
-
/**
|
|
4525
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4526
|
-
*/
|
|
4527
|
-
timestamp?: number;
|
|
4528
|
-
|
|
4529
|
-
/**
|
|
4530
|
-
* The type of calculation made to determine when the discount ends.
|
|
4531
|
-
*/
|
|
4532
|
-
type: DiscountEnd.Type;
|
|
4533
|
-
}
|
|
4534
|
-
|
|
4535
|
-
namespace DiscountEnd {
|
|
4536
|
-
interface Duration {
|
|
4537
|
-
/**
|
|
4538
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4539
|
-
*/
|
|
4540
|
-
interval: Duration.Interval;
|
|
4541
|
-
|
|
4542
|
-
/**
|
|
4543
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4544
|
-
*/
|
|
4545
|
-
interval_count: number;
|
|
4546
|
-
}
|
|
4547
|
-
|
|
4548
|
-
namespace Duration {
|
|
4549
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4550
|
-
}
|
|
4551
|
-
|
|
4552
|
-
type Type = 'duration' | 'timestamp';
|
|
4553
|
-
}
|
|
4554
|
-
}
|
|
4555
|
-
|
|
4556
3142
|
interface PriceData {
|
|
4557
3143
|
/**
|
|
4558
3144
|
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
@@ -4570,7 +3156,7 @@ declare module 'stripe' {
|
|
|
4570
3156
|
recurring: PriceData.Recurring;
|
|
4571
3157
|
|
|
4572
3158
|
/**
|
|
4573
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
3159
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
4574
3160
|
*/
|
|
4575
3161
|
tax_behavior?: PriceData.TaxBehavior;
|
|
4576
3162
|
|
|
@@ -4606,13 +3192,6 @@ declare module 'stripe' {
|
|
|
4606
3192
|
}
|
|
4607
3193
|
}
|
|
4608
3194
|
|
|
4609
|
-
interface Prebilling {
|
|
4610
|
-
/**
|
|
4611
|
-
* This is used to determine the number of billing cycles to prebill.
|
|
4612
|
-
*/
|
|
4613
|
-
iterations: number;
|
|
4614
|
-
}
|
|
4615
|
-
|
|
4616
3195
|
type ProrationBehavior =
|
|
4617
3196
|
| 'always_invoice'
|
|
4618
3197
|
| 'create_prorations'
|
|
@@ -4622,7 +3201,7 @@ declare module 'stripe' {
|
|
|
4622
3201
|
|
|
4623
3202
|
interface InvoiceFinalizeInvoiceParams {
|
|
4624
3203
|
/**
|
|
4625
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
3204
|
+
* 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.
|
|
4626
3205
|
*/
|
|
4627
3206
|
auto_advance?: boolean;
|
|
4628
3207
|
|
|
@@ -4697,7 +3276,7 @@ declare module 'stripe' {
|
|
|
4697
3276
|
expand?: Array<string>;
|
|
4698
3277
|
|
|
4699
3278
|
/**
|
|
4700
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3279
|
+
* 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`.
|
|
4701
3280
|
*/
|
|
4702
3281
|
invoice_metadata?: Stripe.Emptyable<{
|
|
4703
3282
|
[key: string]: string;
|
|
@@ -4724,7 +3303,7 @@ declare module 'stripe' {
|
|
|
4724
3303
|
|
|
4725
3304
|
interface InvoiceSearchParams {
|
|
4726
3305
|
/**
|
|
4727
|
-
* The search query string. See [search query language](https://stripe.com/
|
|
3306
|
+
* The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for invoices](https://docs.stripe.com/search#query-fields-for-invoices).
|
|
4728
3307
|
*/
|
|
4729
3308
|
query: string;
|
|
4730
3309
|
|
|
@@ -4763,7 +3342,7 @@ declare module 'stripe' {
|
|
|
4763
3342
|
expand?: Array<string>;
|
|
4764
3343
|
|
|
4765
3344
|
/**
|
|
4766
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3345
|
+
* 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.
|
|
4767
3346
|
*/
|
|
4768
3347
|
invoice_metadata?: Stripe.Emptyable<{
|
|
4769
3348
|
[key: string]: string;
|
|
@@ -4798,22 +3377,17 @@ declare module 'stripe' {
|
|
|
4798
3377
|
id: string;
|
|
4799
3378
|
|
|
4800
3379
|
/**
|
|
4801
|
-
*
|
|
4802
|
-
*/
|
|
4803
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
4804
|
-
|
|
4805
|
-
/**
|
|
4806
|
-
* Set of [key-value pairs](https://stripe.com/docs/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://stripe.com/docs/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.
|
|
3380
|
+
* 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.
|
|
4807
3381
|
*/
|
|
4808
3382
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
4809
3383
|
|
|
4810
3384
|
/**
|
|
4811
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
3385
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
4812
3386
|
*/
|
|
4813
3387
|
period?: Line.Period;
|
|
4814
3388
|
|
|
4815
3389
|
/**
|
|
4816
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
3390
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
4817
3391
|
*/
|
|
4818
3392
|
price_data?: Line.PriceData;
|
|
4819
3393
|
|
|
@@ -4828,7 +3402,7 @@ declare module 'stripe' {
|
|
|
4828
3402
|
quantity?: number;
|
|
4829
3403
|
|
|
4830
3404
|
/**
|
|
4831
|
-
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/
|
|
3405
|
+
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
|
|
4832
3406
|
*/
|
|
4833
3407
|
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
|
|
4834
3408
|
|
|
@@ -4850,56 +3424,12 @@ declare module 'stripe' {
|
|
|
4850
3424
|
*/
|
|
4851
3425
|
discount?: string;
|
|
4852
3426
|
|
|
4853
|
-
/**
|
|
4854
|
-
* Details to determine how long the discount should be applied for.
|
|
4855
|
-
*/
|
|
4856
|
-
discount_end?: Discount.DiscountEnd;
|
|
4857
|
-
|
|
4858
3427
|
/**
|
|
4859
3428
|
* ID of the promotion code to create a new discount for.
|
|
4860
3429
|
*/
|
|
4861
3430
|
promotion_code?: string;
|
|
4862
3431
|
}
|
|
4863
3432
|
|
|
4864
|
-
namespace Discount {
|
|
4865
|
-
interface DiscountEnd {
|
|
4866
|
-
/**
|
|
4867
|
-
* Time span for the redeemed discount.
|
|
4868
|
-
*/
|
|
4869
|
-
duration?: DiscountEnd.Duration;
|
|
4870
|
-
|
|
4871
|
-
/**
|
|
4872
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
4873
|
-
*/
|
|
4874
|
-
timestamp?: number;
|
|
4875
|
-
|
|
4876
|
-
/**
|
|
4877
|
-
* The type of calculation made to determine when the discount ends.
|
|
4878
|
-
*/
|
|
4879
|
-
type: DiscountEnd.Type;
|
|
4880
|
-
}
|
|
4881
|
-
|
|
4882
|
-
namespace DiscountEnd {
|
|
4883
|
-
interface Duration {
|
|
4884
|
-
/**
|
|
4885
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
4886
|
-
*/
|
|
4887
|
-
interval: Duration.Interval;
|
|
4888
|
-
|
|
4889
|
-
/**
|
|
4890
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
4891
|
-
*/
|
|
4892
|
-
interval_count: number;
|
|
4893
|
-
}
|
|
4894
|
-
|
|
4895
|
-
namespace Duration {
|
|
4896
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
4897
|
-
}
|
|
4898
|
-
|
|
4899
|
-
type Type = 'duration' | 'timestamp';
|
|
4900
|
-
}
|
|
4901
|
-
}
|
|
4902
|
-
|
|
4903
3433
|
interface Period {
|
|
4904
3434
|
/**
|
|
4905
3435
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -4929,7 +3459,7 @@ declare module 'stripe' {
|
|
|
4929
3459
|
product_data?: PriceData.ProductData;
|
|
4930
3460
|
|
|
4931
3461
|
/**
|
|
4932
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
3462
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
4933
3463
|
*/
|
|
4934
3464
|
tax_behavior?: PriceData.TaxBehavior;
|
|
4935
3465
|
|
|
@@ -4957,7 +3487,7 @@ declare module 'stripe' {
|
|
|
4957
3487
|
images?: Array<string>;
|
|
4958
3488
|
|
|
4959
3489
|
/**
|
|
4960
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3490
|
+
* 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`.
|
|
4961
3491
|
*/
|
|
4962
3492
|
metadata?: Stripe.MetadataParam;
|
|
4963
3493
|
|
|
@@ -4967,7 +3497,7 @@ declare module 'stripe' {
|
|
|
4967
3497
|
name: string;
|
|
4968
3498
|
|
|
4969
3499
|
/**
|
|
4970
|
-
* A [tax code](https://stripe.com/
|
|
3500
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
4971
3501
|
*/
|
|
4972
3502
|
tax_code?: string;
|
|
4973
3503
|
|
|
@@ -5132,22 +3662,17 @@ declare module 'stripe' {
|
|
|
5132
3662
|
expand?: Array<string>;
|
|
5133
3663
|
|
|
5134
3664
|
/**
|
|
5135
|
-
*
|
|
5136
|
-
*/
|
|
5137
|
-
margins?: Stripe.Emptyable<Array<string>>;
|
|
5138
|
-
|
|
5139
|
-
/**
|
|
5140
|
-
* Set of [key-value pairs](https://stripe.com/docs/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://stripe.com/docs/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.
|
|
3665
|
+
* 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.
|
|
5141
3666
|
*/
|
|
5142
3667
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
5143
3668
|
|
|
5144
3669
|
/**
|
|
5145
|
-
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
3670
|
+
* The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
5146
3671
|
*/
|
|
5147
3672
|
period?: InvoiceUpdateLineItemParams.Period;
|
|
5148
3673
|
|
|
5149
3674
|
/**
|
|
5150
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
3675
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
5151
3676
|
*/
|
|
5152
3677
|
price_data?: InvoiceUpdateLineItemParams.PriceData;
|
|
5153
3678
|
|
|
@@ -5162,7 +3687,7 @@ declare module 'stripe' {
|
|
|
5162
3687
|
quantity?: number;
|
|
5163
3688
|
|
|
5164
3689
|
/**
|
|
5165
|
-
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/
|
|
3690
|
+
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
|
|
5166
3691
|
*/
|
|
5167
3692
|
tax_amounts?: Stripe.Emptyable<
|
|
5168
3693
|
Array<InvoiceUpdateLineItemParams.TaxAmount>
|
|
@@ -5186,56 +3711,12 @@ declare module 'stripe' {
|
|
|
5186
3711
|
*/
|
|
5187
3712
|
discount?: string;
|
|
5188
3713
|
|
|
5189
|
-
/**
|
|
5190
|
-
* Details to determine how long the discount should be applied for.
|
|
5191
|
-
*/
|
|
5192
|
-
discount_end?: Discount.DiscountEnd;
|
|
5193
|
-
|
|
5194
3714
|
/**
|
|
5195
3715
|
* ID of the promotion code to create a new discount for.
|
|
5196
3716
|
*/
|
|
5197
3717
|
promotion_code?: string;
|
|
5198
3718
|
}
|
|
5199
3719
|
|
|
5200
|
-
namespace Discount {
|
|
5201
|
-
interface DiscountEnd {
|
|
5202
|
-
/**
|
|
5203
|
-
* Time span for the redeemed discount.
|
|
5204
|
-
*/
|
|
5205
|
-
duration?: DiscountEnd.Duration;
|
|
5206
|
-
|
|
5207
|
-
/**
|
|
5208
|
-
* A precise Unix timestamp for the discount to end. Must be in the future.
|
|
5209
|
-
*/
|
|
5210
|
-
timestamp?: number;
|
|
5211
|
-
|
|
5212
|
-
/**
|
|
5213
|
-
* The type of calculation made to determine when the discount ends.
|
|
5214
|
-
*/
|
|
5215
|
-
type: DiscountEnd.Type;
|
|
5216
|
-
}
|
|
5217
|
-
|
|
5218
|
-
namespace DiscountEnd {
|
|
5219
|
-
interface Duration {
|
|
5220
|
-
/**
|
|
5221
|
-
* Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
5222
|
-
*/
|
|
5223
|
-
interval: Duration.Interval;
|
|
5224
|
-
|
|
5225
|
-
/**
|
|
5226
|
-
* The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
5227
|
-
*/
|
|
5228
|
-
interval_count: number;
|
|
5229
|
-
}
|
|
5230
|
-
|
|
5231
|
-
namespace Duration {
|
|
5232
|
-
type Interval = 'day' | 'month' | 'week' | 'year';
|
|
5233
|
-
}
|
|
5234
|
-
|
|
5235
|
-
type Type = 'duration' | 'timestamp';
|
|
5236
|
-
}
|
|
5237
|
-
}
|
|
5238
|
-
|
|
5239
3720
|
interface Period {
|
|
5240
3721
|
/**
|
|
5241
3722
|
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
|
@@ -5265,7 +3746,7 @@ declare module 'stripe' {
|
|
|
5265
3746
|
product_data?: PriceData.ProductData;
|
|
5266
3747
|
|
|
5267
3748
|
/**
|
|
5268
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
3749
|
+
* Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
5269
3750
|
*/
|
|
5270
3751
|
tax_behavior?: PriceData.TaxBehavior;
|
|
5271
3752
|
|
|
@@ -5293,7 +3774,7 @@ declare module 'stripe' {
|
|
|
5293
3774
|
images?: Array<string>;
|
|
5294
3775
|
|
|
5295
3776
|
/**
|
|
5296
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3777
|
+
* 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`.
|
|
5297
3778
|
*/
|
|
5298
3779
|
metadata?: Stripe.MetadataParam;
|
|
5299
3780
|
|
|
@@ -5303,7 +3784,7 @@ declare module 'stripe' {
|
|
|
5303
3784
|
name: string;
|
|
5304
3785
|
|
|
5305
3786
|
/**
|
|
5306
|
-
* A [tax code](https://stripe.com/
|
|
3787
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5307
3788
|
*/
|
|
5308
3789
|
tax_code?: string;
|
|
5309
3790
|
|