stripe 22.4.0-alpha.2 → 22.4.0-alpha.3

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.
Files changed (123) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/OPENAPI_VERSION +1 -1
  3. package/VERSION +1 -1
  4. package/cjs/StripeEventNotificationHandler.js +5 -0
  5. package/cjs/StripeEventNotificationHandler.js.map +1 -1
  6. package/cjs/Webhooks.d.ts +2 -2
  7. package/cjs/apiVersion.d.ts +1 -1
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/resources/Accounts.d.ts +5 -3
  10. package/cjs/resources/Accounts.js +1 -1
  11. package/cjs/resources/BankAccounts.d.ts +2 -2
  12. package/cjs/resources/Billing/AlertRecovereds.d.ts +16 -0
  13. package/cjs/resources/Capabilities.d.ts +2 -2
  14. package/cjs/resources/Capital/FinancingTransactions.d.ts +3 -3
  15. package/cjs/resources/Charges.d.ts +2 -2
  16. package/cjs/resources/Checkout/Sessions.d.ts +28 -3
  17. package/cjs/resources/ConfirmationTokens.d.ts +2 -2
  18. package/cjs/resources/Disputes.d.ts +5 -1
  19. package/cjs/resources/Disputes.js +1 -1
  20. package/cjs/resources/FinancialConnections/Sessions.d.ts +5 -0
  21. package/cjs/resources/Invoices.d.ts +7 -1
  22. package/cjs/resources/Invoices.js.map +1 -1
  23. package/cjs/resources/Issuing/Authorizations.d.ts +47 -0
  24. package/cjs/resources/Issuing/Transactions.d.ts +52 -0
  25. package/cjs/resources/PaymentAttemptRecords.d.ts +3 -3
  26. package/cjs/resources/PaymentIntents.d.ts +81 -3
  27. package/cjs/resources/PaymentIntents.js.map +1 -1
  28. package/cjs/resources/PaymentMethods.d.ts +2 -2
  29. package/cjs/resources/PaymentRecords.d.ts +3 -3
  30. package/cjs/resources/Persons.d.ts +2 -2
  31. package/cjs/resources/PromotionCodes.d.ts +2 -2
  32. package/cjs/resources/QuotePreviewInvoices.d.ts +6 -0
  33. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +44 -0
  34. package/cjs/resources/Quotes.d.ts +22 -0
  35. package/cjs/resources/SetupAttempts.d.ts +9 -0
  36. package/cjs/resources/SetupAttempts.js.map +1 -1
  37. package/cjs/resources/SetupIntents.d.ts +6 -0
  38. package/cjs/resources/SetupIntents.js.map +1 -1
  39. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +2 -2
  40. package/cjs/resources/SubscriptionSchedules.d.ts +49 -5
  41. package/cjs/resources/Tax/CalculationLineItems.d.ts +1 -1
  42. package/cjs/resources/Tax/Calculations.d.ts +2 -2
  43. package/cjs/resources/Tax/Registrations.d.ts +16 -2
  44. package/cjs/resources/Tax/Transactions.d.ts +1 -1
  45. package/cjs/resources/Terminal/Readers.d.ts +203 -2
  46. package/cjs/resources/Terminal/Readers.js +24 -0
  47. package/cjs/resources/Terminal/Readers.js.map +1 -1
  48. package/cjs/resources/Terminal/index.d.ts +4 -0
  49. package/cjs/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +2 -2
  50. package/cjs/resources/V2/Billing/Contracts.d.ts +136 -427
  51. package/cjs/resources/V2/Billing/Contracts.js +8 -284
  52. package/cjs/resources/V2/Billing/Contracts.js.map +1 -1
  53. package/cjs/resources/V2/Core/Accounts.d.ts +22 -1
  54. package/cjs/resources/V2/Core/Events.d.ts +73 -3
  55. package/cjs/resources/V2/Data/Analytics/MetricQuery.d.ts +2 -2
  56. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +2 -2
  57. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +11 -1
  58. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +23 -1
  59. package/cjs/stripe.cjs.node.d.ts +87 -53
  60. package/cjs/stripe.cjs.node.js.map +1 -1
  61. package/cjs/stripe.core.d.ts +12 -0
  62. package/cjs/stripe.core.js +1 -1
  63. package/esm/StripeEventNotificationHandler.js +5 -0
  64. package/esm/StripeEventNotificationHandler.js.map +1 -1
  65. package/esm/Webhooks.d.ts +2 -2
  66. package/esm/apiVersion.d.ts +1 -1
  67. package/esm/apiVersion.js +1 -1
  68. package/esm/resources/Accounts.d.ts +5 -3
  69. package/esm/resources/Accounts.js +1 -1
  70. package/esm/resources/BankAccounts.d.ts +2 -2
  71. package/esm/resources/Billing/AlertRecovereds.d.ts +16 -0
  72. package/esm/resources/Capabilities.d.ts +2 -2
  73. package/esm/resources/Capital/FinancingTransactions.d.ts +3 -3
  74. package/esm/resources/Charges.d.ts +2 -2
  75. package/esm/resources/Checkout/Sessions.d.ts +28 -3
  76. package/esm/resources/ConfirmationTokens.d.ts +2 -2
  77. package/esm/resources/Disputes.d.ts +5 -1
  78. package/esm/resources/Disputes.js +1 -1
  79. package/esm/resources/FinancialConnections/Sessions.d.ts +5 -0
  80. package/esm/resources/Invoices.d.ts +7 -1
  81. package/esm/resources/Invoices.js.map +1 -1
  82. package/esm/resources/Issuing/Authorizations.d.ts +47 -0
  83. package/esm/resources/Issuing/Transactions.d.ts +52 -0
  84. package/esm/resources/PaymentAttemptRecords.d.ts +3 -3
  85. package/esm/resources/PaymentIntents.d.ts +81 -3
  86. package/esm/resources/PaymentIntents.js.map +1 -1
  87. package/esm/resources/PaymentMethods.d.ts +2 -2
  88. package/esm/resources/PaymentRecords.d.ts +3 -3
  89. package/esm/resources/Persons.d.ts +2 -2
  90. package/esm/resources/PromotionCodes.d.ts +2 -2
  91. package/esm/resources/QuotePreviewInvoices.d.ts +6 -0
  92. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +44 -0
  93. package/esm/resources/Quotes.d.ts +22 -0
  94. package/esm/resources/SetupAttempts.d.ts +9 -0
  95. package/esm/resources/SetupAttempts.js.map +1 -1
  96. package/esm/resources/SetupIntents.d.ts +6 -0
  97. package/esm/resources/SetupIntents.js.map +1 -1
  98. package/esm/resources/SharedPayment/GrantedTokens.d.ts +2 -2
  99. package/esm/resources/SubscriptionSchedules.d.ts +49 -5
  100. package/esm/resources/Tax/CalculationLineItems.d.ts +1 -1
  101. package/esm/resources/Tax/Calculations.d.ts +2 -2
  102. package/esm/resources/Tax/Registrations.d.ts +16 -2
  103. package/esm/resources/Tax/Transactions.d.ts +1 -1
  104. package/esm/resources/Terminal/Readers.d.ts +203 -2
  105. package/esm/resources/Terminal/Readers.js +24 -0
  106. package/esm/resources/Terminal/Readers.js.map +1 -1
  107. package/esm/resources/Terminal/index.d.ts +4 -0
  108. package/esm/resources/V2/Billing/ContractPricingLineQuantityChanges.d.ts +2 -2
  109. package/esm/resources/V2/Billing/Contracts.d.ts +136 -427
  110. package/esm/resources/V2/Billing/Contracts.js +8 -284
  111. package/esm/resources/V2/Billing/Contracts.js.map +1 -1
  112. package/esm/resources/V2/Core/Accounts.d.ts +22 -1
  113. package/esm/resources/V2/Core/Events.d.ts +73 -3
  114. package/esm/resources/V2/Data/Analytics/MetricQuery.d.ts +2 -2
  115. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +2 -2
  116. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +11 -1
  117. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +23 -1
  118. package/esm/stripe.core.d.ts +12 -0
  119. package/esm/stripe.core.js +1 -1
  120. package/esm/stripe.esm.node.d.ts +12 -0
  121. package/esm/stripe.esm.node.js +1 -1
  122. package/esm/stripe.esm.node.js.map +1 -1
  123. package/package.json +1 -1
