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
|
@@ -18,12 +18,12 @@ declare module 'stripe' {
|
|
|
18
18
|
object: 'tax.calculation_line_item';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* The line item amount in the [smallest currency unit](https://stripe.com/
|
|
21
|
+
* The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
|
|
22
22
|
*/
|
|
23
23
|
amount: number;
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/
|
|
26
|
+
* The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
27
27
|
*/
|
|
28
28
|
amount_tax: number;
|
|
29
29
|
|
|
@@ -33,12 +33,12 @@ declare module 'stripe' {
|
|
|
33
33
|
livemode: boolean;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
36
|
+
* 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.
|
|
37
37
|
*/
|
|
38
38
|
metadata: Stripe.Metadata | null;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* The ID of an existing [Product](https://stripe.com/
|
|
41
|
+
* The ID of an existing [Product](https://docs.stripe.com/api/products/object).
|
|
42
42
|
*/
|
|
43
43
|
product: string | null;
|
|
44
44
|
|
|
@@ -63,7 +63,7 @@ declare module 'stripe' {
|
|
|
63
63
|
tax_breakdown?: Array<CalculationLineItem.TaxBreakdown> | null;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* The [tax code](https://stripe.com/
|
|
66
|
+
* The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
|
|
67
67
|
*/
|
|
68
68
|
tax_code: string;
|
|
69
69
|
}
|
|
@@ -73,7 +73,7 @@ declare module 'stripe' {
|
|
|
73
73
|
|
|
74
74
|
interface TaxBreakdown {
|
|
75
75
|
/**
|
|
76
|
-
* The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
76
|
+
* The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
77
77
|
*/
|
|
78
78
|
amount: number;
|
|
79
79
|
|
|
@@ -95,7 +95,7 @@ declare module 'stripe' {
|
|
|
95
95
|
taxability_reason: TaxBreakdown.TaxabilityReason;
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
|
-
* The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
98
|
+
* The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
99
99
|
*/
|
|
100
100
|
taxable_amount: number;
|
|
101
101
|
}
|
|
@@ -6,7 +6,7 @@ declare module 'stripe' {
|
|
|
6
6
|
/**
|
|
7
7
|
* A Tax Calculation allows you to calculate the tax to collect from your customer.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [Calculate tax in your custom payment flow](https://stripe.com/
|
|
9
|
+
* Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
|
|
10
10
|
*/
|
|
11
11
|
interface Calculation {
|
|
12
12
|
/**
|
|
@@ -20,7 +20,7 @@ declare module 'stripe' {
|
|
|
20
20
|
object: 'tax.calculation';
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* Total amount after taxes in the [smallest currency unit](https://stripe.com/
|
|
23
|
+
* Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
24
24
|
*/
|
|
25
25
|
amount_total: number;
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ declare module 'stripe' {
|
|
|
30
30
|
currency: string;
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
* The ID of an existing [Customer](https://stripe.com/
|
|
33
|
+
* The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
|
|
34
34
|
*/
|
|
35
35
|
customer: string | null;
|
|
36
36
|
|
|
@@ -252,17 +252,17 @@ declare module 'stripe' {
|
|
|
252
252
|
|
|
253
253
|
interface ShippingCost {
|
|
254
254
|
/**
|
|
255
|
-
* The shipping amount in the [smallest currency unit](https://stripe.com/
|
|
255
|
+
* The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
|
|
256
256
|
*/
|
|
257
257
|
amount: number;
|
|
258
258
|
|
|
259
259
|
/**
|
|
260
|
-
* The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/
|
|
260
|
+
* The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
261
261
|
*/
|
|
262
262
|
amount_tax: number;
|
|
263
263
|
|
|
264
264
|
/**
|
|
265
|
-
* The ID of an existing [ShippingRate](https://stripe.com/
|
|
265
|
+
* The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
|
|
266
266
|
*/
|
|
267
267
|
shipping_rate?: string;
|
|
268
268
|
|
|
@@ -277,7 +277,7 @@ declare module 'stripe' {
|
|
|
277
277
|
tax_breakdown?: Array<ShippingCost.TaxBreakdown>;
|
|
278
278
|
|
|
279
279
|
/**
|
|
280
|
-
* The [tax code](https://stripe.com/
|
|
280
|
+
* The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
|
|
281
281
|
*/
|
|
282
282
|
tax_code: string;
|
|
283
283
|
}
|
|
@@ -287,7 +287,7 @@ declare module 'stripe' {
|
|
|
287
287
|
|
|
288
288
|
interface TaxBreakdown {
|
|
289
289
|
/**
|
|
290
|
-
* The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
290
|
+
* The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
291
291
|
*/
|
|
292
292
|
amount: number;
|
|
293
293
|
|
|
@@ -309,7 +309,7 @@ declare module 'stripe' {
|
|
|
309
309
|
taxability_reason: TaxBreakdown.TaxabilityReason;
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
312
|
+
* The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
313
313
|
*/
|
|
314
314
|
taxable_amount: number;
|
|
315
315
|
}
|
|
@@ -399,7 +399,7 @@ declare module 'stripe' {
|
|
|
399
399
|
|
|
400
400
|
interface TaxBreakdown {
|
|
401
401
|
/**
|
|
402
|
-
* The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
402
|
+
* The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
403
403
|
*/
|
|
404
404
|
amount: number;
|
|
405
405
|
|
|
@@ -416,7 +416,7 @@ declare module 'stripe' {
|
|
|
416
416
|
taxability_reason: TaxBreakdown.TaxabilityReason;
|
|
417
417
|
|
|
418
418
|
/**
|
|
419
|
-
* The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
419
|
+
* The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
420
420
|
*/
|
|
421
421
|
taxable_amount: number;
|
|
422
422
|
}
|
|
@@ -461,7 +461,7 @@ declare module 'stripe' {
|
|
|
461
461
|
rate_type: TaxRateDetails.RateType | null;
|
|
462
462
|
|
|
463
463
|
/**
|
|
464
|
-
* State, county, province, or region.
|
|
464
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
465
465
|
*/
|
|
466
466
|
state: string | null;
|
|
467
467
|
|
|
@@ -242,13 +242,13 @@ declare module 'stripe' {
|
|
|
242
242
|
|
|
243
243
|
interface LineItem {
|
|
244
244
|
/**
|
|
245
|
-
* A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/
|
|
245
|
+
* A positive integer representing the line item's total price in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
246
246
|
* If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
247
247
|
*/
|
|
248
248
|
amount: number;
|
|
249
249
|
|
|
250
250
|
/**
|
|
251
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
251
|
+
* 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.
|
|
252
252
|
*/
|
|
253
253
|
metadata?: Stripe.MetadataParam;
|
|
254
254
|
|
|
@@ -263,7 +263,7 @@ declare module 'stripe' {
|
|
|
263
263
|
quantity?: number;
|
|
264
264
|
|
|
265
265
|
/**
|
|
266
|
-
* A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/
|
|
266
|
+
* A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://docs.stripe.com/tax/reports).
|
|
267
267
|
*/
|
|
268
268
|
reference?: string;
|
|
269
269
|
|
|
@@ -273,7 +273,7 @@ declare module 'stripe' {
|
|
|
273
273
|
tax_behavior?: LineItem.TaxBehavior;
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* A [tax code](https://stripe.com/
|
|
276
|
+
* A [tax code](https://docs.stripe.com/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.
|
|
277
277
|
*/
|
|
278
278
|
tax_code?: string;
|
|
279
279
|
}
|
|
@@ -325,12 +325,12 @@ declare module 'stripe' {
|
|
|
325
325
|
|
|
326
326
|
interface ShippingCost {
|
|
327
327
|
/**
|
|
328
|
-
* A positive integer in the [smallest currency unit](https://stripe.com/
|
|
328
|
+
* A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
329
329
|
*/
|
|
330
330
|
amount?: number;
|
|
331
331
|
|
|
332
332
|
/**
|
|
333
|
-
* If provided, the [shipping rate](https://stripe.com/
|
|
333
|
+
* If provided, the [shipping rate](https://docs.stripe.com/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.
|
|
334
334
|
*/
|
|
335
335
|
shipping_rate?: string;
|
|
336
336
|
|
|
@@ -340,7 +340,7 @@ declare module 'stripe' {
|
|
|
340
340
|
tax_behavior?: ShippingCost.TaxBehavior;
|
|
341
341
|
|
|
342
342
|
/**
|
|
343
|
-
* The [tax code](https://stripe.com/
|
|
343
|
+
* The [tax code](https://docs.stripe.com/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.
|
|
344
344
|
*/
|
|
345
345
|
tax_code?: string;
|
|
346
346
|
}
|
|
@@ -4,11 +4,11 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
namespace Tax {
|
|
6
6
|
/**
|
|
7
|
-
* A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/
|
|
7
|
+
* A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax).
|
|
8
8
|
*
|
|
9
|
-
* Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/
|
|
9
|
+
* Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering).
|
|
10
10
|
*
|
|
11
|
-
* Related guide: [Using the Registrations API](https://stripe.com/
|
|
11
|
+
* Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)
|
|
12
12
|
*/
|
|
13
13
|
interface Registration {
|
|
14
14
|
/**
|
package/types/Tax/Settings.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ declare module 'stripe' {
|
|
|
6
6
|
/**
|
|
7
7
|
* You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [Using the Settings API](https://stripe.com/
|
|
9
|
+
* Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)
|
|
10
10
|
*/
|
|
11
11
|
interface Settings {
|
|
12
12
|
/**
|
|
@@ -18,12 +18,12 @@ declare module 'stripe' {
|
|
|
18
18
|
object: 'tax.transaction_line_item';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* The line item amount in the [smallest currency unit](https://stripe.com/
|
|
21
|
+
* The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
|
|
22
22
|
*/
|
|
23
23
|
amount: number;
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/
|
|
26
|
+
* The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
27
27
|
*/
|
|
28
28
|
amount_tax: number;
|
|
29
29
|
|
|
@@ -33,12 +33,12 @@ declare module 'stripe' {
|
|
|
33
33
|
livemode: boolean;
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
36
|
+
* 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.
|
|
37
37
|
*/
|
|
38
38
|
metadata: Stripe.Metadata | null;
|
|
39
39
|
|
|
40
40
|
/**
|
|
41
|
-
* The ID of an existing [Product](https://stripe.com/
|
|
41
|
+
* The ID of an existing [Product](https://docs.stripe.com/api/products/object).
|
|
42
42
|
*/
|
|
43
43
|
product: string | null;
|
|
44
44
|
|
|
@@ -63,7 +63,7 @@ declare module 'stripe' {
|
|
|
63
63
|
tax_behavior: TransactionLineItem.TaxBehavior;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* The [tax code](https://stripe.com/
|
|
66
|
+
* The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
|
|
67
67
|
*/
|
|
68
68
|
tax_code: string;
|
|
69
69
|
|
|
@@ -6,7 +6,7 @@ declare module 'stripe' {
|
|
|
6
6
|
/**
|
|
7
7
|
* A Tax Transaction records the tax collected from or refunded to your customer.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [Calculate tax in your custom payment flow](https://stripe.com/
|
|
9
|
+
* Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction)
|
|
10
10
|
*/
|
|
11
11
|
interface Transaction {
|
|
12
12
|
/**
|
|
@@ -30,7 +30,7 @@ declare module 'stripe' {
|
|
|
30
30
|
currency: string;
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
|
-
* The ID of an existing [Customer](https://stripe.com/
|
|
33
|
+
* The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
|
|
34
34
|
*/
|
|
35
35
|
customer: string | null;
|
|
36
36
|
|
|
@@ -47,7 +47,7 @@ declare module 'stripe' {
|
|
|
47
47
|
livemode: boolean;
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
50
|
+
* 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.
|
|
51
51
|
*/
|
|
52
52
|
metadata: Stripe.Metadata | null;
|
|
53
53
|
|
|
@@ -264,17 +264,17 @@ declare module 'stripe' {
|
|
|
264
264
|
|
|
265
265
|
interface ShippingCost {
|
|
266
266
|
/**
|
|
267
|
-
* The shipping amount in the [smallest currency unit](https://stripe.com/
|
|
267
|
+
* The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
|
|
268
268
|
*/
|
|
269
269
|
amount: number;
|
|
270
270
|
|
|
271
271
|
/**
|
|
272
|
-
* The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/
|
|
272
|
+
* The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
273
273
|
*/
|
|
274
274
|
amount_tax: number;
|
|
275
275
|
|
|
276
276
|
/**
|
|
277
|
-
* The ID of an existing [ShippingRate](https://stripe.com/
|
|
277
|
+
* The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
|
|
278
278
|
*/
|
|
279
279
|
shipping_rate?: string;
|
|
280
280
|
|
|
@@ -289,7 +289,7 @@ declare module 'stripe' {
|
|
|
289
289
|
tax_breakdown?: Array<ShippingCost.TaxBreakdown>;
|
|
290
290
|
|
|
291
291
|
/**
|
|
292
|
-
* The [tax code](https://stripe.com/
|
|
292
|
+
* The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
|
|
293
293
|
*/
|
|
294
294
|
tax_code: string;
|
|
295
295
|
}
|
|
@@ -299,7 +299,7 @@ declare module 'stripe' {
|
|
|
299
299
|
|
|
300
300
|
interface TaxBreakdown {
|
|
301
301
|
/**
|
|
302
|
-
* The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
302
|
+
* The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
303
303
|
*/
|
|
304
304
|
amount: number;
|
|
305
305
|
|
|
@@ -321,7 +321,7 @@ declare module 'stripe' {
|
|
|
321
321
|
taxability_reason: TaxBreakdown.TaxabilityReason;
|
|
322
322
|
|
|
323
323
|
/**
|
|
324
|
-
* The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
324
|
+
* The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
325
325
|
*/
|
|
326
326
|
taxable_amount: number;
|
|
327
327
|
}
|
|
@@ -27,7 +27,7 @@ declare module 'stripe' {
|
|
|
27
27
|
expand?: Array<string>;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
30
|
+
* 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`.
|
|
31
31
|
*/
|
|
32
32
|
metadata?: Stripe.MetadataParam;
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ declare module 'stripe' {
|
|
|
49
49
|
original_transaction: string;
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/
|
|
52
|
+
* A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports).
|
|
53
53
|
*/
|
|
54
54
|
reference: string;
|
|
55
55
|
|
|
@@ -59,7 +59,7 @@ declare module 'stripe' {
|
|
|
59
59
|
expand?: Array<string>;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/
|
|
62
|
+
* A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.
|
|
63
63
|
*/
|
|
64
64
|
flat_amount?: number;
|
|
65
65
|
|
|
@@ -69,7 +69,7 @@ declare module 'stripe' {
|
|
|
69
69
|
line_items?: Array<TransactionCreateReversalParams.LineItem>;
|
|
70
70
|
|
|
71
71
|
/**
|
|
72
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
72
|
+
* 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`.
|
|
73
73
|
*/
|
|
74
74
|
metadata?: Stripe.MetadataParam;
|
|
75
75
|
|
|
@@ -82,17 +82,17 @@ declare module 'stripe' {
|
|
|
82
82
|
namespace TransactionCreateReversalParams {
|
|
83
83
|
interface LineItem {
|
|
84
84
|
/**
|
|
85
|
-
* The amount to reverse, in the [smallest currency unit](https://stripe.com/
|
|
85
|
+
* The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
86
86
|
*/
|
|
87
87
|
amount: number;
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/
|
|
90
|
+
* The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
91
91
|
*/
|
|
92
92
|
amount_tax: number;
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
95
|
+
* 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.
|
|
96
96
|
*/
|
|
97
97
|
metadata?: Stripe.MetadataParam;
|
|
98
98
|
|
|
@@ -102,7 +102,7 @@ declare module 'stripe' {
|
|
|
102
102
|
original_line_item: string;
|
|
103
103
|
|
|
104
104
|
/**
|
|
105
|
-
* The quantity reversed. Appears in [tax exports](https://stripe.com/
|
|
105
|
+
* The quantity reversed. Appears in [tax exports](https://docs.stripe.com/tax/reports), but does not affect the amount of tax reversed.
|
|
106
106
|
*/
|
|
107
107
|
quantity?: number;
|
|
108
108
|
|
|
@@ -116,12 +116,12 @@ declare module 'stripe' {
|
|
|
116
116
|
|
|
117
117
|
interface ShippingCost {
|
|
118
118
|
/**
|
|
119
|
-
* The amount to reverse, in the [smallest currency unit](https://stripe.com/
|
|
119
|
+
* The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
120
120
|
*/
|
|
121
121
|
amount: number;
|
|
122
122
|
|
|
123
123
|
/**
|
|
124
|
-
* The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/
|
|
124
|
+
* The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
125
125
|
*/
|
|
126
126
|
amount_tax: number;
|
|
127
127
|
}
|
package/types/TaxIds.d.ts
CHANGED
|
@@ -23,10 +23,10 @@ declare module 'stripe' {
|
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
* You can add one or multiple tax IDs to a [customer](https://stripe.com/
|
|
26
|
+
* You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account.
|
|
27
27
|
* Customer and account tax IDs get displayed on related invoices and credit notes.
|
|
28
28
|
*
|
|
29
|
-
* Related guides: [Customer tax identification numbers](https://stripe.com/
|
|
29
|
+
* Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids)
|
|
30
30
|
*/
|
|
31
31
|
interface TaxId {
|
|
32
32
|
/**
|
|
@@ -55,9 +55,9 @@ declare module 'stripe' {
|
|
|
55
55
|
customer: string | Stripe.Customer | null;
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
|
-
* ID of the
|
|
58
|
+
* ID of the Account representing the customer.
|
|
59
59
|
*/
|
|
60
|
-
customer_account
|
|
60
|
+
customer_account: string | null;
|
|
61
61
|
|
|
62
62
|
/**
|
|
63
63
|
* Always true for a deleted object
|
|
@@ -108,9 +108,9 @@ declare module 'stripe' {
|
|
|
108
108
|
customer?: string | Stripe.Customer;
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* The
|
|
111
|
+
* The Account representing the customer being referenced when `type` is `customer`.
|
|
112
112
|
*/
|
|
113
|
-
customer_account
|
|
113
|
+
customer_account: string | null;
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
116
|
* Type of owner referenced.
|
|
@@ -27,7 +27,7 @@ declare module 'stripe' {
|
|
|
27
27
|
namespace TaxIdCreateParams {
|
|
28
28
|
interface Owner {
|
|
29
29
|
/**
|
|
30
|
-
* Account the tax ID belongs to. Required when `type=account`
|
|
30
|
+
* Connected Account the tax ID belongs to. Required when `type=account`
|
|
31
31
|
*/
|
|
32
32
|
account?: string;
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ declare module 'stripe' {
|
|
|
37
37
|
customer?: string;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
40
|
+
* ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer`
|
|
41
41
|
*/
|
|
42
42
|
customer_account?: string;
|
|
43
43
|
|
|
@@ -186,7 +186,7 @@ declare module 'stripe' {
|
|
|
186
186
|
namespace TaxIdListParams {
|
|
187
187
|
interface Owner {
|
|
188
188
|
/**
|
|
189
|
-
* Account the tax ID belongs to. Required when `type=account`
|
|
189
|
+
* Connected Account the tax ID belongs to. Required when `type=account`
|
|
190
190
|
*/
|
|
191
191
|
account?: string;
|
|
192
192
|
|
|
@@ -196,7 +196,7 @@ declare module 'stripe' {
|
|
|
196
196
|
customer?: string;
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
|
-
*
|
|
199
|
+
* ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer`
|
|
200
200
|
*/
|
|
201
201
|
customer_account?: string;
|
|
202
202
|
|
package/types/TaxRates.d.ts
CHANGED
|
@@ -76,7 +76,7 @@ declare module 'stripe' {
|
|
|
76
76
|
livemode: boolean;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
79
|
+
* 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.
|
|
80
80
|
*/
|
|
81
81
|
metadata: Stripe.Metadata | null;
|
|
82
82
|
|
|
@@ -44,7 +44,7 @@ declare module 'stripe' {
|
|
|
44
44
|
jurisdiction?: string;
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
47
|
+
* 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`.
|
|
48
48
|
*/
|
|
49
49
|
metadata?: Stripe.MetadataParam;
|
|
50
50
|
|
|
@@ -116,7 +116,7 @@ declare module 'stripe' {
|
|
|
116
116
|
jurisdiction?: string;
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
119
|
+
* 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`.
|
|
120
120
|
*/
|
|
121
121
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
122
122
|
|
|
@@ -6,7 +6,7 @@ declare module 'stripe' {
|
|
|
6
6
|
/**
|
|
7
7
|
* A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [Fleet management](https://stripe.com/
|
|
9
|
+
* Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
|
|
10
10
|
*/
|
|
11
11
|
interface ConnectionToken {
|
|
12
12
|
/**
|
|
@@ -26,7 +26,7 @@ declare module 'stripe' {
|
|
|
26
26
|
/**
|
|
27
27
|
* A Location represents a grouping of readers.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: [Fleet management](https://stripe.com/
|
|
29
|
+
* Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
|
|
30
30
|
*/
|
|
31
31
|
interface Location {
|
|
32
32
|
/**
|
|
@@ -76,7 +76,7 @@ declare module 'stripe' {
|
|
|
76
76
|
livemode: boolean;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
79
|
+
* 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.
|
|
80
80
|
*/
|
|
81
81
|
metadata: Stripe.Metadata;
|
|
82
82
|
|
|
@@ -45,7 +45,7 @@ declare module 'stripe' {
|
|
|
45
45
|
expand?: Array<string>;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
48
|
+
* 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`.
|
|
49
49
|
*/
|
|
50
50
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
51
51
|
|
|
@@ -83,7 +83,7 @@ declare module 'stripe' {
|
|
|
83
83
|
postal_code?: string;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
|
-
* State, county, province, or region.
|
|
86
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
87
87
|
*/
|
|
88
88
|
state?: string;
|
|
89
89
|
}
|
|
@@ -138,7 +138,7 @@ declare module 'stripe' {
|
|
|
138
138
|
expand?: Array<string>;
|
|
139
139
|
|
|
140
140
|
/**
|
|
141
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
141
|
+
* 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`.
|
|
142
142
|
*/
|
|
143
143
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
144
144
|
|