stripe 20.1.0-alpha.4 → 20.2.0-alpha.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 +39 -0
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/Error.js +9 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
- package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
- package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
- package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
- package/cjs/resources/V2/Tax/ManualRules.js +23 -0
- package/cjs/resources.js +15 -1
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +7 -0
- package/esm/apiVersion.js +1 -1
- package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
- package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
- package/esm/resources/V2/Iam/ApiKeys.js +21 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
- package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
- package/esm/resources/V2/Tax/ManualRules.js +20 -0
- package/esm/resources.js +14 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinks.d.ts +1 -1
- package/types/AccountNotices.d.ts +6 -6
- package/types/AccountNoticesResource.d.ts +1 -1
- package/types/AccountSessions.d.ts +7 -7
- package/types/AccountSessionsResource.d.ts +21 -0
- package/types/Accounts.d.ts +25 -25
- package/types/AccountsResource.d.ts +107 -63
- 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/BalanceTransfers.d.ts +3 -3
- package/types/BalanceTransfersResource.d.ts +1 -1
- package/types/BankAccounts.d.ts +10 -10
- package/types/Billing/Alerts.d.ts +2 -2
- package/types/Billing/CreditBalanceSummary.d.ts +3 -3
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactions.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
- package/types/Billing/CreditGrants.d.ts +4 -4
- 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 -16
- package/types/Capital/FinancingOffers.d.ts +2 -2
- package/types/Capital/FinancingSummary.d.ts +7 -4
- package/types/Capital/FinancingSummaryResource.d.ts +1 -1
- package/types/Cards.d.ts +2 -2
- package/types/CashBalances.d.ts +3 -3
- package/types/Charges.d.ts +59 -27
- package/types/ChargesResource.d.ts +22 -22
- package/types/Checkout/Sessions.d.ts +18 -18
- package/types/Checkout/SessionsResource.d.ts +90 -60
- package/types/Climate/Orders.d.ts +1 -1
- package/types/Climate/OrdersResource.d.ts +2 -2
- package/types/ConfirmationTokens.d.ts +8 -6
- package/types/Coupons.d.ts +3 -3
- package/types/CouponsResource.d.ts +2 -2
- package/types/CreditNoteLineItems.d.ts +3 -0
- 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 -1
- package/types/Customers.d.ts +8 -5
- package/types/CustomersResource.d.ts +21 -16
- package/types/DelegatedCheckout/RequestedSessions.d.ts +83 -17
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +102 -0
- package/types/Discounts.d.ts +6 -6
- package/types/Disputes.d.ts +3 -3
- package/types/DisputesResource.d.ts +1 -1
- package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
- package/types/Errors.d.ts +6 -0
- package/types/Events.d.ts +1 -1
- package/types/ExchangeRates.d.ts +2 -2
- package/types/ExternalAccountsResource.d.ts +4 -4
- 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 +3 -3
- package/types/FinancialConnections/AccountsResource.d.ts +3 -3
- package/types/FinancialConnections/Sessions.d.ts +2 -2
- package/types/FinancialConnections/SessionsResource.d.ts +3 -3
- 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/BlocklistEntries.d.ts +1 -1
- 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 +12 -12
- package/types/InvoiceItemsResource.d.ts +16 -16
- package/types/InvoiceLineItems.d.ts +11 -8
- package/types/InvoicePayments.d.ts +1 -1
- package/types/InvoiceRenderingTemplates.d.ts +1 -1
- package/types/Invoices.d.ts +83 -33
- package/types/InvoicesResource.d.ts +237 -111
- 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 -21
- package/types/Issuing/Cards.d.ts +20 -10
- package/types/Issuing/CardsResource.d.ts +46 -13
- package/types/Issuing/CreditUnderwritingRecords.d.ts +5 -5
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +15 -15
- package/types/Issuing/Disputes.d.ts +7 -7
- package/types/Issuing/DisputesResource.d.ts +5 -5
- package/types/Issuing/FraudLiabilityDebits.d.ts +1 -1
- package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
- package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
- package/types/Issuing/Programs.d.ts +1 -1
- package/types/Issuing/ProgramsResource.d.ts +1 -1
- package/types/Issuing/Settlements.d.ts +2 -2
- package/types/Issuing/Tokens.d.ts +1 -1
- package/types/Issuing/Transactions.d.ts +13 -13
- package/types/Issuing/TransactionsResource.d.ts +1 -1
- package/types/LineItems.d.ts +3 -3
- package/types/LoginLinks.d.ts +1 -1
- package/types/MandatesResource.d.ts +1 -1
- package/types/Margins.d.ts +1 -1
- package/types/MarginsResource.d.ts +2 -2
- package/types/Orders.d.ts +11 -11
- package/types/OrdersResource.d.ts +24 -24
- package/types/PaymentAttemptRecords.d.ts +119 -18
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
- package/types/PaymentIntents.d.ts +72 -44
- package/types/PaymentIntentsResource.d.ts +172 -159
- package/types/PaymentLinks.d.ts +7 -7
- package/types/PaymentLinksResource.d.ts +42 -28
- package/types/PaymentMethodConfigurations.d.ts +4 -4
- package/types/PaymentMethodConfigurationsResource.d.ts +80 -80
- package/types/PaymentMethodDomains.d.ts +1 -1
- package/types/PaymentMethods.d.ts +10 -8
- package/types/PaymentMethodsResource.d.ts +7 -6
- package/types/PaymentRecords.d.ts +126 -18
- 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 -21
- package/types/Plans.d.ts +5 -5
- package/types/PlansResource.d.ts +6 -6
- package/types/Prices.d.ts +6 -6
- package/types/PricesResource.d.ts +10 -10
- package/types/ProductCatalog/TrialOffers.d.ts +1 -1
- package/types/Products.d.ts +10 -10
- package/types/ProductsResource.d.ts +38 -14
- package/types/PromotionCodes.d.ts +5 -5
- package/types/PromotionCodesResource.d.ts +5 -5
- package/types/QuoteLines.d.ts +3 -3
- package/types/QuotePreviewInvoices.d.ts +81 -31
- package/types/QuotePreviewSubscriptionSchedules.d.ts +18 -18
- package/types/Quotes.d.ts +16 -16
- package/types/QuotesResource.d.ts +30 -30
- 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 -3
- 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 +21 -18
- package/types/SetupIntents.d.ts +20 -19
- package/types/SetupIntentsResource.d.ts +47 -44
- package/types/SharedPayment/GrantedTokens.d.ts +102 -0
- package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
- 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 -5
- package/types/SourcesResource.d.ts +2 -2
- package/types/SubscriptionItems.d.ts +7 -7
- package/types/SubscriptionItemsResource.d.ts +22 -22
- package/types/SubscriptionSchedules.d.ts +19 -19
- package/types/SubscriptionSchedulesResource.d.ts +61 -61
- package/types/Subscriptions.d.ts +61 -15
- package/types/SubscriptionsResource.d.ts +142 -58
- 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/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 -10
- package/types/Terminal/ReadersResource.d.ts +7 -7
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -4
- 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/SharedPayment/GrantedTokensResource.d.ts +87 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -1
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -1
- 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 -5
- package/types/TransfersResource.d.ts +6 -6
- 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/FinancialAccounts.d.ts +1 -1
- package/types/Treasury/FinancialAccountsResource.d.ts +2 -2
- 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 -4
- package/types/Treasury/OutboundTransfersResource.d.ts +3 -3
- package/types/Treasury/ReceivedCredits.d.ts +9 -9
- package/types/Treasury/ReceivedDebits.d.ts +6 -6
- package/types/Treasury/TransactionEntries.d.ts +11 -11
- package/types/Treasury/Transactions.d.ts +11 -11
- package/types/V2/Billing/IntentActions.d.ts +141 -36
- package/types/V2/Billing/IntentsResource.d.ts +141 -42
- package/types/V2/Core/AccountLinks.d.ts +11 -11
- package/types/V2/Core/AccountLinksResource.d.ts +6 -6
- package/types/V2/Core/AccountPersons.d.ts +55 -10
- package/types/V2/Core/AccountTokensResource.d.ts +99 -10
- 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 +298 -509
- package/types/V2/Core/AccountsResource.d.ts +256 -51
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +1 -1
- package/types/V2/Core/EventTypes.d.ts +601 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +21 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +26 -0
- package/types/V2/Iam/ApiKeys.d.ts +154 -0
- package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +31 -1
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +8 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +7 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +26 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +2 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +10 -1
- package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
- package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
- package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
- package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
- package/types/V2/Tax/ManualRules.d.ts +142 -0
- package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
- package/types/WebhookEndpoints.d.ts +1 -1
- package/types/WebhookEndpointsResource.d.ts +4 -3
- package/types/apiVersion.d.ts +1 -1
- package/types/index.d.ts +24 -0
|
@@ -14,12 +14,12 @@ declare module 'stripe' {
|
|
|
14
14
|
amounts_due?: Stripe.Emptyable<Array<InvoiceCreateParams.AmountsDue>>;
|
|
15
15
|
|
|
16
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/
|
|
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://docs.stripe.com/billing/invoices/connect#collecting-fees).
|
|
18
18
|
*/
|
|
19
19
|
application_fee_amount?: number;
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
22
|
+
* 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
23
|
*/
|
|
24
24
|
auto_advance?: boolean;
|
|
25
25
|
|
|
@@ -49,12 +49,12 @@ declare module 'stripe' {
|
|
|
49
49
|
custom_fields?: Stripe.Emptyable<Array<InvoiceCreateParams.CustomField>>;
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* The ID of the customer
|
|
52
|
+
* The ID of the customer to bill.
|
|
53
53
|
*/
|
|
54
54
|
customer?: string;
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* The ID of the account
|
|
57
|
+
* The ID of the account to bill.
|
|
58
58
|
*/
|
|
59
59
|
customer_account?: string;
|
|
60
60
|
|
|
@@ -114,7 +114,7 @@ declare module 'stripe' {
|
|
|
114
114
|
footer?: string;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/
|
|
117
|
+
* 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
118
|
*/
|
|
119
119
|
from_invoice?: InvoiceCreateParams.FromInvoice;
|
|
120
120
|
|
|
@@ -124,7 +124,7 @@ declare module 'stripe' {
|
|
|
124
124
|
issuer?: InvoiceCreateParams.Issuer;
|
|
125
125
|
|
|
126
126
|
/**
|
|
127
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
127
|
+
* 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
128
|
*/
|
|
129
129
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
130
130
|
|
|
@@ -134,7 +134,7 @@ declare module 'stripe' {
|
|
|
134
134
|
number?: string;
|
|
135
135
|
|
|
136
136
|
/**
|
|
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/
|
|
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://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
138
138
|
*/
|
|
139
139
|
on_behalf_of?: string;
|
|
140
140
|
|
|
@@ -204,7 +204,7 @@ declare module 'stripe' {
|
|
|
204
204
|
|
|
205
205
|
interface AutomaticTax {
|
|
206
206
|
/**
|
|
207
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
207
|
+
* 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
208
|
*/
|
|
209
209
|
enabled: boolean;
|
|
210
210
|
|
|
@@ -390,6 +390,11 @@ declare module 'stripe' {
|
|
|
390
390
|
*/
|
|
391
391
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
392
392
|
|
|
393
|
+
/**
|
|
394
|
+
* If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
|
|
395
|
+
*/
|
|
396
|
+
payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
|
|
397
|
+
|
|
393
398
|
/**
|
|
394
399
|
* If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
395
400
|
*/
|
|
@@ -456,12 +461,12 @@ declare module 'stripe' {
|
|
|
456
461
|
/**
|
|
457
462
|
* Installment configuration for payments attempted on this invoice.
|
|
458
463
|
*
|
|
459
|
-
* For more information, see the [installments integration guide](https://stripe.com/
|
|
464
|
+
* For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
460
465
|
*/
|
|
461
466
|
installments?: Card.Installments;
|
|
462
467
|
|
|
463
468
|
/**
|
|
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/
|
|
469
|
+
* 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
470
|
*/
|
|
466
471
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
467
472
|
}
|
|
@@ -546,6 +551,42 @@ declare module 'stripe' {
|
|
|
546
551
|
|
|
547
552
|
interface Konbini {}
|
|
548
553
|
|
|
554
|
+
interface Payto {
|
|
555
|
+
/**
|
|
556
|
+
* Additional fields for Mandate creation.
|
|
557
|
+
*/
|
|
558
|
+
mandate_options?: Payto.MandateOptions;
|
|
559
|
+
}
|
|
560
|
+
|
|
561
|
+
namespace Payto {
|
|
562
|
+
interface MandateOptions {
|
|
563
|
+
/**
|
|
564
|
+
* The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
565
|
+
*/
|
|
566
|
+
amount?: number;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
570
|
+
*/
|
|
571
|
+
purpose?: MandateOptions.Purpose;
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
namespace MandateOptions {
|
|
575
|
+
type Purpose =
|
|
576
|
+
| 'dependant_support'
|
|
577
|
+
| 'government'
|
|
578
|
+
| 'loan'
|
|
579
|
+
| 'mortgage'
|
|
580
|
+
| 'other'
|
|
581
|
+
| 'pension'
|
|
582
|
+
| 'personal'
|
|
583
|
+
| 'retail'
|
|
584
|
+
| 'salary'
|
|
585
|
+
| 'tax'
|
|
586
|
+
| 'utility';
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
|
|
549
590
|
interface Pix {
|
|
550
591
|
/**
|
|
551
592
|
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
@@ -692,6 +733,7 @@ declare module 'stripe' {
|
|
|
692
733
|
| 'payco'
|
|
693
734
|
| 'paynow'
|
|
694
735
|
| 'paypal'
|
|
736
|
+
| 'payto'
|
|
695
737
|
| 'pix'
|
|
696
738
|
| 'promptpay'
|
|
697
739
|
| 'revolut_pay'
|
|
@@ -776,7 +818,7 @@ declare module 'stripe' {
|
|
|
776
818
|
fixed_amount?: ShippingRateData.FixedAmount;
|
|
777
819
|
|
|
778
820
|
/**
|
|
779
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
821
|
+
* 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
822
|
*/
|
|
781
823
|
metadata?: Stripe.MetadataParam;
|
|
782
824
|
|
|
@@ -786,7 +828,7 @@ declare module 'stripe' {
|
|
|
786
828
|
tax_behavior?: ShippingRateData.TaxBehavior;
|
|
787
829
|
|
|
788
830
|
/**
|
|
789
|
-
* A [tax code](https://stripe.com/
|
|
831
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
790
832
|
*/
|
|
791
833
|
tax_code?: string;
|
|
792
834
|
|
|
@@ -933,12 +975,12 @@ declare module 'stripe' {
|
|
|
933
975
|
amounts_due?: Stripe.Emptyable<Array<InvoiceUpdateParams.AmountsDue>>;
|
|
934
976
|
|
|
935
977
|
/**
|
|
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/
|
|
978
|
+
* 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
979
|
*/
|
|
938
980
|
application_fee_amount?: number;
|
|
939
981
|
|
|
940
982
|
/**
|
|
941
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
983
|
+
* Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice.
|
|
942
984
|
*/
|
|
943
985
|
auto_advance?: boolean;
|
|
944
986
|
|
|
@@ -1023,7 +1065,7 @@ declare module 'stripe' {
|
|
|
1023
1065
|
issuer?: InvoiceUpdateParams.Issuer;
|
|
1024
1066
|
|
|
1025
1067
|
/**
|
|
1026
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1068
|
+
* 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
1069
|
*/
|
|
1028
1070
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1029
1071
|
|
|
@@ -1033,7 +1075,7 @@ declare module 'stripe' {
|
|
|
1033
1075
|
number?: Stripe.Emptyable<string>;
|
|
1034
1076
|
|
|
1035
1077
|
/**
|
|
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/
|
|
1078
|
+
* 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
1079
|
*/
|
|
1038
1080
|
on_behalf_of?: Stripe.Emptyable<string>;
|
|
1039
1081
|
|
|
@@ -1093,7 +1135,7 @@ declare module 'stripe' {
|
|
|
1093
1135
|
|
|
1094
1136
|
interface AutomaticTax {
|
|
1095
1137
|
/**
|
|
1096
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
1138
|
+
* 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
1139
|
*/
|
|
1098
1140
|
enabled: boolean;
|
|
1099
1141
|
|
|
@@ -1267,6 +1309,11 @@ declare module 'stripe' {
|
|
|
1267
1309
|
*/
|
|
1268
1310
|
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
|
|
1269
1311
|
|
|
1312
|
+
/**
|
|
1313
|
+
* If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice's PaymentIntent.
|
|
1314
|
+
*/
|
|
1315
|
+
payto?: Stripe.Emptyable<PaymentMethodOptions.Payto>;
|
|
1316
|
+
|
|
1270
1317
|
/**
|
|
1271
1318
|
* If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
|
|
1272
1319
|
*/
|
|
@@ -1333,12 +1380,12 @@ declare module 'stripe' {
|
|
|
1333
1380
|
/**
|
|
1334
1381
|
* Installment configuration for payments attempted on this invoice.
|
|
1335
1382
|
*
|
|
1336
|
-
* For more information, see the [installments integration guide](https://stripe.com/
|
|
1383
|
+
* For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
1337
1384
|
*/
|
|
1338
1385
|
installments?: Card.Installments;
|
|
1339
1386
|
|
|
1340
1387
|
/**
|
|
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/
|
|
1388
|
+
* 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
1389
|
*/
|
|
1343
1390
|
request_three_d_secure?: Card.RequestThreeDSecure;
|
|
1344
1391
|
}
|
|
@@ -1423,6 +1470,42 @@ declare module 'stripe' {
|
|
|
1423
1470
|
|
|
1424
1471
|
interface Konbini {}
|
|
1425
1472
|
|
|
1473
|
+
interface Payto {
|
|
1474
|
+
/**
|
|
1475
|
+
* Additional fields for Mandate creation.
|
|
1476
|
+
*/
|
|
1477
|
+
mandate_options?: Payto.MandateOptions;
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
namespace Payto {
|
|
1481
|
+
interface MandateOptions {
|
|
1482
|
+
/**
|
|
1483
|
+
* The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
1484
|
+
*/
|
|
1485
|
+
amount?: number;
|
|
1486
|
+
|
|
1487
|
+
/**
|
|
1488
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
1489
|
+
*/
|
|
1490
|
+
purpose?: MandateOptions.Purpose;
|
|
1491
|
+
}
|
|
1492
|
+
|
|
1493
|
+
namespace MandateOptions {
|
|
1494
|
+
type Purpose =
|
|
1495
|
+
| 'dependant_support'
|
|
1496
|
+
| 'government'
|
|
1497
|
+
| 'loan'
|
|
1498
|
+
| 'mortgage'
|
|
1499
|
+
| 'other'
|
|
1500
|
+
| 'pension'
|
|
1501
|
+
| 'personal'
|
|
1502
|
+
| 'retail'
|
|
1503
|
+
| 'salary'
|
|
1504
|
+
| 'tax'
|
|
1505
|
+
| 'utility';
|
|
1506
|
+
}
|
|
1507
|
+
}
|
|
1508
|
+
|
|
1426
1509
|
interface Pix {
|
|
1427
1510
|
/**
|
|
1428
1511
|
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
@@ -1569,6 +1652,7 @@ declare module 'stripe' {
|
|
|
1569
1652
|
| 'payco'
|
|
1570
1653
|
| 'paynow'
|
|
1571
1654
|
| 'paypal'
|
|
1655
|
+
| 'payto'
|
|
1572
1656
|
| 'pix'
|
|
1573
1657
|
| 'promptpay'
|
|
1574
1658
|
| 'revolut_pay'
|
|
@@ -1651,7 +1735,7 @@ declare module 'stripe' {
|
|
|
1651
1735
|
fixed_amount?: ShippingRateData.FixedAmount;
|
|
1652
1736
|
|
|
1653
1737
|
/**
|
|
1654
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1738
|
+
* 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
1739
|
*/
|
|
1656
1740
|
metadata?: Stripe.MetadataParam;
|
|
1657
1741
|
|
|
@@ -1661,7 +1745,7 @@ declare module 'stripe' {
|
|
|
1661
1745
|
tax_behavior?: ShippingRateData.TaxBehavior;
|
|
1662
1746
|
|
|
1663
1747
|
/**
|
|
1664
|
-
* A [tax code](https://stripe.com/
|
|
1748
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
1665
1749
|
*/
|
|
1666
1750
|
tax_code?: string;
|
|
1667
1751
|
|
|
@@ -1811,7 +1895,7 @@ declare module 'stripe' {
|
|
|
1811
1895
|
customer?: string;
|
|
1812
1896
|
|
|
1813
1897
|
/**
|
|
1814
|
-
* Only return invoices for the account specified by this account ID.
|
|
1898
|
+
* Only return invoices for the account representing the customer specified by this account ID.
|
|
1815
1899
|
*/
|
|
1816
1900
|
customer_account?: string;
|
|
1817
1901
|
|
|
@@ -1823,7 +1907,7 @@ declare module 'stripe' {
|
|
|
1823
1907
|
expand?: Array<string>;
|
|
1824
1908
|
|
|
1825
1909
|
/**
|
|
1826
|
-
* The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/
|
|
1910
|
+
* The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
|
|
1827
1911
|
*/
|
|
1828
1912
|
status?: InvoiceListParams.Status;
|
|
1829
1913
|
|
|
@@ -1853,7 +1937,7 @@ declare module 'stripe' {
|
|
|
1853
1937
|
expand?: Array<string>;
|
|
1854
1938
|
|
|
1855
1939
|
/**
|
|
1856
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1940
|
+
* 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`.
|
|
1857
1941
|
*/
|
|
1858
1942
|
invoice_metadata?: Stripe.Emptyable<{
|
|
1859
1943
|
[key: string]: string;
|
|
@@ -1893,17 +1977,17 @@ declare module 'stripe' {
|
|
|
1893
1977
|
margins?: Stripe.Emptyable<Array<string>>;
|
|
1894
1978
|
|
|
1895
1979
|
/**
|
|
1896
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1980
|
+
* 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`.
|
|
1897
1981
|
*/
|
|
1898
1982
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
1899
1983
|
|
|
1900
1984
|
/**
|
|
1901
|
-
* 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/
|
|
1985
|
+
* 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.
|
|
1902
1986
|
*/
|
|
1903
1987
|
period?: Line.Period;
|
|
1904
1988
|
|
|
1905
1989
|
/**
|
|
1906
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
1990
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
1907
1991
|
*/
|
|
1908
1992
|
price_data?: Line.PriceData;
|
|
1909
1993
|
|
|
@@ -1918,7 +2002,7 @@ declare module 'stripe' {
|
|
|
1918
2002
|
quantity?: number;
|
|
1919
2003
|
|
|
1920
2004
|
/**
|
|
1921
|
-
* 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/
|
|
2005
|
+
* 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.
|
|
1922
2006
|
*/
|
|
1923
2007
|
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
|
|
1924
2008
|
|
|
@@ -2019,7 +2103,7 @@ declare module 'stripe' {
|
|
|
2019
2103
|
product_data?: PriceData.ProductData;
|
|
2020
2104
|
|
|
2021
2105
|
/**
|
|
2022
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2106
|
+
* 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.
|
|
2023
2107
|
*/
|
|
2024
2108
|
tax_behavior?: PriceData.TaxBehavior;
|
|
2025
2109
|
|
|
@@ -2047,7 +2131,7 @@ declare module 'stripe' {
|
|
|
2047
2131
|
images?: Array<string>;
|
|
2048
2132
|
|
|
2049
2133
|
/**
|
|
2050
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2134
|
+
* 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`.
|
|
2051
2135
|
*/
|
|
2052
2136
|
metadata?: Stripe.MetadataParam;
|
|
2053
2137
|
|
|
@@ -2057,7 +2141,7 @@ declare module 'stripe' {
|
|
|
2057
2141
|
name: string;
|
|
2058
2142
|
|
|
2059
2143
|
/**
|
|
2060
|
-
* A [tax code](https://stripe.com/
|
|
2144
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2061
2145
|
*/
|
|
2062
2146
|
tax_code?: string;
|
|
2063
2147
|
|
|
@@ -2065,6 +2149,20 @@ declare module 'stripe' {
|
|
|
2065
2149
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
2066
2150
|
*/
|
|
2067
2151
|
unit_label?: string;
|
|
2152
|
+
|
|
2153
|
+
/**
|
|
2154
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
2155
|
+
*/
|
|
2156
|
+
tax_details?: ProductData.TaxDetails;
|
|
2157
|
+
}
|
|
2158
|
+
|
|
2159
|
+
namespace ProductData {
|
|
2160
|
+
interface TaxDetails {
|
|
2161
|
+
/**
|
|
2162
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2163
|
+
*/
|
|
2164
|
+
tax_code: string;
|
|
2165
|
+
}
|
|
2068
2166
|
}
|
|
2069
2167
|
|
|
2070
2168
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
@@ -2235,7 +2333,7 @@ declare module 'stripe' {
|
|
|
2235
2333
|
currency: string;
|
|
2236
2334
|
|
|
2237
2335
|
/**
|
|
2238
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2336
|
+
* 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`.
|
|
2239
2337
|
*/
|
|
2240
2338
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2241
2339
|
|
|
@@ -2263,7 +2361,7 @@ declare module 'stripe' {
|
|
|
2263
2361
|
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
|
|
2264
2362
|
|
|
2265
2363
|
/**
|
|
2266
|
-
* 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.
|
|
2364
|
+
* 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.
|
|
2267
2365
|
*/
|
|
2268
2366
|
billing_cadence?: string;
|
|
2269
2367
|
|
|
@@ -2273,12 +2371,12 @@ declare module 'stripe' {
|
|
|
2273
2371
|
currency?: string;
|
|
2274
2372
|
|
|
2275
2373
|
/**
|
|
2276
|
-
* The identifier of the customer whose upcoming invoice you'
|
|
2374
|
+
* 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.
|
|
2277
2375
|
*/
|
|
2278
2376
|
customer?: string;
|
|
2279
2377
|
|
|
2280
2378
|
/**
|
|
2281
|
-
* The identifier of the account whose upcoming invoice you'
|
|
2379
|
+
* 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.
|
|
2282
2380
|
*/
|
|
2283
2381
|
customer_account?: string;
|
|
2284
2382
|
|
|
@@ -2308,7 +2406,7 @@ declare module 'stripe' {
|
|
|
2308
2406
|
issuer?: InvoiceCreatePreviewParams.Issuer;
|
|
2309
2407
|
|
|
2310
2408
|
/**
|
|
2311
|
-
* 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/
|
|
2409
|
+
* 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.
|
|
2312
2410
|
*/
|
|
2313
2411
|
on_behalf_of?: Stripe.Emptyable<string>;
|
|
2314
2412
|
|
|
@@ -2341,7 +2439,7 @@ declare module 'stripe' {
|
|
|
2341
2439
|
namespace InvoiceCreatePreviewParams {
|
|
2342
2440
|
interface AutomaticTax {
|
|
2343
2441
|
/**
|
|
2344
|
-
* Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
2442
|
+
* 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.
|
|
2345
2443
|
*/
|
|
2346
2444
|
enabled: boolean;
|
|
2347
2445
|
|
|
@@ -2371,7 +2469,7 @@ declare module 'stripe' {
|
|
|
2371
2469
|
|
|
2372
2470
|
interface CustomerDetails {
|
|
2373
2471
|
/**
|
|
2374
|
-
* The customer's address.
|
|
2472
|
+
* 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).
|
|
2375
2473
|
*/
|
|
2376
2474
|
address?: Stripe.Emptyable<Stripe.AddressParam>;
|
|
2377
2475
|
|
|
@@ -2643,12 +2741,12 @@ declare module 'stripe' {
|
|
|
2643
2741
|
invoiceitem?: string;
|
|
2644
2742
|
|
|
2645
2743
|
/**
|
|
2646
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
2744
|
+
* 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`.
|
|
2647
2745
|
*/
|
|
2648
2746
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
2649
2747
|
|
|
2650
2748
|
/**
|
|
2651
|
-
* 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/
|
|
2749
|
+
* 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.
|
|
2652
2750
|
*/
|
|
2653
2751
|
period?: InvoiceItem.Period;
|
|
2654
2752
|
|
|
@@ -2658,7 +2756,7 @@ declare module 'stripe' {
|
|
|
2658
2756
|
price?: string;
|
|
2659
2757
|
|
|
2660
2758
|
/**
|
|
2661
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
2759
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
2662
2760
|
*/
|
|
2663
2761
|
price_data?: InvoiceItem.PriceData;
|
|
2664
2762
|
|
|
@@ -2668,12 +2766,12 @@ declare module 'stripe' {
|
|
|
2668
2766
|
quantity?: number;
|
|
2669
2767
|
|
|
2670
2768
|
/**
|
|
2671
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2769
|
+
* 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.
|
|
2672
2770
|
*/
|
|
2673
2771
|
tax_behavior?: InvoiceItem.TaxBehavior;
|
|
2674
2772
|
|
|
2675
2773
|
/**
|
|
2676
|
-
* A [tax code](https://stripe.com/
|
|
2774
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
2677
2775
|
*/
|
|
2678
2776
|
tax_code?: Stripe.Emptyable<string>;
|
|
2679
2777
|
|
|
@@ -2779,7 +2877,7 @@ declare module 'stripe' {
|
|
|
2779
2877
|
product: string;
|
|
2780
2878
|
|
|
2781
2879
|
/**
|
|
2782
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
2880
|
+
* 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.
|
|
2783
2881
|
*/
|
|
2784
2882
|
tax_behavior?: PriceData.TaxBehavior;
|
|
2785
2883
|
|
|
@@ -2835,6 +2933,13 @@ declare module 'stripe' {
|
|
|
2835
2933
|
*/
|
|
2836
2934
|
billing_mode?: ScheduleDetails.BillingMode;
|
|
2837
2935
|
|
|
2936
|
+
/**
|
|
2937
|
+
* Sets the billing schedules for the subscription schedule.
|
|
2938
|
+
*/
|
|
2939
|
+
billing_schedules?: Stripe.Emptyable<
|
|
2940
|
+
Array<ScheduleDetails.BillingSchedule>
|
|
2941
|
+
>;
|
|
2942
|
+
|
|
2838
2943
|
/**
|
|
2839
2944
|
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
|
2840
2945
|
*/
|
|
@@ -2854,13 +2959,6 @@ declare module 'stripe' {
|
|
|
2854
2959
|
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
2855
2960
|
*/
|
|
2856
2961
|
proration_behavior?: ScheduleDetails.ProrationBehavior;
|
|
2857
|
-
|
|
2858
|
-
/**
|
|
2859
|
-
* Sets the billing schedules for the subscription schedule.
|
|
2860
|
-
*/
|
|
2861
|
-
billing_schedules?: Stripe.Emptyable<
|
|
2862
|
-
Array<ScheduleDetails.BillingSchedule>
|
|
2863
|
-
>;
|
|
2864
2962
|
}
|
|
2865
2963
|
|
|
2866
2964
|
namespace ScheduleDetails {
|
|
@@ -2880,11 +2978,21 @@ declare module 'stripe' {
|
|
|
2880
2978
|
*/
|
|
2881
2979
|
billing_cycle_anchor?: Amendment.BillingCycleAnchor;
|
|
2882
2980
|
|
|
2981
|
+
/**
|
|
2982
|
+
* Actions to apply to the billing schedules.
|
|
2983
|
+
*/
|
|
2984
|
+
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
2985
|
+
|
|
2883
2986
|
/**
|
|
2884
2987
|
* Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
2885
2988
|
*/
|
|
2886
2989
|
discount_actions?: Array<Amendment.DiscountAction>;
|
|
2887
2990
|
|
|
2991
|
+
/**
|
|
2992
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
2993
|
+
*/
|
|
2994
|
+
effective_at?: Amendment.EffectiveAt;
|
|
2995
|
+
|
|
2888
2996
|
/**
|
|
2889
2997
|
* Changes to the subscription items during the amendment time span.
|
|
2890
2998
|
*/
|
|
@@ -2914,16 +3022,6 @@ declare module 'stripe' {
|
|
|
2914
3022
|
* Settings related to subscription trials.
|
|
2915
3023
|
*/
|
|
2916
3024
|
trial_settings?: Amendment.TrialSettings;
|
|
2917
|
-
|
|
2918
|
-
/**
|
|
2919
|
-
* Actions to apply to the billing schedules.
|
|
2920
|
-
*/
|
|
2921
|
-
billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
|
|
2922
|
-
|
|
2923
|
-
/**
|
|
2924
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
2925
|
-
*/
|
|
2926
|
-
effective_at?: Amendment.EffectiveAt;
|
|
2927
3025
|
}
|
|
2928
3026
|
|
|
2929
3027
|
namespace Amendment {
|
|
@@ -3189,7 +3287,7 @@ declare module 'stripe' {
|
|
|
3189
3287
|
discounts?: Array<Add.Discount>;
|
|
3190
3288
|
|
|
3191
3289
|
/**
|
|
3192
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3290
|
+
* 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`.
|
|
3193
3291
|
*/
|
|
3194
3292
|
metadata?: Stripe.MetadataParam;
|
|
3195
3293
|
|
|
@@ -3625,7 +3723,7 @@ declare module 'stripe' {
|
|
|
3625
3723
|
automatic_tax?: Phase.AutomaticTax;
|
|
3626
3724
|
|
|
3627
3725
|
/**
|
|
3628
|
-
* 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/
|
|
3726
|
+
* 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).
|
|
3629
3727
|
*/
|
|
3630
3728
|
billing_cycle_anchor?: Phase.BillingCycleAnchor;
|
|
3631
3729
|
|
|
@@ -3650,7 +3748,7 @@ declare module 'stripe' {
|
|
|
3650
3748
|
default_payment_method?: string;
|
|
3651
3749
|
|
|
3652
3750
|
/**
|
|
3653
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
3751
|
+
* 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.
|
|
3654
3752
|
*/
|
|
3655
3753
|
default_tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
3656
3754
|
|
|
@@ -3670,7 +3768,12 @@ declare module 'stripe' {
|
|
|
3670
3768
|
duration?: Phase.Duration;
|
|
3671
3769
|
|
|
3672
3770
|
/**
|
|
3673
|
-
*
|
|
3771
|
+
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
3772
|
+
*/
|
|
3773
|
+
effective_at?: Phase.EffectiveAt;
|
|
3774
|
+
|
|
3775
|
+
/**
|
|
3776
|
+
* The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
3674
3777
|
*/
|
|
3675
3778
|
end_date?: number | 'now';
|
|
3676
3779
|
|
|
@@ -3685,7 +3788,7 @@ declare module 'stripe' {
|
|
|
3685
3788
|
items: Array<Phase.Item>;
|
|
3686
3789
|
|
|
3687
3790
|
/**
|
|
3688
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3791
|
+
* 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`.
|
|
3689
3792
|
*/
|
|
3690
3793
|
metadata?: Stripe.MetadataParam;
|
|
3691
3794
|
|
|
@@ -3695,12 +3798,12 @@ declare module 'stripe' {
|
|
|
3695
3798
|
on_behalf_of?: string;
|
|
3696
3799
|
|
|
3697
3800
|
/**
|
|
3698
|
-
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/
|
|
3801
|
+
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
3699
3802
|
*/
|
|
3700
3803
|
pause_collection?: Phase.PauseCollection;
|
|
3701
3804
|
|
|
3702
3805
|
/**
|
|
3703
|
-
* Controls whether the subscription schedule should create [prorations](https://stripe.com/
|
|
3806
|
+
* 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.
|
|
3704
3807
|
*/
|
|
3705
3808
|
proration_behavior?: Phase.ProrationBehavior;
|
|
3706
3809
|
|
|
@@ -3733,11 +3836,6 @@ declare module 'stripe' {
|
|
|
3733
3836
|
* Settings related to subscription trials.
|
|
3734
3837
|
*/
|
|
3735
3838
|
trial_settings?: Phase.TrialSettings;
|
|
3736
|
-
|
|
3737
|
-
/**
|
|
3738
|
-
* Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
3739
|
-
*/
|
|
3740
|
-
effective_at?: Phase.EffectiveAt;
|
|
3741
3839
|
}
|
|
3742
3840
|
|
|
3743
3841
|
namespace Phase {
|
|
@@ -3748,7 +3846,7 @@ declare module 'stripe' {
|
|
|
3748
3846
|
discounts?: Array<AddInvoiceItem.Discount>;
|
|
3749
3847
|
|
|
3750
3848
|
/**
|
|
3751
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
3849
|
+
* 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`.
|
|
3752
3850
|
*/
|
|
3753
3851
|
metadata?: Stripe.MetadataParam;
|
|
3754
3852
|
|
|
@@ -3763,7 +3861,7 @@ declare module 'stripe' {
|
|
|
3763
3861
|
price?: string;
|
|
3764
3862
|
|
|
3765
3863
|
/**
|
|
3766
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
3864
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
3767
3865
|
*/
|
|
3768
3866
|
price_data?: AddInvoiceItem.PriceData;
|
|
3769
3867
|
|
|
@@ -3901,7 +3999,7 @@ declare module 'stripe' {
|
|
|
3901
3999
|
product: string;
|
|
3902
4000
|
|
|
3903
4001
|
/**
|
|
3904
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
4002
|
+
* 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.
|
|
3905
4003
|
*/
|
|
3906
4004
|
tax_behavior?: PriceData.TaxBehavior;
|
|
3907
4005
|
|
|
@@ -4093,7 +4191,7 @@ declare module 'stripe' {
|
|
|
4093
4191
|
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
|
|
4094
4192
|
|
|
4095
4193
|
/**
|
|
4096
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
4194
|
+
* 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`.
|
|
4097
4195
|
*/
|
|
4098
4196
|
metadata?: Stripe.MetadataParam;
|
|
4099
4197
|
|
|
@@ -4108,7 +4206,7 @@ declare module 'stripe' {
|
|
|
4108
4206
|
price?: string;
|
|
4109
4207
|
|
|
4110
4208
|
/**
|
|
4111
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
4209
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
4112
4210
|
*/
|
|
4113
4211
|
price_data?: Item.PriceData;
|
|
4114
4212
|
|
|
@@ -4118,7 +4216,7 @@ declare module 'stripe' {
|
|
|
4118
4216
|
quantity?: number;
|
|
4119
4217
|
|
|
4120
4218
|
/**
|
|
4121
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
4219
|
+
* 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.
|
|
4122
4220
|
*/
|
|
4123
4221
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
4124
4222
|
|
|
@@ -4136,7 +4234,7 @@ declare module 'stripe' {
|
|
|
4136
4234
|
namespace Item {
|
|
4137
4235
|
interface BillingThresholds {
|
|
4138
4236
|
/**
|
|
4139
|
-
* 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/
|
|
4237
|
+
* 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))
|
|
4140
4238
|
*/
|
|
4141
4239
|
usage_gte: number;
|
|
4142
4240
|
}
|
|
@@ -4219,7 +4317,7 @@ declare module 'stripe' {
|
|
|
4219
4317
|
recurring: PriceData.Recurring;
|
|
4220
4318
|
|
|
4221
4319
|
/**
|
|
4222
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
4320
|
+
* 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.
|
|
4223
4321
|
*/
|
|
4224
4322
|
tax_behavior?: PriceData.TaxBehavior;
|
|
4225
4323
|
|
|
@@ -4397,7 +4495,7 @@ declare module 'stripe' {
|
|
|
4397
4495
|
|
|
4398
4496
|
interface SubscriptionDetails {
|
|
4399
4497
|
/**
|
|
4400
|
-
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/
|
|
4498
|
+
* 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`.
|
|
4401
4499
|
*/
|
|
4402
4500
|
billing_cycle_anchor?: SubscriptionDetails.BillingCycleAnchor | number;
|
|
4403
4501
|
|
|
@@ -4444,7 +4542,7 @@ declare module 'stripe' {
|
|
|
4444
4542
|
prebilling?: SubscriptionDetails.Prebilling;
|
|
4445
4543
|
|
|
4446
4544
|
/**
|
|
4447
|
-
* Determines how to handle [prorations](https://stripe.com/
|
|
4545
|
+
* 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`.
|
|
4448
4546
|
*/
|
|
4449
4547
|
proration_behavior?: SubscriptionDetails.ProrationBehavior;
|
|
4450
4548
|
|
|
@@ -4580,6 +4678,11 @@ declare module 'stripe' {
|
|
|
4580
4678
|
*/
|
|
4581
4679
|
clear_usage?: boolean;
|
|
4582
4680
|
|
|
4681
|
+
/**
|
|
4682
|
+
* The trial offer to apply to this subscription item.
|
|
4683
|
+
*/
|
|
4684
|
+
current_trial?: Item.CurrentTrial;
|
|
4685
|
+
|
|
4583
4686
|
/**
|
|
4584
4687
|
* A flag that, if set to `true`, will delete the specified item.
|
|
4585
4688
|
*/
|
|
@@ -4596,7 +4699,7 @@ declare module 'stripe' {
|
|
|
4596
4699
|
id?: string;
|
|
4597
4700
|
|
|
4598
4701
|
/**
|
|
4599
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
4702
|
+
* 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`.
|
|
4600
4703
|
*/
|
|
4601
4704
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
4602
4705
|
|
|
@@ -4611,7 +4714,7 @@ declare module 'stripe' {
|
|
|
4611
4714
|
price?: string;
|
|
4612
4715
|
|
|
4613
4716
|
/**
|
|
4614
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
4717
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
4615
4718
|
*/
|
|
4616
4719
|
price_data?: Item.PriceData;
|
|
4617
4720
|
|
|
@@ -4621,20 +4724,15 @@ declare module 'stripe' {
|
|
|
4621
4724
|
quantity?: number;
|
|
4622
4725
|
|
|
4623
4726
|
/**
|
|
4624
|
-
* A list of [Tax Rate](https://stripe.com/
|
|
4727
|
+
* 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.
|
|
4625
4728
|
*/
|
|
4626
4729
|
tax_rates?: Stripe.Emptyable<Array<string>>;
|
|
4627
|
-
|
|
4628
|
-
/**
|
|
4629
|
-
* The trial offer to apply to this subscription item.
|
|
4630
|
-
*/
|
|
4631
|
-
current_trial?: Item.CurrentTrial;
|
|
4632
4730
|
}
|
|
4633
4731
|
|
|
4634
4732
|
namespace Item {
|
|
4635
4733
|
interface BillingThresholds {
|
|
4636
4734
|
/**
|
|
4637
|
-
* 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/
|
|
4735
|
+
* 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))
|
|
4638
4736
|
*/
|
|
4639
4737
|
usage_gte: number;
|
|
4640
4738
|
}
|
|
@@ -4729,7 +4827,7 @@ declare module 'stripe' {
|
|
|
4729
4827
|
recurring: PriceData.Recurring;
|
|
4730
4828
|
|
|
4731
4829
|
/**
|
|
4732
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
4830
|
+
* 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.
|
|
4733
4831
|
*/
|
|
4734
4832
|
tax_behavior?: PriceData.TaxBehavior;
|
|
4735
4833
|
|
|
@@ -4781,7 +4879,7 @@ declare module 'stripe' {
|
|
|
4781
4879
|
|
|
4782
4880
|
interface InvoiceFinalizeInvoiceParams {
|
|
4783
4881
|
/**
|
|
4784
|
-
* Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
4882
|
+
* 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.
|
|
4785
4883
|
*/
|
|
4786
4884
|
auto_advance?: boolean;
|
|
4787
4885
|
|
|
@@ -4856,7 +4954,7 @@ declare module 'stripe' {
|
|
|
4856
4954
|
expand?: Array<string>;
|
|
4857
4955
|
|
|
4858
4956
|
/**
|
|
4859
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
4957
|
+
* 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`.
|
|
4860
4958
|
*/
|
|
4861
4959
|
invoice_metadata?: Stripe.Emptyable<{
|
|
4862
4960
|
[key: string]: string;
|
|
@@ -4883,7 +4981,7 @@ declare module 'stripe' {
|
|
|
4883
4981
|
|
|
4884
4982
|
interface InvoiceSearchParams {
|
|
4885
4983
|
/**
|
|
4886
|
-
* The search query string. See [search query language](https://stripe.com/
|
|
4984
|
+
* 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).
|
|
4887
4985
|
*/
|
|
4888
4986
|
query: string;
|
|
4889
4987
|
|
|
@@ -4922,7 +5020,7 @@ declare module 'stripe' {
|
|
|
4922
5020
|
expand?: Array<string>;
|
|
4923
5021
|
|
|
4924
5022
|
/**
|
|
4925
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
5023
|
+
* 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.
|
|
4926
5024
|
*/
|
|
4927
5025
|
invoice_metadata?: Stripe.Emptyable<{
|
|
4928
5026
|
[key: string]: string;
|
|
@@ -4962,17 +5060,17 @@ declare module 'stripe' {
|
|
|
4962
5060
|
margins?: Stripe.Emptyable<Array<string>>;
|
|
4963
5061
|
|
|
4964
5062
|
/**
|
|
4965
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
5063
|
+
* 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.
|
|
4966
5064
|
*/
|
|
4967
5065
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
4968
5066
|
|
|
4969
5067
|
/**
|
|
4970
|
-
* 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/
|
|
5068
|
+
* 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.
|
|
4971
5069
|
*/
|
|
4972
5070
|
period?: Line.Period;
|
|
4973
5071
|
|
|
4974
5072
|
/**
|
|
4975
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
5073
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
4976
5074
|
*/
|
|
4977
5075
|
price_data?: Line.PriceData;
|
|
4978
5076
|
|
|
@@ -4987,7 +5085,7 @@ declare module 'stripe' {
|
|
|
4987
5085
|
quantity?: number;
|
|
4988
5086
|
|
|
4989
5087
|
/**
|
|
4990
|
-
* 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/
|
|
5088
|
+
* 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.
|
|
4991
5089
|
*/
|
|
4992
5090
|
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
|
|
4993
5091
|
|
|
@@ -5088,7 +5186,7 @@ declare module 'stripe' {
|
|
|
5088
5186
|
product_data?: PriceData.ProductData;
|
|
5089
5187
|
|
|
5090
5188
|
/**
|
|
5091
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
5189
|
+
* 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.
|
|
5092
5190
|
*/
|
|
5093
5191
|
tax_behavior?: PriceData.TaxBehavior;
|
|
5094
5192
|
|
|
@@ -5116,7 +5214,7 @@ declare module 'stripe' {
|
|
|
5116
5214
|
images?: Array<string>;
|
|
5117
5215
|
|
|
5118
5216
|
/**
|
|
5119
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
5217
|
+
* 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`.
|
|
5120
5218
|
*/
|
|
5121
5219
|
metadata?: Stripe.MetadataParam;
|
|
5122
5220
|
|
|
@@ -5126,7 +5224,7 @@ declare module 'stripe' {
|
|
|
5126
5224
|
name: string;
|
|
5127
5225
|
|
|
5128
5226
|
/**
|
|
5129
|
-
* A [tax code](https://stripe.com/
|
|
5227
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5130
5228
|
*/
|
|
5131
5229
|
tax_code?: string;
|
|
5132
5230
|
|
|
@@ -5134,6 +5232,20 @@ declare module 'stripe' {
|
|
|
5134
5232
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
5135
5233
|
*/
|
|
5136
5234
|
unit_label?: string;
|
|
5235
|
+
|
|
5236
|
+
/**
|
|
5237
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
5238
|
+
*/
|
|
5239
|
+
tax_details?: ProductData.TaxDetails;
|
|
5240
|
+
}
|
|
5241
|
+
|
|
5242
|
+
namespace ProductData {
|
|
5243
|
+
interface TaxDetails {
|
|
5244
|
+
/**
|
|
5245
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5246
|
+
*/
|
|
5247
|
+
tax_code: string;
|
|
5248
|
+
}
|
|
5137
5249
|
}
|
|
5138
5250
|
|
|
5139
5251
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|
|
@@ -5296,17 +5408,17 @@ declare module 'stripe' {
|
|
|
5296
5408
|
margins?: Stripe.Emptyable<Array<string>>;
|
|
5297
5409
|
|
|
5298
5410
|
/**
|
|
5299
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
5411
|
+
* 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.
|
|
5300
5412
|
*/
|
|
5301
5413
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
5302
5414
|
|
|
5303
5415
|
/**
|
|
5304
|
-
* 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/
|
|
5416
|
+
* 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.
|
|
5305
5417
|
*/
|
|
5306
5418
|
period?: InvoiceUpdateLineItemParams.Period;
|
|
5307
5419
|
|
|
5308
5420
|
/**
|
|
5309
|
-
* Data used to generate a new [Price](https://stripe.com/
|
|
5421
|
+
* Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
5310
5422
|
*/
|
|
5311
5423
|
price_data?: InvoiceUpdateLineItemParams.PriceData;
|
|
5312
5424
|
|
|
@@ -5321,7 +5433,7 @@ declare module 'stripe' {
|
|
|
5321
5433
|
quantity?: number;
|
|
5322
5434
|
|
|
5323
5435
|
/**
|
|
5324
|
-
* 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/
|
|
5436
|
+
* 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.
|
|
5325
5437
|
*/
|
|
5326
5438
|
tax_amounts?: Stripe.Emptyable<
|
|
5327
5439
|
Array<InvoiceUpdateLineItemParams.TaxAmount>
|
|
@@ -5424,7 +5536,7 @@ declare module 'stripe' {
|
|
|
5424
5536
|
product_data?: PriceData.ProductData;
|
|
5425
5537
|
|
|
5426
5538
|
/**
|
|
5427
|
-
* Only required if a [default tax behavior](https://stripe.com/
|
|
5539
|
+
* 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.
|
|
5428
5540
|
*/
|
|
5429
5541
|
tax_behavior?: PriceData.TaxBehavior;
|
|
5430
5542
|
|
|
@@ -5452,7 +5564,7 @@ declare module 'stripe' {
|
|
|
5452
5564
|
images?: Array<string>;
|
|
5453
5565
|
|
|
5454
5566
|
/**
|
|
5455
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
5567
|
+
* 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`.
|
|
5456
5568
|
*/
|
|
5457
5569
|
metadata?: Stripe.MetadataParam;
|
|
5458
5570
|
|
|
@@ -5462,7 +5574,7 @@ declare module 'stripe' {
|
|
|
5462
5574
|
name: string;
|
|
5463
5575
|
|
|
5464
5576
|
/**
|
|
5465
|
-
* A [tax code](https://stripe.com/
|
|
5577
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5466
5578
|
*/
|
|
5467
5579
|
tax_code?: string;
|
|
5468
5580
|
|
|
@@ -5470,6 +5582,20 @@ declare module 'stripe' {
|
|
|
5470
5582
|
* A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
5471
5583
|
*/
|
|
5472
5584
|
unit_label?: string;
|
|
5585
|
+
|
|
5586
|
+
/**
|
|
5587
|
+
* Tax details for this product, including the [tax code](https://docs.stripe.com/tax/tax-codes) and an optional performance location.
|
|
5588
|
+
*/
|
|
5589
|
+
tax_details?: ProductData.TaxDetails;
|
|
5590
|
+
}
|
|
5591
|
+
|
|
5592
|
+
namespace ProductData {
|
|
5593
|
+
interface TaxDetails {
|
|
5594
|
+
/**
|
|
5595
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
5596
|
+
*/
|
|
5597
|
+
tax_code: string;
|
|
5598
|
+
}
|
|
5473
5599
|
}
|
|
5474
5600
|
|
|
5475
5601
|
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
|