stripe 17.1.0 → 17.2.0-beta.2

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 (175) hide show
  1. package/CHANGELOG.md +901 -109
  2. package/README.md +4 -4
  3. package/VERSION +1 -1
  4. package/cjs/resources/AccountNotices.js +21 -0
  5. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  6. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  7. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  8. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  9. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  10. package/cjs/resources/GiftCards/Cards.js +23 -0
  11. package/cjs/resources/GiftCards/Transactions.js +33 -0
  12. package/cjs/resources/Invoices.js +17 -0
  13. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  14. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  15. package/cjs/resources/Margins.js +22 -0
  16. package/cjs/resources/Orders.js +24 -0
  17. package/cjs/resources/PaymentIntents.js +4 -0
  18. package/cjs/resources/Quotes.js +32 -0
  19. package/cjs/resources/SubscriptionSchedules.js +4 -0
  20. package/cjs/resources/Tax/Associations.js +9 -0
  21. package/cjs/resources/Tax/Forms.js +20 -0
  22. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  23. package/cjs/resources/Terminal/Readers.js +12 -0
  24. package/cjs/resources/TestHelpers/Issuing/Cards.js +4 -0
  25. package/cjs/resources.js +42 -10
  26. package/cjs/stripe.core.js +1 -1
  27. package/esm/resources/AccountNotices.js +18 -0
  28. package/esm/resources/Capital/FinancingOffers.js +18 -0
  29. package/esm/resources/Capital/FinancingSummary.js +9 -0
  30. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  31. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  32. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  33. package/esm/resources/GiftCards/Cards.js +20 -0
  34. package/esm/resources/GiftCards/Transactions.js +30 -0
  35. package/esm/resources/Invoices.js +17 -0
  36. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  37. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  38. package/esm/resources/Margins.js +19 -0
  39. package/esm/resources/Orders.js +21 -0
  40. package/esm/resources/PaymentIntents.js +4 -0
  41. package/esm/resources/Quotes.js +32 -0
  42. package/esm/resources/SubscriptionSchedules.js +4 -0
  43. package/esm/resources/Tax/Associations.js +6 -0
  44. package/esm/resources/Tax/Forms.js +17 -0
  45. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  46. package/esm/resources/Terminal/Readers.js +12 -0
  47. package/esm/resources/TestHelpers/Issuing/Cards.js +4 -0
  48. package/esm/resources.js +29 -0
  49. package/esm/stripe.core.js +1 -1
  50. package/package.json +1 -1
  51. package/types/AccountLinksResource.d.ts +5 -1
  52. package/types/AccountNotices.d.ts +113 -0
  53. package/types/AccountNoticesResource.d.ts +98 -0
  54. package/types/AccountSessions.d.ts +75 -5
  55. package/types/AccountSessionsResource.d.ts +354 -5
  56. package/types/Accounts.d.ts +127 -3
  57. package/types/AccountsResource.d.ts +296 -2
  58. package/types/Billing/CreditGrants.d.ts +2 -2
  59. package/types/Billing/CreditGrantsResource.d.ts +2 -2
  60. package/types/Billing/MeterErrorReports.d.ts +106 -0
  61. package/types/Billing/Meters.d.ts +2 -0
  62. package/types/Capital/FinancingOffers.d.ts +188 -0
  63. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  64. package/types/Capital/FinancingSummary.d.ts +106 -0
  65. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  66. package/types/Capital/FinancingTransactions.d.ts +135 -0
  67. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  68. package/types/Charges.d.ts +152 -0
  69. package/types/ChargesResource.d.ts +1294 -0
  70. package/types/Checkout/Sessions.d.ts +309 -5
  71. package/types/Checkout/SessionsResource.d.ts +356 -5
  72. package/types/ConfirmationTokens.d.ts +137 -0
  73. package/types/Coupons.d.ts +1 -1
  74. package/types/CouponsResource.d.ts +1 -1
  75. package/types/CreditNotes.d.ts +21 -0
  76. package/types/CreditNotesResource.d.ts +51 -0
  77. package/types/CustomersResource.d.ts +22 -2
  78. package/types/Disputes.d.ts +152 -0
  79. package/types/DisputesResource.d.ts +120 -0
  80. package/types/EventTypes.d.ts +564 -2
  81. package/types/Events.d.ts +91 -0
  82. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  83. package/types/FinancialConnections/Accounts.d.ts +29 -1
  84. package/types/FinancialConnections/AccountsResource.d.ts +35 -3
  85. package/types/FinancialConnections/Institutions.d.ts +93 -0
  86. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  87. package/types/FinancialConnections/Sessions.d.ts +49 -1
  88. package/types/FinancialConnections/SessionsResource.d.ts +38 -1
  89. package/types/Forwarding/Requests.d.ts +5 -0
  90. package/types/GiftCards/Cards.d.ts +118 -0
  91. package/types/GiftCards/CardsResource.d.ts +159 -0
  92. package/types/GiftCards/Transactions.d.ts +129 -0
  93. package/types/GiftCards/TransactionsResource.d.ts +201 -0
  94. package/types/InvoiceItems.d.ts +5 -0
  95. package/types/InvoiceItemsResource.d.ts +98 -0
  96. package/types/InvoiceLineItems.d.ts +31 -1
  97. package/types/InvoicePayments.d.ts +138 -0
  98. package/types/Invoices.d.ts +134 -3
  99. package/types/InvoicesResource.d.ts +5478 -1799
  100. package/types/Issuing/Authorizations.d.ts +1 -1
  101. package/types/Issuing/AuthorizationsResource.d.ts +1 -1
  102. package/types/Issuing/CardholdersResource.d.ts +2 -1
  103. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  104. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  105. package/types/Issuing/DisputeSettlementDetails.d.ts +73 -0
  106. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  107. package/types/Issuing/Settlements.d.ts +103 -0
  108. package/types/Issuing/Transactions.d.ts +2 -0
  109. package/types/Issuing/TransactionsResource.d.ts +5 -0
  110. package/types/LineItems.d.ts +7 -0
  111. package/types/Mandates.d.ts +85 -0
  112. package/types/Margins.d.ts +56 -0
  113. package/types/MarginsResource.d.ts +114 -0
  114. package/types/Orders.d.ts +1154 -0
  115. package/types/OrdersResource.d.ts +2911 -0
  116. package/types/PaymentIntents.d.ts +643 -1
  117. package/types/PaymentIntentsResource.d.ts +7790 -3514
  118. package/types/PaymentLinks.d.ts +3 -0
  119. package/types/PaymentLinksResource.d.ts +6 -0
  120. package/types/PaymentMethodConfigurations.d.ts +36 -0
  121. package/types/PaymentMethodConfigurationsResource.d.ts +52 -2
  122. package/types/PaymentMethods.d.ts +137 -0
  123. package/types/PaymentMethodsResource.d.ts +158 -0
  124. package/types/Persons.d.ts +1 -1
  125. package/types/Prices.d.ts +22 -0
  126. package/types/PricesResource.d.ts +22 -0
  127. package/types/Products.d.ts +39 -0
  128. package/types/ProductsResource.d.ts +36 -0
  129. package/types/QuoteLines.d.ts +634 -0
  130. package/types/QuotePreviewInvoices.d.ts +1596 -0
  131. package/types/QuotePreviewSubscriptionSchedules.d.ts +814 -0
  132. package/types/Quotes.d.ts +591 -1
  133. package/types/QuotesResource.d.ts +2526 -194
  134. package/types/SetupAttempts.d.ts +19 -0
  135. package/types/SetupIntents.d.ts +112 -1
  136. package/types/SetupIntentsResource.d.ts +669 -3
  137. package/types/Sources.d.ts +23 -0
  138. package/types/SubscriptionItems.d.ts +21 -0
  139. package/types/SubscriptionItemsResource.d.ts +109 -0
  140. package/types/SubscriptionSchedules.d.ts +200 -0
  141. package/types/SubscriptionSchedulesResource.d.ts +1234 -16
  142. package/types/Subscriptions.d.ts +82 -1
  143. package/types/SubscriptionsResource.d.ts +348 -3
  144. package/types/Tax/Associations.d.ts +126 -0
  145. package/types/Tax/AssociationsResource.d.ts +29 -0
  146. package/types/Tax/CalculationLineItems.d.ts +1 -0
  147. package/types/Tax/Calculations.d.ts +33 -1
  148. package/types/Tax/CalculationsResource.d.ts +7 -1
  149. package/types/Tax/Forms.d.ts +133 -0
  150. package/types/Tax/FormsResource.d.ts +90 -0
  151. package/types/Tax/Registrations.d.ts +82 -0
  152. package/types/Tax/RegistrationsResource.d.ts +109 -0
  153. package/types/Tax/Transactions.d.ts +8 -1
  154. package/types/TaxIds.d.ts +7 -1
  155. package/types/TaxIdsResource.d.ts +7 -1
  156. package/types/TaxRates.d.ts +25 -0
  157. package/types/TaxRatesResource.d.ts +2 -0
  158. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  159. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  160. package/types/Terminal/Readers.d.ts +278 -0
  161. package/types/Terminal/ReadersResource.d.ts +215 -0
  162. package/types/TestHelpers/ConfirmationTokensResource.d.ts +112 -0
  163. package/types/TestHelpers/Issuing/CardsResource.d.ts +22 -0
  164. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  165. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  166. package/types/TokensResource.d.ts +1 -1
  167. package/types/Treasury/FinancialAccounts.d.ts +6 -1
  168. package/types/Treasury/FinancialAccountsResource.d.ts +10 -0
  169. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  170. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  171. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  172. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  173. package/types/UsageRecordSummaries.d.ts +1 -1
  174. package/types/WebhookEndpointsResource.d.ts +66 -0
  175. package/types/index.d.ts +53 -0
