stripe 17.7.0-beta.1 → 17.7.0

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 (176) hide show
  1. package/CHANGELOG.md +120 -1064
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/apiVersion.js +1 -1
  6. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  7. package/cjs/resources/Invoices.js +0 -17
  8. package/cjs/resources/PaymentIntents.js +0 -8
  9. package/cjs/resources/Quotes.js +0 -32
  10. package/cjs/resources/SubscriptionSchedules.js +0 -4
  11. package/cjs/resources/Terminal/Readers.js +0 -12
  12. package/cjs/resources.js +10 -48
  13. package/cjs/stripe.core.js +1 -1
  14. package/esm/apiVersion.js +1 -1
  15. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  16. package/esm/resources/Invoices.js +0 -17
  17. package/esm/resources/PaymentIntents.js +0 -8
  18. package/esm/resources/Quotes.js +0 -32
  19. package/esm/resources/SubscriptionSchedules.js +0 -4
  20. package/esm/resources/Terminal/Readers.js +0 -12
  21. package/esm/resources.js +0 -33
  22. package/esm/stripe.core.js +1 -1
  23. package/package.json +1 -1
  24. package/types/AccountLinksResource.d.ts +1 -5
  25. package/types/AccountSessions.d.ts +0 -45
  26. package/types/AccountSessionsResource.d.ts +0 -243
  27. package/types/Accounts.d.ts +1 -205
  28. package/types/AccountsResource.d.ts +2 -526
  29. package/types/Billing/CreditBalanceSummaryResource.d.ts +1 -1
  30. package/types/Billing/CreditGrants.d.ts +5 -0
  31. package/types/Billing/CreditGrantsResource.d.ts +7 -2
  32. package/types/Cards.d.ts +0 -5
  33. package/types/Charges.d.ts +1 -149
  34. package/types/ChargesResource.d.ts +0 -1294
  35. package/types/Checkout/Sessions.d.ts +29 -302
  36. package/types/Checkout/SessionsResource.d.ts +30 -383
  37. package/types/ConfirmationTokens.d.ts +0 -99
  38. package/types/Coupons.d.ts +1 -1
  39. package/types/CouponsResource.d.ts +1 -1
  40. package/types/CreditNotes.d.ts +0 -21
  41. package/types/CreditNotesResource.d.ts +0 -51
  42. package/types/CustomersResource.d.ts +0 -7
  43. package/types/EventTypes.d.ts +0 -596
  44. package/types/Events.d.ts +0 -93
  45. package/types/FinancialConnections/Accounts.d.ts +1 -29
  46. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  47. package/types/FinancialConnections/Sessions.d.ts +1 -49
  48. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  49. package/types/InvoiceItems.d.ts +0 -5
  50. package/types/InvoiceItemsResource.d.ts +0 -98
  51. package/types/InvoiceLineItems.d.ts +1 -28
  52. package/types/Invoices.d.ts +2 -137
  53. package/types/InvoicesResource.d.ts +1882 -5567
  54. package/types/Issuing/Authorizations.d.ts +0 -1
  55. package/types/Issuing/CardholdersResource.d.ts +1 -2
  56. package/types/Issuing/Transactions.d.ts +0 -2
  57. package/types/Issuing/TransactionsResource.d.ts +0 -5
  58. package/types/LineItems.d.ts +0 -32
  59. package/types/Mandates.d.ts +0 -77
  60. package/types/PaymentIntents.d.ts +30 -648
  61. package/types/PaymentIntentsResource.d.ts +3848 -8060
  62. package/types/PaymentLinks.d.ts +0 -6
  63. package/types/PaymentLinksResource.d.ts +0 -12
  64. package/types/PaymentMethodConfigurations.d.ts +0 -180
  65. package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
  66. package/types/PaymentMethods.d.ts +0 -99
  67. package/types/PaymentMethodsResource.d.ts +0 -133
  68. package/types/Prices.d.ts +0 -22
  69. package/types/PricesResource.d.ts +0 -22
  70. package/types/Products.d.ts +0 -39
  71. package/types/ProductsResource.d.ts +5 -36
  72. package/types/Quotes.d.ts +1 -591
  73. package/types/QuotesResource.d.ts +199 -2531
  74. package/types/Refunds.d.ts +0 -14
  75. package/types/SetupAttempts.d.ts +0 -38
  76. package/types/SetupIntents.d.ts +1 -111
  77. package/types/SetupIntentsResource.d.ts +3 -645
  78. package/types/Sources.d.ts +0 -29
  79. package/types/SubscriptionItems.d.ts +0 -21
  80. package/types/SubscriptionItemsResource.d.ts +0 -109
  81. package/types/SubscriptionSchedules.d.ts +0 -200
  82. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  83. package/types/Subscriptions.d.ts +1 -91
  84. package/types/SubscriptionsResource.d.ts +2 -369
  85. package/types/Terminal/Readers.d.ts +0 -290
  86. package/types/Terminal/ReadersResource.d.ts +0 -215
  87. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -104
  88. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  89. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  90. package/types/TokensResource.d.ts +1 -3
  91. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  92. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  93. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  94. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  95. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  96. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  97. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  98. package/types/WebhookEndpointsResource.d.ts +2 -71
  99. package/types/index.d.ts +0 -62
  100. package/types/lib.d.ts +1 -1
  101. package/types/test/typescriptTest.ts +3 -3
  102. package/cjs/resources/AccountNotices.js +0 -21
  103. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  104. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  105. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  106. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  107. package/cjs/resources/GiftCards/Cards.js +0 -23
  108. package/cjs/resources/GiftCards/Transactions.js +0 -33
  109. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  110. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  111. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  112. package/cjs/resources/Margins.js +0 -22
  113. package/cjs/resources/Orders.js +0 -24
  114. package/cjs/resources/PaymentAttemptRecords.js +0 -17
  115. package/cjs/resources/PaymentRecords.js +0 -29
  116. package/cjs/resources/Tax/Associations.js +0 -9
  117. package/cjs/resources/Tax/Forms.js +0 -20
  118. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  119. package/esm/resources/AccountNotices.js +0 -18
  120. package/esm/resources/Capital/FinancingOffers.js +0 -18
  121. package/esm/resources/Capital/FinancingSummary.js +0 -9
  122. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  123. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  124. package/esm/resources/GiftCards/Cards.js +0 -20
  125. package/esm/resources/GiftCards/Transactions.js +0 -30
  126. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  127. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  128. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  129. package/esm/resources/Margins.js +0 -19
  130. package/esm/resources/Orders.js +0 -21
  131. package/esm/resources/PaymentAttemptRecords.js +0 -14
  132. package/esm/resources/PaymentRecords.js +0 -26
  133. package/esm/resources/Tax/Associations.js +0 -6
  134. package/esm/resources/Tax/Forms.js +0 -17
  135. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  136. package/types/AccountNotices.d.ts +0 -113
  137. package/types/AccountNoticesResource.d.ts +0 -98
  138. package/types/Billing/MeterErrorReports.d.ts +0 -106
  139. package/types/Capital/FinancingOffers.d.ts +0 -188
  140. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  141. package/types/Capital/FinancingSummary.d.ts +0 -106
  142. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  143. package/types/Capital/FinancingTransactions.d.ts +0 -135
  144. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  145. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  146. package/types/FinancialConnections/Institutions.d.ts +0 -93
  147. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  148. package/types/GiftCards/Cards.d.ts +0 -118
  149. package/types/GiftCards/CardsResource.d.ts +0 -159
  150. package/types/GiftCards/Transactions.d.ts +0 -129
  151. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  152. package/types/InvoicePayments.d.ts +0 -113
  153. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  154. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  155. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  156. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  157. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  158. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  159. package/types/Issuing/Settlements.d.ts +0 -103
  160. package/types/Margins.d.ts +0 -56
  161. package/types/MarginsResource.d.ts +0 -114
  162. package/types/Orders.d.ts +0 -1179
  163. package/types/OrdersResource.d.ts +0 -2961
  164. package/types/PaymentAttemptRecords.d.ts +0 -242
  165. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  166. package/types/PaymentRecords.d.ts +0 -242
  167. package/types/PaymentRecordsResource.d.ts +0 -455
  168. package/types/QuoteLines.d.ts +0 -634
  169. package/types/QuotePreviewInvoices.d.ts +0 -1658
  170. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -824
  171. package/types/Tax/Associations.d.ts +0 -126
  172. package/types/Tax/AssociationsResource.d.ts +0 -29
  173. package/types/Tax/Forms.d.ts +0 -220
  174. package/types/Tax/FormsResource.d.ts +0 -107
  175. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  176. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