@@ -143,6 +143,10 @@ export interface Authorization {
143
143
  * The current status of the authorization in its lifecycle.
144
144
  */
145
145
  status: Authorization.Status;
146
+ /**
147
+ * Details about the cardholder verification outcome at the terminal.
148
+ */
149
+ terminal_data?: Authorization.TerminalData | null;
146
150
  /**
147
151
  * [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.
148
152
  */
@@ -330,10 +334,18 @@ export declare namespace Authorization {
330
334
  url: string | null;
331
335
  }
332
336
  interface NetworkData {
337
+ /**
338
+ * Country code of the acquirer assigned by the card network.
339
+ */
340
+ acquiring_institution_country?: string | null;
333
341
  /**
334
342
  * Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.
335
343
  */
336
344
  acquiring_institution_id: string | null;
345
+ /**
346
+ * Identifier assigned by the acquirer to track all messages related to this transaction.
347
+ */
348
+ retrieval_reference_number?: string | null;
337
349
  /**
338
350
  * The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.
339
351
  */
@@ -412,6 +424,10 @@ export declare namespace Authorization {
412
424
  * The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
413
425
  */
414
426
  merchant_currency: string;
427
+ /**
428
+ * Details about the authorization request, such as identifiers, set by the card network.
429
+ */
430
+ network_data?: RequestHistory.NetworkData | null;
415
431
  /**
416
432
  * The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
417
433
  */
@@ -430,6 +446,12 @@ export declare namespace Authorization {
430
446
  requested_at: number | null;
431
447
  }
432
448
  type Status = 'closed' | 'expired' | 'pending' | 'reversed';
449
+ interface TerminalData {
450
+ /**
451
+ * The method used to confirm the cardholder's identity.
452
+ */
453
+ cardholder_verification_result: TerminalData.CardholderVerificationResult | null;
454
+ }
433
455
  interface TokenDetails {
434
456
  /**
435
457
  * The card associated with this token.
@@ -830,7 +852,32 @@ export declare namespace Authorization {
830
852
  */
831
853
  cashback_amount: number | null;
832
854
  }
855
+ interface NetworkData {
856
+ /**
857
+ * Mastercard identifier for each authorization request.
858
+ */
859
+ trace_id: NetworkData.TraceId | null;
860
+ }
833
861
  type Reason = 'account_disabled' | 'card_active' | 'card_canceled' | 'card_expired' | 'card_inactive' | 'cardholder_blocked' | 'cardholder_inactive' | 'cardholder_verification_required' | 'insecure_authorization_method' | 'insufficient_funds' | 'network_fallback' | 'not_allowed' | 'pin_blocked' | 'spending_controls' | 'suspected_fraud' | 'verification_failed' | 'webhook_approved' | 'webhook_declined' | 'webhook_error' | 'webhook_timeout';
862
+ namespace NetworkData {
863
+ interface TraceId {
864
+ /**
865
+ * The unique reference number within the specified financial network on the specified network date.
866
+ */
867
+ banknet_reference_number: string | null;
868
+ /**
869
+ * The identifier of the program or service.
870
+ */
871
+ financial_network_code: string | null;
872
+ /**
873
+ * The card network's record date for this authorization.
874
+ */
875
+ network_date: string | null;
876
+ }
877
+ }
878
+ }
879
+ namespace TerminalData {
880
+ type CardholderVerificationResult = 'failed' | 'none' | 'pin' | 'pin_and_signature' | 'signature' | 'unknown';
834
881
  }
835
882
  namespace TokenDetails {
836
883
  interface NetworkData {
@@ -108,6 +108,10 @@ export interface Transaction {
108
108
  * The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
109
109
  */
110
110
  settlement?: string | Settlement | null;
111
+ /**
112
+ * Details about the transaction for settlement reconciliation.
113
+ */
114
+ settlement_details?: Transaction.SettlementDetails | null;
111
115
  /**
112
116
  * [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
113
117
  */
@@ -209,6 +213,14 @@ export declare namespace Transaction {
209
213
  * The network-provided acquirer reference number for this transaction, if available. Use this value for downstream operational workflows such as filing disputes with the card network.
210
214
  */
211
215
  acquirer_reference_number?: string | null;
216
+ /**
217
+ * The two-letter country code of the acquirer ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
218
+ */
219
+ acquiring_institution_country?: string | null;
220
+ /**
221
+ * Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be null.
222
+ */
223
+ acquiring_institution_id?: string | null;
212
224
  /**
213
225
  * A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
214
226
  */
@@ -217,6 +229,15 @@ export declare namespace Transaction {
217
229
  * The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
218
230
  */
219
231
  processing_date: string | null;
232
+ /**
233
+ * Identifier assigned by the acquirer to track all messages related to this transaction.
234
+ */
235
+ retrieval_reference_number?: string | null;
236
+ /**
237
+ * The card network over which Stripe received the transaction. This field may differ from the associated card's primary network.
238
+ */
239
+ routed_network?: NetworkData.RoutedNetwork | null;
240
+ trace_id?: NetworkData.TraceId;
220
241
  /**
221
242
  * Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
222
243
  */
@@ -254,6 +275,20 @@ export declare namespace Transaction {
254
275
  */
255
276
  status: Redaction.Status;
256
277
  }
278
+ interface SettlementDetails {
279
+ /**
280
+ * `merchant_amount` in the settlement currency.
281
+ */
282
+ amount: number | null;
283
+ /**
284
+ * Settlement currency.
285
+ */
286
+ currency: string | null;
287
+ /**
288
+ * Exchange rate used by the network to convert the `merchant_amount` to `settlement_details.amount`. The `merchant_amount` multiplied with this rate will equal to the `settlement_details.amount`.
289
+ */
290
+ exchange_rate: number | null;
291
+ }
257
292
  interface Treasury {
258
293
  /**
259
294
  * The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
@@ -388,6 +423,23 @@ export declare namespace Transaction {
388
423
  }
389
424
  }
390
425
  }
426
+ namespace NetworkData {
427
+ type RoutedNetwork = 'cirrus' | 'interlink' | 'maestro' | 'mastercard' | 'other' | 'plus' | 'visa';
428
+ interface TraceId {
429
+ /**
430
+ * The unique reference number within the specified financial network on the specified network date.
431
+ */
432
+ banknet_reference_number: string | null;
433
+ /**
434
+ * The identifier of the program or service.
435
+ */
436
+ financial_network_code: string | null;
437
+ /**
438
+ * The card network's record date for this transaction.
439
+ */
440
+ network_date: string | null;
441
+ }
442
+ }
391
443
  namespace PurchaseDetails {
392
444
  interface Fleet {
393
445
  /**
@@ -884,7 +884,7 @@ export declare namespace PaymentAttemptRecord {
884
884
  */
885
885
  account_holder_type: Fpx.AccountHolderType | null;
886
886
  /**
887
- * The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
887
+ * The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
888
888
  */
889
889
  bank: Fpx.Bank;
890
890
  /**
@@ -1597,7 +1597,7 @@ export declare namespace PaymentAttemptRecord {
1597
1597
  namespace Funding {
1598
1598
  interface Card {
1599
1599
  /**
1600
- * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
1600
+ * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
1601
1601
  */
1602
1602
  brand: string | null;
1603
1603
  /**
@@ -1839,7 +1839,7 @@ export declare namespace PaymentAttemptRecord {
1839
1839
  }
1840
1840
  namespace Fpx {
1841
1841
  type AccountHolderType = 'company' | 'individual';
1842
- type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1842
+ type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1843
1843
  }
1844
1844
  namespace GiftCard {
1845
1845
  interface Balance {
@@ -9,6 +9,7 @@ import { PaymentRecord } from './PaymentRecords.js';
9
9
  import { Review } from './Reviews.js';
10
10
  import { CustomerSource, DeletedCustomerSource } from './CustomerSources.js';
11
11
  import { Profile } from './Profiles.js';
12
+ import { GiftCardOperation } from './GiftCardOperations.js';
12
13
  import { SetupIntent } from './SetupIntents.js';
13
14
  import { Emptyable, MetadataParam, AddressParam, Address, ShippingAddressParam, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
14
15
  import { RequestOptions, ApiListPromise, Response, ApiList, ApiSearchResultPromise } from '../lib.js';
@@ -501,6 +502,11 @@ export declare namespace PaymentIntent {
501
502
  * A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
502
503
  */
503
504
  doc_url?: string;
505
+ /**
506
+ * A GiftCardOperation represents an operation performed on a third-party gift card,
507
+ * such as activation, reload, cashout, balance check, or void.
508
+ */
509
+ gift_card_operation?: GiftCardOperation;
504
510
  /**
505
511
  * A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
506
512
  */
@@ -3533,6 +3539,16 @@ export declare namespace PaymentIntent {
3533
3539
  * Controls when the funds will be captured from the customer's account.
3534
3540
  */
3535
3541
  capture_method?: 'manual';
3542
+ /**
3543
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3544
+ *
3545
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3546
+ *
3547
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3548
+ *
3549
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3550
+ */
3551
+ setup_future_usage?: 'none';
3536
3552
  }
3537
3553
  interface Paynow {
3538
3554
  /**
@@ -3583,6 +3599,16 @@ export declare namespace PaymentIntent {
3583
3599
  subsellers?: Array<string>;
3584
3600
  }
3585
3601
  interface Paypay {
3602
+ /**
3603
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3604
+ *
3605
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3606
+ *
3607
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3608
+ *
3609
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3610
+ */
3611
+ setup_future_usage?: Paypay.SetupFutureUsage;
3586
3612
  }
3587
3613
  interface Payto {
3588
3614
  mandate_options?: Payto.MandateOptions;
@@ -3669,6 +3695,16 @@ export declare namespace PaymentIntent {
3669
3695
  * Controls when the funds will be captured from the customer's account.
3670
3696
  */
3671
3697
  capture_method?: 'manual';
3698
+ /**
3699
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3700
+ *
3701
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3702
+ *
3703
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3704
+ *
3705
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3706
+ */
3707
+ setup_future_usage?: 'none';
3672
3708
  }
3673
3709
  interface Satispay {
3674
3710
  /**
@@ -4251,6 +4287,9 @@ export declare namespace PaymentIntent {
4251
4287
  }
4252
4288
  }
4253
4289
  }
4290
+ namespace Paypay {
4291
+ type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
4292
+ }
4254
4293
  namespace Payto {
4255
4294
  interface MandateOptions {
4256
4295
  /**
@@ -4654,7 +4693,7 @@ export declare namespace PaymentIntentCreateParams {
4654
4693
  */
4655
4694
  enabled?: boolean;
4656
4695
  }
4657
- type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
4696
+ type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boku_promptpay' | 'boleto' | 'capchase_pay' | 'card' | 'cashapp' | 'check_scan' | 'click_to_pay' | 'crypto' | 'customer_balance' | 'demo_pay' | 'duitnow' | 'dummy_auth_push' | 'dummy_passthrough_card' | 'edenred' | 'eps' | 'fpx' | 'gcash' | 'getbalance' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'knet' | 'konbini' | 'kr_card' | 'kr_market' | 'kriya' | 'link' | 'mb_way' | 'mobilepay' | 'momo' | 'mondu' | 'multibanco' | 'naver_pay' | 'netbanking' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'nz_bank_account' | 'octopus' | 'oxxo' | 'p24' | 'paper_check' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'shop_pay' | 'shopeepay' | 'sofort' | 'south_korea_market' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'test_pay' | 'truemoney' | 'twint' | 'upi' | 'us_bank_account' | 'us_cash_voucher' | 'vipps' | 'wechat_pay' | 'wero' | 'zip';
4658
4697
  interface AmountDetails {
4659
4698
  /**
4660
4699
  * The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.
@@ -8515,6 +8554,16 @@ export declare namespace PaymentIntentCreateParams {
8515
8554
  * If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
8516
8555
  */
8517
8556
  capture_method?: Emptyable<'manual'>;
8557
+ /**
8558
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
8559
+ *
8560
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
8561
+ *
8562
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
8563
+ *
8564
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
8565
+ */
8566
+ setup_future_usage?: Emptyable<Paypay.SetupFutureUsage>;
8518
8567
  }
8519
8568
  interface Payto {
8520
8569
  /**
@@ -10242,6 +10291,9 @@ export declare namespace PaymentIntentCreateParams {
10242
10291
  }
10243
10292
  }
10244
10293
  }
10294
+ namespace Paypay {
10295
+ type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
10296
+ }
10245
10297
  namespace Payto {
10246
10298
  interface MandateOptions {
10247
10299
  /**
@@ -10611,7 +10663,7 @@ export declare namespace PaymentIntentUpdateParams {
10611
10663
  */
10612
10664
  enabled?: boolean;
10613
10665
  }
10614
- type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
10666
+ type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boku_promptpay' | 'boleto' | 'capchase_pay' | 'card' | 'cashapp' | 'check_scan' | 'click_to_pay' | 'crypto' | 'customer_balance' | 'demo_pay' | 'duitnow' | 'dummy_auth_push' | 'dummy_passthrough_card' | 'edenred' | 'eps' | 'fpx' | 'gcash' | 'getbalance' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'knet' | 'konbini' | 'kr_card' | 'kr_market' | 'kriya' | 'link' | 'mb_way' | 'mobilepay' | 'momo' | 'mondu' | 'multibanco' | 'naver_pay' | 'netbanking' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'nz_bank_account' | 'octopus' | 'oxxo' | 'p24' | 'paper_check' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'shop_pay' | 'shopeepay' | 'sofort' | 'south_korea_market' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'test_pay' | 'truemoney' | 'twint' | 'upi' | 'us_bank_account' | 'us_cash_voucher' | 'vipps' | 'wechat_pay' | 'wero' | 'zip';
10615
10667
  interface AmountDetails {
10616
10668
  /**
10617
10669
  * The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.
@@ -14414,6 +14466,16 @@ export declare namespace PaymentIntentUpdateParams {
14414
14466
  * If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
14415
14467
  */
14416
14468
  capture_method?: Emptyable<'manual'>;
14469
+ /**
14470
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
14471
+ *
14472
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
14473
+ *
14474
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
14475
+ *
14476
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
14477
+ */
14478
+ setup_future_usage?: Emptyable<Paypay.SetupFutureUsage>;
14417
14479
  }
14418
14480
  interface Payto {
14419
14481
  /**
@@ -16141,6 +16203,9 @@ export declare namespace PaymentIntentUpdateParams {
16141
16203
  }
16142
16204
  }
16143
16205
  }
16206
+ namespace Paypay {
16207
+ type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
16208
+ }
16144
16209
  namespace Payto {
16145
16210
  interface MandateOptions {
16146
16211
  /**
@@ -18333,7 +18398,7 @@ export declare namespace PaymentIntentConfirmParams {
18333
18398
  */
18334
18399
  enabled?: boolean;
18335
18400
  }
18336
- type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
18401
+ type AllowedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boku_promptpay' | 'boleto' | 'capchase_pay' | 'card' | 'cashapp' | 'check_scan' | 'click_to_pay' | 'crypto' | 'customer_balance' | 'demo_pay' | 'duitnow' | 'dummy_auth_push' | 'dummy_passthrough_card' | 'edenred' | 'eps' | 'fpx' | 'gcash' | 'getbalance' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'knet' | 'konbini' | 'kr_card' | 'kr_market' | 'kriya' | 'link' | 'mb_way' | 'mobilepay' | 'momo' | 'mondu' | 'multibanco' | 'naver_pay' | 'netbanking' | 'ng_bank' | 'ng_bank_transfer' | 'ng_card' | 'ng_market' | 'ng_ussd' | 'ng_wallet' | 'nz_bank_account' | 'octopus' | 'oxxo' | 'p24' | 'paper_check' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'shop_pay' | 'shopeepay' | 'sofort' | 'south_korea_market' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'test_pay' | 'truemoney' | 'twint' | 'upi' | 'us_bank_account' | 'us_cash_voucher' | 'vipps' | 'wechat_pay' | 'wero' | 'zip';
18337
18402
  interface AmountDetails {
18338
18403
  /**
18339
18404
  * The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.
@@ -22136,6 +22201,16 @@ export declare namespace PaymentIntentConfirmParams {
22136
22201
  * If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
22137
22202
  */
22138
22203
  capture_method?: Emptyable<'manual'>;
22204
+ /**
22205
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
22206
+ *
22207
+ * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
22208
+ *
22209
+ * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
22210
+ *
22211
+ * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
22212
+ */
22213
+ setup_future_usage?: Emptyable<Paypay.SetupFutureUsage>;
22139
22214
  }
22140
22215
  interface Payto {
22141
22216
  /**
@@ -23863,6 +23938,9 @@ export declare namespace PaymentIntentConfirmParams {
23863
23938
  }
23864
23939
  }
23865
23940
  }
23941
+ namespace Paypay {
23942
+ type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
23943
+ }
23866
23944
  namespace Payto {
23867
23945
  interface MandateOptions {
23868
23946
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"PaymentIntents.js","sourceRoot":"","sources":["../../src/resources/PaymentIntents.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AA8BpD,MAAa,qBAAsB,SAAQ,kCAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE;YACtE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,EACrB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;OAKG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,EAC5B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,QAAQ;SACrB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,oBAAoB,CAClB,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,yBAAyB,EACtE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,OAAO,CACL,EAAU,EACV,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACvD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,CACL,EAAU,EACV,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACvD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,sBAAsB,CACpB,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,0BAA0B,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,sBAAsB,CACpB,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,0BAA0B,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;OASG;IACH,WAAW,CACT,EAAU,EACV,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,cAAc,EAC3D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,yBAAyB,CACvB,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CACvC,EAAE,CACH,+BAA+B,EAChC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,mBAAmB,CACjB,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,uBAAuB,EACpE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,aAAa,CACX,EAAU,EACV,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,4BAA4B,kBAAkB,CAAC,EAAE,CAAC,iBAAiB,EACnE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,0BAA0B,CACxB,EAAU,EACV,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,4BAA4B,EACzE,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;CACF;AA7VD,sDA6VC"}
1
+ {"version":3,"file":"PaymentIntents.js","sourceRoot":"","sources":["../../src/resources/PaymentIntents.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AA+BpD,MAAa,qBAAsB,SAAQ,kCAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE;YACtE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,EACrB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;OAKG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,EAC5B,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,QAAQ;SACrB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,oBAAoB,CAClB,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,yBAAyB,EACtE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;OAMG;IACH,OAAO,CACL,EAAU,EACV,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACvD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,CACL,EAAU,EACV,MAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACvD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,sBAAsB,CACpB,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,0BAA0B,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,sBAAsB,CACpB,EAAU,EACV,MAAiD,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,0BAA0B,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;OASG;IACH,WAAW,CACT,EAAU,EACV,MAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,cAAc,EAC3D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,yBAAyB,CACvB,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CACvC,EAAE,CACH,+BAA+B,EAChC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,mBAAmB,CACjB,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,uBAAuB,EACpE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,aAAa,CACX,EAAU,EACV,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,4BAA4B,kBAAkB,CAAC,EAAE,CAAC,iBAAiB,EACnE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,0BAA0B,CACxB,EAAU,EACV,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,4BAA4B,EACzE,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;CACF;AA7VD,sDA6VC"}
@@ -472,7 +472,7 @@ export declare namespace PaymentMethod {
472
472
  */
473
473
  account_holder_type: Fpx.AccountHolderType | null;
474
474
  /**
475
- * The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
475
+ * The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
476
476
  */
477
477
  bank: Fpx.Bank;
478
478
  }
@@ -1223,7 +1223,7 @@ export declare namespace PaymentMethod {
1223
1223
  }
1224
1224
  namespace Fpx {
1225
1225
  type AccountHolderType = 'company' | 'individual';
1226
- type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1226
+ type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1227
1227
  }
1228
1228
  namespace GiftCard {
1229
1229
  type Brand = 'fiserv_valuelink' | 'givex' | 'svs';
@@ -890,7 +890,7 @@ export declare namespace PaymentRecord {
890
890
  */
891
891
  account_holder_type: Fpx.AccountHolderType | null;
892
892
  /**
893
- * The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
893
+ * The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
894
894
  */
895
895
  bank: Fpx.Bank;
896
896
  /**
@@ -1603,7 +1603,7 @@ export declare namespace PaymentRecord {
1603
1603
  namespace Funding {
1604
1604
  interface Card {
1605
1605
  /**
1606
- * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
1606
+ * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
1607
1607
  */
1608
1608
  brand: string | null;
1609
1609
  /**
@@ -1845,7 +1845,7 @@ export declare namespace PaymentRecord {
1845
1845
  }
1846
1846
  namespace Fpx {
1847
1847
  type AccountHolderType = 'company' | 'individual';
1848
- type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1848
+ type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1849
1849
  }
1850
1850
  namespace GiftCard {
1851
1851
  interface Balance {
@@ -224,7 +224,7 @@ export declare namespace Person {
224
224
  */
225
225
  currently_due: Array<string>;
226
226
  /**
227
- * Details about validation and verification failures for `due` requirements that must be resolved.
227
+ * Fields that are `currently_due` and need to be collected again because validation or verification failed.
228
228
  */
229
229
  errors: Array<FutureRequirements.Error>;
230
230
  /**
@@ -285,7 +285,7 @@ export declare namespace Person {
285
285
  */
286
286
  currently_due: Array<string>;
287
287
  /**
288
- * Details about validation and verification failures for `due` requirements that must be resolved.
288
+ * Fields that are `currently_due` and need to be collected again because validation or verification failed.
289
289
  */
290
290
  errors: Array<Requirements.Error>;
291
291
  /**
@@ -178,7 +178,7 @@ export declare namespace PromotionCodeCreateParams {
178
178
  }
179
179
  interface Restrictions {
180
180
  /**
181
- * Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
181
+ * Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Each currency must be different from the `minimum_amount_currency` set on the promotion code.
182
182
  */
183
183
  currency_options?: {
184
184
  [key: string]: Restrictions.CurrencyOptions;
@@ -232,7 +232,7 @@ export interface PromotionCodeUpdateParams {
232
232
  export declare namespace PromotionCodeUpdateParams {
233
233
  interface Restrictions {
234
234
  /**
235
- * Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
235
+ * Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Each currency must be different from the `minimum_amount_currency` set on the promotion code.
236
236
  */
237
237
  currency_options?: {
238
238
  [key: string]: Restrictions.CurrencyOptions;
@@ -10,6 +10,7 @@ import { InvoiceLineItem } from './InvoiceLineItems.js';
10
10
  import { Account } from './Accounts.js';
11
11
  import { InvoicePayment } from './InvoicePayments.js';
12
12
  import { Subscription } from './Subscriptions.js';
13
+ import { GiftCardOperation } from './GiftCardOperations.js';
13
14
  import { PaymentIntent } from './PaymentIntents.js';
14
15
  import { SetupIntent } from './SetupIntents.js';
15
16
  import { ShippingRate } from './ShippingRates.js';
@@ -486,6 +487,11 @@ export declare namespace QuotePreviewInvoice {
486
487
  * A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
487
488
  */
488
489
  doc_url?: string;
490
+ /**
491
+ * A GiftCardOperation represents an operation performed on a third-party gift card,
492
+ * such as activation, reload, cashout, balance check, or void.
493
+ */
494
+ gift_card_operation?: GiftCardOperation;
489
495
  /**
490
496
  * A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
491
497
  */
@@ -429,10 +429,22 @@ export declare namespace QuotePreviewSubscriptionSchedule {
429
429
  * The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
430
430
  */
431
431
  account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
432
+ /**
433
+ * A list of up to 4 custom fields to be displayed on the invoice.
434
+ */
435
+ custom_fields: Array<InvoiceSettings.CustomField> | null;
432
436
  /**
433
437
  * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
434
438
  */
435
439
  days_until_due: number | null;
440
+ /**
441
+ * An arbitrary string attached to the object. Often useful for displaying to users.
442
+ */
443
+ description: string | null;
444
+ /**
445
+ * Footer to be displayed on the invoice.
446
+ */
447
+ footer: string | null;
436
448
  issuer: InvoiceSettings.Issuer;
437
449
  }
438
450
  type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
@@ -462,6 +474,16 @@ export declare namespace QuotePreviewSubscriptionSchedule {
462
474
  }
463
475
  }
464
476
  namespace InvoiceSettings {
477
+ interface CustomField {
478
+ /**
479
+ * The name of the custom field.
480
+ */
481
+ name: string;
482
+ /**
483
+ * The value of the custom field.
484
+ */
485
+ value: string;
486
+ }
465
487
  interface Issuer {
466
488
  /**
467
489
  * The connected account being referenced when `type` is `account`.
@@ -568,10 +590,22 @@ export declare namespace QuotePreviewSubscriptionSchedule {
568
590
  * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
569
591
  */
570
592
  account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
593
+ /**
594
+ * A list of up to 4 custom fields to be displayed on the invoice.
595
+ */
596
+ custom_fields: Array<InvoiceSettings.CustomField> | null;
571
597
  /**
572
598
  * Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
573
599
  */
574
600
  days_until_due: number | null;
601
+ /**
602
+ * An arbitrary string attached to the object. Often useful for displaying to users.
603
+ */
604
+ description: string | null;
605
+ /**
606
+ * Footer to be displayed on the invoice.
607
+ */
608
+ footer: string | null;
575
609
  /**
576
610
  * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
577
611
  */
@@ -773,6 +807,16 @@ export declare namespace QuotePreviewSubscriptionSchedule {
773
807
  }
774
808
  }
775
809
  namespace InvoiceSettings {
810
+ interface CustomField {
811
+ /**
812
+ * The name of the custom field.
813
+ */
814
+ name: string;
815
+ /**
816
+ * The value of the custom field.
817
+ */
818
+ value: string;
819
+ }
776
820
  interface Issuer {
777
821
  /**
778
822
  * The connected account being referenced when `type` is `account`.