@@ -284,6 +284,11 @@ declare module 'stripe' {
284
284
  */
285
285
  interac_present?: PaymentMethodData.InteracPresent;
286
286
 
287
+ /**
288
+ * If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
289
+ */
290
+ kakao_pay?: PaymentMethodData.KakaoPay;
291
+
287
292
  /**
288
293
  * If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
289
294
  */
@@ -294,11 +299,21 @@ declare module 'stripe' {
294
299
  */
295
300
  konbini?: PaymentMethodData.Konbini;
296
301
 
302
+ /**
303
+ * If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
304
+ */
305
+ kr_card?: PaymentMethodData.KrCard;
306
+
297
307
  /**
298
308
  * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
299
309
  */
300
310
  link?: PaymentMethodData.Link;
301
311
 
312
+ /**
313
+ * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
314
+ */
315
+ mb_way?: PaymentMethodData.MbWay;
316
+
302
317
  /**
303
318
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
304
319
  */
@@ -314,6 +329,11 @@ declare module 'stripe' {
314
329
  */
315
330
  multibanco?: PaymentMethodData.Multibanco;
316
331
 
332
+ /**
333
+ * If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
334
+ */
335
+ naver_pay?: PaymentMethodData.NaverPay;
336
+
317
337
  /**
318
338
  * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
319
339
  */
@@ -324,6 +344,11 @@ declare module 'stripe' {
324
344
  */
325
345
  p24?: PaymentMethodData.P24;
326
346
 
347
+ /**
348
+ * If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
349
+ */
350
+ payco?: PaymentMethodData.Payco;
351
+
327
352
  /**
328
353
  * If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
329
354
  */
@@ -334,6 +359,11 @@ declare module 'stripe' {
334
359
  */
335
360
  paypal?: PaymentMethodData.Paypal;
336
361
 
362
+ /**
363
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
364
+ */
365
+ payto?: PaymentMethodData.Payto;
366
+
337
367
  /**
338
368
  * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
339
369
  */
@@ -349,11 +379,21 @@ declare module 'stripe' {
349
379
  */
350
380
  radar_options?: PaymentMethodData.RadarOptions;
351
381
 
382
+ /**
383
+ * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
384
+ */
385
+ rechnung?: PaymentMethodData.Rechnung;
386
+
352
387
  /**
353
388
  * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
354
389
  */
355
390
  revolut_pay?: PaymentMethodData.RevolutPay;
356
391
 
392
+ /**
393
+ * If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
394
+ */
395
+ samsung_pay?: PaymentMethodData.SamsungPay;
396
+
357
397
  /**
358
398
  * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
359
399
  */
@@ -596,6 +636,8 @@ declare module 'stripe' {
596
636
 
597
637
  interface InteracPresent {}
598
638
 
639
+ interface KakaoPay {}
640
+
599
641
  interface Klarna {
600
642
  /**
601
643
  * Customer's date of birth
@@ -624,12 +666,27 @@ declare module 'stripe' {
624
666
 
625
667
  interface Konbini {}
626
668
 
669
+ interface KrCard {}
670
+
627
671
  interface Link {}
628
672
 
673
+ interface MbWay {}
674
+
629
675
  interface Mobilepay {}
630
676
 
631
677
  interface Multibanco {}
632
678
 
679
+ interface NaverPay {
680
+ /**
681
+ * Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
682
+ */
683
+ funding?: NaverPay.Funding;
684
+ }
685
+
686
+ namespace NaverPay {
687
+ type Funding = 'card' | 'points';
688
+ }
689
+
633
690
  interface Oxxo {}
634
691
 
635
692
  interface P24 {
@@ -669,10 +726,29 @@ declare module 'stripe' {
669
726
  | 'volkswagen_bank';
670
727
  }
671
728
 
729
+ interface Payco {}
730
+
672
731
  interface Paynow {}
673
732
 
674
733
  interface Paypal {}
675
734
 
735
+ interface Payto {
736
+ /**
737
+ * The account number for the bank account.
738
+ */
739
+ account_number?: string;
740
+
741
+ /**
742
+ * Bank-State-Branch number of the bank account.
743
+ */
744
+ bsb_number?: string;
745
+
746
+ /**
747
+ * The PayID alias for the bank account.
748
+ */
749
+ pay_id?: string;
750
+ }
751
+
676
752
  interface Pix {}
677
753
 
678
754
  interface Promptpay {}
@@ -684,8 +760,36 @@ declare module 'stripe' {
684
760
  session?: string;
685
761
  }
686
762
 
763
+ interface Rechnung {
764
+ /**
765
+ * Customer's date of birth
766
+ */
767
+ dob: Rechnung.Dob;
768
+ }
769
+
770
+ namespace Rechnung {
771
+ interface Dob {
772
+ /**
773
+ * The day of birth, between 1 and 31.
774
+ */
775
+ day: number;
776
+
777
+ /**
778
+ * The month of birth, between 1 and 12.
779
+ */
780
+ month: number;
781
+
782
+ /**
783
+ * The four-digit year of birth.
784
+ */
785
+ year: number;
786
+ }
787
+ }
788
+
687
789
  interface RevolutPay {}
688
790
 
791
+ interface SamsungPay {}
792
+
689
793
  interface SepaDebit {
690
794
  /**
691
795
  * IBAN of the bank account.
@@ -726,18 +830,26 @@ declare module 'stripe' {
726
830
  | 'giropay'
727
831
  | 'grabpay'
728
832
  | 'ideal'
833
+ | 'kakao_pay'
729
834
  | 'klarna'
730
835
  | 'konbini'
836
+ | 'kr_card'
731
837
  | 'link'
838
+ | 'mb_way'
732
839
  | 'mobilepay'
733
840
  | 'multibanco'
841
+ | 'naver_pay'
734
842
  | 'oxxo'
735
843
  | 'p24'
844
+ | 'payco'
736
845
  | 'paynow'
737
846
  | 'paypal'
847
+ | 'payto'
738
848
  | 'pix'
739
849
  | 'promptpay'
850
+ | 'rechnung'
740
851
  | 'revolut_pay'
852
+ | 'samsung_pay'
741
853
  | 'sepa_debit'
742
854
  | 'sofort'
743
855
  | 'swish'
@@ -820,6 +932,11 @@ declare module 'stripe' {
820
932
  */
821
933
  paypal?: PaymentMethodOptions.Paypal;
822
934
 
935
+ /**
936
+ * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
937
+ */
938
+ payto?: PaymentMethodOptions.Payto;
939
+
823
940
  /**
824
941
  * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
825
942
  */
@@ -1115,6 +1232,86 @@ declare module 'stripe' {
1115
1232
  * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
1116
1233
  */
1117
1234
  billing_agreement_id?: string;
1235
+
1236
+ currency?: string;
1237
+
1238
+ /**
1239
+ * The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
1240
+ */
1241
+ subsellers?: Array<string>;
1242
+ }
1243
+
1244
+ interface Payto {
1245
+ /**
1246
+ * Additional fields for Mandate creation.
1247
+ */
1248
+ mandate_options?: Payto.MandateOptions;
1249
+ }
1250
+
1251
+ namespace Payto {
1252
+ interface MandateOptions {
1253
+ /**
1254
+ * Amount that will be collected. It is required when `amount_type` is `fixed`.
1255
+ */
1256
+ amount?: number;
1257
+
1258
+ /**
1259
+ * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
1260
+ */
1261
+ amount_type?: MandateOptions.AmountType;
1262
+
1263
+ /**
1264
+ * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
1265
+ */
1266
+ end_date?: string;
1267
+
1268
+ /**
1269
+ * The periodicity at which payments will be collected.
1270
+ */
1271
+ payment_schedule?: MandateOptions.PaymentSchedule;
1272
+
1273
+ /**
1274
+ * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
1275
+ */
1276
+ payments_per_period?: number;
1277
+
1278
+ /**
1279
+ * The purpose for which payments are made. Defaults to retail.
1280
+ */
1281
+ purpose?: MandateOptions.Purpose;
1282
+
1283
+ /**
1284
+ * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
1285
+ */
1286
+ start_date?: string;
1287
+ }
1288
+
1289
+ namespace MandateOptions {
1290
+ type AmountType = 'fixed' | 'maximum';
1291
+
1292
+ type PaymentSchedule =
1293
+ | 'adhoc'
1294
+ | 'annual'
1295
+ | 'daily'
1296
+ | 'fortnightly'
1297
+ | 'monthly'
1298
+ | 'quarterly'
1299
+ | 'semi_annual'
1300
+ | 'weekly';
1301
+
1302
+ type Purpose =
1303
+ | 'dependant_support'
1304
+ | 'government'
1305
+ | 'loan'
1306
+ | 'mortgage'
1307
+ | 'other'
1308
+ | 'pension'
1309
+ | 'personal'
1310
+ | 'retail'
1311
+ | 'salary'
1312
+ | 'tax'
1313
+ | 'utility';
1314
+ }
1118
1315
  }
1119
1316
 
1120
1317
  interface SepaDebit {
@@ -1157,6 +1354,11 @@ declare module 'stripe' {
1157
1354
  */
1158
1355
  filters?: FinancialConnections.Filters;
1159
1356
 
1357
+ /**
1358
+ * Customize manual entry behavior
1359
+ */
1360
+ manual_entry?: FinancialConnections.ManualEntry;
1361
+
1160
1362
  /**
1161
1363
  * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1162
1364
  */
@@ -1179,19 +1381,39 @@ declare module 'stripe' {
1179
1381
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1180
1382
  */
1181
1383
  account_subcategories?: Array<Filters.AccountSubcategory>;
1384
+
1385
+ /**
1386
+ * ID of the institution to use to filter for selectable accounts.
1387
+ */
1388
+ institution?: string;
1182
1389
  }
1183
1390
 
1184
1391
  namespace Filters {
1185
1392
  type AccountSubcategory = 'checking' | 'savings';
1186
1393
  }
1187
1394
 
1395
+ interface ManualEntry {
1396
+ /**
1397
+ * Settings for configuring manual entry of account details.
1398
+ */
1399
+ mode: ManualEntry.Mode;
1400
+ }
1401
+
1402
+ namespace ManualEntry {
1403
+ type Mode = 'automatic' | 'custom';
1404
+ }
1405
+
1188
1406
  type Permission =
1189
1407
  | 'balances'
1190
1408
  | 'ownership'
1191
1409
  | 'payment_method'
1192
1410
  | 'transactions';
1193
1411
 
1194
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1412
+ type Prefetch =
1413
+ | 'balances'
1414
+ | 'inferred_balances'
1415
+ | 'ownership'
1416
+ | 'transactions';
1195
1417
  }
1196
1418
 
1197
1419
  interface MandateOptions {
@@ -1411,6 +1633,11 @@ declare module 'stripe' {
1411
1633
  */
1412
1634
  interac_present?: PaymentMethodData.InteracPresent;
1413
1635
 
1636
+ /**
1637
+ * If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
1638
+ */
1639
+ kakao_pay?: PaymentMethodData.KakaoPay;
1640
+
1414
1641
  /**
1415
1642
  * If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
1416
1643
  */
@@ -1421,11 +1648,21 @@ declare module 'stripe' {
1421
1648
  */
1422
1649
  konbini?: PaymentMethodData.Konbini;
1423
1650
 
1651
+ /**
1652
+ * If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
1653
+ */
1654
+ kr_card?: PaymentMethodData.KrCard;
1655
+
1424
1656
  /**
1425
1657
  * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
1426
1658
  */
1427
1659
  link?: PaymentMethodData.Link;
1428
1660
 
1661
+ /**
1662
+ * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
1663
+ */
1664
+ mb_way?: PaymentMethodData.MbWay;
1665
+
1429
1666
  /**
1430
1667
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
1431
1668
  */
@@ -1441,6 +1678,11 @@ declare module 'stripe' {
1441
1678
  */
1442
1679
  multibanco?: PaymentMethodData.Multibanco;
1443
1680
 
1681
+ /**
1682
+ * If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
1683
+ */
1684
+ naver_pay?: PaymentMethodData.NaverPay;
1685
+
1444
1686
  /**
1445
1687
  * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
1446
1688
  */
@@ -1451,6 +1693,11 @@ declare module 'stripe' {
1451
1693
  */
1452
1694
  p24?: PaymentMethodData.P24;
1453
1695
 
1696
+ /**
1697
+ * If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
1698
+ */
1699
+ payco?: PaymentMethodData.Payco;
1700
+
1454
1701
  /**
1455
1702
  * If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
1456
1703
  */
@@ -1461,6 +1708,11 @@ declare module 'stripe' {
1461
1708
  */
1462
1709
  paypal?: PaymentMethodData.Paypal;
1463
1710
 
1711
+ /**
1712
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
1713
+ */
1714
+ payto?: PaymentMethodData.Payto;
1715
+
1464
1716
  /**
1465
1717
  * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
1466
1718
  */
@@ -1476,11 +1728,21 @@ declare module 'stripe' {
1476
1728
  */
1477
1729
  radar_options?: PaymentMethodData.RadarOptions;
1478
1730
 
1731
+ /**
1732
+ * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
1733
+ */
1734
+ rechnung?: PaymentMethodData.Rechnung;
1735
+
1479
1736
  /**
1480
1737
  * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
1481
1738
  */
1482
1739
  revolut_pay?: PaymentMethodData.RevolutPay;
1483
1740
 
1741
+ /**
1742
+ * If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
1743
+ */
1744
+ samsung_pay?: PaymentMethodData.SamsungPay;
1745
+
1484
1746
  /**
1485
1747
  * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
1486
1748
  */
@@ -1723,6 +1985,8 @@ declare module 'stripe' {
1723
1985
 
1724
1986
  interface InteracPresent {}
1725
1987
 
1988
+ interface KakaoPay {}
1989
+
1726
1990
  interface Klarna {
1727
1991
  /**
1728
1992
  * Customer's date of birth
@@ -1751,12 +2015,27 @@ declare module 'stripe' {
1751
2015
 
1752
2016
  interface Konbini {}
1753
2017
 
2018
+ interface KrCard {}
2019
+
1754
2020
  interface Link {}
1755
2021
 
2022
+ interface MbWay {}
2023
+
1756
2024
  interface Mobilepay {}
1757
2025
 
1758
2026
  interface Multibanco {}
1759
2027
 
2028
+ interface NaverPay {
2029
+ /**
2030
+ * Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
2031
+ */
2032
+ funding?: NaverPay.Funding;
2033
+ }
2034
+
2035
+ namespace NaverPay {
2036
+ type Funding = 'card' | 'points';
2037
+ }
2038
+
1760
2039
  interface Oxxo {}
1761
2040
 
1762
2041
  interface P24 {
@@ -1796,10 +2075,29 @@ declare module 'stripe' {
1796
2075
  | 'volkswagen_bank';
1797
2076
  }
1798
2077
 
2078
+ interface Payco {}
2079
+
1799
2080
  interface Paynow {}
1800
2081
 
1801
2082
  interface Paypal {}
1802
2083
 
2084
+ interface Payto {
2085
+ /**
2086
+ * The account number for the bank account.
2087
+ */
2088
+ account_number?: string;
2089
+
2090
+ /**
2091
+ * Bank-State-Branch number of the bank account.
2092
+ */
2093
+ bsb_number?: string;
2094
+
2095
+ /**
2096
+ * The PayID alias for the bank account.
2097
+ */
2098
+ pay_id?: string;
2099
+ }
2100
+
1803
2101
  interface Pix {}
1804
2102
 
1805
2103
  interface Promptpay {}
@@ -1811,8 +2109,36 @@ declare module 'stripe' {
1811
2109
  session?: string;
1812
2110
  }
1813
2111
 
2112
+ interface Rechnung {
2113
+ /**
2114
+ * Customer's date of birth
2115
+ */
2116
+ dob: Rechnung.Dob;
2117
+ }
2118
+
2119
+ namespace Rechnung {
2120
+ interface Dob {
2121
+ /**
2122
+ * The day of birth, between 1 and 31.
2123
+ */
2124
+ day: number;
2125
+
2126
+ /**
2127
+ * The month of birth, between 1 and 12.
2128
+ */
2129
+ month: number;
2130
+
2131
+ /**
2132
+ * The four-digit year of birth.
2133
+ */
2134
+ year: number;
2135
+ }
2136
+ }
2137
+
1814
2138
  interface RevolutPay {}
1815
2139
 
2140
+ interface SamsungPay {}
2141
+
1816
2142
  interface SepaDebit {
1817
2143
  /**
1818
2144
  * IBAN of the bank account.
@@ -1853,18 +2179,26 @@ declare module 'stripe' {
1853
2179
  | 'giropay'
1854
2180
  | 'grabpay'
1855
2181
  | 'ideal'
2182
+ | 'kakao_pay'
1856
2183
  | 'klarna'
1857
2184
  | 'konbini'
2185
+ | 'kr_card'
1858
2186
  | 'link'
2187
+ | 'mb_way'
1859
2188
  | 'mobilepay'
1860
2189
  | 'multibanco'
2190
+ | 'naver_pay'
1861
2191
  | 'oxxo'
1862
2192
  | 'p24'
2193
+ | 'payco'
1863
2194
  | 'paynow'
1864
2195
  | 'paypal'
2196
+ | 'payto'
1865
2197
  | 'pix'
1866
2198
  | 'promptpay'
2199
+ | 'rechnung'
1867
2200
  | 'revolut_pay'
2201
+ | 'samsung_pay'
1868
2202
  | 'sepa_debit'
1869
2203
  | 'sofort'
1870
2204
  | 'swish'
@@ -1947,6 +2281,11 @@ declare module 'stripe' {
1947
2281
  */
1948
2282
  paypal?: PaymentMethodOptions.Paypal;
1949
2283
 
2284
+ /**
2285
+ * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
2286
+ */
2287
+ payto?: PaymentMethodOptions.Payto;
2288
+
1950
2289
  /**
1951
2290
  * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
1952
2291
  */
@@ -2242,6 +2581,86 @@ declare module 'stripe' {
2242
2581
  * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
2243
2582
  */
2244
2583
  billing_agreement_id?: string;
2584
+
2585
+ currency?: string;
2586
+
2587
+ /**
2588
+ * The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
2589
+ */
2590
+ subsellers?: Array<string>;
2591
+ }
2592
+
2593
+ interface Payto {
2594
+ /**
2595
+ * Additional fields for Mandate creation.
2596
+ */
2597
+ mandate_options?: Payto.MandateOptions;
2598
+ }
2599
+
2600
+ namespace Payto {
2601
+ interface MandateOptions {
2602
+ /**
2603
+ * Amount that will be collected. It is required when `amount_type` is `fixed`.
2604
+ */
2605
+ amount?: number;
2606
+
2607
+ /**
2608
+ * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
2609
+ */
2610
+ amount_type?: MandateOptions.AmountType;
2611
+
2612
+ /**
2613
+ * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
2614
+ */
2615
+ end_date?: string;
2616
+
2617
+ /**
2618
+ * The periodicity at which payments will be collected.
2619
+ */
2620
+ payment_schedule?: MandateOptions.PaymentSchedule;
2621
+
2622
+ /**
2623
+ * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
2624
+ */
2625
+ payments_per_period?: number;
2626
+
2627
+ /**
2628
+ * The purpose for which payments are made. Defaults to retail.
2629
+ */
2630
+ purpose?: MandateOptions.Purpose;
2631
+
2632
+ /**
2633
+ * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
2634
+ */
2635
+ start_date?: string;
2636
+ }
2637
+
2638
+ namespace MandateOptions {
2639
+ type AmountType = 'fixed' | 'maximum';
2640
+
2641
+ type PaymentSchedule =
2642
+ | 'adhoc'
2643
+ | 'annual'
2644
+ | 'daily'
2645
+ | 'fortnightly'
2646
+ | 'monthly'
2647
+ | 'quarterly'
2648
+ | 'semi_annual'
2649
+ | 'weekly';
2650
+
2651
+ type Purpose =
2652
+ | 'dependant_support'
2653
+ | 'government'
2654
+ | 'loan'
2655
+ | 'mortgage'
2656
+ | 'other'
2657
+ | 'pension'
2658
+ | 'personal'
2659
+ | 'retail'
2660
+ | 'salary'
2661
+ | 'tax'
2662
+ | 'utility';
2663
+ }
2245
2664
  }
2246
2665
 
2247
2666
  interface SepaDebit {
@@ -2284,6 +2703,11 @@ declare module 'stripe' {
2284
2703
  */
2285
2704
  filters?: FinancialConnections.Filters;
2286
2705
 
2706
+ /**
2707
+ * Customize manual entry behavior
2708
+ */
2709
+ manual_entry?: FinancialConnections.ManualEntry;
2710
+
2287
2711
  /**
2288
2712
  * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
2289
2713
  */
@@ -2306,19 +2730,39 @@ declare module 'stripe' {
2306
2730
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2307
2731
  */
2308
2732
  account_subcategories?: Array<Filters.AccountSubcategory>;
2733
+
2734
+ /**
2735
+ * ID of the institution to use to filter for selectable accounts.
2736
+ */
2737
+ institution?: string;
2309
2738
  }
2310
2739
 
2311
2740
  namespace Filters {
2312
2741
  type AccountSubcategory = 'checking' | 'savings';
2313
2742
  }
2314
2743
 
2744
+ interface ManualEntry {
2745
+ /**
2746
+ * Settings for configuring manual entry of account details.
2747
+ */
2748
+ mode: ManualEntry.Mode;
2749
+ }
2750
+
2751
+ namespace ManualEntry {
2752
+ type Mode = 'automatic' | 'custom';
2753
+ }
2754
+
2315
2755
  type Permission =
2316
2756
  | 'balances'
2317
2757
  | 'ownership'
2318
2758
  | 'payment_method'
2319
2759
  | 'transactions';
2320
2760
 
2321
- type Prefetch = 'balances' | 'ownership' | 'transactions';
2761
+ type Prefetch =
2762
+ | 'balances'
2763
+ | 'inferred_balances'
2764
+ | 'ownership'
2765
+ | 'transactions';
2322
2766
  }
2323
2767
 
2324
2768
  interface MandateOptions {
@@ -2587,6 +3031,11 @@ declare module 'stripe' {
2587
3031
  */
2588
3032
  interac_present?: PaymentMethodData.InteracPresent;
2589
3033
 
3034
+ /**
3035
+ * If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
3036
+ */
3037
+ kakao_pay?: PaymentMethodData.KakaoPay;
3038
+
2590
3039
  /**
2591
3040
  * If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
2592
3041
  */
@@ -2597,11 +3046,21 @@ declare module 'stripe' {
2597
3046
  */
2598
3047
  konbini?: PaymentMethodData.Konbini;
2599
3048
 
3049
+ /**
3050
+ * If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
3051
+ */
3052
+ kr_card?: PaymentMethodData.KrCard;
3053
+
2600
3054
  /**
2601
3055
  * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
2602
3056
  */
2603
3057
  link?: PaymentMethodData.Link;
2604
3058
 
3059
+ /**
3060
+ * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
3061
+ */
3062
+ mb_way?: PaymentMethodData.MbWay;
3063
+
2605
3064
  /**
2606
3065
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
2607
3066
  */
@@ -2617,6 +3076,11 @@ declare module 'stripe' {
2617
3076
  */
2618
3077
  multibanco?: PaymentMethodData.Multibanco;
2619
3078
 
3079
+ /**
3080
+ * If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
3081
+ */
3082
+ naver_pay?: PaymentMethodData.NaverPay;
3083
+
2620
3084
  /**
2621
3085
  * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
2622
3086
  */
@@ -2627,6 +3091,11 @@ declare module 'stripe' {
2627
3091
  */
2628
3092
  p24?: PaymentMethodData.P24;
2629
3093
 
3094
+ /**
3095
+ * If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
3096
+ */
3097
+ payco?: PaymentMethodData.Payco;
3098
+
2630
3099
  /**
2631
3100
  * If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
2632
3101
  */
@@ -2637,6 +3106,11 @@ declare module 'stripe' {
2637
3106
  */
2638
3107
  paypal?: PaymentMethodData.Paypal;
2639
3108
 
3109
+ /**
3110
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
3111
+ */
3112
+ payto?: PaymentMethodData.Payto;
3113
+
2640
3114
  /**
2641
3115
  * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
2642
3116
  */
@@ -2652,11 +3126,21 @@ declare module 'stripe' {
2652
3126
  */
2653
3127
  radar_options?: PaymentMethodData.RadarOptions;
2654
3128
 
3129
+ /**
3130
+ * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
3131
+ */
3132
+ rechnung?: PaymentMethodData.Rechnung;
3133
+
2655
3134
  /**
2656
3135
  * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
2657
3136
  */
2658
3137
  revolut_pay?: PaymentMethodData.RevolutPay;
2659
3138
 
3139
+ /**
3140
+ * If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
3141
+ */
3142
+ samsung_pay?: PaymentMethodData.SamsungPay;
3143
+
2660
3144
  /**
2661
3145
  * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
2662
3146
  */
@@ -2899,6 +3383,8 @@ declare module 'stripe' {
2899
3383
 
2900
3384
  interface InteracPresent {}
2901
3385
 
3386
+ interface KakaoPay {}
3387
+
2902
3388
  interface Klarna {
2903
3389
  /**
2904
3390
  * Customer's date of birth
@@ -2927,12 +3413,27 @@ declare module 'stripe' {
2927
3413
 
2928
3414
  interface Konbini {}
2929
3415
 
3416
+ interface KrCard {}
3417
+
2930
3418
  interface Link {}
2931
3419
 
3420
+ interface MbWay {}
3421
+
2932
3422
  interface Mobilepay {}
2933
3423
 
2934
3424
  interface Multibanco {}
2935
3425
 
3426
+ interface NaverPay {
3427
+ /**
3428
+ * Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
3429
+ */
3430
+ funding?: NaverPay.Funding;
3431
+ }
3432
+
3433
+ namespace NaverPay {
3434
+ type Funding = 'card' | 'points';
3435
+ }
3436
+
2936
3437
  interface Oxxo {}
2937
3438
 
2938
3439
  interface P24 {
@@ -2972,10 +3473,29 @@ declare module 'stripe' {
2972
3473
  | 'volkswagen_bank';
2973
3474
  }
2974
3475
 
3476
+ interface Payco {}
3477
+
2975
3478
  interface Paynow {}
2976
3479
 
2977
3480
  interface Paypal {}
2978
3481
 
3482
+ interface Payto {
3483
+ /**
3484
+ * The account number for the bank account.
3485
+ */
3486
+ account_number?: string;
3487
+
3488
+ /**
3489
+ * Bank-State-Branch number of the bank account.
3490
+ */
3491
+ bsb_number?: string;
3492
+
3493
+ /**
3494
+ * The PayID alias for the bank account.
3495
+ */
3496
+ pay_id?: string;
3497
+ }
3498
+
2979
3499
  interface Pix {}
2980
3500
 
2981
3501
  interface Promptpay {}
@@ -2987,8 +3507,36 @@ declare module 'stripe' {
2987
3507
  session?: string;
2988
3508
  }
2989
3509
 
3510
+ interface Rechnung {
3511
+ /**
3512
+ * Customer's date of birth
3513
+ */
3514
+ dob: Rechnung.Dob;
3515
+ }
3516
+
3517
+ namespace Rechnung {
3518
+ interface Dob {
3519
+ /**
3520
+ * The day of birth, between 1 and 31.
3521
+ */
3522
+ day: number;
3523
+
3524
+ /**
3525
+ * The month of birth, between 1 and 12.
3526
+ */
3527
+ month: number;
3528
+
3529
+ /**
3530
+ * The four-digit year of birth.
3531
+ */
3532
+ year: number;
3533
+ }
3534
+ }
3535
+
2990
3536
  interface RevolutPay {}
2991
3537
 
3538
+ interface SamsungPay {}
3539
+
2992
3540
  interface SepaDebit {
2993
3541
  /**
2994
3542
  * IBAN of the bank account.
@@ -3029,18 +3577,26 @@ declare module 'stripe' {
3029
3577
  | 'giropay'
3030
3578
  | 'grabpay'
3031
3579
  | 'ideal'
3580
+ | 'kakao_pay'
3032
3581
  | 'klarna'
3033
3582
  | 'konbini'
3583
+ | 'kr_card'
3034
3584
  | 'link'
3585
+ | 'mb_way'
3035
3586
  | 'mobilepay'
3036
3587
  | 'multibanco'
3588
+ | 'naver_pay'
3037
3589
  | 'oxxo'
3038
3590
  | 'p24'
3591
+ | 'payco'
3039
3592
  | 'paynow'
3040
3593
  | 'paypal'
3594
+ | 'payto'
3041
3595
  | 'pix'
3042
3596
  | 'promptpay'
3597
+ | 'rechnung'
3043
3598
  | 'revolut_pay'
3599
+ | 'samsung_pay'
3044
3600
  | 'sepa_debit'
3045
3601
  | 'sofort'
3046
3602
  | 'swish'
@@ -3123,6 +3679,11 @@ declare module 'stripe' {
3123
3679
  */
3124
3680
  paypal?: PaymentMethodOptions.Paypal;
3125
3681
 
3682
+ /**
3683
+ * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
3684
+ */
3685
+ payto?: PaymentMethodOptions.Payto;
3686
+
3126
3687
  /**
3127
3688
  * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
3128
3689
  */
@@ -3418,6 +3979,86 @@ declare module 'stripe' {
3418
3979
  * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
3419
3980
  */
3420
3981
  billing_agreement_id?: string;
3982
+
3983
+ currency?: string;
3984
+
3985
+ /**
3986
+ * The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
3987
+ */
3988
+ subsellers?: Array<string>;
3989
+ }
3990
+
3991
+ interface Payto {
3992
+ /**
3993
+ * Additional fields for Mandate creation.
3994
+ */
3995
+ mandate_options?: Payto.MandateOptions;
3996
+ }
3997
+
3998
+ namespace Payto {
3999
+ interface MandateOptions {
4000
+ /**
4001
+ * Amount that will be collected. It is required when `amount_type` is `fixed`.
4002
+ */
4003
+ amount?: number;
4004
+
4005
+ /**
4006
+ * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
4007
+ */
4008
+ amount_type?: MandateOptions.AmountType;
4009
+
4010
+ /**
4011
+ * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
4012
+ */
4013
+ end_date?: string;
4014
+
4015
+ /**
4016
+ * The periodicity at which payments will be collected.
4017
+ */
4018
+ payment_schedule?: MandateOptions.PaymentSchedule;
4019
+
4020
+ /**
4021
+ * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
4022
+ */
4023
+ payments_per_period?: number;
4024
+
4025
+ /**
4026
+ * The purpose for which payments are made. Defaults to retail.
4027
+ */
4028
+ purpose?: MandateOptions.Purpose;
4029
+
4030
+ /**
4031
+ * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
4032
+ */
4033
+ start_date?: string;
4034
+ }
4035
+
4036
+ namespace MandateOptions {
4037
+ type AmountType = 'fixed' | 'maximum';
4038
+
4039
+ type PaymentSchedule =
4040
+ | 'adhoc'
4041
+ | 'annual'
4042
+ | 'daily'
4043
+ | 'fortnightly'
4044
+ | 'monthly'
4045
+ | 'quarterly'
4046
+ | 'semi_annual'
4047
+ | 'weekly';
4048
+
4049
+ type Purpose =
4050
+ | 'dependant_support'
4051
+ | 'government'
4052
+ | 'loan'
4053
+ | 'mortgage'
4054
+ | 'other'
4055
+ | 'pension'
4056
+ | 'personal'
4057
+ | 'retail'
4058
+ | 'salary'
4059
+ | 'tax'
4060
+ | 'utility';
4061
+ }
3421
4062
  }
3422
4063
 
3423
4064
  interface SepaDebit {
@@ -3460,6 +4101,11 @@ declare module 'stripe' {
3460
4101
  */
3461
4102
  filters?: FinancialConnections.Filters;
3462
4103
 
4104
+ /**
4105
+ * Customize manual entry behavior
4106
+ */
4107
+ manual_entry?: FinancialConnections.ManualEntry;
4108
+
3463
4109
  /**
3464
4110
  * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
3465
4111
  */
@@ -3482,19 +4128,39 @@ declare module 'stripe' {
3482
4128
  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
3483
4129
  */
3484
4130
  account_subcategories?: Array<Filters.AccountSubcategory>;
4131
+
4132
+ /**
4133
+ * ID of the institution to use to filter for selectable accounts.
4134
+ */
4135
+ institution?: string;
3485
4136
  }
3486
4137
 
3487
4138
  namespace Filters {
3488
4139
  type AccountSubcategory = 'checking' | 'savings';
3489
4140
  }
3490
4141
 
4142
+ interface ManualEntry {
4143
+ /**
4144
+ * Settings for configuring manual entry of account details.
4145
+ */
4146
+ mode: ManualEntry.Mode;
4147
+ }
4148
+
4149
+ namespace ManualEntry {
4150
+ type Mode = 'automatic' | 'custom';
4151
+ }
4152
+
3491
4153
  type Permission =
3492
4154
  | 'balances'
3493
4155
  | 'ownership'
3494
4156
  | 'payment_method'
3495
4157
  | 'transactions';
3496
4158
 
3497
- type Prefetch = 'balances' | 'ownership' | 'transactions';
4159
+ type Prefetch =
4160
+ | 'balances'
4161
+ | 'inferred_balances'
4162
+ | 'ownership'
4163
+ | 'transactions';
3498
4164
  }
3499
4165
 
3500
4166
  interface MandateOptions {