stripe 17.5.0 → 17.6.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 (181) hide show
  1. package/CHANGELOG.md +1052 -109
  2. package/README.md +24 -16
  3. package/VERSION +1 -1
  4. package/cjs/apiVersion.js +1 -1
  5. package/cjs/resources/AccountNotices.js +21 -0
  6. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  7. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  8. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  9. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  10. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  11. package/cjs/resources/GiftCards/Cards.js +23 -0
  12. package/cjs/resources/GiftCards/Transactions.js +33 -0
  13. package/cjs/resources/Invoices.js +17 -0
  14. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  15. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  16. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  17. package/cjs/resources/Margins.js +22 -0
  18. package/cjs/resources/Orders.js +24 -0
  19. package/cjs/resources/PaymentAttemptRecords.js +17 -0
  20. package/cjs/resources/PaymentIntents.js +8 -0
  21. package/cjs/resources/PaymentRecords.js +29 -0
  22. package/cjs/resources/Quotes.js +32 -0
  23. package/cjs/resources/SubscriptionSchedules.js +4 -0
  24. package/cjs/resources/Tax/Associations.js +9 -0
  25. package/cjs/resources/Tax/Forms.js +20 -0
  26. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  27. package/cjs/resources/Terminal/Readers.js +12 -0
  28. package/cjs/resources/Treasury/FinancialAccounts.js +4 -0
  29. package/cjs/resources.js +48 -10
  30. package/cjs/stripe.core.js +1 -1
  31. package/esm/apiVersion.js +1 -1
  32. package/esm/resources/AccountNotices.js +18 -0
  33. package/esm/resources/Capital/FinancingOffers.js +18 -0
  34. package/esm/resources/Capital/FinancingSummary.js +9 -0
  35. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  36. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  37. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  38. package/esm/resources/GiftCards/Cards.js +20 -0
  39. package/esm/resources/GiftCards/Transactions.js +30 -0
  40. package/esm/resources/Invoices.js +17 -0
  41. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  42. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  43. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  44. package/esm/resources/Margins.js +19 -0
  45. package/esm/resources/Orders.js +21 -0
  46. package/esm/resources/PaymentAttemptRecords.js +14 -0
  47. package/esm/resources/PaymentIntents.js +8 -0
  48. package/esm/resources/PaymentRecords.js +26 -0
  49. package/esm/resources/Quotes.js +32 -0
  50. package/esm/resources/SubscriptionSchedules.js +4 -0
  51. package/esm/resources/Tax/Associations.js +6 -0
  52. package/esm/resources/Tax/Forms.js +17 -0
  53. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  54. package/esm/resources/Terminal/Readers.js +12 -0
  55. package/esm/resources/Treasury/FinancialAccounts.js +4 -0
  56. package/esm/resources.js +33 -0
  57. package/esm/stripe.core.js +1 -1
  58. package/package.json +3 -15
  59. package/types/AccountLinksResource.d.ts +5 -1
  60. package/types/AccountNotices.d.ts +113 -0
  61. package/types/AccountNoticesResource.d.ts +98 -0
  62. package/types/AccountSessions.d.ts +175 -0
  63. package/types/AccountSessionsResource.d.ts +376 -0
  64. package/types/Accounts.d.ts +225 -1
  65. package/types/AccountsResource.d.ts +628 -0
  66. package/types/Billing/CreditBalanceTransactions.d.ts +1 -1
  67. package/types/Billing/MeterErrorReports.d.ts +106 -0
  68. package/types/BillingPortal/ConfigurationsResource.d.ts +2 -2
  69. package/types/Capital/FinancingOffers.d.ts +188 -0
  70. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  71. package/types/Capital/FinancingSummary.d.ts +106 -0
  72. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  73. package/types/Capital/FinancingTransactions.d.ts +135 -0
  74. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  75. package/types/Cards.d.ts +6 -1
  76. package/types/Charges.d.ts +159 -2
  77. package/types/ChargesResource.d.ts +1294 -0
  78. package/types/Checkout/Sessions.d.ts +359 -5
  79. package/types/Checkout/SessionsResource.d.ts +456 -5
  80. package/types/ConfirmationTokens.d.ts +110 -1
  81. package/types/Coupons.d.ts +1 -1
  82. package/types/CouponsResource.d.ts +1 -1
  83. package/types/CreditNoteLineItems.d.ts +1 -1
  84. package/types/CreditNotes.d.ts +22 -1
  85. package/types/CreditNotesResource.d.ts +51 -0
  86. package/types/CustomersResource.d.ts +8 -0
  87. package/types/EventTypes.d.ts +596 -0
  88. package/types/Events.d.ts +93 -0
  89. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  90. package/types/FinancialConnections/Accounts.d.ts +29 -1
  91. package/types/FinancialConnections/AccountsResource.d.ts +35 -3
  92. package/types/FinancialConnections/Institutions.d.ts +93 -0
  93. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  94. package/types/FinancialConnections/Sessions.d.ts +49 -1
  95. package/types/FinancialConnections/SessionsResource.d.ts +38 -1
  96. package/types/FinancialConnections/TransactionsResource.d.ts +1 -1
  97. package/types/GiftCards/Cards.d.ts +118 -0
  98. package/types/GiftCards/CardsResource.d.ts +159 -0
  99. package/types/GiftCards/Transactions.d.ts +129 -0
  100. package/types/GiftCards/TransactionsResource.d.ts +201 -0
  101. package/types/InvoiceItems.d.ts +5 -0
  102. package/types/InvoiceItemsResource.d.ts +98 -0
  103. package/types/InvoiceLineItems.d.ts +29 -2
  104. package/types/InvoicePayments.d.ts +113 -0
  105. package/types/Invoices.d.ts +143 -3
  106. package/types/InvoicesResource.d.ts +4618 -933
  107. package/types/Issuing/Authorizations.d.ts +2 -1
  108. package/types/Issuing/CardholdersResource.d.ts +2 -1
  109. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  110. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  111. package/types/Issuing/DisputeSettlementDetails.d.ts +73 -0
  112. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  113. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  114. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  115. package/types/Issuing/Settlements.d.ts +103 -0
  116. package/types/Issuing/Transactions.d.ts +3 -1
  117. package/types/Issuing/TransactionsResource.d.ts +5 -0
  118. package/types/LineItems.d.ts +32 -0
  119. package/types/Mandates.d.ts +77 -0
  120. package/types/Margins.d.ts +56 -0
  121. package/types/MarginsResource.d.ts +114 -0
  122. package/types/Orders.d.ts +1179 -0
  123. package/types/OrdersResource.d.ts +2961 -0
  124. package/types/PaymentAttemptRecords.d.ts +242 -0
  125. package/types/PaymentAttemptRecordsResource.d.ts +47 -0
  126. package/types/PaymentIntents.d.ts +653 -1
  127. package/types/PaymentIntentsResource.d.ts +8018 -3686
  128. package/types/PaymentLinks.d.ts +8 -0
  129. package/types/PaymentLinksResource.d.ts +30 -0
  130. package/types/PaymentMethodConfigurations.d.ts +216 -0
  131. package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
  132. package/types/PaymentMethods.d.ts +110 -1
  133. package/types/PaymentMethodsResource.d.ts +149 -0
  134. package/types/PaymentRecords.d.ts +242 -0
  135. package/types/PaymentRecordsResource.d.ts +455 -0
  136. package/types/Prices.d.ts +22 -0
  137. package/types/PricesResource.d.ts +22 -0
  138. package/types/Products.d.ts +39 -0
  139. package/types/ProductsResource.d.ts +36 -0
  140. package/types/QuoteLines.d.ts +634 -0
  141. package/types/QuotePreviewInvoices.d.ts +1658 -0
  142. package/types/QuotePreviewSubscriptionSchedules.d.ts +824 -0
  143. package/types/Quotes.d.ts +591 -1
  144. package/types/QuotesResource.d.ts +2526 -194
  145. package/types/Refunds.d.ts +14 -0
  146. package/types/SetupAttempts.d.ts +43 -0
  147. package/types/SetupIntents.d.ts +116 -1
  148. package/types/SetupIntentsResource.d.ts +669 -3
  149. package/types/Sources.d.ts +29 -0
  150. package/types/SubscriptionItems.d.ts +21 -0
  151. package/types/SubscriptionItemsResource.d.ts +109 -0
  152. package/types/SubscriptionSchedules.d.ts +200 -0
  153. package/types/SubscriptionSchedulesResource.d.ts +1234 -16
  154. package/types/Subscriptions.d.ts +91 -1
  155. package/types/SubscriptionsResource.d.ts +369 -2
  156. package/types/Tax/Associations.d.ts +126 -0
  157. package/types/Tax/AssociationsResource.d.ts +29 -0
  158. package/types/Tax/Forms.d.ts +220 -0
  159. package/types/Tax/FormsResource.d.ts +107 -0
  160. package/types/Terminal/Configurations.d.ts +19 -0
  161. package/types/Terminal/ConfigurationsResource.d.ts +44 -0
  162. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  163. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  164. package/types/Terminal/Readers.d.ts +310 -0
  165. package/types/Terminal/ReadersResource.d.ts +215 -0
  166. package/types/TestHelpers/ConfirmationTokensResource.d.ts +112 -0
  167. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  168. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  169. package/types/TokensResource.d.ts +30 -0
  170. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  171. package/types/Treasury/FinancialAccounts.d.ts +12 -0
  172. package/types/Treasury/FinancialAccountsResource.d.ts +121 -0
  173. package/types/Treasury/OutboundTransfers.d.ts +43 -1
  174. package/types/Treasury/OutboundTransfersResource.d.ts +43 -0
  175. package/types/Treasury/ReceivedCredits.d.ts +36 -0
  176. package/types/Treasury/ReceivedCreditsResource.d.ts +1 -0
  177. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  178. package/types/WebhookEndpointsResource.d.ts +72 -1
  179. package/types/index.d.ts +62 -0
  180. package/types/lib.d.ts +1 -1
  181. package/types/test/typescriptTest.ts +3 -3
