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
|
@@ -4,11 +4,11 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
namespace Issuing {
|
|
6
6
|
/**
|
|
7
|
-
* When an [issued card](https://stripe.com/
|
|
8
|
-
* object is created. [Authorizations](https://stripe.com/
|
|
7
|
+
* When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization`
|
|
8
|
+
* object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the
|
|
9
9
|
* purchase to be completed successfully.
|
|
10
10
|
*
|
|
11
|
-
* Related guide: [Issued card authorizations](https://stripe.com/
|
|
11
|
+
* Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations)
|
|
12
12
|
*/
|
|
13
13
|
interface Authorization {
|
|
14
14
|
/**
|
|
@@ -27,7 +27,7 @@ declare module 'stripe' {
|
|
|
27
27
|
amount: number;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
30
|
+
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
31
31
|
*/
|
|
32
32
|
amount_details: Authorization.AmountDetails | null;
|
|
33
33
|
|
|
@@ -47,7 +47,7 @@ declare module 'stripe' {
|
|
|
47
47
|
balance_transactions: Array<Stripe.BalanceTransaction>;
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
* You can [create physical or virtual cards](https://stripe.com/
|
|
50
|
+
* You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.
|
|
51
51
|
*/
|
|
52
52
|
card: Stripe.Issuing.Card;
|
|
53
53
|
|
|
@@ -99,7 +99,7 @@ declare module 'stripe' {
|
|
|
99
99
|
merchant_data: Authorization.MerchantData;
|
|
100
100
|
|
|
101
101
|
/**
|
|
102
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
102
|
+
* 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.
|
|
103
103
|
*/
|
|
104
104
|
metadata: Stripe.Metadata;
|
|
105
105
|
|
|
@@ -124,17 +124,17 @@ declare module 'stripe' {
|
|
|
124
124
|
status: Authorization.Status;
|
|
125
125
|
|
|
126
126
|
/**
|
|
127
|
-
* [Token](https://stripe.com/
|
|
127
|
+
* [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
|
|
128
128
|
*/
|
|
129
129
|
token?: string | Stripe.Issuing.Token | null;
|
|
130
130
|
|
|
131
131
|
/**
|
|
132
|
-
* List of [transactions](https://stripe.com/
|
|
132
|
+
* List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization.
|
|
133
133
|
*/
|
|
134
134
|
transactions: Array<Stripe.Issuing.Transaction>;
|
|
135
135
|
|
|
136
136
|
/**
|
|
137
|
-
* [Treasury](https://stripe.com/
|
|
137
|
+
* [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts).
|
|
138
138
|
*/
|
|
139
139
|
treasury?: Authorization.Treasury | null;
|
|
140
140
|
|
|
@@ -361,7 +361,7 @@ declare module 'stripe' {
|
|
|
361
361
|
|
|
362
362
|
interface MerchantData {
|
|
363
363
|
/**
|
|
364
|
-
* A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/
|
|
364
|
+
* A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.
|
|
365
365
|
*/
|
|
366
366
|
category: string;
|
|
367
367
|
|
|
@@ -435,12 +435,12 @@ declare module 'stripe' {
|
|
|
435
435
|
|
|
436
436
|
interface PendingRequest {
|
|
437
437
|
/**
|
|
438
|
-
* The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/
|
|
438
|
+
* The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
439
439
|
*/
|
|
440
440
|
amount: number;
|
|
441
441
|
|
|
442
442
|
/**
|
|
443
|
-
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
443
|
+
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
444
444
|
*/
|
|
445
445
|
amount_details: PendingRequest.AmountDetails | null;
|
|
446
446
|
|
|
@@ -450,12 +450,12 @@ declare module 'stripe' {
|
|
|
450
450
|
currency: string;
|
|
451
451
|
|
|
452
452
|
/**
|
|
453
|
-
* If set `true`, you may provide [amount](https://stripe.com/
|
|
453
|
+
* If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
|
|
454
454
|
*/
|
|
455
455
|
is_amount_controllable: boolean;
|
|
456
456
|
|
|
457
457
|
/**
|
|
458
|
-
* The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/
|
|
458
|
+
* The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
459
459
|
*/
|
|
460
460
|
merchant_amount: number;
|
|
461
461
|
|
|
@@ -486,12 +486,12 @@ declare module 'stripe' {
|
|
|
486
486
|
|
|
487
487
|
interface RequestHistory {
|
|
488
488
|
/**
|
|
489
|
-
* The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/
|
|
489
|
+
* The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
|
|
490
490
|
*/
|
|
491
491
|
amount: number;
|
|
492
492
|
|
|
493
493
|
/**
|
|
494
|
-
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
494
|
+
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
495
495
|
*/
|
|
496
496
|
amount_details: RequestHistory.AmountDetails | null;
|
|
497
497
|
|
|
@@ -516,7 +516,7 @@ declare module 'stripe' {
|
|
|
516
516
|
currency: string;
|
|
517
517
|
|
|
518
518
|
/**
|
|
519
|
-
* The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/
|
|
519
|
+
* The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
520
520
|
*/
|
|
521
521
|
merchant_amount: number;
|
|
522
522
|
|
|
@@ -586,17 +586,17 @@ declare module 'stripe' {
|
|
|
586
586
|
|
|
587
587
|
interface Treasury {
|
|
588
588
|
/**
|
|
589
|
-
* The array of [ReceivedCredits](https://stripe.com/
|
|
589
|
+
* The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization
|
|
590
590
|
*/
|
|
591
591
|
received_credits: Array<string>;
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* The array of [ReceivedDebits](https://stripe.com/
|
|
594
|
+
* The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization
|
|
595
595
|
*/
|
|
596
596
|
received_debits: Array<string>;
|
|
597
597
|
|
|
598
598
|
/**
|
|
599
|
-
* The Treasury [Transaction](https://stripe.com/
|
|
599
|
+
* The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization
|
|
600
600
|
*/
|
|
601
601
|
transaction: string | null;
|
|
602
602
|
}
|
|
@@ -17,7 +17,7 @@ declare module 'stripe' {
|
|
|
17
17
|
expand?: Array<string>;
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
20
|
+
* 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`.
|
|
21
21
|
*/
|
|
22
22
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
23
23
|
}
|
|
@@ -55,7 +55,7 @@ declare module 'stripe' {
|
|
|
55
55
|
|
|
56
56
|
interface AuthorizationApproveParams {
|
|
57
57
|
/**
|
|
58
|
-
* If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/
|
|
58
|
+
* If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://docs.stripe.com/api/issuing/authorizations/decline) to decline an authorization request).
|
|
59
59
|
*/
|
|
60
60
|
amount?: number;
|
|
61
61
|
|
|
@@ -65,7 +65,7 @@ declare module 'stripe' {
|
|
|
65
65
|
expand?: Array<string>;
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
68
|
+
* 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`.
|
|
69
69
|
*/
|
|
70
70
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
71
71
|
}
|
|
@@ -77,7 +77,7 @@ declare module 'stripe' {
|
|
|
77
77
|
expand?: Array<string>;
|
|
78
78
|
|
|
79
79
|
/**
|
|
80
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
80
|
+
* 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`.
|
|
81
81
|
*/
|
|
82
82
|
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
|
|
83
83
|
}
|
|
@@ -4,9 +4,9 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
namespace Issuing {
|
|
6
6
|
/**
|
|
7
|
-
* An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/
|
|
7
|
+
* An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.
|
|
8
8
|
*
|
|
9
|
-
* Related guide: [How to create a cardholder](https://stripe.com/
|
|
9
|
+
* Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
|
|
10
10
|
*/
|
|
11
11
|
interface Cardholder {
|
|
12
12
|
/**
|
|
@@ -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;
|
|
53
53
|
|
|
@@ -57,20 +57,20 @@ declare module 'stripe' {
|
|
|
57
57
|
name: string;
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
|
-
* The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/
|
|
60
|
+
* The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
|
|
61
61
|
*/
|
|
62
62
|
phone_number: string | null;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
65
|
* The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
|
|
66
|
-
* This changes the language of the [3D Secure flow](https://stripe.com/
|
|
66
|
+
* This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
|
|
67
67
|
*/
|
|
68
68
|
preferred_locales: Array<Cardholder.PreferredLocale> | null;
|
|
69
69
|
|
|
70
70
|
requirements: Cardholder.Requirements;
|
|
71
71
|
|
|
72
72
|
/**
|
|
73
|
-
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/
|
|
73
|
+
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
|
|
74
74
|
*/
|
|
75
75
|
spending_controls: Cardholder.SpendingControls | null;
|
|
76
76
|
|
|
@@ -80,7 +80,7 @@ declare module 'stripe' {
|
|
|
80
80
|
status: Cardholder.Status;
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/
|
|
83
|
+
* One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details.
|
|
84
84
|
*/
|
|
85
85
|
type: Cardholder.Type;
|
|
86
86
|
}
|
|
@@ -178,12 +178,12 @@ declare module 'stripe' {
|
|
|
178
178
|
namespace Verification {
|
|
179
179
|
interface Document {
|
|
180
180
|
/**
|
|
181
|
-
* The back of a document returned by a [file upload](https://stripe.com
|
|
181
|
+
* The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
182
182
|
*/
|
|
183
183
|
back: string | Stripe.File | null;
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
|
-
* The front of a document returned by a [file upload](https://stripe.com
|
|
186
|
+
* The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
187
187
|
*/
|
|
188
188
|
front: string | Stripe.File | null;
|
|
189
189
|
}
|
|
@@ -225,7 +225,7 @@ declare module 'stripe' {
|
|
|
225
225
|
|
|
226
226
|
interface SpendingControls {
|
|
227
227
|
/**
|
|
228
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
228
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
229
229
|
*/
|
|
230
230
|
allowed_categories: Array<SpendingControls.AllowedCategory> | null;
|
|
231
231
|
|
|
@@ -235,7 +235,7 @@ declare module 'stripe' {
|
|
|
235
235
|
allowed_merchant_countries: Array<string> | null;
|
|
236
236
|
|
|
237
237
|
/**
|
|
238
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
238
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
239
239
|
*/
|
|
240
240
|
blocked_categories: Array<SpendingControls.BlockedCategory> | null;
|
|
241
241
|
|
|
@@ -852,12 +852,12 @@ declare module 'stripe' {
|
|
|
852
852
|
|
|
853
853
|
interface SpendingLimit {
|
|
854
854
|
/**
|
|
855
|
-
* Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/
|
|
855
|
+
* Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
856
856
|
*/
|
|
857
857
|
amount: number;
|
|
858
858
|
|
|
859
859
|
/**
|
|
860
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
860
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
861
861
|
*/
|
|
862
862
|
categories: Array<SpendingLimit.Category> | null;
|
|
863
863
|
|
|
@@ -35,24 +35,24 @@ declare module 'stripe' {
|
|
|
35
35
|
individual?: CardholderCreateParams.Individual;
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
38
|
+
* 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`.
|
|
39
39
|
*/
|
|
40
40
|
metadata?: Stripe.MetadataParam;
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
43
|
* The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
|
|
44
|
-
* While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/
|
|
44
|
+
* While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
|
|
45
45
|
*/
|
|
46
46
|
phone_number?: string;
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
|
|
50
|
-
* This changes the language of the [3D Secure flow](https://stripe.com/
|
|
50
|
+
* This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
|
|
51
51
|
*/
|
|
52
52
|
preferred_locales?: Array<CardholderCreateParams.PreferredLocale>;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/
|
|
55
|
+
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
|
|
56
56
|
*/
|
|
57
57
|
spending_controls?: CardholderCreateParams.SpendingControls;
|
|
58
58
|
|
|
@@ -62,7 +62,7 @@ declare module 'stripe' {
|
|
|
62
62
|
status?: CardholderCreateParams.Status;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
|
-
* One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/
|
|
65
|
+
* One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details.
|
|
66
66
|
*/
|
|
67
67
|
type?: CardholderCreateParams.Type;
|
|
68
68
|
}
|
|
@@ -103,7 +103,7 @@ declare module 'stripe' {
|
|
|
103
103
|
postal_code: string;
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
* State, county, province, or region.
|
|
106
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
107
107
|
*/
|
|
108
108
|
state?: string;
|
|
109
109
|
}
|
|
@@ -197,12 +197,12 @@ declare module 'stripe' {
|
|
|
197
197
|
namespace Verification {
|
|
198
198
|
interface Document {
|
|
199
199
|
/**
|
|
200
|
-
* The back of an ID returned by a [file upload](https://stripe.com
|
|
200
|
+
* The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
201
201
|
*/
|
|
202
202
|
back?: string;
|
|
203
203
|
|
|
204
204
|
/**
|
|
205
|
-
* The front of an ID returned by a [file upload](https://stripe.com
|
|
205
|
+
* The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
206
206
|
*/
|
|
207
207
|
front?: string;
|
|
208
208
|
}
|
|
@@ -213,7 +213,7 @@ declare module 'stripe' {
|
|
|
213
213
|
|
|
214
214
|
interface SpendingControls {
|
|
215
215
|
/**
|
|
216
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
216
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
217
217
|
*/
|
|
218
218
|
allowed_categories?: Array<SpendingControls.AllowedCategory>;
|
|
219
219
|
|
|
@@ -223,7 +223,7 @@ declare module 'stripe' {
|
|
|
223
223
|
allowed_merchant_countries?: Array<string>;
|
|
224
224
|
|
|
225
225
|
/**
|
|
226
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
226
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
227
227
|
*/
|
|
228
228
|
blocked_categories?: Array<SpendingControls.BlockedCategory>;
|
|
229
229
|
|
|
@@ -845,7 +845,7 @@ declare module 'stripe' {
|
|
|
845
845
|
amount: number;
|
|
846
846
|
|
|
847
847
|
/**
|
|
848
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
848
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
849
849
|
*/
|
|
850
850
|
categories?: Array<SpendingLimit.Category>;
|
|
851
851
|
|
|
@@ -1202,23 +1202,23 @@ declare module 'stripe' {
|
|
|
1202
1202
|
individual?: CardholderUpdateParams.Individual;
|
|
1203
1203
|
|
|
1204
1204
|
/**
|
|
1205
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
1205
|
+
* 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`.
|
|
1206
1206
|
*/
|
|
1207
1207
|
metadata?: Stripe.MetadataParam;
|
|
1208
1208
|
|
|
1209
1209
|
/**
|
|
1210
|
-
* The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/
|
|
1210
|
+
* The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure) for more details.
|
|
1211
1211
|
*/
|
|
1212
1212
|
phone_number?: string;
|
|
1213
1213
|
|
|
1214
1214
|
/**
|
|
1215
1215
|
* The cardholder's preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
|
|
1216
|
-
* This changes the language of the [3D Secure flow](https://stripe.com/
|
|
1216
|
+
* This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
|
|
1217
1217
|
*/
|
|
1218
1218
|
preferred_locales?: Array<CardholderUpdateParams.PreferredLocale>;
|
|
1219
1219
|
|
|
1220
1220
|
/**
|
|
1221
|
-
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/
|
|
1221
|
+
* Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
|
|
1222
1222
|
*/
|
|
1223
1223
|
spending_controls?: CardholderUpdateParams.SpendingControls;
|
|
1224
1224
|
|
|
@@ -1264,7 +1264,7 @@ declare module 'stripe' {
|
|
|
1264
1264
|
postal_code: string;
|
|
1265
1265
|
|
|
1266
1266
|
/**
|
|
1267
|
-
* State, county, province, or region.
|
|
1267
|
+
* State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1268
1268
|
*/
|
|
1269
1269
|
state?: string;
|
|
1270
1270
|
}
|
|
@@ -1358,12 +1358,12 @@ declare module 'stripe' {
|
|
|
1358
1358
|
namespace Verification {
|
|
1359
1359
|
interface Document {
|
|
1360
1360
|
/**
|
|
1361
|
-
* The back of an ID returned by a [file upload](https://stripe.com
|
|
1361
|
+
* The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
1362
1362
|
*/
|
|
1363
1363
|
back?: string;
|
|
1364
1364
|
|
|
1365
1365
|
/**
|
|
1366
|
-
* The front of an ID returned by a [file upload](https://stripe.com
|
|
1366
|
+
* The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
1367
1367
|
*/
|
|
1368
1368
|
front?: string;
|
|
1369
1369
|
}
|
|
@@ -1374,7 +1374,7 @@ declare module 'stripe' {
|
|
|
1374
1374
|
|
|
1375
1375
|
interface SpendingControls {
|
|
1376
1376
|
/**
|
|
1377
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
1377
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
1378
1378
|
*/
|
|
1379
1379
|
allowed_categories?: Array<SpendingControls.AllowedCategory>;
|
|
1380
1380
|
|
|
@@ -1384,7 +1384,7 @@ declare module 'stripe' {
|
|
|
1384
1384
|
allowed_merchant_countries?: Array<string>;
|
|
1385
1385
|
|
|
1386
1386
|
/**
|
|
1387
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
1387
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
1388
1388
|
*/
|
|
1389
1389
|
blocked_categories?: Array<SpendingControls.BlockedCategory>;
|
|
1390
1390
|
|
|
@@ -2006,7 +2006,7 @@ declare module 'stripe' {
|
|
|
2006
2006
|
amount: number;
|
|
2007
2007
|
|
|
2008
2008
|
/**
|
|
2009
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
2009
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
2010
2010
|
*/
|
|
2011
2011
|
categories?: Array<SpendingLimit.Category>;
|
|
2012
2012
|
|
package/types/Issuing/Cards.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ declare module 'stripe' {
|
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
namespace Issuing {
|
|
6
6
|
/**
|
|
7
|
-
* You can [create physical or virtual cards](https://stripe.com/
|
|
7
|
+
* You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.
|
|
8
8
|
*/
|
|
9
9
|
interface Card {
|
|
10
10
|
/**
|
|
@@ -28,9 +28,9 @@ declare module 'stripe' {
|
|
|
28
28
|
cancellation_reason: Card.CancellationReason | null;
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/
|
|
31
|
+
* An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.
|
|
32
32
|
*
|
|
33
|
-
* Related guide: [How to create a cardholder](https://stripe.com/
|
|
33
|
+
* Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
|
|
34
34
|
*/
|
|
35
35
|
cardholder: Stripe.Issuing.Cardholder;
|
|
36
36
|
|
|
@@ -45,7 +45,7 @@ declare module 'stripe' {
|
|
|
45
45
|
currency: string;
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
|
-
* The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/
|
|
48
|
+
* The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
|
|
49
49
|
*/
|
|
50
50
|
cvc?: string;
|
|
51
51
|
|
|
@@ -80,12 +80,12 @@ declare module 'stripe' {
|
|
|
80
80
|
livemode: boolean;
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* Set of [key-value pairs](https://stripe.com/
|
|
83
|
+
* 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.
|
|
84
84
|
*/
|
|
85
85
|
metadata: Stripe.Metadata;
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
|
-
* The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/
|
|
88
|
+
* The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
|
|
89
89
|
*/
|
|
90
90
|
number?: string;
|
|
91
91
|
|
|
@@ -284,7 +284,7 @@ declare module 'stripe' {
|
|
|
284
284
|
|
|
285
285
|
interface SpendingControls {
|
|
286
286
|
/**
|
|
287
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
287
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
288
288
|
*/
|
|
289
289
|
allowed_categories: Array<SpendingControls.AllowedCategory> | null;
|
|
290
290
|
|
|
@@ -294,7 +294,7 @@ declare module 'stripe' {
|
|
|
294
294
|
allowed_merchant_countries: Array<string> | null;
|
|
295
295
|
|
|
296
296
|
/**
|
|
297
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
297
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
298
298
|
*/
|
|
299
299
|
blocked_categories: Array<SpendingControls.BlockedCategory> | null;
|
|
300
300
|
|
|
@@ -911,12 +911,12 @@ declare module 'stripe' {
|
|
|
911
911
|
|
|
912
912
|
interface SpendingLimit {
|
|
913
913
|
/**
|
|
914
|
-
* Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/
|
|
914
|
+
* Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
915
915
|
*/
|
|
916
916
|
amount: number;
|
|
917
917
|
|
|
918
918
|
/**
|
|
919
|
-
* Array of strings containing [categories](https://stripe.com/
|
|
919
|
+
* Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
920
920
|
*/
|
|
921
921
|
categories: Array<SpendingLimit.Category> | null;
|
|
922
922
|
|
|
@@ -1260,6 +1260,11 @@ declare module 'stripe' {
|
|
|
1260
1260
|
* Reason the card is ineligible for Apple Pay
|
|
1261
1261
|
*/
|
|
1262
1262
|
ineligible_reason: ApplePay.IneligibleReason | null;
|
|
1263
|
+
|
|
1264
|
+
/**
|
|
1265
|
+
* Unique identifier for the card in Apple Pay
|
|
1266
|
+
*/
|
|
1267
|
+
primary_account_identifier?: string | null;
|
|
1263
1268
|
}
|
|
1264
1269
|
|
|
1265
1270
|
namespace ApplePay {
|
|
@@ -1279,6 +1284,11 @@ declare module 'stripe' {
|
|
|
1279
1284
|
* Reason the card is ineligible for Google Pay
|
|
1280
1285
|
*/
|
|
1281
1286
|
ineligible_reason: GooglePay.IneligibleReason | null;
|
|
1287
|
+
|
|
1288
|
+
/**
|
|
1289
|
+
* Unique identifier for the card in Google Pay
|
|
1290
|
+
*/
|
|
1291
|
+
primary_account_identifier?: string | null;
|
|
1282
1292
|
}
|
|
1283
1293
|
|
|
1284
1294
|
namespace GooglePay {
|