stripe 17.3.1 → 17.4.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 (195) hide show
  1. package/CHANGELOG.md +967 -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/Issuing/FraudLiabilityDebits.js +17 -0
  16. package/cjs/resources/Margins.js +22 -0
  17. package/cjs/resources/Orders.js +24 -0
  18. package/cjs/resources/PaymentAttemptRecords.js +17 -0
  19. package/cjs/resources/PaymentIntents.js +8 -0
  20. package/cjs/resources/PaymentRecords.js +29 -0
  21. package/cjs/resources/Quotes.js +32 -0
  22. package/cjs/resources/SubscriptionSchedules.js +4 -0
  23. package/cjs/resources/Tax/Associations.js +9 -0
  24. package/cjs/resources/Tax/Forms.js +20 -0
  25. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  26. package/cjs/resources/Terminal/Readers.js +12 -0
  27. package/cjs/resources.js +68 -14
  28. package/cjs/stripe.core.js +1 -1
  29. package/esm/resources/AccountNotices.js +18 -0
  30. package/esm/resources/Capital/FinancingOffers.js +18 -0
  31. package/esm/resources/Capital/FinancingSummary.js +9 -0
  32. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  33. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  34. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  35. package/esm/resources/GiftCards/Cards.js +20 -0
  36. package/esm/resources/GiftCards/Transactions.js +30 -0
  37. package/esm/resources/Invoices.js +17 -0
  38. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  39. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  40. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  41. package/esm/resources/Margins.js +19 -0
  42. package/esm/resources/Orders.js +21 -0
  43. package/esm/resources/PaymentAttemptRecords.js +14 -0
  44. package/esm/resources/PaymentIntents.js +8 -0
  45. package/esm/resources/PaymentRecords.js +26 -0
  46. package/esm/resources/Quotes.js +32 -0
  47. package/esm/resources/SubscriptionSchedules.js +4 -0
  48. package/esm/resources/Tax/Associations.js +6 -0
  49. package/esm/resources/Tax/Forms.js +17 -0
  50. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  51. package/esm/resources/Terminal/Readers.js +12 -0
  52. package/esm/resources.js +51 -1
  53. package/esm/stripe.core.js +1 -1
  54. package/package.json +1 -1
  55. package/types/AccountLinksResource.d.ts +5 -1
  56. package/types/AccountNotices.d.ts +113 -0
  57. package/types/AccountNoticesResource.d.ts +98 -0
  58. package/types/AccountSessions.d.ts +50 -5
  59. package/types/AccountSessionsResource.d.ts +355 -0
  60. package/types/Accounts.d.ts +221 -5
  61. package/types/AccountsResource.d.ts +496 -0
  62. package/types/Billing/CreditBalanceSummaryResource.d.ts +1 -1
  63. package/types/Billing/CreditGrants.d.ts +5 -6
  64. package/types/Billing/CreditGrantsResource.d.ts +11 -11
  65. package/types/Billing/MeterErrorReports.d.ts +106 -0
  66. package/types/Billing/MeterEventsResource.d.ts +1 -1
  67. package/types/Capital/FinancingOffers.d.ts +188 -0
  68. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  69. package/types/Capital/FinancingSummary.d.ts +106 -0
  70. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  71. package/types/Capital/FinancingTransactions.d.ts +135 -0
  72. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  73. package/types/Charges.d.ts +121 -5
  74. package/types/ChargesResource.d.ts +1294 -0
  75. package/types/Checkout/Sessions.d.ts +360 -5
  76. package/types/Checkout/SessionsResource.d.ts +444 -9
  77. package/types/ConfirmationTokens.d.ts +103 -4
  78. package/types/Coupons.d.ts +1 -1
  79. package/types/CouponsResource.d.ts +1 -1
  80. package/types/CreditNotes.d.ts +21 -0
  81. package/types/CreditNotesResource.d.ts +51 -0
  82. package/types/CustomersResource.d.ts +11 -2
  83. package/types/Disputes.d.ts +1 -1
  84. package/types/EventTypes.d.ts +579 -0
  85. package/types/Events.d.ts +92 -0
  86. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  87. package/types/FinancialConnections/Accounts.d.ts +29 -1
  88. package/types/FinancialConnections/AccountsResource.d.ts +35 -3
  89. package/types/FinancialConnections/Institutions.d.ts +93 -0
  90. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  91. package/types/FinancialConnections/Sessions.d.ts +49 -1
  92. package/types/FinancialConnections/SessionsResource.d.ts +38 -1
  93. package/types/FundingInstructions.d.ts +28 -0
  94. package/types/GiftCards/Cards.d.ts +118 -0
  95. package/types/GiftCards/CardsResource.d.ts +159 -0
  96. package/types/GiftCards/Transactions.d.ts +129 -0
  97. package/types/GiftCards/TransactionsResource.d.ts +201 -0
  98. package/types/Identity/VerificationReports.d.ts +1 -1
  99. package/types/Identity/VerificationSessions.d.ts +1 -1
  100. package/types/Identity/VerificationSessionsResource.d.ts +1 -1
  101. package/types/InvoiceItems.d.ts +5 -0
  102. package/types/InvoiceItemsResource.d.ts +98 -0
  103. package/types/InvoiceLineItems.d.ts +28 -1
  104. package/types/InvoicePayments.d.ts +113 -0
  105. package/types/Invoices.d.ts +139 -3
  106. package/types/InvoicesResource.d.ts +5536 -1845
  107. package/types/Issuing/Authorizations.d.ts +1 -1
  108. package/types/Issuing/CardholdersResource.d.ts +2 -1
  109. package/types/Issuing/Cards.d.ts +1 -1
  110. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  111. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  112. package/types/Issuing/DisputeSettlementDetails.d.ts +73 -0
  113. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  114. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  115. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  116. package/types/Issuing/Settlements.d.ts +103 -0
  117. package/types/Issuing/Transactions.d.ts +2 -0
  118. package/types/Issuing/TransactionsResource.d.ts +5 -0
  119. package/types/LineItems.d.ts +7 -0
  120. package/types/Mandates.d.ts +77 -0
  121. package/types/Margins.d.ts +56 -0
  122. package/types/MarginsResource.d.ts +114 -0
  123. package/types/Orders.d.ts +1155 -0
  124. package/types/OrdersResource.d.ts +2913 -0
  125. package/types/PaymentAttemptRecords.d.ts +242 -0
  126. package/types/PaymentAttemptRecordsResource.d.ts +47 -0
  127. package/types/PaymentIntents.d.ts +667 -2
  128. package/types/PaymentIntentsResource.d.ts +7948 -3704
  129. package/types/PaymentLinks.d.ts +6 -0
  130. package/types/PaymentLinksResource.d.ts +21 -2
  131. package/types/PaymentMethodConfigurations.d.ts +180 -0
  132. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  133. package/types/PaymentMethods.d.ts +103 -4
  134. package/types/PaymentMethodsResource.d.ts +133 -0
  135. package/types/PaymentRecords.d.ts +259 -0
  136. package/types/PaymentRecordsResource.d.ts +455 -0
  137. package/types/Prices.d.ts +22 -0
  138. package/types/PricesResource.d.ts +22 -0
  139. package/types/Products.d.ts +39 -0
  140. package/types/ProductsResource.d.ts +36 -0
  141. package/types/QuoteLines.d.ts +634 -0
  142. package/types/QuotePreviewInvoices.d.ts +1615 -0
  143. package/types/QuotePreviewSubscriptionSchedules.d.ts +814 -0
  144. package/types/Quotes.d.ts +591 -1
  145. package/types/QuotesResource.d.ts +2526 -194
  146. package/types/Refunds.d.ts +14 -0
  147. package/types/SetupAttempts.d.ts +40 -2
  148. package/types/SetupIntents.d.ts +113 -2
  149. package/types/SetupIntentsResource.d.ts +652 -7
  150. package/types/Sources.d.ts +23 -0
  151. package/types/SubscriptionItems.d.ts +21 -0
  152. package/types/SubscriptionItemsResource.d.ts +109 -0
  153. package/types/SubscriptionSchedules.d.ts +200 -0
  154. package/types/SubscriptionSchedulesResource.d.ts +1234 -16
  155. package/types/Subscriptions.d.ts +92 -1
  156. package/types/SubscriptionsResource.d.ts +371 -2
  157. package/types/Tax/Associations.d.ts +126 -0
  158. package/types/Tax/AssociationsResource.d.ts +29 -0
  159. package/types/Tax/CalculationLineItems.d.ts +1 -0
  160. package/types/Tax/Calculations.d.ts +4 -1
  161. package/types/Tax/CalculationsResource.d.ts +2 -1
  162. package/types/Tax/Forms.d.ts +220 -0
  163. package/types/Tax/FormsResource.d.ts +107 -0
  164. package/types/Tax/Transactions.d.ts +3 -1
  165. package/types/TaxIds.d.ts +2 -1
  166. package/types/TaxIdsResource.d.ts +2 -1
  167. package/types/TaxRates.d.ts +1 -0
  168. package/types/TaxRatesResource.d.ts +2 -0
  169. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  170. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  171. package/types/Terminal/Readers.d.ts +278 -0
  172. package/types/Terminal/ReadersResource.d.ts +215 -0
  173. package/types/TestHelpers/ConfirmationTokensResource.d.ts +104 -0
  174. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +14 -4
  175. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  176. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  177. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  178. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  179. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  180. package/types/Treasury/InboundTransfers.d.ts +1 -1
  181. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  182. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  183. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  184. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  185. package/types/WebhookEndpointsResource.d.ts +68 -0
  186. package/types/index.d.ts +74 -4
  187. package/cjs/resources/V2/Billing.js +0 -18
  188. package/cjs/resources/V2/Core.js +0 -14
  189. package/cjs/resources/V2.js +0 -14
  190. package/esm/resources/V2/Billing.js +0 -15
  191. package/esm/resources/V2/Core.js +0 -11
  192. package/esm/resources/V2.js +0 -11
  193. package/types/V2/BillingResource.d.ts +0 -14
  194. package/types/V2/CoreResource.d.ts +0 -12
  195. package/types/V2Resource.d.ts +0 -10