@@ -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
  */
@@ -178,6 +193,11 @@ declare module 'stripe' {
178
193
  */
179
194
  p24?: PaymentMethodCreateParams.P24;
180
195
 
196
+ /**
197
+ * If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
198
+ */
199
+ pay_by_bank?: PaymentMethodCreateParams.PayByBank;
200
+
181
201
  /**
182
202
  * If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
183
203
  */
@@ -198,6 +218,11 @@ declare module 'stripe' {
198
218
  */
199
219
  paypal?: PaymentMethodCreateParams.Paypal;
200
220
 
221
+ /**
222
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
223
+ */
224
+ payto?: PaymentMethodCreateParams.Payto;
225
+
201
226
  /**
202
227
  * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
203
228
  */
@@ -208,11 +233,21 @@ declare module 'stripe' {
208
233
  */
209
234
  promptpay?: PaymentMethodCreateParams.Promptpay;
210
235
 
236
+ /**
237
+ * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
238
+ */
239
+ qris?: PaymentMethodCreateParams.Qris;
240
+
211
241
  /**
212
242
  * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
213
243
  */
214
244
  radar_options?: PaymentMethodCreateParams.RadarOptions;
215
245
 
246
+ /**
247
+ * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
248
+ */
249
+ rechnung?: PaymentMethodCreateParams.Rechnung;
250
+
216
251
  /**
217
252
  * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
218
253
  */
@@ -228,6 +263,11 @@ declare module 'stripe' {
228
263
  */
229
264
  sepa_debit?: PaymentMethodCreateParams.SepaDebit;
230
265
 
266
+ /**
267
+ * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
268
+ */
269
+ shopeepay?: PaymentMethodCreateParams.Shopeepay;
270
+
231
271
  /**
232
272
  * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
233
273
  */
@@ -481,8 +521,21 @@ declare module 'stripe' {
481
521
 
482
522
  interface Giropay {}
483
523
 
524
+ interface Gopay {}
525
+
484
526
  interface Grabpay {}
485
527
 
528
+ interface IdBankTransfer {
529
+ /**
530
+ * Bank where the account is held.
531
+ */
532
+ bank?: IdBankTransfer.Bank;
533
+ }
534
+
535
+ namespace IdBankTransfer {
536
+ type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
537
+ }
538
+
486
539
  interface Ideal {
487
540
  /**
488
541
  * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -546,6 +599,8 @@ declare module 'stripe' {
546
599
 
547
600
  interface Link {}
548
601
 
602
+ interface MbWay {}
603
+
549
604
  interface Mobilepay {}
550
605
 
551
606
  interface Multibanco {}
@@ -600,16 +655,37 @@ declare module 'stripe' {
600
655
  | 'volkswagen_bank';
601
656
  }
602
657
 
658
+ interface PayByBank {}
659
+
603
660
  interface Payco {}
604
661
 
605
662
  interface Paynow {}
606
663
 
607
664
  interface Paypal {}
608
665
 
666
+ interface Payto {
667
+ /**
668
+ * The account number for the bank account.
669
+ */
670
+ account_number?: string;
671
+
672
+ /**
673
+ * Bank-State-Branch number of the bank account.
674
+ */
675
+ bsb_number?: string;
676
+
677
+ /**
678
+ * The PayID alias for the bank account.
679
+ */
680
+ pay_id?: string;
681
+ }
682
+
609
683
  interface Pix {}
610
684
 
611
685
  interface Promptpay {}
612
686
 
687
+ interface Qris {}
688
+
613
689
  interface RadarOptions {
614
690
  /**
615
691
  * 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 +693,32 @@ declare module 'stripe' {
617
693
  session?: string;
618
694
  }
619
695
 
696
+ interface Rechnung {
697
+ /**
698
+ * Customer's date of birth
699
+ */
700
+ dob: Rechnung.Dob;
701
+ }
702
+
703
+ namespace Rechnung {
704
+ interface Dob {
705
+ /**
706
+ * The day of birth, between 1 and 31.
707
+ */
708
+ day: number;
709
+
710
+ /**
711
+ * The month of birth, between 1 and 12.
712
+ */
713
+ month: number;
714
+
715
+ /**
716
+ * The four-digit year of birth.
717
+ */
718
+ year: number;
719
+ }
720
+ }
721
+
620
722
  interface RevolutPay {}
621
723
 
622
724
  interface SamsungPay {}
@@ -628,6 +730,8 @@ declare module 'stripe' {
628
730
  iban: string;
629
731
  }
630
732
 
733
+ interface Shopeepay {}
734
+
631
735
  interface Sofort {
632
736
  /**
633
737
  * Two-letter ISO code representing the country the bank account is located in.
@@ -661,26 +765,34 @@ declare module 'stripe' {
661
765
  | 'eps'
662
766
  | 'fpx'
663
767
  | 'giropay'
768
+ | 'gopay'
664
769
  | 'grabpay'
770
+ | 'id_bank_transfer'
665
771
  | 'ideal'
666
772
  | 'kakao_pay'
667
773
  | 'klarna'
668
774
  | 'konbini'
669
775
  | 'kr_card'
670
776
  | 'link'
777
+ | 'mb_way'
671
778
  | 'mobilepay'
672
779
  | 'multibanco'
673
780
  | 'naver_pay'
674
781
  | 'oxxo'
675
782
  | 'p24'
783
+ | 'pay_by_bank'
676
784
  | 'payco'
677
785
  | 'paynow'
678
786
  | 'paypal'
787
+ | 'payto'
679
788
  | 'pix'
680
789
  | 'promptpay'
790
+ | 'qris'
791
+ | 'rechnung'
681
792
  | 'revolut_pay'
682
793
  | 'samsung_pay'
683
794
  | 'sepa_debit'
795
+ | 'shopeepay'
684
796
  | 'sofort'
685
797
  | 'swish'
686
798
  | 'twint'
@@ -769,6 +881,16 @@ declare module 'stripe' {
769
881
  */
770
882
  naver_pay?: PaymentMethodUpdateParams.NaverPay;
771
883
 
884
+ /**
885
+ * If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
886
+ */
887
+ pay_by_bank?: PaymentMethodUpdateParams.PayByBank;
888
+
889
+ /**
890
+ * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
891
+ */
892
+ payto?: PaymentMethodUpdateParams.Payto;
893
+
772
894
  /**
773
895
  * If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
774
896
  */
@@ -843,6 +965,25 @@ declare module 'stripe' {
843
965
  type Funding = 'card' | 'points';
844
966
  }
845
967
 
968
+ interface PayByBank {}
969
+
970
+ interface Payto {
971
+ /**
972
+ * The account number for the bank account.
973
+ */
974
+ account_number?: string;
975
+
976
+ /**
977
+ * Bank-State-Branch number of the bank account.
978
+ */
979
+ bsb_number?: string;
980
+
981
+ /**
982
+ * The PayID alias for the bank account.
983
+ */
984
+ pay_id?: string;
985
+ }
986
+
846
987
  interface UsBankAccount {
847
988
  /**
848
989
  * Bank account holder type.
@@ -898,26 +1039,34 @@ declare module 'stripe' {
898
1039
  | 'eps'
899
1040
  | 'fpx'
900
1041
  | 'giropay'
1042
+ | 'gopay'
901
1043
  | 'grabpay'
1044
+ | 'id_bank_transfer'
902
1045
  | 'ideal'
903
1046
  | 'kakao_pay'
904
1047
  | 'klarna'
905
1048
  | 'konbini'
906
1049
  | 'kr_card'
907
1050
  | 'link'
1051
+ | 'mb_way'
908
1052
  | 'mobilepay'
909
1053
  | 'multibanco'
910
1054
  | 'naver_pay'
911
1055
  | 'oxxo'
912
1056
  | 'p24'
1057
+ | 'pay_by_bank'
913
1058
  | 'payco'
914
1059
  | 'paynow'
915
1060
  | 'paypal'
1061
+ | 'payto'
916
1062
  | 'pix'
917
1063
  | 'promptpay'
1064
+ | 'qris'
1065
+ | 'rechnung'
918
1066
  | 'revolut_pay'
919
1067
  | 'samsung_pay'
920
1068
  | 'sepa_debit'
1069
+ | 'shopeepay'
921
1070
  | 'sofort'
922
1071
  | 'swish'
923
1072
  | 'twint'
@@ -0,0 +1,242 @@
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_requested: PaymentRecord.AmountRequested;
41
+
42
+ /**
43
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
44
+ */
45
+ created: number;
46
+
47
+ /**
48
+ * Customer information for this payment.
49
+ */
50
+ customer_details: PaymentRecord.CustomerDetails | null;
51
+
52
+ /**
53
+ * Indicates whether the customer was present in your checkout flow during this payment.
54
+ */
55
+ customer_presence: PaymentRecord.CustomerPresence | null;
56
+
57
+ /**
58
+ * An arbitrary string attached to the object. Often useful for displaying to users.
59
+ */
60
+ description: string | null;
61
+
62
+ /**
63
+ * ID of the latest Payment Attempt Record attached to this Payment Record.
64
+ */
65
+ latest_payment_attempt_record: string;
66
+
67
+ /**
68
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
69
+ */
70
+ livemode: boolean;
71
+
72
+ /**
73
+ * 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.
74
+ */
75
+ metadata: Stripe.Metadata | null;
76
+
77
+ /**
78
+ * Information about the Payment Method debited for this payment.
79
+ */
80
+ payment_method_details: PaymentRecord.PaymentMethodDetails | null;
81
+
82
+ /**
83
+ * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
84
+ */
85
+ payment_reference: string | null;
86
+
87
+ /**
88
+ * Shipping information for this payment.
89
+ */
90
+ shipping_details: PaymentRecord.ShippingDetails | null;
91
+ }
92
+
93
+ namespace PaymentRecord {
94
+ interface AmountCanceled {
95
+ /**
96
+ * 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).
97
+ */
98
+ currency: string;
99
+
100
+ /**
101
+ * 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).
102
+ */
103
+ value: number;
104
+ }
105
+
106
+ interface AmountFailed {
107
+ /**
108
+ * 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).
109
+ */
110
+ currency: string;
111
+
112
+ /**
113
+ * 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).
114
+ */
115
+ value: number;
116
+ }
117
+
118
+ interface AmountGuaranteed {
119
+ /**
120
+ * 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).
121
+ */
122
+ currency: string;
123
+
124
+ /**
125
+ * 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).
126
+ */
127
+ value: number;
128
+ }
129
+
130
+ interface AmountRequested {
131
+ /**
132
+ * 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).
133
+ */
134
+ currency: string;
135
+
136
+ /**
137
+ * 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).
138
+ */
139
+ value: number;
140
+ }
141
+
142
+ interface CustomerDetails {
143
+ /**
144
+ * ID of the Stripe Customer associated with this payment.
145
+ */
146
+ customer: string | null;
147
+
148
+ /**
149
+ * The customer's email address.
150
+ */
151
+ email: string | null;
152
+
153
+ /**
154
+ * The customer's name.
155
+ */
156
+ name: string | null;
157
+
158
+ /**
159
+ * The customer's phone number.
160
+ */
161
+ phone: string | null;
162
+ }
163
+
164
+ type CustomerPresence = 'off_session' | 'on_session';
165
+
166
+ interface PaymentMethodDetails {
167
+ /**
168
+ * The billing details associated with the method of payment.
169
+ */
170
+ billing_details: PaymentMethodDetails.BillingDetails | null;
171
+
172
+ /**
173
+ * Information about the custom (user-defined) payment method used to make this payment.
174
+ */
175
+ custom: PaymentMethodDetails.Custom | null;
176
+
177
+ /**
178
+ * ID of the Stripe PaymentMethod used to make this payment.
179
+ */
180
+ payment_method: string | null;
181
+
182
+ /**
183
+ * The type of Payment Method used for this payment attempt.
184
+ */
185
+ type: 'custom';
186
+ }
187
+
188
+ namespace PaymentMethodDetails {
189
+ interface BillingDetails {
190
+ /**
191
+ * A representation of a physical address.
192
+ */
193
+ address: Stripe.Address;
194
+
195
+ /**
196
+ * The billing email associated with the method of payment.
197
+ */
198
+ email: string | null;
199
+
200
+ /**
201
+ * The billing name associated with the method of payment.
202
+ */
203
+ name: string | null;
204
+
205
+ /**
206
+ * The billing phone number associated with the method of payment.
207
+ */
208
+ phone: string | null;
209
+ }
210
+
211
+ interface Custom {
212
+ /**
213
+ * Display name for the custom (user-defined) payment method type used to make this payment.
214
+ */
215
+ display_name: string;
216
+
217
+ /**
218
+ * The custom payment method type associated with this payment.
219
+ */
220
+ type: string | null;
221
+ }
222
+ }
223
+
224
+ interface ShippingDetails {
225
+ /**
226
+ * A representation of a physical address.
227
+ */
228
+ address: Stripe.Address;
229
+
230
+ /**
231
+ * The shipping recipient's name.
232
+ */
233
+ name: string | null;
234
+
235
+ /**
236
+ * The shipping recipient's phone number.
237
+ */
238
+ phone: string | null;
239
+ }
240
+ }
241
+ }
242
+ }