@@ -188,11 +188,6 @@ declare module 'stripe' {
188
188
  */
189
189
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
190
190
 
191
- /**
192
- * Provides industry-specific information about the charge.
193
- */
194
- payment_details?: ChargeUpdateParams.PaymentDetails;
195
-
196
191
  /**
197
192
  * This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
198
193
  */
@@ -221,648 +216,6 @@ declare module 'stripe' {
221
216
  type UserReport = 'fraudulent' | 'safe';
222
217
  }
223
218
 
224
- interface PaymentDetails {
225
- /**
226
- * Car rental details for this PaymentIntent.
227
- */
228
- car_rental?: PaymentDetails.CarRental;
229
-
230
- /**
231
- * Event details for this PaymentIntent
232
- */
233
- event_details?: PaymentDetails.EventDetails;
234
-
235
- /**
236
- * Flight reservation details for this PaymentIntent
237
- */
238
- flight?: PaymentDetails.Flight;
239
-
240
- /**
241
- * Lodging reservation details for this PaymentIntent
242
- */
243
- lodging?: PaymentDetails.Lodging;
244
-
245
- /**
246
- * Subscription details for this PaymentIntent
247
- */
248
- subscription?: PaymentDetails.Subscription;
249
- }
250
-
251
- namespace PaymentDetails {
252
- interface CarRental {
253
- /**
254
- * Affiliate details for this purchase.
255
- */
256
- affiliate?: CarRental.Affiliate;
257
-
258
- /**
259
- * The booking number associated with the car rental.
260
- */
261
- booking_number: string;
262
-
263
- /**
264
- * Class code of the car.
265
- */
266
- car_class_code?: string;
267
-
268
- /**
269
- * Make of the car.
270
- */
271
- car_make?: string;
272
-
273
- /**
274
- * Model of the car.
275
- */
276
- car_model?: string;
277
-
278
- /**
279
- * The name of the rental car company.
280
- */
281
- company?: string;
282
-
283
- /**
284
- * The customer service phone number of the car rental company.
285
- */
286
- customer_service_phone_number?: string;
287
-
288
- /**
289
- * Number of days the car is being rented.
290
- */
291
- days_rented: number;
292
-
293
- /**
294
- * Delivery details for this purchase.
295
- */
296
- delivery?: CarRental.Delivery;
297
-
298
- /**
299
- * The details of the passengers in the travel reservation
300
- */
301
- drivers?: Array<CarRental.Driver>;
302
-
303
- /**
304
- * List of additional charges being billed.
305
- */
306
- extra_charges?: Array<CarRental.ExtraCharge>;
307
-
308
- /**
309
- * Indicates if the customer did not keep nor cancel their booking.
310
- */
311
- no_show?: boolean;
312
-
313
- /**
314
- * Car pick-up address.
315
- */
316
- pickup_address?: Stripe.AddressParam;
317
-
318
- /**
319
- * Car pick-up time. Measured in seconds since the Unix epoch.
320
- */
321
- pickup_at: number;
322
-
323
- /**
324
- * Rental rate.
325
- */
326
- rate_amount?: number;
327
-
328
- /**
329
- * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
330
- */
331
- rate_interval?: CarRental.RateInterval;
332
-
333
- /**
334
- * The name of the person or entity renting the car.
335
- */
336
- renter_name?: string;
337
-
338
- /**
339
- * Car return address.
340
- */
341
- return_address?: Stripe.AddressParam;
342
-
343
- /**
344
- * Car return time. Measured in seconds since the Unix epoch.
345
- */
346
- return_at: number;
347
-
348
- /**
349
- * Indicates whether the goods or services are tax-exempt or tax is not collected.
350
- */
351
- tax_exempt?: boolean;
352
- }
353
-
354
- namespace CarRental {
355
- interface Affiliate {
356
- /**
357
- * The name of the affiliate that originated the purchase.
358
- */
359
- name: string;
360
- }
361
-
362
- interface Delivery {
363
- /**
364
- * The delivery method for the payment
365
- */
366
- mode?: Delivery.Mode;
367
-
368
- /**
369
- * Details of the recipient.
370
- */
371
- recipient?: Delivery.Recipient;
372
- }
373
-
374
- namespace Delivery {
375
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
376
-
377
- interface Recipient {
378
- /**
379
- * The email of the recipient the ticket is delivered to.
380
- */
381
- email?: string;
382
-
383
- /**
384
- * The name of the recipient the ticket is delivered to.
385
- */
386
- name?: string;
387
-
388
- /**
389
- * The phone number of the recipient the ticket is delivered to.
390
- */
391
- phone?: string;
392
- }
393
- }
394
-
395
- interface Driver {
396
- /**
397
- * Full name of the person or entity on the car reservation.
398
- */
399
- name: string;
400
- }
401
-
402
- type ExtraCharge =
403
- | 'extra_mileage'
404
- | 'gas'
405
- | 'late_return'
406
- | 'one_way_service'
407
- | 'parking_violation';
408
-
409
- type RateInterval = 'day' | 'month' | 'week';
410
- }
411
-
412
- interface EventDetails {
413
- /**
414
- * Indicates if the tickets are digitally checked when entering the venue.
415
- */
416
- access_controlled_venue?: boolean;
417
-
418
- /**
419
- * The event location's address.
420
- */
421
- address?: Stripe.AddressParam;
422
-
423
- /**
424
- * Affiliate details for this purchase.
425
- */
426
- affiliate?: EventDetails.Affiliate;
427
-
428
- /**
429
- * The name of the company
430
- */
431
- company?: string;
432
-
433
- /**
434
- * Delivery details for this purchase.
435
- */
436
- delivery?: EventDetails.Delivery;
437
-
438
- /**
439
- * Event end time. Measured in seconds since the Unix epoch.
440
- */
441
- ends_at?: number;
442
-
443
- /**
444
- * Type of the event entertainment (concert, sports event etc)
445
- */
446
- genre?: string;
447
-
448
- /**
449
- * The name of the event.
450
- */
451
- name: string;
452
-
453
- /**
454
- * Event start time. Measured in seconds since the Unix epoch.
455
- */
456
- starts_at?: number;
457
- }
458
-
459
- namespace EventDetails {
460
- interface Affiliate {
461
- /**
462
- * The name of the affiliate that originated the purchase.
463
- */
464
- name: string;
465
- }
466
-
467
- interface Delivery {
468
- /**
469
- * The delivery method for the payment
470
- */
471
- mode?: Delivery.Mode;
472
-
473
- /**
474
- * Details of the recipient.
475
- */
476
- recipient?: Delivery.Recipient;
477
- }
478
-
479
- namespace Delivery {
480
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
481
-
482
- interface Recipient {
483
- /**
484
- * The email of the recipient the ticket is delivered to.
485
- */
486
- email?: string;
487
-
488
- /**
489
- * The name of the recipient the ticket is delivered to.
490
- */
491
- name?: string;
492
-
493
- /**
494
- * The phone number of the recipient the ticket is delivered to.
495
- */
496
- phone?: string;
497
- }
498
- }
499
- }
500
-
501
- interface Flight {
502
- /**
503
- * Affiliate details for this purchase.
504
- */
505
- affiliate?: Flight.Affiliate;
506
-
507
- /**
508
- * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
509
- */
510
- agency_number?: string;
511
-
512
- /**
513
- * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
514
- */
515
- carrier?: string;
516
-
517
- /**
518
- * Delivery details for this purchase.
519
- */
520
- delivery?: Flight.Delivery;
521
-
522
- /**
523
- * The name of the person or entity on the reservation.
524
- */
525
- passenger_name?: string;
526
-
527
- /**
528
- * The details of the passengers in the travel reservation.
529
- */
530
- passengers?: Array<Flight.Passenger>;
531
-
532
- /**
533
- * The individual flight segments associated with the trip.
534
- */
535
- segments: Array<Flight.Segment>;
536
-
537
- /**
538
- * The ticket number associated with the travel reservation.
539
- */
540
- ticket_number?: string;
541
- }
542
-
543
- namespace Flight {
544
- interface Affiliate {
545
- /**
546
- * The name of the affiliate that originated the purchase.
547
- */
548
- name: string;
549
- }
550
-
551
- interface Delivery {
552
- /**
553
- * The delivery method for the payment
554
- */
555
- mode?: Delivery.Mode;
556
-
557
- /**
558
- * Details of the recipient.
559
- */
560
- recipient?: Delivery.Recipient;
561
- }
562
-
563
- namespace Delivery {
564
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
565
-
566
- interface Recipient {
567
- /**
568
- * The email of the recipient the ticket is delivered to.
569
- */
570
- email?: string;
571
-
572
- /**
573
- * The name of the recipient the ticket is delivered to.
574
- */
575
- name?: string;
576
-
577
- /**
578
- * The phone number of the recipient the ticket is delivered to.
579
- */
580
- phone?: string;
581
- }
582
- }
583
-
584
- interface Passenger {
585
- /**
586
- * Full name of the person or entity on the flight reservation.
587
- */
588
- name: string;
589
- }
590
-
591
- interface Segment {
592
- /**
593
- * The flight segment amount.
594
- */
595
- amount?: number;
596
-
597
- /**
598
- * The International Air Transport Association (IATA) airport code for the arrival airport.
599
- */
600
- arrival_airport?: string;
601
-
602
- /**
603
- * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
604
- */
605
- arrives_at?: number;
606
-
607
- /**
608
- * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
609
- */
610
- carrier?: string;
611
-
612
- /**
613
- * The departure time for the flight segment. Measured in seconds since the Unix epoch.
614
- */
615
- departs_at: number;
616
-
617
- /**
618
- * The International Air Transport Association (IATA) airport code for the departure airport.
619
- */
620
- departure_airport?: string;
621
-
622
- /**
623
- * The flight number associated with the segment
624
- */
625
- flight_number?: string;
626
-
627
- /**
628
- * The fare class for the segment.
629
- */
630
- service_class?: Segment.ServiceClass;
631
- }
632
-
633
- namespace Segment {
634
- type ServiceClass =
635
- | 'business'
636
- | 'economy'
637
- | 'first'
638
- | 'premium_economy';
639
- }
640
- }
641
-
642
- interface Lodging {
643
- /**
644
- * The lodging location's address.
645
- */
646
- address?: Stripe.AddressParam;
647
-
648
- /**
649
- * The number of adults on the booking
650
- */
651
- adults?: number;
652
-
653
- /**
654
- * Affiliate details for this purchase.
655
- */
656
- affiliate?: Lodging.Affiliate;
657
-
658
- /**
659
- * The booking number associated with the lodging reservation.
660
- */
661
- booking_number?: string;
662
-
663
- /**
664
- * The lodging category
665
- */
666
- category?: Lodging.Category;
667
-
668
- /**
669
- * Loding check-in time. Measured in seconds since the Unix epoch.
670
- */
671
- checkin_at: number;
672
-
673
- /**
674
- * Lodging check-out time. Measured in seconds since the Unix epoch.
675
- */
676
- checkout_at: number;
677
-
678
- /**
679
- * The customer service phone number of the lodging company.
680
- */
681
- customer_service_phone_number?: string;
682
-
683
- /**
684
- * The daily lodging room rate.
685
- */
686
- daily_room_rate_amount?: number;
687
-
688
- /**
689
- * Delivery details for this purchase.
690
- */
691
- delivery?: Lodging.Delivery;
692
-
693
- /**
694
- * List of additional charges being billed.
695
- */
696
- extra_charges?: Array<Lodging.ExtraCharge>;
697
-
698
- /**
699
- * Indicates whether the lodging location is compliant with the Fire Safety Act.
700
- */
701
- fire_safety_act_compliance?: boolean;
702
-
703
- /**
704
- * The name of the lodging location.
705
- */
706
- name?: string;
707
-
708
- /**
709
- * Indicates if the customer did not keep their booking while failing to cancel the reservation.
710
- */
711
- no_show?: boolean;
712
-
713
- /**
714
- * The number of rooms on the booking
715
- */
716
- number_of_rooms?: number;
717
-
718
- /**
719
- * The details of the passengers in the travel reservation
720
- */
721
- passengers?: Array<Lodging.Passenger>;
722
-
723
- /**
724
- * The phone number of the lodging location.
725
- */
726
- property_phone_number?: string;
727
-
728
- /**
729
- * The room class for this purchase.
730
- */
731
- room_class?: string;
732
-
733
- /**
734
- * The number of room nights
735
- */
736
- room_nights?: number;
737
-
738
- /**
739
- * The total tax amount associating with the room reservation.
740
- */
741
- total_room_tax_amount?: number;
742
-
743
- /**
744
- * The total tax amount
745
- */
746
- total_tax_amount?: number;
747
- }
748
-
749
- namespace Lodging {
750
- interface Affiliate {
751
- /**
752
- * The name of the affiliate that originated the purchase.
753
- */
754
- name: string;
755
- }
756
-
757
- type Category = 'hotel' | 'vacation_rental';
758
-
759
- interface Delivery {
760
- /**
761
- * The delivery method for the payment
762
- */
763
- mode?: Delivery.Mode;
764
-
765
- /**
766
- * Details of the recipient.
767
- */
768
- recipient?: Delivery.Recipient;
769
- }
770
-
771
- namespace Delivery {
772
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
773
-
774
- interface Recipient {
775
- /**
776
- * The email of the recipient the ticket is delivered to.
777
- */
778
- email?: string;
779
-
780
- /**
781
- * The name of the recipient the ticket is delivered to.
782
- */
783
- name?: string;
784
-
785
- /**
786
- * The phone number of the recipient the ticket is delivered to.
787
- */
788
- phone?: string;
789
- }
790
- }
791
-
792
- type ExtraCharge =
793
- | 'gift_shop'
794
- | 'laundry'
795
- | 'mini_bar'
796
- | 'other'
797
- | 'restaurant'
798
- | 'telephone';
799
-
800
- interface Passenger {
801
- /**
802
- * Full name of the person or entity on the lodging reservation.
803
- */
804
- name: string;
805
- }
806
- }
807
-
808
- interface Subscription {
809
- /**
810
- * Affiliate details for this purchase.
811
- */
812
- affiliate?: Subscription.Affiliate;
813
-
814
- /**
815
- * Info whether the subscription will be auto renewed upon expiry.
816
- */
817
- auto_renewal?: boolean;
818
-
819
- /**
820
- * Subscription billing details for this purchase.
821
- */
822
- billing_interval?: Subscription.BillingInterval;
823
-
824
- /**
825
- * Subscription end time. Measured in seconds since the Unix epoch.
826
- */
827
- ends_at?: number;
828
-
829
- /**
830
- * Name of the product on subscription. e.g. Apple Music Subscription
831
- */
832
- name: string;
833
-
834
- /**
835
- * Subscription start time. Measured in seconds since the Unix epoch.
836
- */
837
- starts_at?: number;
838
- }
839
-
840
- namespace Subscription {
841
- interface Affiliate {
842
- /**
843
- * The name of the affiliate that originated the purchase.
844
- */
845
- name: string;
846
- }
847
-
848
- interface BillingInterval {
849
- /**
850
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
851
- */
852
- count: number;
853
-
854
- /**
855
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
856
- */
857
- interval: BillingInterval.Interval;
858
- }
859
-
860
- namespace BillingInterval {
861
- type Interval = 'day' | 'month' | 'week' | 'year';
862
- }
863
- }
864
- }
865
-
866
219
  interface Shipping {
867
220
  /**
868
221
  * Shipping address.
@@ -939,11 +292,6 @@ declare module 'stripe' {
939
292
  */
940
293
  expand?: Array<string>;
941
294
 
942
- /**
943
- * Provides industry-specific information about the charge.
944
- */
945
- payment_details?: ChargeCaptureParams.PaymentDetails;
946
-
947
295
  /**
948
296
  * The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
949
297
  */
@@ -973,648 +321,6 @@ declare module 'stripe' {
973
321
  }
974
322
 
975
323
  namespace ChargeCaptureParams {
976
- interface PaymentDetails {
977
- /**
978
- * Car rental details for this PaymentIntent.
979
- */
980
- car_rental?: PaymentDetails.CarRental;
981
-
982
- /**
983
- * Event details for this PaymentIntent
984
- */
985
- event_details?: PaymentDetails.EventDetails;
986
-
987
- /**
988
- * Flight reservation details for this PaymentIntent
989
- */
990
- flight?: PaymentDetails.Flight;
991
-
992
- /**
993
- * Lodging reservation details for this PaymentIntent
994
- */
995
- lodging?: PaymentDetails.Lodging;
996
-
997
- /**
998
- * Subscription details for this PaymentIntent
999
- */
1000
- subscription?: PaymentDetails.Subscription;
1001
- }
1002
-
1003
- namespace PaymentDetails {
1004
- interface CarRental {
1005
- /**
1006
- * Affiliate details for this purchase.
1007
- */
1008
- affiliate?: CarRental.Affiliate;
1009
-
1010
- /**
1011
- * The booking number associated with the car rental.
1012
- */
1013
- booking_number: string;
1014
-
1015
- /**
1016
- * Class code of the car.
1017
- */
1018
- car_class_code?: string;
1019
-
1020
- /**
1021
- * Make of the car.
1022
- */
1023
- car_make?: string;
1024
-
1025
- /**
1026
- * Model of the car.
1027
- */
1028
- car_model?: string;
1029
-
1030
- /**
1031
- * The name of the rental car company.
1032
- */
1033
- company?: string;
1034
-
1035
- /**
1036
- * The customer service phone number of the car rental company.
1037
- */
1038
- customer_service_phone_number?: string;
1039
-
1040
- /**
1041
- * Number of days the car is being rented.
1042
- */
1043
- days_rented: number;
1044
-
1045
- /**
1046
- * Delivery details for this purchase.
1047
- */
1048
- delivery?: CarRental.Delivery;
1049
-
1050
- /**
1051
- * The details of the passengers in the travel reservation
1052
- */
1053
- drivers?: Array<CarRental.Driver>;
1054
-
1055
- /**
1056
- * List of additional charges being billed.
1057
- */
1058
- extra_charges?: Array<CarRental.ExtraCharge>;
1059
-
1060
- /**
1061
- * Indicates if the customer did not keep nor cancel their booking.
1062
- */
1063
- no_show?: boolean;
1064
-
1065
- /**
1066
- * Car pick-up address.
1067
- */
1068
- pickup_address?: Stripe.AddressParam;
1069
-
1070
- /**
1071
- * Car pick-up time. Measured in seconds since the Unix epoch.
1072
- */
1073
- pickup_at: number;
1074
-
1075
- /**
1076
- * Rental rate.
1077
- */
1078
- rate_amount?: number;
1079
-
1080
- /**
1081
- * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
1082
- */
1083
- rate_interval?: CarRental.RateInterval;
1084
-
1085
- /**
1086
- * The name of the person or entity renting the car.
1087
- */
1088
- renter_name?: string;
1089
-
1090
- /**
1091
- * Car return address.
1092
- */
1093
- return_address?: Stripe.AddressParam;
1094
-
1095
- /**
1096
- * Car return time. Measured in seconds since the Unix epoch.
1097
- */
1098
- return_at: number;
1099
-
1100
- /**
1101
- * Indicates whether the goods or services are tax-exempt or tax is not collected.
1102
- */
1103
- tax_exempt?: boolean;
1104
- }
1105
-
1106
- namespace CarRental {
1107
- interface Affiliate {
1108
- /**
1109
- * The name of the affiliate that originated the purchase.
1110
- */
1111
- name: string;
1112
- }
1113
-
1114
- interface Delivery {
1115
- /**
1116
- * The delivery method for the payment
1117
- */
1118
- mode?: Delivery.Mode;
1119
-
1120
- /**
1121
- * Details of the recipient.
1122
- */
1123
- recipient?: Delivery.Recipient;
1124
- }
1125
-
1126
- namespace Delivery {
1127
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
1128
-
1129
- interface Recipient {
1130
- /**
1131
- * The email of the recipient the ticket is delivered to.
1132
- */
1133
- email?: string;
1134
-
1135
- /**
1136
- * The name of the recipient the ticket is delivered to.
1137
- */
1138
- name?: string;
1139
-
1140
- /**
1141
- * The phone number of the recipient the ticket is delivered to.
1142
- */
1143
- phone?: string;
1144
- }
1145
- }
1146
-
1147
- interface Driver {
1148
- /**
1149
- * Full name of the person or entity on the car reservation.
1150
- */
1151
- name: string;
1152
- }
1153
-
1154
- type ExtraCharge =
1155
- | 'extra_mileage'
1156
- | 'gas'
1157
- | 'late_return'
1158
- | 'one_way_service'
1159
- | 'parking_violation';
1160
-
1161
- type RateInterval = 'day' | 'month' | 'week';
1162
- }
1163
-
1164
- interface EventDetails {
1165
- /**
1166
- * Indicates if the tickets are digitally checked when entering the venue.
1167
- */
1168
- access_controlled_venue?: boolean;
1169
-
1170
- /**
1171
- * The event location's address.
1172
- */
1173
- address?: Stripe.AddressParam;
1174
-
1175
- /**
1176
- * Affiliate details for this purchase.
1177
- */
1178
- affiliate?: EventDetails.Affiliate;
1179
-
1180
- /**
1181
- * The name of the company
1182
- */
1183
- company?: string;
1184
-
1185
- /**
1186
- * Delivery details for this purchase.
1187
- */
1188
- delivery?: EventDetails.Delivery;
1189
-
1190
- /**
1191
- * Event end time. Measured in seconds since the Unix epoch.
1192
- */
1193
- ends_at?: number;
1194
-
1195
- /**
1196
- * Type of the event entertainment (concert, sports event etc)
1197
- */
1198
- genre?: string;
1199
-
1200
- /**
1201
- * The name of the event.
1202
- */
1203
- name: string;
1204
-
1205
- /**
1206
- * Event start time. Measured in seconds since the Unix epoch.
1207
- */
1208
- starts_at?: number;
1209
- }
1210
-
1211
- namespace EventDetails {
1212
- interface Affiliate {
1213
- /**
1214
- * The name of the affiliate that originated the purchase.
1215
- */
1216
- name: string;
1217
- }
1218
-
1219
- interface Delivery {
1220
- /**
1221
- * The delivery method for the payment
1222
- */
1223
- mode?: Delivery.Mode;
1224
-
1225
- /**
1226
- * Details of the recipient.
1227
- */
1228
- recipient?: Delivery.Recipient;
1229
- }
1230
-
1231
- namespace Delivery {
1232
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
1233
-
1234
- interface Recipient {
1235
- /**
1236
- * The email of the recipient the ticket is delivered to.
1237
- */
1238
- email?: string;
1239
-
1240
- /**
1241
- * The name of the recipient the ticket is delivered to.
1242
- */
1243
- name?: string;
1244
-
1245
- /**
1246
- * The phone number of the recipient the ticket is delivered to.
1247
- */
1248
- phone?: string;
1249
- }
1250
- }
1251
- }
1252
-
1253
- interface Flight {
1254
- /**
1255
- * Affiliate details for this purchase.
1256
- */
1257
- affiliate?: Flight.Affiliate;
1258
-
1259
- /**
1260
- * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
1261
- */
1262
- agency_number?: string;
1263
-
1264
- /**
1265
- * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
1266
- */
1267
- carrier?: string;
1268
-
1269
- /**
1270
- * Delivery details for this purchase.
1271
- */
1272
- delivery?: Flight.Delivery;
1273
-
1274
- /**
1275
- * The name of the person or entity on the reservation.
1276
- */
1277
- passenger_name?: string;
1278
-
1279
- /**
1280
- * The details of the passengers in the travel reservation.
1281
- */
1282
- passengers?: Array<Flight.Passenger>;
1283
-
1284
- /**
1285
- * The individual flight segments associated with the trip.
1286
- */
1287
- segments: Array<Flight.Segment>;
1288
-
1289
- /**
1290
- * The ticket number associated with the travel reservation.
1291
- */
1292
- ticket_number?: string;
1293
- }
1294
-
1295
- namespace Flight {
1296
- interface Affiliate {
1297
- /**
1298
- * The name of the affiliate that originated the purchase.
1299
- */
1300
- name: string;
1301
- }
1302
-
1303
- interface Delivery {
1304
- /**
1305
- * The delivery method for the payment
1306
- */
1307
- mode?: Delivery.Mode;
1308
-
1309
- /**
1310
- * Details of the recipient.
1311
- */
1312
- recipient?: Delivery.Recipient;
1313
- }
1314
-
1315
- namespace Delivery {
1316
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
1317
-
1318
- interface Recipient {
1319
- /**
1320
- * The email of the recipient the ticket is delivered to.
1321
- */
1322
- email?: string;
1323
-
1324
- /**
1325
- * The name of the recipient the ticket is delivered to.
1326
- */
1327
- name?: string;
1328
-
1329
- /**
1330
- * The phone number of the recipient the ticket is delivered to.
1331
- */
1332
- phone?: string;
1333
- }
1334
- }
1335
-
1336
- interface Passenger {
1337
- /**
1338
- * Full name of the person or entity on the flight reservation.
1339
- */
1340
- name: string;
1341
- }
1342
-
1343
- interface Segment {
1344
- /**
1345
- * The flight segment amount.
1346
- */
1347
- amount?: number;
1348
-
1349
- /**
1350
- * The International Air Transport Association (IATA) airport code for the arrival airport.
1351
- */
1352
- arrival_airport?: string;
1353
-
1354
- /**
1355
- * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
1356
- */
1357
- arrives_at?: number;
1358
-
1359
- /**
1360
- * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
1361
- */
1362
- carrier?: string;
1363
-
1364
- /**
1365
- * The departure time for the flight segment. Measured in seconds since the Unix epoch.
1366
- */
1367
- departs_at: number;
1368
-
1369
- /**
1370
- * The International Air Transport Association (IATA) airport code for the departure airport.
1371
- */
1372
- departure_airport?: string;
1373
-
1374
- /**
1375
- * The flight number associated with the segment
1376
- */
1377
- flight_number?: string;
1378
-
1379
- /**
1380
- * The fare class for the segment.
1381
- */
1382
- service_class?: Segment.ServiceClass;
1383
- }
1384
-
1385
- namespace Segment {
1386
- type ServiceClass =
1387
- | 'business'
1388
- | 'economy'
1389
- | 'first'
1390
- | 'premium_economy';
1391
- }
1392
- }
1393
-
1394
- interface Lodging {
1395
- /**
1396
- * The lodging location's address.
1397
- */
1398
- address?: Stripe.AddressParam;
1399
-
1400
- /**
1401
- * The number of adults on the booking
1402
- */
1403
- adults?: number;
1404
-
1405
- /**
1406
- * Affiliate details for this purchase.
1407
- */
1408
- affiliate?: Lodging.Affiliate;
1409
-
1410
- /**
1411
- * The booking number associated with the lodging reservation.
1412
- */
1413
- booking_number?: string;
1414
-
1415
- /**
1416
- * The lodging category
1417
- */
1418
- category?: Lodging.Category;
1419
-
1420
- /**
1421
- * Loding check-in time. Measured in seconds since the Unix epoch.
1422
- */
1423
- checkin_at: number;
1424
-
1425
- /**
1426
- * Lodging check-out time. Measured in seconds since the Unix epoch.
1427
- */
1428
- checkout_at: number;
1429
-
1430
- /**
1431
- * The customer service phone number of the lodging company.
1432
- */
1433
- customer_service_phone_number?: string;
1434
-
1435
- /**
1436
- * The daily lodging room rate.
1437
- */
1438
- daily_room_rate_amount?: number;
1439
-
1440
- /**
1441
- * Delivery details for this purchase.
1442
- */
1443
- delivery?: Lodging.Delivery;
1444
-
1445
- /**
1446
- * List of additional charges being billed.
1447
- */
1448
- extra_charges?: Array<Lodging.ExtraCharge>;
1449
-
1450
- /**
1451
- * Indicates whether the lodging location is compliant with the Fire Safety Act.
1452
- */
1453
- fire_safety_act_compliance?: boolean;
1454
-
1455
- /**
1456
- * The name of the lodging location.
1457
- */
1458
- name?: string;
1459
-
1460
- /**
1461
- * Indicates if the customer did not keep their booking while failing to cancel the reservation.
1462
- */
1463
- no_show?: boolean;
1464
-
1465
- /**
1466
- * The number of rooms on the booking
1467
- */
1468
- number_of_rooms?: number;
1469
-
1470
- /**
1471
- * The details of the passengers in the travel reservation
1472
- */
1473
- passengers?: Array<Lodging.Passenger>;
1474
-
1475
- /**
1476
- * The phone number of the lodging location.
1477
- */
1478
- property_phone_number?: string;
1479
-
1480
- /**
1481
- * The room class for this purchase.
1482
- */
1483
- room_class?: string;
1484
-
1485
- /**
1486
- * The number of room nights
1487
- */
1488
- room_nights?: number;
1489
-
1490
- /**
1491
- * The total tax amount associating with the room reservation.
1492
- */
1493
- total_room_tax_amount?: number;
1494
-
1495
- /**
1496
- * The total tax amount
1497
- */
1498
- total_tax_amount?: number;
1499
- }
1500
-
1501
- namespace Lodging {
1502
- interface Affiliate {
1503
- /**
1504
- * The name of the affiliate that originated the purchase.
1505
- */
1506
- name: string;
1507
- }
1508
-
1509
- type Category = 'hotel' | 'vacation_rental';
1510
-
1511
- interface Delivery {
1512
- /**
1513
- * The delivery method for the payment
1514
- */
1515
- mode?: Delivery.Mode;
1516
-
1517
- /**
1518
- * Details of the recipient.
1519
- */
1520
- recipient?: Delivery.Recipient;
1521
- }
1522
-
1523
- namespace Delivery {
1524
- type Mode = 'email' | 'phone' | 'pickup' | 'post';
1525
-
1526
- interface Recipient {
1527
- /**
1528
- * The email of the recipient the ticket is delivered to.
1529
- */
1530
- email?: string;
1531
-
1532
- /**
1533
- * The name of the recipient the ticket is delivered to.
1534
- */
1535
- name?: string;
1536
-
1537
- /**
1538
- * The phone number of the recipient the ticket is delivered to.
1539
- */
1540
- phone?: string;
1541
- }
1542
- }
1543
-
1544
- type ExtraCharge =
1545
- | 'gift_shop'
1546
- | 'laundry'
1547
- | 'mini_bar'
1548
- | 'other'
1549
- | 'restaurant'
1550
- | 'telephone';
1551
-
1552
- interface Passenger {
1553
- /**
1554
- * Full name of the person or entity on the lodging reservation.
1555
- */
1556
- name: string;
1557
- }
1558
- }
1559
-
1560
- interface Subscription {
1561
- /**
1562
- * Affiliate details for this purchase.
1563
- */
1564
- affiliate?: Subscription.Affiliate;
1565
-
1566
- /**
1567
- * Info whether the subscription will be auto renewed upon expiry.
1568
- */
1569
- auto_renewal?: boolean;
1570
-
1571
- /**
1572
- * Subscription billing details for this purchase.
1573
- */
1574
- billing_interval?: Subscription.BillingInterval;
1575
-
1576
- /**
1577
- * Subscription end time. Measured in seconds since the Unix epoch.
1578
- */
1579
- ends_at?: number;
1580
-
1581
- /**
1582
- * Name of the product on subscription. e.g. Apple Music Subscription
1583
- */
1584
- name: string;
1585
-
1586
- /**
1587
- * Subscription start time. Measured in seconds since the Unix epoch.
1588
- */
1589
- starts_at?: number;
1590
- }
1591
-
1592
- namespace Subscription {
1593
- interface Affiliate {
1594
- /**
1595
- * The name of the affiliate that originated the purchase.
1596
- */
1597
- name: string;
1598
- }
1599
-
1600
- interface BillingInterval {
1601
- /**
1602
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1603
- */
1604
- count: number;
1605
-
1606
- /**
1607
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1608
- */
1609
- interval: BillingInterval.Interval;
1610
- }
1611
-
1612
- namespace BillingInterval {
1613
- type Interval = 'day' | 'month' | 'week' | 'year';
1614
- }
1615
- }
1616
- }
1617
-
1618
324
  interface TransferData {
1619
325
  /**
1620
326
  * The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.