@@ -108,11 +108,21 @@ declare module 'stripe' {
108
108
  */
109
109
  giropay?: PaymentMethodCreateParams.Giropay;
110
110
 
111
+ /**
112
+ * If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
113
+ */
114
+ gopay?: PaymentMethodCreateParams.Gopay;
115
+
111
116
  /**
112
117
  * If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
113
118
  */
114
119
  grabpay?: PaymentMethodCreateParams.Grabpay;
115
120
 
121
+ /**
122
+ * If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
123
+ */
124
+ id_bank_transfer?: PaymentMethodCreateParams.IdBankTransfer;
125
+
116
126
  /**
117
127
  * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
118
128
  */
@@ -148,6 +158,11 @@ declare module 'stripe' {
148
158
  */
149
159
  link?: PaymentMethodCreateParams.Link;
150
160
 
161
+ /**
162
+ * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
163
+ */
164
+ mb_way?: PaymentMethodCreateParams.MbWay;
165
+
151
166
  /**
152
167
  * 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`.
153
168
  */
@@ -198,6 +213,11 @@ declare module 'stripe' {
198
213
  */
199
214
  paypal?: PaymentMethodCreateParams.Paypal;
200
215
 
216
+ /**
217
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
218
+ */
219
+ payto?: PaymentMethodCreateParams.Payto;
220
+
201
221
  /**
202
222
  * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
203
223
  */
@@ -208,11 +228,21 @@ declare module 'stripe' {
208
228
  */
209
229
  promptpay?: PaymentMethodCreateParams.Promptpay;
210
230
 
231
+ /**
232
+ * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
233
+ */
234
+ qris?: PaymentMethodCreateParams.Qris;
235
+
211
236
  /**
212
237
  * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
213
238
  */
214
239
  radar_options?: PaymentMethodCreateParams.RadarOptions;
215
240
 
241
+ /**
242
+ * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
243
+ */
244
+ rechnung?: PaymentMethodCreateParams.Rechnung;
245
+
216
246
  /**
217
247
  * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
218
248
  */
@@ -228,6 +258,11 @@ declare module 'stripe' {
228
258
  */
229
259
  sepa_debit?: PaymentMethodCreateParams.SepaDebit;
230
260
 
261
+ /**
262
+ * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
263
+ */
264
+ shopeepay?: PaymentMethodCreateParams.Shopeepay;
265
+
231
266
  /**
232
267
  * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
233
268
  */
@@ -481,8 +516,21 @@ declare module 'stripe' {
481
516
 
482
517
  interface Giropay {}
483
518
 
519
+ interface Gopay {}
520
+
484
521
  interface Grabpay {}
485
522
 
523
+ interface IdBankTransfer {
524
+ /**
525
+ * Bank where the account is held.
526
+ */
527
+ bank?: IdBankTransfer.Bank;
528
+ }
529
+
530
+ namespace IdBankTransfer {
531
+ type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
532
+ }
533
+
486
534
  interface Ideal {
487
535
  /**
488
536
  * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -546,6 +594,8 @@ declare module 'stripe' {
546
594
 
547
595
  interface Link {}
548
596
 
597
+ interface MbWay {}
598
+
549
599
  interface Mobilepay {}
550
600
 
551
601
  interface Multibanco {}
@@ -606,10 +656,29 @@ declare module 'stripe' {
606
656
 
607
657
  interface Paypal {}
608
658
 
659
+ interface Payto {
660
+ /**
661
+ * The account number for the bank account.
662
+ */
663
+ account_number?: string;
664
+
665
+ /**
666
+ * Bank-State-Branch number of the bank account.
667
+ */
668
+ bsb_number?: string;
669
+
670
+ /**
671
+ * The PayID alias for the bank account.
672
+ */
673
+ pay_id?: string;
674
+ }
675
+
609
676
  interface Pix {}
610
677
 
611
678
  interface Promptpay {}
612
679
 
680
+ interface Qris {}
681
+
613
682
  interface RadarOptions {
614
683
  /**
615
684
  * A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -617,6 +686,32 @@ declare module 'stripe' {
617
686
  session?: string;
618
687
  }
619
688
 
689
+ interface Rechnung {
690
+ /**
691
+ * Customer's date of birth
692
+ */
693
+ dob: Rechnung.Dob;
694
+ }
695
+
696
+ namespace Rechnung {
697
+ interface Dob {
698
+ /**
699
+ * The day of birth, between 1 and 31.
700
+ */
701
+ day: number;
702
+
703
+ /**
704
+ * The month of birth, between 1 and 12.
705
+ */
706
+ month: number;
707
+
708
+ /**
709
+ * The four-digit year of birth.
710
+ */
711
+ year: number;
712
+ }
713
+ }
714
+
620
715
  interface RevolutPay {}
621
716
 
622
717
  interface SamsungPay {}
@@ -628,6 +723,8 @@ declare module 'stripe' {
628
723
  iban: string;
629
724
  }
630
725
 
726
+ interface Shopeepay {}
727
+
631
728
  interface Sofort {
632
729
  /**
633
730
  * Two-letter ISO code representing the country the bank account is located in.
@@ -661,13 +758,16 @@ declare module 'stripe' {
661
758
  | 'eps'
662
759
  | 'fpx'
663
760
  | 'giropay'
761
+ | 'gopay'
664
762
  | 'grabpay'
763
+ | 'id_bank_transfer'
665
764
  | 'ideal'
666
765
  | 'kakao_pay'
667
766
  | 'klarna'
668
767
  | 'konbini'
669
768
  | 'kr_card'
670
769
  | 'link'
770
+ | 'mb_way'
671
771
  | 'mobilepay'
672
772
  | 'multibanco'
673
773
  | 'naver_pay'
@@ -676,11 +776,15 @@ declare module 'stripe' {
676
776
  | 'payco'
677
777
  | 'paynow'
678
778
  | 'paypal'
779
+ | 'payto'
679
780
  | 'pix'
680
781
  | 'promptpay'
782
+ | 'qris'
783
+ | 'rechnung'
681
784
  | 'revolut_pay'
682
785
  | 'samsung_pay'
683
786
  | 'sepa_debit'
787
+ | 'shopeepay'
684
788
  | 'sofort'
685
789
  | 'swish'
686
790
  | 'twint'
@@ -769,6 +873,11 @@ declare module 'stripe' {
769
873
  */
770
874
  naver_pay?: PaymentMethodUpdateParams.NaverPay;
771
875
 
876
+ /**
877
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
878
+ */
879
+ payto?: PaymentMethodUpdateParams.Payto;
880
+
772
881
  /**
773
882
  * If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
774
883
  */
@@ -843,6 +952,23 @@ declare module 'stripe' {
843
952
  type Funding = 'card' | 'points';
844
953
  }
845
954
 
955
+ interface Payto {
956
+ /**
957
+ * The account number for the bank account.
958
+ */
959
+ account_number?: string;
960
+
961
+ /**
962
+ * Bank-State-Branch number of the bank account.
963
+ */
964
+ bsb_number?: string;
965
+
966
+ /**
967
+ * The PayID alias for the bank account.
968
+ */
969
+ pay_id?: string;
970
+ }
971
+
846
972
  interface UsBankAccount {
847
973
  /**
848
974
  * Bank account holder type.
@@ -898,13 +1024,16 @@ declare module 'stripe' {
898
1024
  | 'eps'
899
1025
  | 'fpx'
900
1026
  | 'giropay'
1027
+ | 'gopay'
901
1028
  | 'grabpay'
1029
+ | 'id_bank_transfer'
902
1030
  | 'ideal'
903
1031
  | 'kakao_pay'
904
1032
  | 'klarna'
905
1033
  | 'konbini'
906
1034
  | 'kr_card'
907
1035
  | 'link'
1036
+ | 'mb_way'
908
1037
  | 'mobilepay'
909
1038
  | 'multibanco'
910
1039
  | 'naver_pay'
@@ -913,11 +1042,15 @@ declare module 'stripe' {
913
1042
  | 'payco'
914
1043
  | 'paynow'
915
1044
  | 'paypal'
1045
+ | 'payto'
916
1046
  | 'pix'
917
1047
  | 'promptpay'
1048
+ | 'qris'
1049
+ | 'rechnung'
918
1050
  | 'revolut_pay'
919
1051
  | 'samsung_pay'
920
1052
  | 'sepa_debit'
1053
+ | 'shopeepay'
921
1054
  | 'sofort'
922
1055
  | 'swish'
923
1056
  | 'twint'
@@ -0,0 +1,259 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ /**
6
+ * A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
7
+ * For example, you can create a Payment Record to model a payment made on a different payment processor,
8
+ * in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
9
+ * more Payment Attempt Records, which represent individual attempts made on a payment network.
10
+ */
11
+ interface PaymentRecord {
12
+ /**
13
+ * Unique identifier for the object.
14
+ */
15
+ id: string;
16
+
17
+ /**
18
+ * String representing the object's type. Objects of the same type share the same value.
19
+ */
20
+ object: 'payment_record';
21
+
22
+ /**
23
+ * A representation of an amount of money, consisting of an amount and a currency.
24
+ */
25
+ amount_canceled: PaymentRecord.AmountCanceled;
26
+
27
+ /**
28
+ * A representation of an amount of money, consisting of an amount and a currency.
29
+ */
30
+ amount_failed: PaymentRecord.AmountFailed;
31
+
32
+ /**
33
+ * A representation of an amount of money, consisting of an amount and a currency.
34
+ */
35
+ amount_guaranteed: PaymentRecord.AmountGuaranteed;
36
+
37
+ /**
38
+ * A representation of an amount of money, consisting of an amount and a currency.
39
+ */
40
+ amount_refunded: PaymentRecord.AmountRefunded;
41
+
42
+ /**
43
+ * A representation of an amount of money, consisting of an amount and a currency.
44
+ */
45
+ amount_requested: PaymentRecord.AmountRequested;
46
+
47
+ /**
48
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
49
+ */
50
+ created: number;
51
+
52
+ /**
53
+ * Customer information for this payment.
54
+ */
55
+ customer_details: PaymentRecord.CustomerDetails | null;
56
+
57
+ /**
58
+ * Indicates whether the customer was present in your checkout flow during this payment.
59
+ */
60
+ customer_presence: PaymentRecord.CustomerPresence | null;
61
+
62
+ /**
63
+ * An arbitrary string attached to the object. Often useful for displaying to users.
64
+ */
65
+ description: string | null;
66
+
67
+ /**
68
+ * ID of the latest Payment Attempt Record attached to this Payment Record.
69
+ */
70
+ latest_payment_attempt_record: string;
71
+
72
+ /**
73
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
74
+ */
75
+ livemode: boolean;
76
+
77
+ /**
78
+ * 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.
79
+ */
80
+ metadata: Stripe.Metadata | null;
81
+
82
+ /**
83
+ * Information about the Payment Method debited for this payment.
84
+ */
85
+ payment_method_details: PaymentRecord.PaymentMethodDetails | null;
86
+
87
+ /**
88
+ * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
89
+ */
90
+ payment_reference: string | null;
91
+
92
+ /**
93
+ * Shipping information for this payment.
94
+ */
95
+ shipping_details: PaymentRecord.ShippingDetails | null;
96
+ }
97
+
98
+ namespace PaymentRecord {
99
+ interface AmountCanceled {
100
+ /**
101
+ * 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).
102
+ */
103
+ currency: string;
104
+
105
+ /**
106
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
107
+ */
108
+ value: number;
109
+ }
110
+
111
+ interface AmountFailed {
112
+ /**
113
+ * 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).
114
+ */
115
+ currency: string;
116
+
117
+ /**
118
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
119
+ */
120
+ value: number;
121
+ }
122
+
123
+ interface AmountGuaranteed {
124
+ /**
125
+ * 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).
126
+ */
127
+ currency: string;
128
+
129
+ /**
130
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
131
+ */
132
+ value: number;
133
+ }
134
+
135
+ interface AmountRefunded {
136
+ /**
137
+ * 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).
138
+ */
139
+ currency: string;
140
+
141
+ /**
142
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
143
+ */
144
+ value: number;
145
+ }
146
+
147
+ interface AmountRequested {
148
+ /**
149
+ * 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).
150
+ */
151
+ currency: string;
152
+
153
+ /**
154
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
155
+ */
156
+ value: number;
157
+ }
158
+
159
+ interface CustomerDetails {
160
+ /**
161
+ * ID of the Stripe Customer associated with this payment.
162
+ */
163
+ customer: string | null;
164
+
165
+ /**
166
+ * The customer's email address.
167
+ */
168
+ email: string | null;
169
+
170
+ /**
171
+ * The customer's name.
172
+ */
173
+ name: string | null;
174
+
175
+ /**
176
+ * The customer's phone number.
177
+ */
178
+ phone: string | null;
179
+ }
180
+
181
+ type CustomerPresence = 'off_session' | 'on_session';
182
+
183
+ interface PaymentMethodDetails {
184
+ /**
185
+ * The billing details associated with the method of payment.
186
+ */
187
+ billing_details: PaymentMethodDetails.BillingDetails | null;
188
+
189
+ /**
190
+ * Information about the custom (user-defined) payment method used to make this payment.
191
+ */
192
+ custom: PaymentMethodDetails.Custom | null;
193
+
194
+ /**
195
+ * ID of the Stripe PaymentMethod used to make this payment.
196
+ */
197
+ payment_method: string | null;
198
+
199
+ /**
200
+ * The type of Payment Method used for this payment attempt.
201
+ */
202
+ type: 'custom';
203
+ }
204
+
205
+ namespace PaymentMethodDetails {
206
+ interface BillingDetails {
207
+ /**
208
+ * A representation of a physical address.
209
+ */
210
+ address: Stripe.Address;
211
+
212
+ /**
213
+ * The billing email associated with the method of payment.
214
+ */
215
+ email: string | null;
216
+
217
+ /**
218
+ * The billing name associated with the method of payment.
219
+ */
220
+ name: string | null;
221
+
222
+ /**
223
+ * The billing phone number associated with the method of payment.
224
+ */
225
+ phone: string | null;
226
+ }
227
+
228
+ interface Custom {
229
+ /**
230
+ * Display name for the custom (user-defined) payment method type used to make this payment.
231
+ */
232
+ display_name: string;
233
+
234
+ /**
235
+ * The custom payment method type associated with this payment.
236
+ */
237
+ type: string | null;
238
+ }
239
+ }
240
+
241
+ interface ShippingDetails {
242
+ /**
243
+ * A representation of a physical address.
244
+ */
245
+ address: Stripe.Address;
246
+
247
+ /**
248
+ * The shipping recipient's name.
249
+ */
250
+ name: string | null;
251
+
252
+ /**
253
+ * The shipping recipient's phone number.
254
+ */
255
+ phone: string | null;
256
+ }
257
+ }
258
+ }
259
+ }