stripe 22.3.0 → 22.4.0-beta.1

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 (797) hide show
  1. package/CHANGELOG.md +1798 -54
  2. package/README.md +42 -58
  3. package/VERSION +1 -1
  4. package/cjs/Error.d.ts +50 -0
  5. package/cjs/Error.js +125 -1
  6. package/cjs/Error.js.map +1 -1
  7. package/cjs/StripeEventNotificationHandler.d.ts +19 -0
  8. package/cjs/StripeEventNotificationHandler.js +150 -0
  9. package/cjs/StripeEventNotificationHandler.js.map +1 -0
  10. package/cjs/Types.d.ts +4 -2
  11. package/cjs/Types.js.map +1 -1
  12. package/cjs/apiVersion.d.ts +1 -2
  13. package/cjs/apiVersion.js +2 -3
  14. package/cjs/apiVersion.js.map +1 -1
  15. package/cjs/resources/AccountLinks.d.ts +1 -1
  16. package/cjs/resources/AccountNotices.d.ts +140 -0
  17. package/cjs/resources/AccountNotices.js +29 -0
  18. package/cjs/resources/AccountNotices.js.map +1 -0
  19. package/cjs/resources/AccountSessions.d.ts +262 -0
  20. package/cjs/resources/AccountSessions.js.map +1 -1
  21. package/cjs/resources/Accounts.d.ts +827 -3
  22. package/cjs/resources/Accounts.js +14 -0
  23. package/cjs/resources/Accounts.js.map +1 -1
  24. package/cjs/resources/Balance.d.ts +67 -0
  25. package/cjs/resources/BankAccounts.d.ts +2 -2
  26. package/cjs/resources/Billing/AlertTriggereds.d.ts +2 -1
  27. package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
  28. package/cjs/resources/Billing/Analytics/MeterUsage.js +15 -0
  29. package/cjs/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  30. package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
  31. package/cjs/resources/Billing/Analytics/MeterUsageRows.js +4 -0
  32. package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  33. package/cjs/resources/Billing/Analytics/index.d.ts +15 -0
  34. package/cjs/resources/Billing/Analytics/index.js +13 -0
  35. package/cjs/resources/Billing/Analytics/index.js.map +1 -0
  36. package/cjs/resources/Billing/index.d.ts +3 -0
  37. package/cjs/resources/Billing/index.js +2 -0
  38. package/cjs/resources/Billing/index.js.map +1 -1
  39. package/cjs/resources/Capabilities.d.ts +2 -2
  40. package/cjs/resources/Capital/FinancingOffers.d.ts +194 -0
  41. package/cjs/resources/Capital/FinancingOffers.js +30 -0
  42. package/cjs/resources/Capital/FinancingOffers.js.map +1 -0
  43. package/cjs/resources/Capital/FinancingSummary.d.ts +101 -0
  44. package/cjs/resources/Capital/FinancingSummary.js +15 -0
  45. package/cjs/resources/Capital/FinancingSummary.js.map +1 -0
  46. package/cjs/resources/Capital/FinancingTransactions.d.ts +141 -0
  47. package/cjs/resources/Capital/FinancingTransactions.js +24 -0
  48. package/cjs/resources/Capital/FinancingTransactions.js.map +1 -0
  49. package/cjs/resources/Capital/index.d.ts +25 -0
  50. package/cjs/resources/Capital/index.js +17 -0
  51. package/cjs/resources/Capital/index.js.map +1 -0
  52. package/cjs/resources/Cards.d.ts +17 -0
  53. package/cjs/resources/Charges.d.ts +3077 -70
  54. package/cjs/resources/Checkout/Sessions.d.ts +403 -4
  55. package/cjs/resources/ConfirmationTokens.d.ts +67 -1
  56. package/cjs/resources/Coupons.d.ts +53 -0
  57. package/cjs/resources/Coupons.js +13 -0
  58. package/cjs/resources/Coupons.js.map +1 -1
  59. package/cjs/resources/CreditNoteLineItems.d.ts +15 -1
  60. package/cjs/resources/CreditNotes.d.ts +1 -1
  61. package/cjs/resources/CustomerSessions.d.ts +68 -0
  62. package/cjs/resources/Customers.d.ts +20 -1
  63. package/cjs/resources/Customers.js +14 -0
  64. package/cjs/resources/Customers.js.map +1 -1
  65. package/cjs/resources/Disputes.d.ts +29 -0
  66. package/cjs/resources/Events.d.ts +547 -2
  67. package/cjs/resources/ExternalAccounts.d.ts +212 -1
  68. package/cjs/resources/ExternalAccounts.js +44 -0
  69. package/cjs/resources/ExternalAccounts.js.map +1 -1
  70. package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  71. package/cjs/resources/FinancialConnections/AccountInferredBalances.js +4 -0
  72. package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  73. package/cjs/resources/FinancialConnections/Accounts.d.ts +69 -4
  74. package/cjs/resources/FinancialConnections/Accounts.js +8 -0
  75. package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
  76. package/cjs/resources/FinancialConnections/Authorizations.d.ts +99 -0
  77. package/cjs/resources/FinancialConnections/Authorizations.js +15 -0
  78. package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -0
  79. package/cjs/resources/FinancialConnections/Institutions.d.ts +99 -0
  80. package/cjs/resources/FinancialConnections/Institutions.js +23 -0
  81. package/cjs/resources/FinancialConnections/Institutions.js.map +1 -0
  82. package/cjs/resources/FinancialConnections/Sessions.d.ts +156 -7
  83. package/cjs/resources/FinancialConnections/Sessions.js.map +1 -1
  84. package/cjs/resources/FinancialConnections/index.d.ts +21 -6
  85. package/cjs/resources/FinancialConnections/index.js +4 -0
  86. package/cjs/resources/FinancialConnections/index.js.map +1 -1
  87. package/cjs/resources/FxQuotes.d.ts +212 -0
  88. package/cjs/resources/FxQuotes.js +29 -0
  89. package/cjs/resources/FxQuotes.js.map +1 -0
  90. package/cjs/resources/InvoiceItems.d.ts +85 -0
  91. package/cjs/resources/InvoiceItems.js.map +1 -1
  92. package/cjs/resources/InvoiceLineItems.d.ts +40 -2
  93. package/cjs/resources/Invoices.d.ts +1388 -15
  94. package/cjs/resources/Invoices.js +41 -0
  95. package/cjs/resources/Invoices.js.map +1 -1
  96. package/cjs/resources/Issuing/Authorizations.d.ts +13 -0
  97. package/cjs/resources/Issuing/Cardholders.d.ts +15 -1
  98. package/cjs/resources/Issuing/Cards.d.ts +13 -0
  99. package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +638 -0
  100. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +47 -0
  101. package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  102. package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  103. package/cjs/resources/Issuing/DisputeSettlementDetails.js +23 -0
  104. package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  105. package/cjs/resources/Issuing/Disputes.d.ts +13 -0
  106. package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  107. package/cjs/resources/Issuing/FraudLiabilityDebits.js +23 -0
  108. package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  109. package/cjs/resources/Issuing/Settlements.d.ts +83 -0
  110. package/cjs/resources/Issuing/Settlements.js +4 -0
  111. package/cjs/resources/Issuing/Settlements.js.map +1 -0
  112. package/cjs/resources/Issuing/Transactions.d.ts +22 -0
  113. package/cjs/resources/Issuing/Transactions.js.map +1 -1
  114. package/cjs/resources/Issuing/index.d.ts +47 -22
  115. package/cjs/resources/Issuing/index.js +6 -0
  116. package/cjs/resources/Issuing/index.js.map +1 -1
  117. package/cjs/resources/LineItems.d.ts +29 -2
  118. package/cjs/resources/Mandates.d.ts +33 -1
  119. package/cjs/resources/Mandates.js +8 -0
  120. package/cjs/resources/Mandates.js.map +1 -1
  121. package/cjs/resources/Margins.d.ts +115 -0
  122. package/cjs/resources/Margins.js +35 -0
  123. package/cjs/resources/Margins.js.map +1 -0
  124. package/cjs/resources/Orders.d.ts +4693 -0
  125. package/cjs/resources/Orders.js +457 -0
  126. package/cjs/resources/Orders.js.map +1 -0
  127. package/cjs/resources/PaymentAttemptRecords.d.ts +82 -0
  128. package/cjs/resources/PaymentIntents.d.ts +13283 -2352
  129. package/cjs/resources/PaymentIntents.js +27 -0
  130. package/cjs/resources/PaymentIntents.js.map +1 -1
  131. package/cjs/resources/PaymentLinks.d.ts +19 -3
  132. package/cjs/resources/PaymentMethodConfigurations.d.ts +350 -0
  133. package/cjs/resources/PaymentMethods.d.ts +164 -3
  134. package/cjs/resources/PaymentMethods.js.map +1 -1
  135. package/cjs/resources/PaymentRecords.d.ts +82 -0
  136. package/cjs/resources/Persons.d.ts +2 -2
  137. package/cjs/resources/Plans.d.ts +16 -0
  138. package/cjs/resources/Prices.d.ts +52 -0
  139. package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
  140. package/cjs/resources/Privacy/RedactionJobValidationErrors.js +4 -0
  141. package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  142. package/cjs/resources/Privacy/RedactionJobs.d.ts +227 -0
  143. package/cjs/resources/Privacy/RedactionJobs.js +73 -0
  144. package/cjs/resources/Privacy/RedactionJobs.js.map +1 -0
  145. package/cjs/resources/Privacy/index.d.ts +22 -0
  146. package/cjs/resources/Privacy/index.js +13 -0
  147. package/cjs/resources/Privacy/index.js.map +1 -0
  148. package/cjs/resources/ProductCatalog/TrialOffers.d.ts +125 -0
  149. package/cjs/resources/ProductCatalog/TrialOffers.js +15 -0
  150. package/cjs/resources/ProductCatalog/TrialOffers.js.map +1 -0
  151. package/cjs/resources/ProductCatalog/index.d.ts +12 -0
  152. package/cjs/resources/ProductCatalog/index.js +13 -0
  153. package/cjs/resources/ProductCatalog/index.js.map +1 -0
  154. package/cjs/resources/Products.d.ts +42 -0
  155. package/cjs/resources/PromotionCodes.d.ts +12 -0
  156. package/cjs/resources/PromotionCodes.js +27 -0
  157. package/cjs/resources/PromotionCodes.js.map +1 -1
  158. package/cjs/resources/QuoteLines.d.ts +507 -0
  159. package/cjs/resources/QuoteLines.js +4 -0
  160. package/cjs/resources/QuoteLines.js.map +1 -0
  161. package/cjs/resources/QuotePreviewInvoices.d.ts +1120 -0
  162. package/cjs/resources/QuotePreviewInvoices.js +4 -0
  163. package/cjs/resources/QuotePreviewInvoices.js.map +1 -0
  164. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +738 -0
  165. package/cjs/resources/QuotePreviewSubscriptionSchedules.js +4 -0
  166. package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  167. package/cjs/resources/Quotes.d.ts +2266 -57
  168. package/cjs/resources/Quotes.js +1184 -16
  169. package/cjs/resources/Quotes.js.map +1 -1
  170. package/cjs/resources/Radar/PaymentEvaluations.d.ts +1 -1
  171. package/cjs/resources/Radar/ValueListItems.d.ts +30 -0
  172. package/cjs/resources/Refunds.d.ts +11 -0
  173. package/cjs/resources/Reserve/Holds.d.ts +53 -1
  174. package/cjs/resources/Reserve/Holds.js +19 -0
  175. package/cjs/resources/Reserve/Holds.js.map +1 -1
  176. package/cjs/resources/Reserve/Plans.d.ts +16 -0
  177. package/cjs/resources/Reserve/Plans.js +11 -0
  178. package/cjs/resources/Reserve/Plans.js.map +1 -1
  179. package/cjs/resources/Reserve/Releases.d.ts +41 -1
  180. package/cjs/resources/Reserve/Releases.js +19 -0
  181. package/cjs/resources/Reserve/Releases.js.map +1 -1
  182. package/cjs/resources/Reserve/index.d.ts +17 -6
  183. package/cjs/resources/Reserve/index.js +9 -0
  184. package/cjs/resources/Reserve/index.js.map +1 -1
  185. package/cjs/resources/SetupAttempts.d.ts +26 -1
  186. package/cjs/resources/SetupIntents.d.ts +343 -11
  187. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +1105 -0
  188. package/cjs/resources/SharedPayment/GrantedTokens.js +15 -0
  189. package/cjs/resources/SharedPayment/GrantedTokens.js.map +1 -0
  190. package/cjs/resources/SharedPayment/IssuedTokens.d.ts +306 -0
  191. package/cjs/resources/SharedPayment/IssuedTokens.js +27 -0
  192. package/cjs/resources/SharedPayment/IssuedTokens.js.map +1 -0
  193. package/cjs/resources/SharedPayment/index.d.ts +19 -0
  194. package/cjs/resources/SharedPayment/index.js +15 -0
  195. package/cjs/resources/SharedPayment/index.js.map +1 -0
  196. package/cjs/resources/Sources.d.ts +29 -1
  197. package/cjs/resources/SubscriptionItems.d.ts +143 -0
  198. package/cjs/resources/SubscriptionSchedules.d.ts +1152 -0
  199. package/cjs/resources/SubscriptionSchedules.js +6 -0
  200. package/cjs/resources/SubscriptionSchedules.js.map +1 -1
  201. package/cjs/resources/Subscriptions.d.ts +571 -6
  202. package/cjs/resources/Subscriptions.js +145 -0
  203. package/cjs/resources/Subscriptions.js.map +1 -1
  204. package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -2
  205. package/cjs/resources/Tax/Calculations.d.ts +7 -3
  206. package/cjs/resources/Tax/Forms.d.ts +228 -0
  207. package/cjs/resources/Tax/Forms.js +32 -0
  208. package/cjs/resources/Tax/Forms.js.map +1 -0
  209. package/cjs/resources/Tax/Locations.d.ts +108 -0
  210. package/cjs/resources/Tax/Locations.js +33 -0
  211. package/cjs/resources/Tax/Locations.js.map +1 -0
  212. package/cjs/resources/Tax/Registrations.d.ts +138 -2
  213. package/cjs/resources/Tax/Transactions.d.ts +2 -2
  214. package/cjs/resources/Tax/index.d.ts +27 -13
  215. package/cjs/resources/Tax/index.js +4 -0
  216. package/cjs/resources/Tax/index.js.map +1 -1
  217. package/cjs/resources/TaxCodes.d.ts +15 -0
  218. package/cjs/resources/Terminal/Configurations.d.ts +27 -0
  219. package/cjs/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  220. package/cjs/resources/Terminal/ReaderCollectedData.js +15 -0
  221. package/cjs/resources/Terminal/ReaderCollectedData.js.map +1 -0
  222. package/cjs/resources/Terminal/Readers.d.ts +17 -1
  223. package/cjs/resources/Terminal/index.d.ts +5 -0
  224. package/cjs/resources/Terminal/index.js +2 -0
  225. package/cjs/resources/Terminal/index.js.map +1 -1
  226. package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  227. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
  228. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +21 -0
  229. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  230. package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  231. package/cjs/resources/TestHelpers/SharedPayment/index.js +13 -0
  232. package/cjs/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  233. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  234. package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  235. package/cjs/resources/TestHelpers/index.d.ts +3 -0
  236. package/cjs/resources/TestHelpers/index.js +6 -4
  237. package/cjs/resources/TestHelpers/index.js.map +1 -1
  238. package/cjs/resources/Tokens.d.ts +15 -0
  239. package/cjs/resources/Transfers.d.ts +8 -0
  240. package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  241. package/cjs/resources/Treasury/FinancialAccounts.d.ts +34 -1
  242. package/cjs/resources/Treasury/OutboundPayments.d.ts +8 -0
  243. package/cjs/resources/Treasury/OutboundTransfers.d.ts +44 -0
  244. package/cjs/resources/Treasury/ReceivedCredits.d.ts +22 -0
  245. package/cjs/resources/Treasury/ReceivedDebits.d.ts +26 -0
  246. package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
  247. package/cjs/resources/V2/Billing/BillSettingVersions.js +4 -0
  248. package/cjs/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  249. package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  250. package/cjs/resources/V2/Billing/BillSettings/Versions.js +23 -0
  251. package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  252. package/cjs/resources/V2/Billing/BillSettings.d.ts +280 -0
  253. package/cjs/resources/V2/Billing/BillSettings.js +41 -0
  254. package/cjs/resources/V2/Billing/BillSettings.js.map +1 -0
  255. package/cjs/resources/V2/Billing/Cadences.d.ts +947 -0
  256. package/cjs/resources/V2/Billing/Cadences.js +198 -0
  257. package/cjs/resources/V2/Billing/Cadences.js.map +1 -0
  258. package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
  259. package/cjs/resources/V2/Billing/CollectionSettingVersions.js +4 -0
  260. package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  261. package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  262. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +70 -0
  263. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  264. package/cjs/resources/V2/Billing/CollectionSettings.d.ts +775 -0
  265. package/cjs/resources/V2/Billing/CollectionSettings.js +166 -0
  266. package/cjs/resources/V2/Billing/CollectionSettings.js.map +1 -0
  267. package/cjs/resources/V2/Billing/Profiles.d.ts +162 -0
  268. package/cjs/resources/V2/Billing/Profiles.js +35 -0
  269. package/cjs/resources/V2/Billing/Profiles.js.map +1 -0
  270. package/cjs/resources/V2/Billing/index.d.ts +45 -6
  271. package/cjs/resources/V2/Billing/index.js +8 -0
  272. package/cjs/resources/V2/Billing/index.js.map +1 -1
  273. package/cjs/resources/V2/Core/AccountLinks.d.ts +4 -4
  274. package/cjs/resources/V2/Core/AccountTokens.d.ts +10 -0
  275. package/cjs/resources/V2/Core/Accounts.d.ts +1565 -75
  276. package/cjs/resources/V2/Core/BatchJobs.d.ts +360 -0
  277. package/cjs/resources/V2/Core/BatchJobs.js +225 -0
  278. package/cjs/resources/V2/Core/BatchJobs.js.map +1 -0
  279. package/cjs/resources/V2/Core/Events.d.ts +1151 -4
  280. package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
  281. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +54 -0
  282. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  283. package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +249 -0
  284. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +63 -0
  285. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  286. package/cjs/resources/V2/Core/Vault/index.d.ts +28 -0
  287. package/cjs/resources/V2/Core/Vault/index.js +15 -0
  288. package/cjs/resources/V2/Core/Vault/index.js.map +1 -0
  289. package/cjs/resources/V2/Core/index.d.ts +19 -9
  290. package/cjs/resources/V2/Core/index.js +4 -0
  291. package/cjs/resources/V2/Core/index.js.map +1 -1
  292. package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +150 -0
  293. package/cjs/resources/V2/Data/Reporting/QueryRuns.js +46 -0
  294. package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  295. package/cjs/resources/V2/Data/Reporting/index.d.ts +13 -0
  296. package/cjs/resources/V2/Data/Reporting/index.js +13 -0
  297. package/cjs/resources/V2/Data/Reporting/index.js.map +1 -0
  298. package/cjs/resources/V2/Data/index.d.ts +10 -0
  299. package/cjs/resources/V2/Data/index.js +13 -0
  300. package/cjs/resources/V2/Data/index.js.map +1 -0
  301. package/cjs/resources/V2/EventMisc.d.ts +0 -0
  302. package/cjs/resources/V2/EventMisc.js +2 -0
  303. package/cjs/resources/V2/EventMisc.js.map +1 -0
  304. package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
  305. package/cjs/resources/V2/Extend/WorkflowRuns.js +23 -0
  306. package/cjs/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  307. package/cjs/resources/V2/Extend/Workflows.d.ts +119 -0
  308. package/cjs/resources/V2/Extend/Workflows.js +30 -0
  309. package/cjs/resources/V2/Extend/Workflows.js.map +1 -0
  310. package/cjs/resources/V2/Extend/index.d.ts +20 -0
  311. package/cjs/resources/V2/Extend/index.js +15 -0
  312. package/cjs/resources/V2/Extend/index.js.map +1 -0
  313. package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  314. package/cjs/resources/V2/FinancialAddressCreditSimulations.js +4 -0
  315. package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  316. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  317. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +4 -0
  318. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  319. package/cjs/resources/V2/Iam/ActivityLogs.d.ts +210 -0
  320. package/cjs/resources/V2/Iam/ActivityLogs.js +23 -0
  321. package/cjs/resources/V2/Iam/ActivityLogs.js.map +1 -0
  322. package/cjs/resources/V2/Iam/index.d.ts +13 -0
  323. package/cjs/resources/V2/Iam/index.js +13 -0
  324. package/cjs/resources/V2/Iam/index.js.map +1 -0
  325. package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +131 -0
  326. package/cjs/resources/V2/MoneyManagement/Adjustments.js +23 -0
  327. package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  328. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +240 -0
  329. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +44 -0
  330. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  331. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +211 -0
  332. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +31 -0
  333. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  334. package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
  335. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +30 -0
  336. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  337. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +208 -0
  338. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +22 -0
  339. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  340. package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +394 -0
  341. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +41 -0
  342. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  343. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +296 -0
  344. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +49 -0
  345. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  346. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +336 -0
  347. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +39 -0
  348. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  349. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +239 -0
  350. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +44 -0
  351. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  352. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  353. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +17 -0
  354. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  355. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
  356. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +23 -0
  357. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  358. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +157 -0
  359. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +23 -0
  360. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  361. package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +161 -0
  362. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +23 -0
  363. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  364. package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +192 -0
  365. package/cjs/resources/V2/MoneyManagement/Transactions.js +23 -0
  366. package/cjs/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  367. package/cjs/resources/V2/MoneyManagement/index.d.ts +104 -0
  368. package/cjs/resources/V2/MoneyManagement/index.js +39 -0
  369. package/cjs/resources/V2/MoneyManagement/index.js.map +1 -0
  370. package/cjs/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  371. package/cjs/resources/V2/Network/BusinessProfiles.js +21 -0
  372. package/cjs/resources/V2/Network/BusinessProfiles.js.map +1 -0
  373. package/cjs/resources/V2/Network/index.d.ts +13 -0
  374. package/cjs/resources/V2/Network/index.js +13 -0
  375. package/cjs/resources/V2/Network/index.js.map +1 -0
  376. package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  377. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +41 -0
  378. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  379. package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  380. package/cjs/resources/V2/OrchestratedCommerce/index.js +13 -0
  381. package/cjs/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  382. package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  383. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +23 -0
  384. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  385. package/cjs/resources/V2/TestHelpers/index.d.ts +8 -0
  386. package/cjs/resources/V2/TestHelpers/index.js +13 -0
  387. package/cjs/resources/V2/TestHelpers/index.js.map +1 -0
  388. package/cjs/resources/V2/index.d.ts +27 -0
  389. package/cjs/resources/V2/index.js +14 -0
  390. package/cjs/resources/V2/index.js.map +1 -1
  391. package/cjs/resources/WebhookEndpoints.d.ts +2 -2
  392. package/cjs/resources.d.ts +10 -0
  393. package/cjs/resources.js +146 -10
  394. package/cjs/resources.js.map +1 -1
  395. package/cjs/stripe.cjs.node.d.ts +6536 -109
  396. package/cjs/stripe.cjs.node.js.map +1 -1
  397. package/cjs/stripe.core.d.ts +91 -26
  398. package/cjs/stripe.core.js +55 -32
  399. package/cjs/stripe.core.js.map +1 -1
  400. package/esm/Error.d.ts +50 -0
  401. package/esm/Error.js +109 -0
  402. package/esm/Error.js.map +1 -1
  403. package/esm/StripeEventNotificationHandler.d.ts +19 -0
  404. package/esm/StripeEventNotificationHandler.js +146 -0
  405. package/esm/StripeEventNotificationHandler.js.map +1 -0
  406. package/esm/Types.d.ts +4 -2
  407. package/esm/Types.js.map +1 -1
  408. package/esm/apiVersion.d.ts +1 -2
  409. package/esm/apiVersion.js +1 -2
  410. package/esm/apiVersion.js.map +1 -1
  411. package/esm/resources/AccountLinks.d.ts +1 -1
  412. package/esm/resources/AccountNotices.d.ts +140 -0
  413. package/esm/resources/AccountNotices.js +25 -0
  414. package/esm/resources/AccountNotices.js.map +1 -0
  415. package/esm/resources/AccountSessions.d.ts +262 -0
  416. package/esm/resources/AccountSessions.js.map +1 -1
  417. package/esm/resources/Accounts.d.ts +827 -3
  418. package/esm/resources/Accounts.js +14 -0
  419. package/esm/resources/Accounts.js.map +1 -1
  420. package/esm/resources/Balance.d.ts +67 -0
  421. package/esm/resources/BankAccounts.d.ts +2 -2
  422. package/esm/resources/Billing/AlertTriggereds.d.ts +2 -1
  423. package/esm/resources/Billing/Analytics/MeterUsage.d.ts +84 -0
  424. package/esm/resources/Billing/Analytics/MeterUsage.js +11 -0
  425. package/esm/resources/Billing/Analytics/MeterUsage.js.map +1 -0
  426. package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +32 -0
  427. package/esm/resources/Billing/Analytics/MeterUsageRows.js +3 -0
  428. package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +1 -0
  429. package/esm/resources/Billing/Analytics/index.d.ts +15 -0
  430. package/esm/resources/Billing/Analytics/index.js +9 -0
  431. package/esm/resources/Billing/Analytics/index.js.map +1 -0
  432. package/esm/resources/Billing/index.d.ts +3 -0
  433. package/esm/resources/Billing/index.js +2 -0
  434. package/esm/resources/Billing/index.js.map +1 -1
  435. package/esm/resources/Capabilities.d.ts +2 -2
  436. package/esm/resources/Capital/FinancingOffers.d.ts +194 -0
  437. package/esm/resources/Capital/FinancingOffers.js +26 -0
  438. package/esm/resources/Capital/FinancingOffers.js.map +1 -0
  439. package/esm/resources/Capital/FinancingSummary.d.ts +101 -0
  440. package/esm/resources/Capital/FinancingSummary.js +11 -0
  441. package/esm/resources/Capital/FinancingSummary.js.map +1 -0
  442. package/esm/resources/Capital/FinancingTransactions.d.ts +141 -0
  443. package/esm/resources/Capital/FinancingTransactions.js +20 -0
  444. package/esm/resources/Capital/FinancingTransactions.js.map +1 -0
  445. package/esm/resources/Capital/index.d.ts +25 -0
  446. package/esm/resources/Capital/index.js +13 -0
  447. package/esm/resources/Capital/index.js.map +1 -0
  448. package/esm/resources/Cards.d.ts +17 -0
  449. package/esm/resources/Charges.d.ts +3077 -70
  450. package/esm/resources/Checkout/Sessions.d.ts +403 -4
  451. package/esm/resources/ConfirmationTokens.d.ts +67 -1
  452. package/esm/resources/Coupons.d.ts +53 -0
  453. package/esm/resources/Coupons.js +13 -0
  454. package/esm/resources/Coupons.js.map +1 -1
  455. package/esm/resources/CreditNoteLineItems.d.ts +15 -1
  456. package/esm/resources/CreditNotes.d.ts +1 -1
  457. package/esm/resources/CustomerSessions.d.ts +68 -0
  458. package/esm/resources/Customers.d.ts +20 -1
  459. package/esm/resources/Customers.js +14 -0
  460. package/esm/resources/Customers.js.map +1 -1
  461. package/esm/resources/Disputes.d.ts +29 -0
  462. package/esm/resources/Events.d.ts +547 -2
  463. package/esm/resources/ExternalAccounts.d.ts +212 -1
  464. package/esm/resources/ExternalAccounts.js +42 -1
  465. package/esm/resources/ExternalAccounts.js.map +1 -1
  466. package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +24 -0
  467. package/esm/resources/FinancialConnections/AccountInferredBalances.js +3 -0
  468. package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +1 -0
  469. package/esm/resources/FinancialConnections/Accounts.d.ts +69 -4
  470. package/esm/resources/FinancialConnections/Accounts.js +8 -0
  471. package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
  472. package/esm/resources/FinancialConnections/Authorizations.d.ts +99 -0
  473. package/esm/resources/FinancialConnections/Authorizations.js +11 -0
  474. package/esm/resources/FinancialConnections/Authorizations.js.map +1 -0
  475. package/esm/resources/FinancialConnections/Institutions.d.ts +99 -0
  476. package/esm/resources/FinancialConnections/Institutions.js +19 -0
  477. package/esm/resources/FinancialConnections/Institutions.js.map +1 -0
  478. package/esm/resources/FinancialConnections/Sessions.d.ts +156 -7
  479. package/esm/resources/FinancialConnections/Sessions.js.map +1 -1
  480. package/esm/resources/FinancialConnections/index.d.ts +21 -6
  481. package/esm/resources/FinancialConnections/index.js +4 -0
  482. package/esm/resources/FinancialConnections/index.js.map +1 -1
  483. package/esm/resources/FxQuotes.d.ts +212 -0
  484. package/esm/resources/FxQuotes.js +25 -0
  485. package/esm/resources/FxQuotes.js.map +1 -0
  486. package/esm/resources/InvoiceItems.d.ts +85 -0
  487. package/esm/resources/InvoiceItems.js.map +1 -1
  488. package/esm/resources/InvoiceLineItems.d.ts +40 -2
  489. package/esm/resources/Invoices.d.ts +1388 -15
  490. package/esm/resources/Invoices.js +41 -0
  491. package/esm/resources/Invoices.js.map +1 -1
  492. package/esm/resources/Issuing/Authorizations.d.ts +13 -0
  493. package/esm/resources/Issuing/Cardholders.d.ts +15 -1
  494. package/esm/resources/Issuing/Cards.d.ts +13 -0
  495. package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +638 -0
  496. package/esm/resources/Issuing/CreditUnderwritingRecords.js +43 -0
  497. package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +1 -0
  498. package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +93 -0
  499. package/esm/resources/Issuing/DisputeSettlementDetails.js +19 -0
  500. package/esm/resources/Issuing/DisputeSettlementDetails.js.map +1 -0
  501. package/esm/resources/Issuing/Disputes.d.ts +13 -0
  502. package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +68 -0
  503. package/esm/resources/Issuing/FraudLiabilityDebits.js +19 -0
  504. package/esm/resources/Issuing/FraudLiabilityDebits.js.map +1 -0
  505. package/esm/resources/Issuing/Settlements.d.ts +83 -0
  506. package/esm/resources/Issuing/Settlements.js +3 -0
  507. package/esm/resources/Issuing/Settlements.js.map +1 -0
  508. package/esm/resources/Issuing/Transactions.d.ts +22 -0
  509. package/esm/resources/Issuing/Transactions.js.map +1 -1
  510. package/esm/resources/Issuing/index.d.ts +47 -22
  511. package/esm/resources/Issuing/index.js +6 -0
  512. package/esm/resources/Issuing/index.js.map +1 -1
  513. package/esm/resources/LineItems.d.ts +29 -2
  514. package/esm/resources/Mandates.d.ts +33 -1
  515. package/esm/resources/Mandates.js +8 -0
  516. package/esm/resources/Mandates.js.map +1 -1
  517. package/esm/resources/Margins.d.ts +115 -0
  518. package/esm/resources/Margins.js +31 -0
  519. package/esm/resources/Margins.js.map +1 -0
  520. package/esm/resources/Orders.d.ts +4693 -0
  521. package/esm/resources/Orders.js +453 -0
  522. package/esm/resources/Orders.js.map +1 -0
  523. package/esm/resources/PaymentAttemptRecords.d.ts +82 -0
  524. package/esm/resources/PaymentIntents.d.ts +13283 -2352
  525. package/esm/resources/PaymentIntents.js +27 -0
  526. package/esm/resources/PaymentIntents.js.map +1 -1
  527. package/esm/resources/PaymentLinks.d.ts +19 -3
  528. package/esm/resources/PaymentMethodConfigurations.d.ts +350 -0
  529. package/esm/resources/PaymentMethods.d.ts +164 -3
  530. package/esm/resources/PaymentMethods.js.map +1 -1
  531. package/esm/resources/PaymentRecords.d.ts +82 -0
  532. package/esm/resources/Persons.d.ts +2 -2
  533. package/esm/resources/Plans.d.ts +16 -0
  534. package/esm/resources/Prices.d.ts +52 -0
  535. package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +35 -0
  536. package/esm/resources/Privacy/RedactionJobValidationErrors.js +3 -0
  537. package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +1 -0
  538. package/esm/resources/Privacy/RedactionJobs.d.ts +227 -0
  539. package/esm/resources/Privacy/RedactionJobs.js +69 -0
  540. package/esm/resources/Privacy/RedactionJobs.js.map +1 -0
  541. package/esm/resources/Privacy/index.d.ts +22 -0
  542. package/esm/resources/Privacy/index.js +9 -0
  543. package/esm/resources/Privacy/index.js.map +1 -0
  544. package/esm/resources/ProductCatalog/TrialOffers.d.ts +125 -0
  545. package/esm/resources/ProductCatalog/TrialOffers.js +11 -0
  546. package/esm/resources/ProductCatalog/TrialOffers.js.map +1 -0
  547. package/esm/resources/ProductCatalog/index.d.ts +12 -0
  548. package/esm/resources/ProductCatalog/index.js +9 -0
  549. package/esm/resources/ProductCatalog/index.js.map +1 -0
  550. package/esm/resources/Products.d.ts +42 -0
  551. package/esm/resources/PromotionCodes.d.ts +12 -0
  552. package/esm/resources/PromotionCodes.js +27 -0
  553. package/esm/resources/PromotionCodes.js.map +1 -1
  554. package/esm/resources/QuoteLines.d.ts +507 -0
  555. package/esm/resources/QuoteLines.js +3 -0
  556. package/esm/resources/QuoteLines.js.map +1 -0
  557. package/esm/resources/QuotePreviewInvoices.d.ts +1120 -0
  558. package/esm/resources/QuotePreviewInvoices.js +3 -0
  559. package/esm/resources/QuotePreviewInvoices.js.map +1 -0
  560. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +738 -0
  561. package/esm/resources/QuotePreviewSubscriptionSchedules.js +3 -0
  562. package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +1 -0
  563. package/esm/resources/Quotes.d.ts +2266 -57
  564. package/esm/resources/Quotes.js +1184 -16
  565. package/esm/resources/Quotes.js.map +1 -1
  566. package/esm/resources/Radar/PaymentEvaluations.d.ts +1 -1
  567. package/esm/resources/Radar/ValueListItems.d.ts +30 -0
  568. package/esm/resources/Refunds.d.ts +11 -0
  569. package/esm/resources/Reserve/Holds.d.ts +53 -1
  570. package/esm/resources/Reserve/Holds.js +17 -1
  571. package/esm/resources/Reserve/Holds.js.map +1 -1
  572. package/esm/resources/Reserve/Plans.d.ts +16 -0
  573. package/esm/resources/Reserve/Plans.js +9 -1
  574. package/esm/resources/Reserve/Plans.js.map +1 -1
  575. package/esm/resources/Reserve/Releases.d.ts +41 -1
  576. package/esm/resources/Reserve/Releases.js +17 -1
  577. package/esm/resources/Reserve/Releases.js.map +1 -1
  578. package/esm/resources/Reserve/index.d.ts +17 -6
  579. package/esm/resources/Reserve/index.js +9 -0
  580. package/esm/resources/Reserve/index.js.map +1 -1
  581. package/esm/resources/SetupAttempts.d.ts +26 -1
  582. package/esm/resources/SetupIntents.d.ts +343 -11
  583. package/esm/resources/SharedPayment/GrantedTokens.d.ts +1105 -0
  584. package/esm/resources/SharedPayment/GrantedTokens.js +11 -0
  585. package/esm/resources/SharedPayment/GrantedTokens.js.map +1 -0
  586. package/esm/resources/SharedPayment/IssuedTokens.d.ts +306 -0
  587. package/esm/resources/SharedPayment/IssuedTokens.js +23 -0
  588. package/esm/resources/SharedPayment/IssuedTokens.js.map +1 -0
  589. package/esm/resources/SharedPayment/index.d.ts +19 -0
  590. package/esm/resources/SharedPayment/index.js +11 -0
  591. package/esm/resources/SharedPayment/index.js.map +1 -0
  592. package/esm/resources/Sources.d.ts +29 -1
  593. package/esm/resources/SubscriptionItems.d.ts +143 -0
  594. package/esm/resources/SubscriptionSchedules.d.ts +1152 -0
  595. package/esm/resources/SubscriptionSchedules.js +6 -0
  596. package/esm/resources/SubscriptionSchedules.js.map +1 -1
  597. package/esm/resources/Subscriptions.d.ts +571 -6
  598. package/esm/resources/Subscriptions.js +145 -0
  599. package/esm/resources/Subscriptions.js.map +1 -1
  600. package/esm/resources/Tax/CalculationLineItems.d.ts +6 -2
  601. package/esm/resources/Tax/Calculations.d.ts +7 -3
  602. package/esm/resources/Tax/Forms.d.ts +228 -0
  603. package/esm/resources/Tax/Forms.js +28 -0
  604. package/esm/resources/Tax/Forms.js.map +1 -0
  605. package/esm/resources/Tax/Locations.d.ts +108 -0
  606. package/esm/resources/Tax/Locations.js +29 -0
  607. package/esm/resources/Tax/Locations.js.map +1 -0
  608. package/esm/resources/Tax/Registrations.d.ts +138 -2
  609. package/esm/resources/Tax/Transactions.d.ts +2 -2
  610. package/esm/resources/Tax/index.d.ts +27 -13
  611. package/esm/resources/Tax/index.js +4 -0
  612. package/esm/resources/Tax/index.js.map +1 -1
  613. package/esm/resources/TaxCodes.d.ts +15 -0
  614. package/esm/resources/Terminal/Configurations.d.ts +27 -0
  615. package/esm/resources/Terminal/ReaderCollectedData.d.ts +50 -0
  616. package/esm/resources/Terminal/ReaderCollectedData.js +11 -0
  617. package/esm/resources/Terminal/ReaderCollectedData.js.map +1 -0
  618. package/esm/resources/Terminal/Readers.d.ts +17 -1
  619. package/esm/resources/Terminal/index.d.ts +5 -0
  620. package/esm/resources/Terminal/index.js +2 -0
  621. package/esm/resources/Terminal/index.js.map +1 -1
  622. package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +78 -1
  623. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +68 -0
  624. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +17 -0
  625. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +1 -0
  626. package/esm/resources/TestHelpers/SharedPayment/index.d.ts +8 -0
  627. package/esm/resources/TestHelpers/SharedPayment/index.js +9 -0
  628. package/esm/resources/TestHelpers/SharedPayment/index.js.map +1 -0
  629. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +22 -0
  630. package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +22 -0
  631. package/esm/resources/TestHelpers/index.d.ts +3 -0
  632. package/esm/resources/TestHelpers/index.js +2 -0
  633. package/esm/resources/TestHelpers/index.js.map +1 -1
  634. package/esm/resources/Tokens.d.ts +15 -0
  635. package/esm/resources/Transfers.d.ts +8 -0
  636. package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +5 -0
  637. package/esm/resources/Treasury/FinancialAccounts.d.ts +34 -1
  638. package/esm/resources/Treasury/OutboundPayments.d.ts +8 -0
  639. package/esm/resources/Treasury/OutboundTransfers.d.ts +44 -0
  640. package/esm/resources/Treasury/ReceivedCredits.d.ts +22 -0
  641. package/esm/resources/Treasury/ReceivedDebits.d.ts +26 -0
  642. package/esm/resources/V2/Billing/BillSettingVersions.d.ts +71 -0
  643. package/esm/resources/V2/Billing/BillSettingVersions.js +3 -0
  644. package/esm/resources/V2/Billing/BillSettingVersions.js.map +1 -0
  645. package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +33 -0
  646. package/esm/resources/V2/Billing/BillSettings/Versions.js +19 -0
  647. package/esm/resources/V2/Billing/BillSettings/Versions.js.map +1 -0
  648. package/esm/resources/V2/Billing/BillSettings.d.ts +280 -0
  649. package/esm/resources/V2/Billing/BillSettings.js +37 -0
  650. package/esm/resources/V2/Billing/BillSettings.js.map +1 -0
  651. package/esm/resources/V2/Billing/Cadences.d.ts +947 -0
  652. package/esm/resources/V2/Billing/Cadences.js +194 -0
  653. package/esm/resources/V2/Billing/Cadences.js.map +1 -0
  654. package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +236 -0
  655. package/esm/resources/V2/Billing/CollectionSettingVersions.js +3 -0
  656. package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +1 -0
  657. package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +33 -0
  658. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +66 -0
  659. package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +1 -0
  660. package/esm/resources/V2/Billing/CollectionSettings.d.ts +775 -0
  661. package/esm/resources/V2/Billing/CollectionSettings.js +162 -0
  662. package/esm/resources/V2/Billing/CollectionSettings.js.map +1 -0
  663. package/esm/resources/V2/Billing/Profiles.d.ts +162 -0
  664. package/esm/resources/V2/Billing/Profiles.js +31 -0
  665. package/esm/resources/V2/Billing/Profiles.js.map +1 -0
  666. package/esm/resources/V2/Billing/index.d.ts +45 -6
  667. package/esm/resources/V2/Billing/index.js +8 -0
  668. package/esm/resources/V2/Billing/index.js.map +1 -1
  669. package/esm/resources/V2/Core/AccountLinks.d.ts +4 -4
  670. package/esm/resources/V2/Core/AccountTokens.d.ts +10 -0
  671. package/esm/resources/V2/Core/Accounts.d.ts +1565 -75
  672. package/esm/resources/V2/Core/BatchJobs.d.ts +360 -0
  673. package/esm/resources/V2/Core/BatchJobs.js +221 -0
  674. package/esm/resources/V2/Core/BatchJobs.js.map +1 -0
  675. package/esm/resources/V2/Core/Events.d.ts +1151 -4
  676. package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +279 -0
  677. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +50 -0
  678. package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +1 -0
  679. package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +249 -0
  680. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +59 -0
  681. package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +1 -0
  682. package/esm/resources/V2/Core/Vault/index.d.ts +28 -0
  683. package/esm/resources/V2/Core/Vault/index.js +11 -0
  684. package/esm/resources/V2/Core/Vault/index.js.map +1 -0
  685. package/esm/resources/V2/Core/index.d.ts +19 -9
  686. package/esm/resources/V2/Core/index.js +4 -0
  687. package/esm/resources/V2/Core/index.js.map +1 -1
  688. package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +150 -0
  689. package/esm/resources/V2/Data/Reporting/QueryRuns.js +42 -0
  690. package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +1 -0
  691. package/esm/resources/V2/Data/Reporting/index.d.ts +13 -0
  692. package/esm/resources/V2/Data/Reporting/index.js +9 -0
  693. package/esm/resources/V2/Data/Reporting/index.js.map +1 -0
  694. package/esm/resources/V2/Data/index.d.ts +10 -0
  695. package/esm/resources/V2/Data/index.js +9 -0
  696. package/esm/resources/V2/Data/index.js.map +1 -0
  697. package/esm/resources/V2/EventMisc.d.ts +0 -0
  698. package/esm/resources/V2/EventMisc.js +2 -0
  699. package/esm/resources/V2/EventMisc.js.map +1 -0
  700. package/esm/resources/V2/Extend/WorkflowRuns.d.ts +162 -0
  701. package/esm/resources/V2/Extend/WorkflowRuns.js +19 -0
  702. package/esm/resources/V2/Extend/WorkflowRuns.js.map +1 -0
  703. package/esm/resources/V2/Extend/Workflows.d.ts +119 -0
  704. package/esm/resources/V2/Extend/Workflows.js +26 -0
  705. package/esm/resources/V2/Extend/Workflows.js.map +1 -0
  706. package/esm/resources/V2/Extend/index.d.ts +20 -0
  707. package/esm/resources/V2/Extend/index.js +11 -0
  708. package/esm/resources/V2/Extend/index.js.map +1 -0
  709. package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +14 -0
  710. package/esm/resources/V2/FinancialAddressCreditSimulations.js +3 -0
  711. package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +1 -0
  712. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +19 -0
  713. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +3 -0
  714. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +1 -0
  715. package/esm/resources/V2/Iam/ActivityLogs.d.ts +210 -0
  716. package/esm/resources/V2/Iam/ActivityLogs.js +19 -0
  717. package/esm/resources/V2/Iam/ActivityLogs.js.map +1 -0
  718. package/esm/resources/V2/Iam/index.d.ts +13 -0
  719. package/esm/resources/V2/Iam/index.js +9 -0
  720. package/esm/resources/V2/Iam/index.js.map +1 -0
  721. package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +131 -0
  722. package/esm/resources/V2/MoneyManagement/Adjustments.js +19 -0
  723. package/esm/resources/V2/MoneyManagement/Adjustments.js.map +1 -0
  724. package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +240 -0
  725. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +40 -0
  726. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +1 -0
  727. package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +211 -0
  728. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +27 -0
  729. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +1 -0
  730. package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
  731. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +26 -0
  732. package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +1 -0
  733. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +208 -0
  734. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +18 -0
  735. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +1 -0
  736. package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +394 -0
  737. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +37 -0
  738. package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +1 -0
  739. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +296 -0
  740. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +45 -0
  741. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +1 -0
  742. package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +336 -0
  743. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +35 -0
  744. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +1 -0
  745. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +239 -0
  746. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +40 -0
  747. package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +1 -0
  748. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +92 -0
  749. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +13 -0
  750. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +1 -0
  751. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +295 -0
  752. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +19 -0
  753. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +1 -0
  754. package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +157 -0
  755. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +19 -0
  756. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +1 -0
  757. package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +161 -0
  758. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +19 -0
  759. package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +1 -0
  760. package/esm/resources/V2/MoneyManagement/Transactions.d.ts +192 -0
  761. package/esm/resources/V2/MoneyManagement/Transactions.js +19 -0
  762. package/esm/resources/V2/MoneyManagement/Transactions.js.map +1 -0
  763. package/esm/resources/V2/MoneyManagement/index.d.ts +104 -0
  764. package/esm/resources/V2/MoneyManagement/index.js +35 -0
  765. package/esm/resources/V2/MoneyManagement/index.js.map +1 -0
  766. package/esm/resources/V2/Network/BusinessProfiles.d.ts +92 -0
  767. package/esm/resources/V2/Network/BusinessProfiles.js +17 -0
  768. package/esm/resources/V2/Network/BusinessProfiles.js.map +1 -0
  769. package/esm/resources/V2/Network/index.d.ts +13 -0
  770. package/esm/resources/V2/Network/index.js +9 -0
  771. package/esm/resources/V2/Network/index.js.map +1 -0
  772. package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +143 -0
  773. package/esm/resources/V2/OrchestratedCommerce/Agreements.js +37 -0
  774. package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +1 -0
  775. package/esm/resources/V2/OrchestratedCommerce/index.d.ts +16 -0
  776. package/esm/resources/V2/OrchestratedCommerce/index.js +9 -0
  777. package/esm/resources/V2/OrchestratedCommerce/index.js.map +1 -0
  778. package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +44 -0
  779. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +19 -0
  780. package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +1 -0
  781. package/esm/resources/V2/TestHelpers/index.d.ts +8 -0
  782. package/esm/resources/V2/TestHelpers/index.js +9 -0
  783. package/esm/resources/V2/TestHelpers/index.js.map +1 -0
  784. package/esm/resources/V2/index.d.ts +27 -0
  785. package/esm/resources/V2/index.js +14 -0
  786. package/esm/resources/V2/index.js.map +1 -1
  787. package/esm/resources/WebhookEndpoints.d.ts +2 -2
  788. package/esm/resources.d.ts +10 -0
  789. package/esm/resources.js +131 -0
  790. package/esm/resources.js.map +1 -1
  791. package/esm/stripe.core.d.ts +91 -26
  792. package/esm/stripe.core.js +25 -2
  793. package/esm/stripe.core.js.map +1 -1
  794. package/esm/stripe.esm.node.d.ts +93 -27
  795. package/esm/stripe.esm.node.js +25 -2
  796. package/esm/stripe.esm.node.js.map +1 -1
  797. package/package.json +1 -1
@@ -11,7 +11,7 @@ import { CustomerSource } from './CustomerSources.js';
11
11
  import { Transfer } from './Transfers.js';
12
12
  import { PaymentMethod } from './PaymentMethods.js';
13
13
  import { Mandate } from './Mandates.js';
14
- import { Emptyable, MetadataParam, AddressParam, PaginationParams, RangeQueryParam, Metadata, Address } from '../shared.js';
14
+ import { Emptyable, MetadataParam, AddressParam, Address, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
15
15
  import { RequestOptions, ApiListPromise, Response, ApiList, ApiSearchResultPromise } from '../lib.js';
16
16
  export declare class ChargeResource extends StripeResource {
17
17
  /**
@@ -184,6 +184,10 @@ export interface Charge {
184
184
  * This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
185
185
  */
186
186
  receipt_url: string | null;
187
+ /**
188
+ * Redaction status of this charge. If not null, this charge is associated to a redaction job.
189
+ */
190
+ redaction?: Charge.Redaction | null;
187
191
  /**
188
192
  * Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
189
193
  */
@@ -342,7 +346,9 @@ export declare namespace Charge {
342
346
  eps?: PaymentMethodDetails.Eps;
343
347
  fpx?: PaymentMethodDetails.Fpx;
344
348
  giropay?: PaymentMethodDetails.Giropay;
349
+ gopay?: PaymentMethodDetails.Gopay;
345
350
  grabpay?: PaymentMethodDetails.Grabpay;
351
+ id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
346
352
  ideal?: PaymentMethodDetails.Ideal;
347
353
  interac_present?: PaymentMethodDetails.InteracPresent;
348
354
  kakao_pay?: PaymentMethodDetails.KakaoPay;
@@ -361,17 +367,22 @@ export declare namespace Charge {
361
367
  payco?: PaymentMethodDetails.Payco;
362
368
  paynow?: PaymentMethodDetails.Paynow;
363
369
  paypal?: PaymentMethodDetails.Paypal;
370
+ paypay?: PaymentMethodDetails.Paypay;
364
371
  payto?: PaymentMethodDetails.Payto;
365
372
  pix?: PaymentMethodDetails.Pix;
366
373
  promptpay?: PaymentMethodDetails.Promptpay;
374
+ qris?: PaymentMethodDetails.Qris;
375
+ rechnung?: PaymentMethodDetails.Rechnung;
367
376
  revolut_pay?: PaymentMethodDetails.RevolutPay;
368
377
  samsung_pay?: PaymentMethodDetails.SamsungPay;
369
378
  satispay?: PaymentMethodDetails.Satispay;
370
379
  scalapay?: PaymentMethodDetails.Scalapay;
371
380
  sepa_credit_transfer?: PaymentMethodDetails.SepaCreditTransfer;
372
381
  sepa_debit?: PaymentMethodDetails.SepaDebit;
382
+ shopeepay?: PaymentMethodDetails.Shopeepay;
373
383
  sofort?: PaymentMethodDetails.Sofort;
374
384
  stripe_account?: PaymentMethodDetails.StripeAccount;
385
+ stripe_balance?: PaymentMethodDetails.StripeBalance;
375
386
  sunbit?: PaymentMethodDetails.Sunbit;
376
387
  swish?: PaymentMethodDetails.Swish;
377
388
  twint?: PaymentMethodDetails.Twint;
@@ -403,6 +414,12 @@ export declare namespace Charge {
403
414
  */
404
415
  session?: string;
405
416
  }
417
+ interface Redaction {
418
+ /**
419
+ * Indicates whether this object and its related objects have been redacted or not.
420
+ */
421
+ status: Redaction.Status;
422
+ }
406
423
  interface Shipping {
407
424
  address?: Address;
408
425
  /**
@@ -700,6 +717,10 @@ export declare namespace Charge {
700
717
  * The authorized amount.
701
718
  */
702
719
  amount_authorized: number | null;
720
+ /**
721
+ * The latest amount intended to be authorized by this charge.
722
+ */
723
+ amount_requested?: number | null;
703
724
  /**
704
725
  * Authorization code on the charge.
705
726
  */
@@ -720,6 +741,7 @@ export declare namespace Charge {
720
741
  * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
721
742
  */
722
743
  country: string | null;
744
+ decremental_authorization?: Card.DecrementalAuthorization;
723
745
  /**
724
746
  * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
725
747
  */
@@ -784,6 +806,7 @@ export declare namespace Charge {
784
806
  */
785
807
  network_transaction_id: string | null;
786
808
  overcapture?: Card.Overcapture;
809
+ partial_authorization?: Card.PartialAuthorization;
787
810
  /**
788
811
  * Status of a card based on the card issuer.
789
812
  */
@@ -990,12 +1013,36 @@ export declare namespace Charge {
990
1013
  */
991
1014
  verified_name: string | null;
992
1015
  }
1016
+ interface Gopay {
1017
+ }
993
1018
  interface Grabpay {
994
1019
  /**
995
1020
  * Unique transaction id generated by GrabPay
996
1021
  */
997
1022
  transaction_id: string | null;
998
1023
  }
1024
+ interface IdBankTransfer {
1025
+ /**
1026
+ * Account number of the bank account to transfer funds to.
1027
+ */
1028
+ account_number: string;
1029
+ /**
1030
+ * Bank where the account is located.
1031
+ */
1032
+ bank: IdBankTransfer.Bank;
1033
+ /**
1034
+ * Local bank code of the bank.
1035
+ */
1036
+ bank_code?: string;
1037
+ /**
1038
+ * Name of the bank associated with the bank account.
1039
+ */
1040
+ bank_name?: string;
1041
+ /**
1042
+ * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
1043
+ */
1044
+ display_name?: string;
1045
+ }
999
1046
  interface Ideal {
1000
1047
  /**
1001
1048
  * The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1305,10 +1352,34 @@ export declare namespace Charge {
1305
1352
  * The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
1306
1353
  */
1307
1354
  seller_protection: Paypal.SellerProtection | null;
1355
+ /**
1356
+ * The shipping address for the customer, as supplied by the merchant at the point of payment
1357
+ * execution. This shipping address will not be updated if the merchant updates the shipping
1358
+ * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1359
+ */
1360
+ shipping?: Address | null;
1308
1361
  /**
1309
1362
  * A unique ID generated by PayPal for this transaction.
1310
1363
  */
1311
1364
  transaction_id: string | null;
1365
+ /**
1366
+ * The shipping address for the customer, as supplied by the merchant at the point of payment
1367
+ * execution. This shipping address will not be updated if the merchant updates the shipping
1368
+ * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1369
+ */
1370
+ verified_address?: Address | null;
1371
+ /**
1372
+ * Owner's verified email. Values are verified or provided by PayPal directly
1373
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1374
+ */
1375
+ verified_email?: string | null;
1376
+ /**
1377
+ * Owner's verified full name. Values are verified or provided by PayPal directly
1378
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1379
+ */
1380
+ verified_name?: string | null;
1381
+ }
1382
+ interface Paypay {
1312
1383
  }
1313
1384
  interface Payto {
1314
1385
  /**
@@ -1348,6 +1419,14 @@ export declare namespace Charge {
1348
1419
  */
1349
1420
  reference: string | null;
1350
1421
  }
1422
+ interface Qris {
1423
+ }
1424
+ interface Rechnung {
1425
+ /**
1426
+ * Payment portal URL.
1427
+ */
1428
+ payment_portal_url: string | null;
1429
+ }
1351
1430
  interface RevolutPay {
1352
1431
  funding?: RevolutPay.Funding;
1353
1432
  /**
@@ -1421,6 +1500,8 @@ export declare namespace Charge {
1421
1500
  */
1422
1501
  mandate: string | null;
1423
1502
  }
1503
+ interface Shopeepay {
1504
+ }
1424
1505
  interface Sofort {
1425
1506
  /**
1426
1507
  * Bank code of bank associated with the bank account.
@@ -1463,6 +1544,12 @@ export declare namespace Charge {
1463
1544
  }
1464
1545
  interface StripeAccount {
1465
1546
  }
1547
+ interface StripeBalance {
1548
+ /**
1549
+ * The connected account ID whose Stripe balance to use as the source of payment
1550
+ */
1551
+ account?: string | null;
1552
+ }
1466
1553
  interface Sunbit {
1467
1554
  /**
1468
1555
  * The Sunbit transaction ID associated with this payment.
@@ -1580,6 +1667,10 @@ export declare namespace Charge {
1580
1667
  * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
1581
1668
  */
1582
1669
  brand: string | null;
1670
+ /**
1671
+ * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
1672
+ */
1673
+ brand_product?: string | null;
1583
1674
  /**
1584
1675
  * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
1585
1676
  */
@@ -1621,6 +1712,12 @@ export declare namespace Charge {
1621
1712
  */
1622
1713
  cvc_check: string | null;
1623
1714
  }
1715
+ interface DecrementalAuthorization {
1716
+ /**
1717
+ * Indicates whether or not the decremental authorization feature is supported.
1718
+ */
1719
+ status: DecrementalAuthorization.Status;
1720
+ }
1624
1721
  interface ExtendedAuthorization {
1625
1722
  /**
1626
1723
  * Indicates whether or not the capture window is extended beyond the standard authorization.
@@ -1661,6 +1758,12 @@ export declare namespace Charge {
1661
1758
  */
1662
1759
  status: Overcapture.Status;
1663
1760
  }
1761
+ interface PartialAuthorization {
1762
+ /**
1763
+ * Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
1764
+ */
1765
+ status: PartialAuthorization.Status;
1766
+ }
1664
1767
  type RegulatedStatus = 'regulated' | 'unregulated';
1665
1768
  interface ThreeDSecure {
1666
1769
  /**
@@ -1718,6 +1821,9 @@ export declare namespace Charge {
1718
1821
  type: Wallet.Type;
1719
1822
  visa_checkout?: Wallet.VisaCheckout;
1720
1823
  }
1824
+ namespace DecrementalAuthorization {
1825
+ type Status = 'available' | 'unavailable';
1826
+ }
1721
1827
  namespace ExtendedAuthorization {
1722
1828
  type Status = 'disabled' | 'enabled';
1723
1829
  }
@@ -1750,6 +1856,9 @@ export declare namespace Charge {
1750
1856
  namespace Overcapture {
1751
1857
  type Status = 'available' | 'unavailable';
1752
1858
  }
1859
+ namespace PartialAuthorization {
1860
+ type Status = 'declined' | 'fully_authorized' | 'not_requested' | 'partially_authorized';
1861
+ }
1753
1862
  namespace ThreeDSecure {
1754
1863
  type AuthenticationFlow = 'challenge' | 'frictionless';
1755
1864
  type ElectronicCommerceIndicator = '01' | '02' | '05' | '06' | '07';
@@ -1882,6 +1991,9 @@ export declare namespace Charge {
1882
1991
  type AccountHolderType = 'company' | 'individual';
1883
1992
  type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
1884
1993
  }
1994
+ namespace IdBankTransfer {
1995
+ type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
1996
+ }
1885
1997
  namespace Ideal {
1886
1998
  type Bank = 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe';
1887
1999
  type Bic = 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U';
@@ -2017,6 +2129,10 @@ export declare namespace Charge {
2017
2129
  * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
2018
2130
  */
2019
2131
  brand: string | null;
2132
+ /**
2133
+ * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
2134
+ */
2135
+ brand_product?: string | null;
2020
2136
  /**
2021
2137
  * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
2022
2138
  */
@@ -2048,6 +2164,9 @@ export declare namespace Charge {
2048
2164
  type AccountType = 'checking' | 'savings';
2049
2165
  }
2050
2166
  }
2167
+ namespace Redaction {
2168
+ type Status = 'processing' | 'redacted' | 'validated';
2169
+ }
2051
2170
  }
2052
2171
  export interface ChargeCreateParams {
2053
2172
  /**
@@ -2204,6 +2323,10 @@ export interface ChargeUpdateParams {
2204
2323
  * Set of [key-value pairs](https://docs.stripe.com/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`.
2205
2324
  */
2206
2325
  metadata?: Emptyable<MetadataParam>;
2326
+ /**
2327
+ * Provides industry-specific information about the charge.
2328
+ */
2329
+ payment_details?: ChargeUpdateParams.PaymentDetails;
2207
2330
  /**
2208
2331
  * 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.
2209
2332
  */
@@ -2224,6 +2347,52 @@ export declare namespace ChargeUpdateParams {
2224
2347
  */
2225
2348
  user_report: Emptyable<FraudDetails.UserReport>;
2226
2349
  }
2350
+ interface PaymentDetails {
2351
+ /**
2352
+ * Car rental details for this PaymentIntent.
2353
+ */
2354
+ car_rental?: PaymentDetails.CarRental;
2355
+ /**
2356
+ * Car rental data for this PaymentIntent.
2357
+ */
2358
+ car_rental_data?: Emptyable<Array<PaymentDetails.CarRentalDatum>>;
2359
+ /**
2360
+ * A unique value to identify the customer. This field is available only for card payments.
2361
+ *
2362
+ * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
2363
+ */
2364
+ customer_reference?: Emptyable<string>;
2365
+ /**
2366
+ * Event details for this PaymentIntent
2367
+ */
2368
+ event_details?: PaymentDetails.EventDetails;
2369
+ /**
2370
+ * Flight reservation details for this PaymentIntent
2371
+ */
2372
+ flight?: PaymentDetails.Flight;
2373
+ /**
2374
+ * Flight data for this PaymentIntent.
2375
+ */
2376
+ flight_data?: Emptyable<Array<PaymentDetails.FlightDatum>>;
2377
+ /**
2378
+ * Lodging reservation details for this PaymentIntent
2379
+ */
2380
+ lodging?: PaymentDetails.Lodging;
2381
+ /**
2382
+ * Lodging data for this PaymentIntent.
2383
+ */
2384
+ lodging_data?: Emptyable<Array<PaymentDetails.LodgingDatum>>;
2385
+ /**
2386
+ * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
2387
+ *
2388
+ * For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
2389
+ */
2390
+ order_reference?: Emptyable<string>;
2391
+ /**
2392
+ * Subscription details for this PaymentIntent
2393
+ */
2394
+ subscription?: PaymentDetails.Subscription;
2395
+ }
2227
2396
  interface Shipping {
2228
2397
  /**
2229
2398
  * Shipping address.
@@ -2249,75 +2418,2913 @@ export declare namespace ChargeUpdateParams {
2249
2418
  namespace FraudDetails {
2250
2419
  type UserReport = 'fraudulent' | 'safe';
2251
2420
  }
2252
- }
2253
- export interface ChargeListParams extends PaginationParams {
2254
- /**
2255
- * Only return charges that were created during the given date interval.
2256
- */
2257
- created?: RangeQueryParam | number;
2258
- /**
2259
- * Only return charges for the customer specified by this customer ID.
2260
- */
2261
- customer?: string;
2262
- /**
2263
- * Specifies which fields in the response should be expanded.
2264
- */
2265
- expand?: Array<string>;
2266
- /**
2267
- * Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
2268
- */
2269
- payment_intent?: string;
2270
- /**
2271
- * Only return charges for this transfer group, limited to 100.
2272
- */
2273
- transfer_group?: string;
2274
- }
2275
- export interface ChargeCaptureParams {
2276
- /**
2277
- * The amount to capture, which must be less than or equal to the original amount.
2278
- */
2279
- amount?: number;
2280
- /**
2281
- * An application fee to add on to this charge.
2282
- */
2283
- application_fee?: number;
2284
- /**
2285
- * An application fee amount to add on to this charge, which must be less than or equal to the original amount.
2286
- */
2287
- application_fee_amount?: number;
2288
- /**
2289
- * Specifies which fields in the response should be expanded.
2290
- */
2291
- expand?: Array<string>;
2292
- /**
2293
- * 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.
2294
- */
2295
- receipt_email?: string;
2296
- /**
2297
- * For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
2298
- *
2299
- * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
2300
- */
2301
- statement_descriptor?: string;
2302
- /**
2303
- * Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
2304
- */
2305
- statement_descriptor_suffix?: string;
2306
- /**
2307
- * An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
2308
- */
2309
- transfer_data?: ChargeCaptureParams.TransferData;
2310
- /**
2311
- * A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
2312
- */
2313
- transfer_group?: string;
2314
- }
2315
- export declare namespace ChargeCaptureParams {
2316
- interface TransferData {
2317
- /**
2318
- * The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
2319
- */
2320
- amount?: number;
2421
+ namespace PaymentDetails {
2422
+ interface CarRental {
2423
+ /**
2424
+ * Affiliate details for this purchase.
2425
+ */
2426
+ affiliate?: CarRental.Affiliate;
2427
+ /**
2428
+ * The booking number associated with the car rental.
2429
+ */
2430
+ booking_number: string;
2431
+ /**
2432
+ * Class code of the car.
2433
+ */
2434
+ car_class_code?: string;
2435
+ /**
2436
+ * Make of the car.
2437
+ */
2438
+ car_make?: string;
2439
+ /**
2440
+ * Model of the car.
2441
+ */
2442
+ car_model?: string;
2443
+ /**
2444
+ * The name of the rental car company.
2445
+ */
2446
+ company?: string;
2447
+ /**
2448
+ * The customer service phone number of the car rental company.
2449
+ */
2450
+ customer_service_phone_number?: string;
2451
+ /**
2452
+ * Number of days the car is being rented.
2453
+ */
2454
+ days_rented: number;
2455
+ /**
2456
+ * Delivery details for this purchase.
2457
+ */
2458
+ delivery?: CarRental.Delivery;
2459
+ /**
2460
+ * The details of the distance traveled during the rental period.
2461
+ */
2462
+ distance?: CarRental.Distance;
2463
+ /**
2464
+ * The details of the passengers in the travel reservation
2465
+ */
2466
+ drivers?: Array<CarRental.Driver>;
2467
+ /**
2468
+ * List of additional charges being billed.
2469
+ */
2470
+ extra_charges?: Array<CarRental.ExtraCharge>;
2471
+ /**
2472
+ * Indicates if the customer did not keep nor cancel their booking.
2473
+ */
2474
+ no_show?: boolean;
2475
+ /**
2476
+ * Car pick-up address.
2477
+ */
2478
+ pickup_address?: AddressParam;
2479
+ /**
2480
+ * Car pick-up time. Measured in seconds since the Unix epoch.
2481
+ */
2482
+ pickup_at: number;
2483
+ /**
2484
+ * Name of the pickup location.
2485
+ */
2486
+ pickup_location_name?: string;
2487
+ /**
2488
+ * Rental rate.
2489
+ */
2490
+ rate_amount?: number;
2491
+ /**
2492
+ * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2493
+ */
2494
+ rate_interval?: CarRental.RateInterval;
2495
+ /**
2496
+ * The name of the person or entity renting the car.
2497
+ */
2498
+ renter_name?: string;
2499
+ /**
2500
+ * Car return address.
2501
+ */
2502
+ return_address?: AddressParam;
2503
+ /**
2504
+ * Car return time. Measured in seconds since the Unix epoch.
2505
+ */
2506
+ return_at: number;
2507
+ /**
2508
+ * Name of the return location.
2509
+ */
2510
+ return_location_name?: string;
2511
+ /**
2512
+ * Indicates whether the goods or services are tax-exempt or tax is not collected.
2513
+ */
2514
+ tax_exempt?: boolean;
2515
+ /**
2516
+ * The vehicle identification number.
2517
+ */
2518
+ vehicle_identification_number?: string;
2519
+ }
2520
+ interface CarRentalDatum {
2521
+ /**
2522
+ * Affiliate (such as travel agency) details for the rental.
2523
+ */
2524
+ affiliate?: CarRentalDatum.Affiliate;
2525
+ /**
2526
+ * Booking confirmation number for the car rental.
2527
+ */
2528
+ booking_number?: string;
2529
+ /**
2530
+ * Name of the car rental company.
2531
+ */
2532
+ carrier_name?: string;
2533
+ /**
2534
+ * Customer service phone number for the car rental company.
2535
+ */
2536
+ customer_service_phone_number?: string;
2537
+ /**
2538
+ * Number of days the car is being rented.
2539
+ */
2540
+ days_rented?: number;
2541
+ /**
2542
+ * Distance details for the rental.
2543
+ */
2544
+ distance?: CarRentalDatum.Distance;
2545
+ /**
2546
+ * List of drivers for the rental.
2547
+ */
2548
+ drivers?: Array<CarRentalDatum.Driver>;
2549
+ /**
2550
+ * Drop-off location details.
2551
+ */
2552
+ drop_off: CarRentalDatum.DropOff;
2553
+ /**
2554
+ * Insurance details for the rental.
2555
+ */
2556
+ insurances?: Array<CarRentalDatum.Insurance>;
2557
+ /**
2558
+ * Indicates if the customer was a no-show.
2559
+ */
2560
+ no_show_indicator?: boolean;
2561
+ /**
2562
+ * Pickup location details.
2563
+ */
2564
+ pickup: CarRentalDatum.Pickup;
2565
+ /**
2566
+ * Name of the person renting the vehicle.
2567
+ */
2568
+ renter_name?: string;
2569
+ /**
2570
+ * Total cost breakdown for the rental.
2571
+ */
2572
+ total: CarRentalDatum.Total;
2573
+ /**
2574
+ * Vehicle details for the rental.
2575
+ */
2576
+ vehicle?: CarRentalDatum.Vehicle;
2577
+ }
2578
+ interface EventDetails {
2579
+ /**
2580
+ * Indicates if the tickets are digitally checked when entering the venue.
2581
+ */
2582
+ access_controlled_venue?: boolean;
2583
+ /**
2584
+ * The event location's address.
2585
+ */
2586
+ address?: AddressParam;
2587
+ /**
2588
+ * Affiliate details for this purchase.
2589
+ */
2590
+ affiliate?: EventDetails.Affiliate;
2591
+ /**
2592
+ * The name of the company
2593
+ */
2594
+ company?: string;
2595
+ /**
2596
+ * Delivery details for this purchase.
2597
+ */
2598
+ delivery?: EventDetails.Delivery;
2599
+ /**
2600
+ * Event end time. Measured in seconds since the Unix epoch.
2601
+ */
2602
+ ends_at?: number;
2603
+ /**
2604
+ * Type of the event entertainment (concert, sports event etc)
2605
+ */
2606
+ genre?: string;
2607
+ /**
2608
+ * The name of the event.
2609
+ */
2610
+ name: string;
2611
+ /**
2612
+ * Event start time. Measured in seconds since the Unix epoch.
2613
+ */
2614
+ starts_at?: number;
2615
+ }
2616
+ interface Flight {
2617
+ /**
2618
+ * Affiliate details for this purchase.
2619
+ */
2620
+ affiliate?: Flight.Affiliate;
2621
+ /**
2622
+ * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
2623
+ */
2624
+ agency_number?: string;
2625
+ /**
2626
+ * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
2627
+ */
2628
+ carrier?: string;
2629
+ /**
2630
+ * Delivery details for this purchase.
2631
+ */
2632
+ delivery?: Flight.Delivery;
2633
+ /**
2634
+ * The name of the person or entity on the reservation.
2635
+ */
2636
+ passenger_name?: string;
2637
+ /**
2638
+ * The details of the passengers in the travel reservation.
2639
+ */
2640
+ passengers?: Array<Flight.Passenger>;
2641
+ /**
2642
+ * The individual flight segments associated with the trip.
2643
+ */
2644
+ segments: Array<Flight.Segment>;
2645
+ /**
2646
+ * The ticket number associated with the travel reservation.
2647
+ */
2648
+ ticket_number?: string;
2649
+ }
2650
+ interface FlightDatum {
2651
+ /**
2652
+ * Affiliate details if applicable.
2653
+ */
2654
+ affiliate?: FlightDatum.Affiliate;
2655
+ /**
2656
+ * Reservation reference.
2657
+ */
2658
+ booking_number?: string;
2659
+ /**
2660
+ * Computerized reservation system used to make the reservation and purchase the ticket.
2661
+ */
2662
+ computerized_reservation_system?: string;
2663
+ /**
2664
+ * Ticket restrictions.
2665
+ */
2666
+ endorsements_and_restrictions?: string;
2667
+ /**
2668
+ * List of insurances.
2669
+ */
2670
+ insurances?: Array<FlightDatum.Insurance>;
2671
+ /**
2672
+ * List of passengers.
2673
+ */
2674
+ passengers?: Array<FlightDatum.Passenger>;
2675
+ /**
2676
+ * List of flight segments.
2677
+ */
2678
+ segments: Array<FlightDatum.Segment>;
2679
+ /**
2680
+ * Electronic ticket indicator.
2681
+ */
2682
+ ticket_electronically_issued_indicator?: boolean;
2683
+ /**
2684
+ * Total cost breakdown.
2685
+ */
2686
+ total: FlightDatum.Total;
2687
+ /**
2688
+ * Type of flight transaction.
2689
+ */
2690
+ transaction_type?: FlightDatum.TransactionType;
2691
+ }
2692
+ interface Lodging {
2693
+ /**
2694
+ * The lodging location's address.
2695
+ */
2696
+ address?: AddressParam;
2697
+ /**
2698
+ * The number of adults on the booking
2699
+ */
2700
+ adults?: number;
2701
+ /**
2702
+ * Affiliate details for this purchase.
2703
+ */
2704
+ affiliate?: Lodging.Affiliate;
2705
+ /**
2706
+ * The booking number associated with the lodging reservation.
2707
+ */
2708
+ booking_number?: string;
2709
+ /**
2710
+ * The lodging category
2711
+ */
2712
+ category?: Lodging.Category;
2713
+ /**
2714
+ * Lodging check-in time. Measured in seconds since the Unix epoch.
2715
+ */
2716
+ checkin_at: number;
2717
+ /**
2718
+ * Lodging check-out time. Measured in seconds since the Unix epoch.
2719
+ */
2720
+ checkout_at: number;
2721
+ /**
2722
+ * The customer service phone number of the lodging company.
2723
+ */
2724
+ customer_service_phone_number?: string;
2725
+ /**
2726
+ * The daily lodging room rate.
2727
+ */
2728
+ daily_room_rate_amount?: number;
2729
+ /**
2730
+ * Delivery details for this purchase.
2731
+ */
2732
+ delivery?: Lodging.Delivery;
2733
+ /**
2734
+ * List of additional charges being billed.
2735
+ */
2736
+ extra_charges?: Array<Lodging.ExtraCharge>;
2737
+ /**
2738
+ * Indicates whether the lodging location is compliant with the Fire Safety Act.
2739
+ */
2740
+ fire_safety_act_compliance?: boolean;
2741
+ /**
2742
+ * The name of the lodging location.
2743
+ */
2744
+ name?: string;
2745
+ /**
2746
+ * Indicates if the customer did not keep their booking while failing to cancel the reservation.
2747
+ */
2748
+ no_show?: boolean;
2749
+ /**
2750
+ * The number of rooms on the booking
2751
+ */
2752
+ number_of_rooms?: number;
2753
+ /**
2754
+ * The details of the passengers in the travel reservation
2755
+ */
2756
+ passengers?: Array<Lodging.Passenger>;
2757
+ /**
2758
+ * The phone number of the lodging location.
2759
+ */
2760
+ property_phone_number?: string;
2761
+ /**
2762
+ * The room class for this purchase.
2763
+ */
2764
+ room_class?: string;
2765
+ /**
2766
+ * The number of room nights
2767
+ */
2768
+ room_nights?: number;
2769
+ /**
2770
+ * The total tax amount associating with the room reservation.
2771
+ */
2772
+ total_room_tax_amount?: number;
2773
+ /**
2774
+ * The total tax amount
2775
+ */
2776
+ total_tax_amount?: number;
2777
+ }
2778
+ interface LodgingDatum {
2779
+ /**
2780
+ * Accommodation details for the lodging.
2781
+ */
2782
+ accommodation?: LodgingDatum.Accommodation;
2783
+ /**
2784
+ * Affiliate details if applicable.
2785
+ */
2786
+ affiliate?: LodgingDatum.Affiliate;
2787
+ /**
2788
+ * Booking confirmation number for the lodging.
2789
+ */
2790
+ booking_number?: string;
2791
+ /**
2792
+ * Check-in date.
2793
+ */
2794
+ checkin_at: number;
2795
+ /**
2796
+ * Check-out date.
2797
+ */
2798
+ checkout_at: number;
2799
+ /**
2800
+ * Customer service phone number for the lodging company.
2801
+ */
2802
+ customer_service_phone_number?: string;
2803
+ /**
2804
+ * Whether the lodging is compliant with any hotel fire safety regulations.
2805
+ */
2806
+ fire_safety_act_compliance_indicator?: boolean;
2807
+ /**
2808
+ * List of guests for the lodging.
2809
+ */
2810
+ guests?: Array<LodgingDatum.Guest>;
2811
+ /**
2812
+ * Host details for the lodging.
2813
+ */
2814
+ host?: LodgingDatum.Host;
2815
+ /**
2816
+ * List of insurances for the lodging.
2817
+ */
2818
+ insurances?: Array<LodgingDatum.Insurance>;
2819
+ /**
2820
+ * Whether the renter is a no-show.
2821
+ */
2822
+ no_show_indicator?: boolean;
2823
+ /**
2824
+ * Renter ID number for the lodging.
2825
+ */
2826
+ renter_id_number?: string;
2827
+ /**
2828
+ * Renter name for the lodging.
2829
+ */
2830
+ renter_name?: string;
2831
+ /**
2832
+ * Total details for the lodging.
2833
+ */
2834
+ total: LodgingDatum.Total;
2835
+ }
2836
+ interface Subscription {
2837
+ /**
2838
+ * Affiliate details for this purchase.
2839
+ */
2840
+ affiliate?: Subscription.Affiliate;
2841
+ /**
2842
+ * Info whether the subscription will be auto renewed upon expiry.
2843
+ */
2844
+ auto_renewal?: boolean;
2845
+ /**
2846
+ * Subscription billing details for this purchase.
2847
+ */
2848
+ billing_interval?: Subscription.BillingInterval;
2849
+ /**
2850
+ * Subscription end time. Measured in seconds since the Unix epoch.
2851
+ */
2852
+ ends_at?: number;
2853
+ /**
2854
+ * Name of the product on subscription. e.g. Apple Music Subscription
2855
+ */
2856
+ name: string;
2857
+ /**
2858
+ * Subscription start time. Measured in seconds since the Unix epoch.
2859
+ */
2860
+ starts_at?: number;
2861
+ }
2862
+ namespace CarRental {
2863
+ interface Affiliate {
2864
+ /**
2865
+ * The name of the affiliate that originated the purchase.
2866
+ */
2867
+ name: string;
2868
+ }
2869
+ interface Delivery {
2870
+ /**
2871
+ * The delivery method for the payment
2872
+ */
2873
+ mode?: Delivery.Mode;
2874
+ /**
2875
+ * Details of the recipient.
2876
+ */
2877
+ recipient?: Delivery.Recipient;
2878
+ }
2879
+ interface Distance {
2880
+ /**
2881
+ * Distance traveled.
2882
+ */
2883
+ amount?: number;
2884
+ /**
2885
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
2886
+ */
2887
+ unit?: Distance.Unit;
2888
+ }
2889
+ interface Driver {
2890
+ /**
2891
+ * Driver's identification number.
2892
+ */
2893
+ driver_identification_number?: string;
2894
+ /**
2895
+ * Driver's tax number.
2896
+ */
2897
+ driver_tax_number?: string;
2898
+ /**
2899
+ * Full name of the person or entity on the car reservation.
2900
+ */
2901
+ name: string;
2902
+ }
2903
+ type ExtraCharge = 'extra_mileage' | 'gas' | 'late_return' | 'one_way_service' | 'parking_violation';
2904
+ type RateInterval = 'day' | 'month' | 'week';
2905
+ namespace Delivery {
2906
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
2907
+ interface Recipient {
2908
+ /**
2909
+ * The email of the recipient the ticket is delivered to.
2910
+ */
2911
+ email?: string;
2912
+ /**
2913
+ * The name of the recipient the ticket is delivered to.
2914
+ */
2915
+ name?: string;
2916
+ /**
2917
+ * The phone number of the recipient the ticket is delivered to.
2918
+ */
2919
+ phone?: string;
2920
+ }
2921
+ }
2922
+ namespace Distance {
2923
+ type Unit = 'kilometers' | 'miles';
2924
+ }
2925
+ }
2926
+ namespace CarRentalDatum {
2927
+ interface Affiliate {
2928
+ /**
2929
+ * Affiliate partner code.
2930
+ */
2931
+ code?: string;
2932
+ /**
2933
+ * Name of affiliate partner.
2934
+ */
2935
+ name?: string;
2936
+ }
2937
+ interface Distance {
2938
+ /**
2939
+ * Distance traveled.
2940
+ */
2941
+ amount: number;
2942
+ /**
2943
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
2944
+ */
2945
+ unit: Distance.Unit;
2946
+ }
2947
+ interface Driver {
2948
+ /**
2949
+ * Driver's date of birth.
2950
+ */
2951
+ date_of_birth?: Driver.DateOfBirth;
2952
+ /**
2953
+ * Driver's identification number.
2954
+ */
2955
+ driver_identification_number?: string;
2956
+ /**
2957
+ * Driver's tax number.
2958
+ */
2959
+ driver_tax_number?: string;
2960
+ /**
2961
+ * Driver's full name.
2962
+ */
2963
+ name: string;
2964
+ }
2965
+ interface DropOff {
2966
+ /**
2967
+ * Address of the rental location.
2968
+ */
2969
+ address: DropOff.Address;
2970
+ /**
2971
+ * Location name.
2972
+ */
2973
+ location_name?: string;
2974
+ /**
2975
+ * Timestamp for the location.
2976
+ */
2977
+ time: number;
2978
+ }
2979
+ interface Insurance {
2980
+ /**
2981
+ * Amount of the insurance coverage in cents.
2982
+ */
2983
+ amount: number;
2984
+ /**
2985
+ * Currency of the insurance amount.
2986
+ */
2987
+ currency?: string;
2988
+ /**
2989
+ * Name of the insurance company.
2990
+ */
2991
+ insurance_company_name?: string;
2992
+ /**
2993
+ * Type of insurance coverage.
2994
+ */
2995
+ insurance_type: Insurance.InsuranceType;
2996
+ }
2997
+ interface Pickup {
2998
+ /**
2999
+ * Address of the rental location.
3000
+ */
3001
+ address: Pickup.Address;
3002
+ /**
3003
+ * Location name.
3004
+ */
3005
+ location_name?: string;
3006
+ /**
3007
+ * Timestamp for the location.
3008
+ */
3009
+ time: number;
3010
+ }
3011
+ interface Total {
3012
+ /**
3013
+ * Total amount in cents.
3014
+ */
3015
+ amount: number;
3016
+ /**
3017
+ * Currency of the amount.
3018
+ */
3019
+ currency?: string;
3020
+ /**
3021
+ * Discount details for the rental.
3022
+ */
3023
+ discounts?: Total.Discounts;
3024
+ /**
3025
+ * Additional charges for the rental.
3026
+ */
3027
+ extra_charges?: Array<Total.ExtraCharge>;
3028
+ /**
3029
+ * Rate per unit for the rental.
3030
+ */
3031
+ rate_per_unit?: number;
3032
+ /**
3033
+ * Unit of measurement for the rate.
3034
+ */
3035
+ rate_unit?: Total.RateUnit;
3036
+ /**
3037
+ * Tax breakdown for the rental.
3038
+ */
3039
+ tax?: Total.Tax;
3040
+ }
3041
+ interface Vehicle {
3042
+ /**
3043
+ * Make of the rental vehicle.
3044
+ */
3045
+ make?: string;
3046
+ /**
3047
+ * Model of the rental vehicle.
3048
+ */
3049
+ model?: string;
3050
+ /**
3051
+ * Odometer reading at the time of rental.
3052
+ */
3053
+ odometer?: number;
3054
+ /**
3055
+ * Type of the rental vehicle.
3056
+ */
3057
+ type?: Vehicle.Type;
3058
+ /**
3059
+ * Class of the rental vehicle.
3060
+ */
3061
+ vehicle_class?: Vehicle.VehicleClass;
3062
+ /**
3063
+ * Vehicle identification number (VIN).
3064
+ */
3065
+ vehicle_identification_number?: string;
3066
+ }
3067
+ namespace Distance {
3068
+ type Unit = 'kilometers' | 'miles';
3069
+ }
3070
+ namespace Driver {
3071
+ interface DateOfBirth {
3072
+ /**
3073
+ * Day of birth (1-31).
3074
+ */
3075
+ day: number;
3076
+ /**
3077
+ * Month of birth (1-12).
3078
+ */
3079
+ month: number;
3080
+ /**
3081
+ * Year of birth (must be greater than 1900).
3082
+ */
3083
+ year: number;
3084
+ }
3085
+ }
3086
+ namespace DropOff {
3087
+ interface Address {
3088
+ /**
3089
+ * City, district, suburb, town, or village.
3090
+ */
3091
+ city: string;
3092
+ /**
3093
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3094
+ */
3095
+ country: string;
3096
+ /**
3097
+ * Address line 1, such as the street, PO Box, or company name.
3098
+ */
3099
+ line1: string;
3100
+ /**
3101
+ * Address line 2, such as the apartment, suite, unit, or building.
3102
+ */
3103
+ line2?: string;
3104
+ /**
3105
+ * ZIP or postal code.
3106
+ */
3107
+ postal_code: string;
3108
+ /**
3109
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
3110
+ */
3111
+ state?: string;
3112
+ }
3113
+ }
3114
+ namespace Insurance {
3115
+ type InsuranceType = 'liability_supplement' | 'loss_damage_waiver' | 'other' | 'partial_damage_waiver' | 'personal_accident' | 'personal_effects';
3116
+ }
3117
+ namespace Pickup {
3118
+ interface Address {
3119
+ /**
3120
+ * City, district, suburb, town, or village.
3121
+ */
3122
+ city: string;
3123
+ /**
3124
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3125
+ */
3126
+ country: string;
3127
+ /**
3128
+ * Address line 1, such as the street, PO Box, or company name.
3129
+ */
3130
+ line1: string;
3131
+ /**
3132
+ * Address line 2, such as the apartment, suite, unit, or building.
3133
+ */
3134
+ line2?: string;
3135
+ /**
3136
+ * ZIP or postal code.
3137
+ */
3138
+ postal_code: string;
3139
+ /**
3140
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
3141
+ */
3142
+ state?: string;
3143
+ }
3144
+ }
3145
+ namespace Total {
3146
+ interface Discounts {
3147
+ /**
3148
+ * Corporate client discount code.
3149
+ */
3150
+ corporate_client_code?: string;
3151
+ /**
3152
+ * Coupon code applied to the rental.
3153
+ */
3154
+ coupon?: string;
3155
+ /**
3156
+ * Maximum number of free miles or kilometers included.
3157
+ */
3158
+ maximum_free_miles_or_kilometers?: number;
3159
+ }
3160
+ interface ExtraCharge {
3161
+ /**
3162
+ * Amount of the extra charge in cents.
3163
+ */
3164
+ amount: number;
3165
+ /**
3166
+ * Type of extra charge.
3167
+ */
3168
+ type: ExtraCharge.Type;
3169
+ }
3170
+ type RateUnit = 'days' | 'kilometers' | 'miles' | 'months' | 'weeks';
3171
+ interface Tax {
3172
+ /**
3173
+ * Indicates if the transaction is tax exempt.
3174
+ */
3175
+ tax_exempt_indicator?: boolean;
3176
+ /**
3177
+ * Array of tax details.
3178
+ */
3179
+ taxes?: Array<Tax.Tax>;
3180
+ }
3181
+ namespace ExtraCharge {
3182
+ type Type = 'extra_mileage' | 'gas' | 'gps' | 'late_charge' | 'one_way_drop_off' | 'other' | 'parking' | 'phone' | 'regular_mileage' | 'towing';
3183
+ }
3184
+ namespace Tax {
3185
+ interface Tax {
3186
+ /**
3187
+ * Tax amount.
3188
+ */
3189
+ amount?: number;
3190
+ /**
3191
+ * Tax rate applied.
3192
+ */
3193
+ rate?: number;
3194
+ /**
3195
+ * Type of tax applied.
3196
+ */
3197
+ type?: string;
3198
+ }
3199
+ }
3200
+ }
3201
+ namespace Vehicle {
3202
+ type Type = 'cargo_van' | 'compact' | 'economy' | 'exotic' | 'exotic_suv' | 'fifteen_passenger_van' | 'four_wheel_drive' | 'full_size' | 'intermediate' | 'large_suv' | 'large_truck' | 'luxury' | 'medium_suv' | 'midsize' | 'mini' | 'minivan' | 'miscellaneous' | 'moped' | 'moving_van' | 'premium' | 'regular' | 'small_medium_truck' | 'small_suv' | 'special' | 'standard' | 'stretch' | 'subcompact' | 'taxi' | 'twelve_foot_truck' | 'twelve_passenger_van' | 'twenty_foot_truck' | 'twenty_four_foot_truck' | 'twenty_six_foot_truck' | 'unique';
3203
+ type VehicleClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
3204
+ }
3205
+ }
3206
+ namespace EventDetails {
3207
+ interface Affiliate {
3208
+ /**
3209
+ * The name of the affiliate that originated the purchase.
3210
+ */
3211
+ name: string;
3212
+ }
3213
+ interface Delivery {
3214
+ /**
3215
+ * The delivery method for the payment
3216
+ */
3217
+ mode?: Delivery.Mode;
3218
+ /**
3219
+ * Details of the recipient.
3220
+ */
3221
+ recipient?: Delivery.Recipient;
3222
+ }
3223
+ namespace Delivery {
3224
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3225
+ interface Recipient {
3226
+ /**
3227
+ * The email of the recipient the ticket is delivered to.
3228
+ */
3229
+ email?: string;
3230
+ /**
3231
+ * The name of the recipient the ticket is delivered to.
3232
+ */
3233
+ name?: string;
3234
+ /**
3235
+ * The phone number of the recipient the ticket is delivered to.
3236
+ */
3237
+ phone?: string;
3238
+ }
3239
+ }
3240
+ }
3241
+ namespace Flight {
3242
+ interface Affiliate {
3243
+ /**
3244
+ * The name of the affiliate that originated the purchase.
3245
+ */
3246
+ name: string;
3247
+ }
3248
+ interface Delivery {
3249
+ /**
3250
+ * The delivery method for the payment
3251
+ */
3252
+ mode?: Delivery.Mode;
3253
+ /**
3254
+ * Details of the recipient.
3255
+ */
3256
+ recipient?: Delivery.Recipient;
3257
+ }
3258
+ interface Passenger {
3259
+ /**
3260
+ * Full name of the person or entity on the flight reservation.
3261
+ */
3262
+ name: string;
3263
+ }
3264
+ interface Segment {
3265
+ /**
3266
+ * The flight segment amount.
3267
+ */
3268
+ amount?: number;
3269
+ /**
3270
+ * The International Air Transport Association (IATA) airport code for the arrival airport.
3271
+ */
3272
+ arrival_airport?: string;
3273
+ /**
3274
+ * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
3275
+ */
3276
+ arrives_at?: number;
3277
+ /**
3278
+ * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
3279
+ */
3280
+ carrier?: string;
3281
+ /**
3282
+ * The departure time for the flight segment. Measured in seconds since the Unix epoch.
3283
+ */
3284
+ departs_at: number;
3285
+ /**
3286
+ * The International Air Transport Association (IATA) airport code for the departure airport.
3287
+ */
3288
+ departure_airport?: string;
3289
+ /**
3290
+ * The flight number associated with the segment
3291
+ */
3292
+ flight_number?: string;
3293
+ /**
3294
+ * The fare class for the segment.
3295
+ */
3296
+ service_class?: Segment.ServiceClass;
3297
+ }
3298
+ namespace Delivery {
3299
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3300
+ interface Recipient {
3301
+ /**
3302
+ * The email of the recipient the ticket is delivered to.
3303
+ */
3304
+ email?: string;
3305
+ /**
3306
+ * The name of the recipient the ticket is delivered to.
3307
+ */
3308
+ name?: string;
3309
+ /**
3310
+ * The phone number of the recipient the ticket is delivered to.
3311
+ */
3312
+ phone?: string;
3313
+ }
3314
+ }
3315
+ namespace Segment {
3316
+ type ServiceClass = 'business' | 'economy' | 'first' | 'premium_economy';
3317
+ }
3318
+ }
3319
+ namespace FlightDatum {
3320
+ interface Affiliate {
3321
+ /**
3322
+ * Affiliate partner code.
3323
+ */
3324
+ code?: string;
3325
+ /**
3326
+ * Name of affiliate partner.
3327
+ */
3328
+ name?: string;
3329
+ /**
3330
+ * Code provided by the company to a travel agent authorizing ticket issuance.
3331
+ */
3332
+ travel_authorization_code?: string;
3333
+ }
3334
+ interface Insurance {
3335
+ /**
3336
+ * Insurance cost.
3337
+ */
3338
+ amount: number;
3339
+ /**
3340
+ * Insurance currency.
3341
+ */
3342
+ currency?: string;
3343
+ /**
3344
+ * Insurance company name.
3345
+ */
3346
+ insurance_company_name?: string;
3347
+ /**
3348
+ * Type of insurance.
3349
+ */
3350
+ insurance_type: Insurance.InsuranceType;
3351
+ }
3352
+ interface Passenger {
3353
+ /**
3354
+ * Passenger's full name.
3355
+ */
3356
+ name: string;
3357
+ }
3358
+ interface Segment {
3359
+ /**
3360
+ * Segment fare amount.
3361
+ */
3362
+ amount?: number;
3363
+ /**
3364
+ * Arrival details.
3365
+ */
3366
+ arrival: Segment.Arrival;
3367
+ /**
3368
+ * Airline carrier code.
3369
+ */
3370
+ carrier_code: string;
3371
+ /**
3372
+ * Carrier name.
3373
+ */
3374
+ carrier_name?: string;
3375
+ /**
3376
+ * Segment currency.
3377
+ */
3378
+ currency?: string;
3379
+ /**
3380
+ * Departure details.
3381
+ */
3382
+ departure: Segment.Departure;
3383
+ /**
3384
+ * Exchange ticket number.
3385
+ */
3386
+ exchange_ticket_number?: string;
3387
+ /**
3388
+ * Fare basis code.
3389
+ */
3390
+ fare_basis_code?: string;
3391
+ /**
3392
+ * Additional fees.
3393
+ */
3394
+ fees?: number;
3395
+ /**
3396
+ * Flight number.
3397
+ */
3398
+ flight_number?: string;
3399
+ /**
3400
+ * Stopover indicator.
3401
+ */
3402
+ is_stop_over_indicator?: boolean;
3403
+ /**
3404
+ * Refundable ticket indicator.
3405
+ */
3406
+ refundable?: boolean;
3407
+ /**
3408
+ * Class of service.
3409
+ */
3410
+ service_class: Segment.ServiceClass;
3411
+ /**
3412
+ * Tax amount for segment.
3413
+ */
3414
+ tax_amount?: number;
3415
+ /**
3416
+ * Ticket number.
3417
+ */
3418
+ ticket_number?: string;
3419
+ }
3420
+ interface Total {
3421
+ /**
3422
+ * Total flight amount.
3423
+ */
3424
+ amount: number;
3425
+ /**
3426
+ * Reason for credit.
3427
+ */
3428
+ credit_reason?: Total.CreditReason;
3429
+ /**
3430
+ * Total currency.
3431
+ */
3432
+ currency?: string;
3433
+ /**
3434
+ * Discount details.
3435
+ */
3436
+ discounts?: Total.Discounts;
3437
+ /**
3438
+ * Additional charges.
3439
+ */
3440
+ extra_charges?: Array<Total.ExtraCharge>;
3441
+ /**
3442
+ * Tax breakdown.
3443
+ */
3444
+ tax?: Total.Tax;
3445
+ }
3446
+ type TransactionType = 'exchange_ticket' | 'miscellaneous' | 'refund' | 'ticket_purchase';
3447
+ namespace Insurance {
3448
+ type InsuranceType = 'baggage' | 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
3449
+ }
3450
+ namespace Segment {
3451
+ interface Arrival {
3452
+ /**
3453
+ * Arrival airport IATA code.
3454
+ */
3455
+ airport: string;
3456
+ /**
3457
+ * Arrival date/time.
3458
+ */
3459
+ arrives_at?: number;
3460
+ /**
3461
+ * Arrival city.
3462
+ */
3463
+ city?: string;
3464
+ /**
3465
+ * Arrival country.
3466
+ */
3467
+ country?: string;
3468
+ }
3469
+ interface Departure {
3470
+ /**
3471
+ * Departure airport IATA code.
3472
+ */
3473
+ airport: string;
3474
+ /**
3475
+ * Departure city.
3476
+ */
3477
+ city?: string;
3478
+ /**
3479
+ * Departure country.
3480
+ */
3481
+ country?: string;
3482
+ /**
3483
+ * Departure date/time.
3484
+ */
3485
+ departs_at: number;
3486
+ }
3487
+ type ServiceClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
3488
+ }
3489
+ namespace Total {
3490
+ type CreditReason = 'other' | 'partial_ticket_refund' | 'passenger_transport_ancillary_cancellation' | 'ticket_and_ancillary_cancellation' | 'ticket_cancellation';
3491
+ interface Discounts {
3492
+ /**
3493
+ * Corporate client discount code.
3494
+ */
3495
+ corporate_client_code?: string;
3496
+ }
3497
+ interface ExtraCharge {
3498
+ /**
3499
+ * Amount of additional charges.
3500
+ */
3501
+ amount?: number;
3502
+ /**
3503
+ * Type of additional charges.
3504
+ */
3505
+ type?: ExtraCharge.Type;
3506
+ }
3507
+ interface Tax {
3508
+ /**
3509
+ * Array of tax details.
3510
+ */
3511
+ taxes?: Array<Tax.Tax>;
3512
+ }
3513
+ namespace ExtraCharge {
3514
+ type Type = 'additional_fees' | 'ancillary_service_charges' | 'exchange_fee';
3515
+ }
3516
+ namespace Tax {
3517
+ interface Tax {
3518
+ /**
3519
+ * Tax amount.
3520
+ */
3521
+ amount?: number;
3522
+ /**
3523
+ * Tax rate.
3524
+ */
3525
+ rate?: number;
3526
+ /**
3527
+ * Type of tax.
3528
+ */
3529
+ type?: string;
3530
+ }
3531
+ }
3532
+ }
3533
+ }
3534
+ namespace Lodging {
3535
+ interface Affiliate {
3536
+ /**
3537
+ * The name of the affiliate that originated the purchase.
3538
+ */
3539
+ name: string;
3540
+ }
3541
+ type Category = 'hotel' | 'vacation_rental';
3542
+ interface Delivery {
3543
+ /**
3544
+ * The delivery method for the payment
3545
+ */
3546
+ mode?: Delivery.Mode;
3547
+ /**
3548
+ * Details of the recipient.
3549
+ */
3550
+ recipient?: Delivery.Recipient;
3551
+ }
3552
+ type ExtraCharge = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'restaurant' | 'telephone';
3553
+ interface Passenger {
3554
+ /**
3555
+ * Full name of the person or entity on the lodging reservation.
3556
+ */
3557
+ name: string;
3558
+ }
3559
+ namespace Delivery {
3560
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3561
+ interface Recipient {
3562
+ /**
3563
+ * The email of the recipient the ticket is delivered to.
3564
+ */
3565
+ email?: string;
3566
+ /**
3567
+ * The name of the recipient the ticket is delivered to.
3568
+ */
3569
+ name?: string;
3570
+ /**
3571
+ * The phone number of the recipient the ticket is delivered to.
3572
+ */
3573
+ phone?: string;
3574
+ }
3575
+ }
3576
+ }
3577
+ namespace LodgingDatum {
3578
+ interface Accommodation {
3579
+ /**
3580
+ * Type of accommodation.
3581
+ */
3582
+ accommodation_type?: Accommodation.AccommodationType;
3583
+ /**
3584
+ * Bed type.
3585
+ */
3586
+ bed_type?: string;
3587
+ /**
3588
+ * Daily accommodation rate in cents.
3589
+ */
3590
+ daily_rate_amount?: number;
3591
+ /**
3592
+ * Number of nights.
3593
+ */
3594
+ nights?: number;
3595
+ /**
3596
+ * Number of rooms, cabanas, apartments, and so on.
3597
+ */
3598
+ number_of_rooms?: number;
3599
+ /**
3600
+ * Rate type.
3601
+ */
3602
+ rate_type?: string;
3603
+ /**
3604
+ * Whether smoking is allowed.
3605
+ */
3606
+ smoking_indicator?: boolean;
3607
+ }
3608
+ interface Affiliate {
3609
+ /**
3610
+ * Affiliate partner code.
3611
+ */
3612
+ code?: string;
3613
+ /**
3614
+ * Affiliate partner name.
3615
+ */
3616
+ name?: string;
3617
+ }
3618
+ interface Guest {
3619
+ /**
3620
+ * Guest's full name.
3621
+ */
3622
+ name: string;
3623
+ }
3624
+ interface Host {
3625
+ /**
3626
+ * Address of the host.
3627
+ */
3628
+ address?: Host.Address;
3629
+ /**
3630
+ * Host's country of domicile.
3631
+ */
3632
+ country_of_domicile?: string;
3633
+ /**
3634
+ * Reference number for the host.
3635
+ */
3636
+ host_reference?: string;
3637
+ /**
3638
+ * Type of host.
3639
+ */
3640
+ host_type?: Host.HostType;
3641
+ /**
3642
+ * Name of the lodging property or host.
3643
+ */
3644
+ name?: string;
3645
+ /**
3646
+ * Total number of reservations for the host.
3647
+ */
3648
+ number_of_reservations?: number;
3649
+ /**
3650
+ * Property phone number.
3651
+ */
3652
+ property_phone_number?: string;
3653
+ /**
3654
+ * Host's registration date.
3655
+ */
3656
+ registered_at?: number;
3657
+ }
3658
+ interface Insurance {
3659
+ /**
3660
+ * Price of the insurance coverage in cents.
3661
+ */
3662
+ amount: number;
3663
+ /**
3664
+ * Currency of the insurance amount.
3665
+ */
3666
+ currency?: string;
3667
+ /**
3668
+ * Name of the insurance company.
3669
+ */
3670
+ insurance_company_name?: string;
3671
+ /**
3672
+ * Type of insurance coverage.
3673
+ */
3674
+ insurance_type: Insurance.InsuranceType;
3675
+ }
3676
+ interface Total {
3677
+ /**
3678
+ * Total price of the lodging reservation in cents.
3679
+ */
3680
+ amount: number;
3681
+ /**
3682
+ * Cash advances in cents.
3683
+ */
3684
+ cash_advances?: number;
3685
+ /**
3686
+ * Currency of the total amount.
3687
+ */
3688
+ currency?: string;
3689
+ /**
3690
+ * Discount details for the lodging.
3691
+ */
3692
+ discounts?: Total.Discounts;
3693
+ /**
3694
+ * Additional charges for the lodging.
3695
+ */
3696
+ extra_charges?: Array<Total.ExtraCharge>;
3697
+ /**
3698
+ * Prepaid amount in cents.
3699
+ */
3700
+ prepaid_amount?: number;
3701
+ /**
3702
+ * Tax breakdown for the lodging reservation.
3703
+ */
3704
+ tax?: Total.Tax;
3705
+ }
3706
+ namespace Accommodation {
3707
+ type AccommodationType = 'apartment' | 'cabana' | 'house' | 'penthouse' | 'room' | 'standard' | 'suite' | 'villa';
3708
+ }
3709
+ namespace Host {
3710
+ interface Address {
3711
+ /**
3712
+ * City, district, suburb, town, or village.
3713
+ */
3714
+ city: string;
3715
+ /**
3716
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3717
+ */
3718
+ country: string;
3719
+ /**
3720
+ * Address line 1, such as the street, PO Box, or company name.
3721
+ */
3722
+ line1: string;
3723
+ /**
3724
+ * Address line 2, such as the apartment, suite, unit, or building.
3725
+ */
3726
+ line2?: string;
3727
+ /**
3728
+ * ZIP or postal code.
3729
+ */
3730
+ postal_code: string;
3731
+ /**
3732
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
3733
+ */
3734
+ state?: string;
3735
+ }
3736
+ type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
3737
+ }
3738
+ namespace Insurance {
3739
+ type InsuranceType = 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
3740
+ }
3741
+ namespace Total {
3742
+ interface Discounts {
3743
+ /**
3744
+ * Corporate client discount code.
3745
+ */
3746
+ corporate_client_code?: string;
3747
+ /**
3748
+ * Coupon code.
3749
+ */
3750
+ coupon?: string;
3751
+ }
3752
+ interface ExtraCharge {
3753
+ /**
3754
+ * Amount of the extra charge in cents.
3755
+ */
3756
+ amount?: number;
3757
+ /**
3758
+ * Type of extra charge.
3759
+ */
3760
+ type?: ExtraCharge.Type;
3761
+ }
3762
+ interface Tax {
3763
+ /**
3764
+ * Indicates whether the transaction is tax exempt.
3765
+ */
3766
+ tax_exempt_indicator?: boolean;
3767
+ /**
3768
+ * Tax details.
3769
+ */
3770
+ taxes?: Array<Tax.Tax>;
3771
+ }
3772
+ namespace ExtraCharge {
3773
+ type Type = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'phone' | 'restaurant';
3774
+ }
3775
+ namespace Tax {
3776
+ interface Tax {
3777
+ /**
3778
+ * Tax amount in cents.
3779
+ */
3780
+ amount?: number;
3781
+ /**
3782
+ * Tax rate.
3783
+ */
3784
+ rate?: number;
3785
+ /**
3786
+ * Type of tax applied.
3787
+ */
3788
+ type?: string;
3789
+ }
3790
+ }
3791
+ }
3792
+ }
3793
+ namespace Subscription {
3794
+ interface Affiliate {
3795
+ /**
3796
+ * The name of the affiliate that originated the purchase.
3797
+ */
3798
+ name: string;
3799
+ }
3800
+ interface BillingInterval {
3801
+ /**
3802
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3803
+ */
3804
+ count: number;
3805
+ /**
3806
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3807
+ */
3808
+ interval: BillingInterval.Interval;
3809
+ }
3810
+ namespace BillingInterval {
3811
+ type Interval = 'day' | 'month' | 'week' | 'year';
3812
+ }
3813
+ }
3814
+ }
3815
+ }
3816
+ export interface ChargeListParams extends PaginationParams {
3817
+ /**
3818
+ * Only return charges that were created during the given date interval.
3819
+ */
3820
+ created?: RangeQueryParam | number;
3821
+ /**
3822
+ * Only return charges for the customer specified by this customer ID.
3823
+ */
3824
+ customer?: string;
3825
+ /**
3826
+ * Specifies which fields in the response should be expanded.
3827
+ */
3828
+ expand?: Array<string>;
3829
+ /**
3830
+ * Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
3831
+ */
3832
+ payment_intent?: string;
3833
+ /**
3834
+ * Only return charges for this transfer group, limited to 100.
3835
+ */
3836
+ transfer_group?: string;
3837
+ }
3838
+ export interface ChargeCaptureParams {
3839
+ /**
3840
+ * The amount to capture, which must be less than or equal to the original amount.
3841
+ */
3842
+ amount?: number;
3843
+ /**
3844
+ * An application fee to add on to this charge.
3845
+ */
3846
+ application_fee?: number;
3847
+ /**
3848
+ * An application fee amount to add on to this charge, which must be less than or equal to the original amount.
3849
+ */
3850
+ application_fee_amount?: number;
3851
+ /**
3852
+ * Specifies which fields in the response should be expanded.
3853
+ */
3854
+ expand?: Array<string>;
3855
+ /**
3856
+ * Provides industry-specific information about the charge.
3857
+ */
3858
+ payment_details?: ChargeCaptureParams.PaymentDetails;
3859
+ /**
3860
+ * 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.
3861
+ */
3862
+ receipt_email?: string;
3863
+ /**
3864
+ * For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
3865
+ *
3866
+ * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
3867
+ */
3868
+ statement_descriptor?: string;
3869
+ /**
3870
+ * Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
3871
+ */
3872
+ statement_descriptor_suffix?: string;
3873
+ /**
3874
+ * An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
3875
+ */
3876
+ transfer_data?: ChargeCaptureParams.TransferData;
3877
+ /**
3878
+ * A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
3879
+ */
3880
+ transfer_group?: string;
3881
+ }
3882
+ export declare namespace ChargeCaptureParams {
3883
+ interface PaymentDetails {
3884
+ /**
3885
+ * Car rental details for this PaymentIntent.
3886
+ */
3887
+ car_rental?: PaymentDetails.CarRental;
3888
+ /**
3889
+ * Car rental data for this PaymentIntent.
3890
+ */
3891
+ car_rental_data?: Emptyable<Array<PaymentDetails.CarRentalDatum>>;
3892
+ /**
3893
+ * A unique value to identify the customer. This field is available only for card payments.
3894
+ *
3895
+ * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
3896
+ */
3897
+ customer_reference?: Emptyable<string>;
3898
+ /**
3899
+ * Event details for this PaymentIntent
3900
+ */
3901
+ event_details?: PaymentDetails.EventDetails;
3902
+ /**
3903
+ * Flight reservation details for this PaymentIntent
3904
+ */
3905
+ flight?: PaymentDetails.Flight;
3906
+ /**
3907
+ * Flight data for this PaymentIntent.
3908
+ */
3909
+ flight_data?: Emptyable<Array<PaymentDetails.FlightDatum>>;
3910
+ /**
3911
+ * Lodging reservation details for this PaymentIntent
3912
+ */
3913
+ lodging?: PaymentDetails.Lodging;
3914
+ /**
3915
+ * Lodging data for this PaymentIntent.
3916
+ */
3917
+ lodging_data?: Emptyable<Array<PaymentDetails.LodgingDatum>>;
3918
+ /**
3919
+ * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
3920
+ *
3921
+ * For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
3922
+ */
3923
+ order_reference?: Emptyable<string>;
3924
+ /**
3925
+ * Subscription details for this PaymentIntent
3926
+ */
3927
+ subscription?: PaymentDetails.Subscription;
3928
+ }
3929
+ interface TransferData {
3930
+ /**
3931
+ * The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
3932
+ */
3933
+ amount?: number;
3934
+ }
3935
+ namespace PaymentDetails {
3936
+ interface CarRental {
3937
+ /**
3938
+ * Affiliate details for this purchase.
3939
+ */
3940
+ affiliate?: CarRental.Affiliate;
3941
+ /**
3942
+ * The booking number associated with the car rental.
3943
+ */
3944
+ booking_number: string;
3945
+ /**
3946
+ * Class code of the car.
3947
+ */
3948
+ car_class_code?: string;
3949
+ /**
3950
+ * Make of the car.
3951
+ */
3952
+ car_make?: string;
3953
+ /**
3954
+ * Model of the car.
3955
+ */
3956
+ car_model?: string;
3957
+ /**
3958
+ * The name of the rental car company.
3959
+ */
3960
+ company?: string;
3961
+ /**
3962
+ * The customer service phone number of the car rental company.
3963
+ */
3964
+ customer_service_phone_number?: string;
3965
+ /**
3966
+ * Number of days the car is being rented.
3967
+ */
3968
+ days_rented: number;
3969
+ /**
3970
+ * Delivery details for this purchase.
3971
+ */
3972
+ delivery?: CarRental.Delivery;
3973
+ /**
3974
+ * The details of the distance traveled during the rental period.
3975
+ */
3976
+ distance?: CarRental.Distance;
3977
+ /**
3978
+ * The details of the passengers in the travel reservation
3979
+ */
3980
+ drivers?: Array<CarRental.Driver>;
3981
+ /**
3982
+ * List of additional charges being billed.
3983
+ */
3984
+ extra_charges?: Array<CarRental.ExtraCharge>;
3985
+ /**
3986
+ * Indicates if the customer did not keep nor cancel their booking.
3987
+ */
3988
+ no_show?: boolean;
3989
+ /**
3990
+ * Car pick-up address.
3991
+ */
3992
+ pickup_address?: AddressParam;
3993
+ /**
3994
+ * Car pick-up time. Measured in seconds since the Unix epoch.
3995
+ */
3996
+ pickup_at: number;
3997
+ /**
3998
+ * Name of the pickup location.
3999
+ */
4000
+ pickup_location_name?: string;
4001
+ /**
4002
+ * Rental rate.
4003
+ */
4004
+ rate_amount?: number;
4005
+ /**
4006
+ * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
4007
+ */
4008
+ rate_interval?: CarRental.RateInterval;
4009
+ /**
4010
+ * The name of the person or entity renting the car.
4011
+ */
4012
+ renter_name?: string;
4013
+ /**
4014
+ * Car return address.
4015
+ */
4016
+ return_address?: AddressParam;
4017
+ /**
4018
+ * Car return time. Measured in seconds since the Unix epoch.
4019
+ */
4020
+ return_at: number;
4021
+ /**
4022
+ * Name of the return location.
4023
+ */
4024
+ return_location_name?: string;
4025
+ /**
4026
+ * Indicates whether the goods or services are tax-exempt or tax is not collected.
4027
+ */
4028
+ tax_exempt?: boolean;
4029
+ /**
4030
+ * The vehicle identification number.
4031
+ */
4032
+ vehicle_identification_number?: string;
4033
+ }
4034
+ interface CarRentalDatum {
4035
+ /**
4036
+ * Affiliate (such as travel agency) details for the rental.
4037
+ */
4038
+ affiliate?: CarRentalDatum.Affiliate;
4039
+ /**
4040
+ * Booking confirmation number for the car rental.
4041
+ */
4042
+ booking_number?: string;
4043
+ /**
4044
+ * Name of the car rental company.
4045
+ */
4046
+ carrier_name?: string;
4047
+ /**
4048
+ * Customer service phone number for the car rental company.
4049
+ */
4050
+ customer_service_phone_number?: string;
4051
+ /**
4052
+ * Number of days the car is being rented.
4053
+ */
4054
+ days_rented?: number;
4055
+ /**
4056
+ * Distance details for the rental.
4057
+ */
4058
+ distance?: CarRentalDatum.Distance;
4059
+ /**
4060
+ * List of drivers for the rental.
4061
+ */
4062
+ drivers?: Array<CarRentalDatum.Driver>;
4063
+ /**
4064
+ * Drop-off location details.
4065
+ */
4066
+ drop_off: CarRentalDatum.DropOff;
4067
+ /**
4068
+ * Insurance details for the rental.
4069
+ */
4070
+ insurances?: Array<CarRentalDatum.Insurance>;
4071
+ /**
4072
+ * Indicates if the customer was a no-show.
4073
+ */
4074
+ no_show_indicator?: boolean;
4075
+ /**
4076
+ * Pickup location details.
4077
+ */
4078
+ pickup: CarRentalDatum.Pickup;
4079
+ /**
4080
+ * Name of the person renting the vehicle.
4081
+ */
4082
+ renter_name?: string;
4083
+ /**
4084
+ * Total cost breakdown for the rental.
4085
+ */
4086
+ total: CarRentalDatum.Total;
4087
+ /**
4088
+ * Vehicle details for the rental.
4089
+ */
4090
+ vehicle?: CarRentalDatum.Vehicle;
4091
+ }
4092
+ interface EventDetails {
4093
+ /**
4094
+ * Indicates if the tickets are digitally checked when entering the venue.
4095
+ */
4096
+ access_controlled_venue?: boolean;
4097
+ /**
4098
+ * The event location's address.
4099
+ */
4100
+ address?: AddressParam;
4101
+ /**
4102
+ * Affiliate details for this purchase.
4103
+ */
4104
+ affiliate?: EventDetails.Affiliate;
4105
+ /**
4106
+ * The name of the company
4107
+ */
4108
+ company?: string;
4109
+ /**
4110
+ * Delivery details for this purchase.
4111
+ */
4112
+ delivery?: EventDetails.Delivery;
4113
+ /**
4114
+ * Event end time. Measured in seconds since the Unix epoch.
4115
+ */
4116
+ ends_at?: number;
4117
+ /**
4118
+ * Type of the event entertainment (concert, sports event etc)
4119
+ */
4120
+ genre?: string;
4121
+ /**
4122
+ * The name of the event.
4123
+ */
4124
+ name: string;
4125
+ /**
4126
+ * Event start time. Measured in seconds since the Unix epoch.
4127
+ */
4128
+ starts_at?: number;
4129
+ }
4130
+ interface Flight {
4131
+ /**
4132
+ * Affiliate details for this purchase.
4133
+ */
4134
+ affiliate?: Flight.Affiliate;
4135
+ /**
4136
+ * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
4137
+ */
4138
+ agency_number?: string;
4139
+ /**
4140
+ * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
4141
+ */
4142
+ carrier?: string;
4143
+ /**
4144
+ * Delivery details for this purchase.
4145
+ */
4146
+ delivery?: Flight.Delivery;
4147
+ /**
4148
+ * The name of the person or entity on the reservation.
4149
+ */
4150
+ passenger_name?: string;
4151
+ /**
4152
+ * The details of the passengers in the travel reservation.
4153
+ */
4154
+ passengers?: Array<Flight.Passenger>;
4155
+ /**
4156
+ * The individual flight segments associated with the trip.
4157
+ */
4158
+ segments: Array<Flight.Segment>;
4159
+ /**
4160
+ * The ticket number associated with the travel reservation.
4161
+ */
4162
+ ticket_number?: string;
4163
+ }
4164
+ interface FlightDatum {
4165
+ /**
4166
+ * Affiliate details if applicable.
4167
+ */
4168
+ affiliate?: FlightDatum.Affiliate;
4169
+ /**
4170
+ * Reservation reference.
4171
+ */
4172
+ booking_number?: string;
4173
+ /**
4174
+ * Computerized reservation system used to make the reservation and purchase the ticket.
4175
+ */
4176
+ computerized_reservation_system?: string;
4177
+ /**
4178
+ * Ticket restrictions.
4179
+ */
4180
+ endorsements_and_restrictions?: string;
4181
+ /**
4182
+ * List of insurances.
4183
+ */
4184
+ insurances?: Array<FlightDatum.Insurance>;
4185
+ /**
4186
+ * List of passengers.
4187
+ */
4188
+ passengers?: Array<FlightDatum.Passenger>;
4189
+ /**
4190
+ * List of flight segments.
4191
+ */
4192
+ segments: Array<FlightDatum.Segment>;
4193
+ /**
4194
+ * Electronic ticket indicator.
4195
+ */
4196
+ ticket_electronically_issued_indicator?: boolean;
4197
+ /**
4198
+ * Total cost breakdown.
4199
+ */
4200
+ total: FlightDatum.Total;
4201
+ /**
4202
+ * Type of flight transaction.
4203
+ */
4204
+ transaction_type?: FlightDatum.TransactionType;
4205
+ }
4206
+ interface Lodging {
4207
+ /**
4208
+ * The lodging location's address.
4209
+ */
4210
+ address?: AddressParam;
4211
+ /**
4212
+ * The number of adults on the booking
4213
+ */
4214
+ adults?: number;
4215
+ /**
4216
+ * Affiliate details for this purchase.
4217
+ */
4218
+ affiliate?: Lodging.Affiliate;
4219
+ /**
4220
+ * The booking number associated with the lodging reservation.
4221
+ */
4222
+ booking_number?: string;
4223
+ /**
4224
+ * The lodging category
4225
+ */
4226
+ category?: Lodging.Category;
4227
+ /**
4228
+ * Lodging check-in time. Measured in seconds since the Unix epoch.
4229
+ */
4230
+ checkin_at: number;
4231
+ /**
4232
+ * Lodging check-out time. Measured in seconds since the Unix epoch.
4233
+ */
4234
+ checkout_at: number;
4235
+ /**
4236
+ * The customer service phone number of the lodging company.
4237
+ */
4238
+ customer_service_phone_number?: string;
4239
+ /**
4240
+ * The daily lodging room rate.
4241
+ */
4242
+ daily_room_rate_amount?: number;
4243
+ /**
4244
+ * Delivery details for this purchase.
4245
+ */
4246
+ delivery?: Lodging.Delivery;
4247
+ /**
4248
+ * List of additional charges being billed.
4249
+ */
4250
+ extra_charges?: Array<Lodging.ExtraCharge>;
4251
+ /**
4252
+ * Indicates whether the lodging location is compliant with the Fire Safety Act.
4253
+ */
4254
+ fire_safety_act_compliance?: boolean;
4255
+ /**
4256
+ * The name of the lodging location.
4257
+ */
4258
+ name?: string;
4259
+ /**
4260
+ * Indicates if the customer did not keep their booking while failing to cancel the reservation.
4261
+ */
4262
+ no_show?: boolean;
4263
+ /**
4264
+ * The number of rooms on the booking
4265
+ */
4266
+ number_of_rooms?: number;
4267
+ /**
4268
+ * The details of the passengers in the travel reservation
4269
+ */
4270
+ passengers?: Array<Lodging.Passenger>;
4271
+ /**
4272
+ * The phone number of the lodging location.
4273
+ */
4274
+ property_phone_number?: string;
4275
+ /**
4276
+ * The room class for this purchase.
4277
+ */
4278
+ room_class?: string;
4279
+ /**
4280
+ * The number of room nights
4281
+ */
4282
+ room_nights?: number;
4283
+ /**
4284
+ * The total tax amount associating with the room reservation.
4285
+ */
4286
+ total_room_tax_amount?: number;
4287
+ /**
4288
+ * The total tax amount
4289
+ */
4290
+ total_tax_amount?: number;
4291
+ }
4292
+ interface LodgingDatum {
4293
+ /**
4294
+ * Accommodation details for the lodging.
4295
+ */
4296
+ accommodation?: LodgingDatum.Accommodation;
4297
+ /**
4298
+ * Affiliate details if applicable.
4299
+ */
4300
+ affiliate?: LodgingDatum.Affiliate;
4301
+ /**
4302
+ * Booking confirmation number for the lodging.
4303
+ */
4304
+ booking_number?: string;
4305
+ /**
4306
+ * Check-in date.
4307
+ */
4308
+ checkin_at: number;
4309
+ /**
4310
+ * Check-out date.
4311
+ */
4312
+ checkout_at: number;
4313
+ /**
4314
+ * Customer service phone number for the lodging company.
4315
+ */
4316
+ customer_service_phone_number?: string;
4317
+ /**
4318
+ * Whether the lodging is compliant with any hotel fire safety regulations.
4319
+ */
4320
+ fire_safety_act_compliance_indicator?: boolean;
4321
+ /**
4322
+ * List of guests for the lodging.
4323
+ */
4324
+ guests?: Array<LodgingDatum.Guest>;
4325
+ /**
4326
+ * Host details for the lodging.
4327
+ */
4328
+ host?: LodgingDatum.Host;
4329
+ /**
4330
+ * List of insurances for the lodging.
4331
+ */
4332
+ insurances?: Array<LodgingDatum.Insurance>;
4333
+ /**
4334
+ * Whether the renter is a no-show.
4335
+ */
4336
+ no_show_indicator?: boolean;
4337
+ /**
4338
+ * Renter ID number for the lodging.
4339
+ */
4340
+ renter_id_number?: string;
4341
+ /**
4342
+ * Renter name for the lodging.
4343
+ */
4344
+ renter_name?: string;
4345
+ /**
4346
+ * Total details for the lodging.
4347
+ */
4348
+ total: LodgingDatum.Total;
4349
+ }
4350
+ interface Subscription {
4351
+ /**
4352
+ * Affiliate details for this purchase.
4353
+ */
4354
+ affiliate?: Subscription.Affiliate;
4355
+ /**
4356
+ * Info whether the subscription will be auto renewed upon expiry.
4357
+ */
4358
+ auto_renewal?: boolean;
4359
+ /**
4360
+ * Subscription billing details for this purchase.
4361
+ */
4362
+ billing_interval?: Subscription.BillingInterval;
4363
+ /**
4364
+ * Subscription end time. Measured in seconds since the Unix epoch.
4365
+ */
4366
+ ends_at?: number;
4367
+ /**
4368
+ * Name of the product on subscription. e.g. Apple Music Subscription
4369
+ */
4370
+ name: string;
4371
+ /**
4372
+ * Subscription start time. Measured in seconds since the Unix epoch.
4373
+ */
4374
+ starts_at?: number;
4375
+ }
4376
+ namespace CarRental {
4377
+ interface Affiliate {
4378
+ /**
4379
+ * The name of the affiliate that originated the purchase.
4380
+ */
4381
+ name: string;
4382
+ }
4383
+ interface Delivery {
4384
+ /**
4385
+ * The delivery method for the payment
4386
+ */
4387
+ mode?: Delivery.Mode;
4388
+ /**
4389
+ * Details of the recipient.
4390
+ */
4391
+ recipient?: Delivery.Recipient;
4392
+ }
4393
+ interface Distance {
4394
+ /**
4395
+ * Distance traveled.
4396
+ */
4397
+ amount?: number;
4398
+ /**
4399
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
4400
+ */
4401
+ unit?: Distance.Unit;
4402
+ }
4403
+ interface Driver {
4404
+ /**
4405
+ * Driver's identification number.
4406
+ */
4407
+ driver_identification_number?: string;
4408
+ /**
4409
+ * Driver's tax number.
4410
+ */
4411
+ driver_tax_number?: string;
4412
+ /**
4413
+ * Full name of the person or entity on the car reservation.
4414
+ */
4415
+ name: string;
4416
+ }
4417
+ type ExtraCharge = 'extra_mileage' | 'gas' | 'late_return' | 'one_way_service' | 'parking_violation';
4418
+ type RateInterval = 'day' | 'month' | 'week';
4419
+ namespace Delivery {
4420
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
4421
+ interface Recipient {
4422
+ /**
4423
+ * The email of the recipient the ticket is delivered to.
4424
+ */
4425
+ email?: string;
4426
+ /**
4427
+ * The name of the recipient the ticket is delivered to.
4428
+ */
4429
+ name?: string;
4430
+ /**
4431
+ * The phone number of the recipient the ticket is delivered to.
4432
+ */
4433
+ phone?: string;
4434
+ }
4435
+ }
4436
+ namespace Distance {
4437
+ type Unit = 'kilometers' | 'miles';
4438
+ }
4439
+ }
4440
+ namespace CarRentalDatum {
4441
+ interface Affiliate {
4442
+ /**
4443
+ * Affiliate partner code.
4444
+ */
4445
+ code?: string;
4446
+ /**
4447
+ * Name of affiliate partner.
4448
+ */
4449
+ name?: string;
4450
+ }
4451
+ interface Distance {
4452
+ /**
4453
+ * Distance traveled.
4454
+ */
4455
+ amount: number;
4456
+ /**
4457
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
4458
+ */
4459
+ unit: Distance.Unit;
4460
+ }
4461
+ interface Driver {
4462
+ /**
4463
+ * Driver's date of birth.
4464
+ */
4465
+ date_of_birth?: Driver.DateOfBirth;
4466
+ /**
4467
+ * Driver's identification number.
4468
+ */
4469
+ driver_identification_number?: string;
4470
+ /**
4471
+ * Driver's tax number.
4472
+ */
4473
+ driver_tax_number?: string;
4474
+ /**
4475
+ * Driver's full name.
4476
+ */
4477
+ name: string;
4478
+ }
4479
+ interface DropOff {
4480
+ /**
4481
+ * Address of the rental location.
4482
+ */
4483
+ address: DropOff.Address;
4484
+ /**
4485
+ * Location name.
4486
+ */
4487
+ location_name?: string;
4488
+ /**
4489
+ * Timestamp for the location.
4490
+ */
4491
+ time: number;
4492
+ }
4493
+ interface Insurance {
4494
+ /**
4495
+ * Amount of the insurance coverage in cents.
4496
+ */
4497
+ amount: number;
4498
+ /**
4499
+ * Currency of the insurance amount.
4500
+ */
4501
+ currency?: string;
4502
+ /**
4503
+ * Name of the insurance company.
4504
+ */
4505
+ insurance_company_name?: string;
4506
+ /**
4507
+ * Type of insurance coverage.
4508
+ */
4509
+ insurance_type: Insurance.InsuranceType;
4510
+ }
4511
+ interface Pickup {
4512
+ /**
4513
+ * Address of the rental location.
4514
+ */
4515
+ address: Pickup.Address;
4516
+ /**
4517
+ * Location name.
4518
+ */
4519
+ location_name?: string;
4520
+ /**
4521
+ * Timestamp for the location.
4522
+ */
4523
+ time: number;
4524
+ }
4525
+ interface Total {
4526
+ /**
4527
+ * Total amount in cents.
4528
+ */
4529
+ amount: number;
4530
+ /**
4531
+ * Currency of the amount.
4532
+ */
4533
+ currency?: string;
4534
+ /**
4535
+ * Discount details for the rental.
4536
+ */
4537
+ discounts?: Total.Discounts;
4538
+ /**
4539
+ * Additional charges for the rental.
4540
+ */
4541
+ extra_charges?: Array<Total.ExtraCharge>;
4542
+ /**
4543
+ * Rate per unit for the rental.
4544
+ */
4545
+ rate_per_unit?: number;
4546
+ /**
4547
+ * Unit of measurement for the rate.
4548
+ */
4549
+ rate_unit?: Total.RateUnit;
4550
+ /**
4551
+ * Tax breakdown for the rental.
4552
+ */
4553
+ tax?: Total.Tax;
4554
+ }
4555
+ interface Vehicle {
4556
+ /**
4557
+ * Make of the rental vehicle.
4558
+ */
4559
+ make?: string;
4560
+ /**
4561
+ * Model of the rental vehicle.
4562
+ */
4563
+ model?: string;
4564
+ /**
4565
+ * Odometer reading at the time of rental.
4566
+ */
4567
+ odometer?: number;
4568
+ /**
4569
+ * Type of the rental vehicle.
4570
+ */
4571
+ type?: Vehicle.Type;
4572
+ /**
4573
+ * Class of the rental vehicle.
4574
+ */
4575
+ vehicle_class?: Vehicle.VehicleClass;
4576
+ /**
4577
+ * Vehicle identification number (VIN).
4578
+ */
4579
+ vehicle_identification_number?: string;
4580
+ }
4581
+ namespace Distance {
4582
+ type Unit = 'kilometers' | 'miles';
4583
+ }
4584
+ namespace Driver {
4585
+ interface DateOfBirth {
4586
+ /**
4587
+ * Day of birth (1-31).
4588
+ */
4589
+ day: number;
4590
+ /**
4591
+ * Month of birth (1-12).
4592
+ */
4593
+ month: number;
4594
+ /**
4595
+ * Year of birth (must be greater than 1900).
4596
+ */
4597
+ year: number;
4598
+ }
4599
+ }
4600
+ namespace DropOff {
4601
+ interface Address {
4602
+ /**
4603
+ * City, district, suburb, town, or village.
4604
+ */
4605
+ city: string;
4606
+ /**
4607
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
4608
+ */
4609
+ country: string;
4610
+ /**
4611
+ * Address line 1, such as the street, PO Box, or company name.
4612
+ */
4613
+ line1: string;
4614
+ /**
4615
+ * Address line 2, such as the apartment, suite, unit, or building.
4616
+ */
4617
+ line2?: string;
4618
+ /**
4619
+ * ZIP or postal code.
4620
+ */
4621
+ postal_code: string;
4622
+ /**
4623
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
4624
+ */
4625
+ state?: string;
4626
+ }
4627
+ }
4628
+ namespace Insurance {
4629
+ type InsuranceType = 'liability_supplement' | 'loss_damage_waiver' | 'other' | 'partial_damage_waiver' | 'personal_accident' | 'personal_effects';
4630
+ }
4631
+ namespace Pickup {
4632
+ interface Address {
4633
+ /**
4634
+ * City, district, suburb, town, or village.
4635
+ */
4636
+ city: string;
4637
+ /**
4638
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
4639
+ */
4640
+ country: string;
4641
+ /**
4642
+ * Address line 1, such as the street, PO Box, or company name.
4643
+ */
4644
+ line1: string;
4645
+ /**
4646
+ * Address line 2, such as the apartment, suite, unit, or building.
4647
+ */
4648
+ line2?: string;
4649
+ /**
4650
+ * ZIP or postal code.
4651
+ */
4652
+ postal_code: string;
4653
+ /**
4654
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
4655
+ */
4656
+ state?: string;
4657
+ }
4658
+ }
4659
+ namespace Total {
4660
+ interface Discounts {
4661
+ /**
4662
+ * Corporate client discount code.
4663
+ */
4664
+ corporate_client_code?: string;
4665
+ /**
4666
+ * Coupon code applied to the rental.
4667
+ */
4668
+ coupon?: string;
4669
+ /**
4670
+ * Maximum number of free miles or kilometers included.
4671
+ */
4672
+ maximum_free_miles_or_kilometers?: number;
4673
+ }
4674
+ interface ExtraCharge {
4675
+ /**
4676
+ * Amount of the extra charge in cents.
4677
+ */
4678
+ amount: number;
4679
+ /**
4680
+ * Type of extra charge.
4681
+ */
4682
+ type: ExtraCharge.Type;
4683
+ }
4684
+ type RateUnit = 'days' | 'kilometers' | 'miles' | 'months' | 'weeks';
4685
+ interface Tax {
4686
+ /**
4687
+ * Indicates if the transaction is tax exempt.
4688
+ */
4689
+ tax_exempt_indicator?: boolean;
4690
+ /**
4691
+ * Array of tax details.
4692
+ */
4693
+ taxes?: Array<Tax.Tax>;
4694
+ }
4695
+ namespace ExtraCharge {
4696
+ type Type = 'extra_mileage' | 'gas' | 'gps' | 'late_charge' | 'one_way_drop_off' | 'other' | 'parking' | 'phone' | 'regular_mileage' | 'towing';
4697
+ }
4698
+ namespace Tax {
4699
+ interface Tax {
4700
+ /**
4701
+ * Tax amount.
4702
+ */
4703
+ amount?: number;
4704
+ /**
4705
+ * Tax rate applied.
4706
+ */
4707
+ rate?: number;
4708
+ /**
4709
+ * Type of tax applied.
4710
+ */
4711
+ type?: string;
4712
+ }
4713
+ }
4714
+ }
4715
+ namespace Vehicle {
4716
+ type Type = 'cargo_van' | 'compact' | 'economy' | 'exotic' | 'exotic_suv' | 'fifteen_passenger_van' | 'four_wheel_drive' | 'full_size' | 'intermediate' | 'large_suv' | 'large_truck' | 'luxury' | 'medium_suv' | 'midsize' | 'mini' | 'minivan' | 'miscellaneous' | 'moped' | 'moving_van' | 'premium' | 'regular' | 'small_medium_truck' | 'small_suv' | 'special' | 'standard' | 'stretch' | 'subcompact' | 'taxi' | 'twelve_foot_truck' | 'twelve_passenger_van' | 'twenty_foot_truck' | 'twenty_four_foot_truck' | 'twenty_six_foot_truck' | 'unique';
4717
+ type VehicleClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
4718
+ }
4719
+ }
4720
+ namespace EventDetails {
4721
+ interface Affiliate {
4722
+ /**
4723
+ * The name of the affiliate that originated the purchase.
4724
+ */
4725
+ name: string;
4726
+ }
4727
+ interface Delivery {
4728
+ /**
4729
+ * The delivery method for the payment
4730
+ */
4731
+ mode?: Delivery.Mode;
4732
+ /**
4733
+ * Details of the recipient.
4734
+ */
4735
+ recipient?: Delivery.Recipient;
4736
+ }
4737
+ namespace Delivery {
4738
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
4739
+ interface Recipient {
4740
+ /**
4741
+ * The email of the recipient the ticket is delivered to.
4742
+ */
4743
+ email?: string;
4744
+ /**
4745
+ * The name of the recipient the ticket is delivered to.
4746
+ */
4747
+ name?: string;
4748
+ /**
4749
+ * The phone number of the recipient the ticket is delivered to.
4750
+ */
4751
+ phone?: string;
4752
+ }
4753
+ }
4754
+ }
4755
+ namespace Flight {
4756
+ interface Affiliate {
4757
+ /**
4758
+ * The name of the affiliate that originated the purchase.
4759
+ */
4760
+ name: string;
4761
+ }
4762
+ interface Delivery {
4763
+ /**
4764
+ * The delivery method for the payment
4765
+ */
4766
+ mode?: Delivery.Mode;
4767
+ /**
4768
+ * Details of the recipient.
4769
+ */
4770
+ recipient?: Delivery.Recipient;
4771
+ }
4772
+ interface Passenger {
4773
+ /**
4774
+ * Full name of the person or entity on the flight reservation.
4775
+ */
4776
+ name: string;
4777
+ }
4778
+ interface Segment {
4779
+ /**
4780
+ * The flight segment amount.
4781
+ */
4782
+ amount?: number;
4783
+ /**
4784
+ * The International Air Transport Association (IATA) airport code for the arrival airport.
4785
+ */
4786
+ arrival_airport?: string;
4787
+ /**
4788
+ * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
4789
+ */
4790
+ arrives_at?: number;
4791
+ /**
4792
+ * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
4793
+ */
4794
+ carrier?: string;
4795
+ /**
4796
+ * The departure time for the flight segment. Measured in seconds since the Unix epoch.
4797
+ */
4798
+ departs_at: number;
4799
+ /**
4800
+ * The International Air Transport Association (IATA) airport code for the departure airport.
4801
+ */
4802
+ departure_airport?: string;
4803
+ /**
4804
+ * The flight number associated with the segment
4805
+ */
4806
+ flight_number?: string;
4807
+ /**
4808
+ * The fare class for the segment.
4809
+ */
4810
+ service_class?: Segment.ServiceClass;
4811
+ }
4812
+ namespace Delivery {
4813
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
4814
+ interface Recipient {
4815
+ /**
4816
+ * The email of the recipient the ticket is delivered to.
4817
+ */
4818
+ email?: string;
4819
+ /**
4820
+ * The name of the recipient the ticket is delivered to.
4821
+ */
4822
+ name?: string;
4823
+ /**
4824
+ * The phone number of the recipient the ticket is delivered to.
4825
+ */
4826
+ phone?: string;
4827
+ }
4828
+ }
4829
+ namespace Segment {
4830
+ type ServiceClass = 'business' | 'economy' | 'first' | 'premium_economy';
4831
+ }
4832
+ }
4833
+ namespace FlightDatum {
4834
+ interface Affiliate {
4835
+ /**
4836
+ * Affiliate partner code.
4837
+ */
4838
+ code?: string;
4839
+ /**
4840
+ * Name of affiliate partner.
4841
+ */
4842
+ name?: string;
4843
+ /**
4844
+ * Code provided by the company to a travel agent authorizing ticket issuance.
4845
+ */
4846
+ travel_authorization_code?: string;
4847
+ }
4848
+ interface Insurance {
4849
+ /**
4850
+ * Insurance cost.
4851
+ */
4852
+ amount: number;
4853
+ /**
4854
+ * Insurance currency.
4855
+ */
4856
+ currency?: string;
4857
+ /**
4858
+ * Insurance company name.
4859
+ */
4860
+ insurance_company_name?: string;
4861
+ /**
4862
+ * Type of insurance.
4863
+ */
4864
+ insurance_type: Insurance.InsuranceType;
4865
+ }
4866
+ interface Passenger {
4867
+ /**
4868
+ * Passenger's full name.
4869
+ */
4870
+ name: string;
4871
+ }
4872
+ interface Segment {
4873
+ /**
4874
+ * Segment fare amount.
4875
+ */
4876
+ amount?: number;
4877
+ /**
4878
+ * Arrival details.
4879
+ */
4880
+ arrival: Segment.Arrival;
4881
+ /**
4882
+ * Airline carrier code.
4883
+ */
4884
+ carrier_code: string;
4885
+ /**
4886
+ * Carrier name.
4887
+ */
4888
+ carrier_name?: string;
4889
+ /**
4890
+ * Segment currency.
4891
+ */
4892
+ currency?: string;
4893
+ /**
4894
+ * Departure details.
4895
+ */
4896
+ departure: Segment.Departure;
4897
+ /**
4898
+ * Exchange ticket number.
4899
+ */
4900
+ exchange_ticket_number?: string;
4901
+ /**
4902
+ * Fare basis code.
4903
+ */
4904
+ fare_basis_code?: string;
4905
+ /**
4906
+ * Additional fees.
4907
+ */
4908
+ fees?: number;
4909
+ /**
4910
+ * Flight number.
4911
+ */
4912
+ flight_number?: string;
4913
+ /**
4914
+ * Stopover indicator.
4915
+ */
4916
+ is_stop_over_indicator?: boolean;
4917
+ /**
4918
+ * Refundable ticket indicator.
4919
+ */
4920
+ refundable?: boolean;
4921
+ /**
4922
+ * Class of service.
4923
+ */
4924
+ service_class: Segment.ServiceClass;
4925
+ /**
4926
+ * Tax amount for segment.
4927
+ */
4928
+ tax_amount?: number;
4929
+ /**
4930
+ * Ticket number.
4931
+ */
4932
+ ticket_number?: string;
4933
+ }
4934
+ interface Total {
4935
+ /**
4936
+ * Total flight amount.
4937
+ */
4938
+ amount: number;
4939
+ /**
4940
+ * Reason for credit.
4941
+ */
4942
+ credit_reason?: Total.CreditReason;
4943
+ /**
4944
+ * Total currency.
4945
+ */
4946
+ currency?: string;
4947
+ /**
4948
+ * Discount details.
4949
+ */
4950
+ discounts?: Total.Discounts;
4951
+ /**
4952
+ * Additional charges.
4953
+ */
4954
+ extra_charges?: Array<Total.ExtraCharge>;
4955
+ /**
4956
+ * Tax breakdown.
4957
+ */
4958
+ tax?: Total.Tax;
4959
+ }
4960
+ type TransactionType = 'exchange_ticket' | 'miscellaneous' | 'refund' | 'ticket_purchase';
4961
+ namespace Insurance {
4962
+ type InsuranceType = 'baggage' | 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
4963
+ }
4964
+ namespace Segment {
4965
+ interface Arrival {
4966
+ /**
4967
+ * Arrival airport IATA code.
4968
+ */
4969
+ airport: string;
4970
+ /**
4971
+ * Arrival date/time.
4972
+ */
4973
+ arrives_at?: number;
4974
+ /**
4975
+ * Arrival city.
4976
+ */
4977
+ city?: string;
4978
+ /**
4979
+ * Arrival country.
4980
+ */
4981
+ country?: string;
4982
+ }
4983
+ interface Departure {
4984
+ /**
4985
+ * Departure airport IATA code.
4986
+ */
4987
+ airport: string;
4988
+ /**
4989
+ * Departure city.
4990
+ */
4991
+ city?: string;
4992
+ /**
4993
+ * Departure country.
4994
+ */
4995
+ country?: string;
4996
+ /**
4997
+ * Departure date/time.
4998
+ */
4999
+ departs_at: number;
5000
+ }
5001
+ type ServiceClass = 'business' | 'economy' | 'first_class' | 'premium_economy';
5002
+ }
5003
+ namespace Total {
5004
+ type CreditReason = 'other' | 'partial_ticket_refund' | 'passenger_transport_ancillary_cancellation' | 'ticket_and_ancillary_cancellation' | 'ticket_cancellation';
5005
+ interface Discounts {
5006
+ /**
5007
+ * Corporate client discount code.
5008
+ */
5009
+ corporate_client_code?: string;
5010
+ }
5011
+ interface ExtraCharge {
5012
+ /**
5013
+ * Amount of additional charges.
5014
+ */
5015
+ amount?: number;
5016
+ /**
5017
+ * Type of additional charges.
5018
+ */
5019
+ type?: ExtraCharge.Type;
5020
+ }
5021
+ interface Tax {
5022
+ /**
5023
+ * Array of tax details.
5024
+ */
5025
+ taxes?: Array<Tax.Tax>;
5026
+ }
5027
+ namespace ExtraCharge {
5028
+ type Type = 'additional_fees' | 'ancillary_service_charges' | 'exchange_fee';
5029
+ }
5030
+ namespace Tax {
5031
+ interface Tax {
5032
+ /**
5033
+ * Tax amount.
5034
+ */
5035
+ amount?: number;
5036
+ /**
5037
+ * Tax rate.
5038
+ */
5039
+ rate?: number;
5040
+ /**
5041
+ * Type of tax.
5042
+ */
5043
+ type?: string;
5044
+ }
5045
+ }
5046
+ }
5047
+ }
5048
+ namespace Lodging {
5049
+ interface Affiliate {
5050
+ /**
5051
+ * The name of the affiliate that originated the purchase.
5052
+ */
5053
+ name: string;
5054
+ }
5055
+ type Category = 'hotel' | 'vacation_rental';
5056
+ interface Delivery {
5057
+ /**
5058
+ * The delivery method for the payment
5059
+ */
5060
+ mode?: Delivery.Mode;
5061
+ /**
5062
+ * Details of the recipient.
5063
+ */
5064
+ recipient?: Delivery.Recipient;
5065
+ }
5066
+ type ExtraCharge = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'restaurant' | 'telephone';
5067
+ interface Passenger {
5068
+ /**
5069
+ * Full name of the person or entity on the lodging reservation.
5070
+ */
5071
+ name: string;
5072
+ }
5073
+ namespace Delivery {
5074
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
5075
+ interface Recipient {
5076
+ /**
5077
+ * The email of the recipient the ticket is delivered to.
5078
+ */
5079
+ email?: string;
5080
+ /**
5081
+ * The name of the recipient the ticket is delivered to.
5082
+ */
5083
+ name?: string;
5084
+ /**
5085
+ * The phone number of the recipient the ticket is delivered to.
5086
+ */
5087
+ phone?: string;
5088
+ }
5089
+ }
5090
+ }
5091
+ namespace LodgingDatum {
5092
+ interface Accommodation {
5093
+ /**
5094
+ * Type of accommodation.
5095
+ */
5096
+ accommodation_type?: Accommodation.AccommodationType;
5097
+ /**
5098
+ * Bed type.
5099
+ */
5100
+ bed_type?: string;
5101
+ /**
5102
+ * Daily accommodation rate in cents.
5103
+ */
5104
+ daily_rate_amount?: number;
5105
+ /**
5106
+ * Number of nights.
5107
+ */
5108
+ nights?: number;
5109
+ /**
5110
+ * Number of rooms, cabanas, apartments, and so on.
5111
+ */
5112
+ number_of_rooms?: number;
5113
+ /**
5114
+ * Rate type.
5115
+ */
5116
+ rate_type?: string;
5117
+ /**
5118
+ * Whether smoking is allowed.
5119
+ */
5120
+ smoking_indicator?: boolean;
5121
+ }
5122
+ interface Affiliate {
5123
+ /**
5124
+ * Affiliate partner code.
5125
+ */
5126
+ code?: string;
5127
+ /**
5128
+ * Affiliate partner name.
5129
+ */
5130
+ name?: string;
5131
+ }
5132
+ interface Guest {
5133
+ /**
5134
+ * Guest's full name.
5135
+ */
5136
+ name: string;
5137
+ }
5138
+ interface Host {
5139
+ /**
5140
+ * Address of the host.
5141
+ */
5142
+ address?: Host.Address;
5143
+ /**
5144
+ * Host's country of domicile.
5145
+ */
5146
+ country_of_domicile?: string;
5147
+ /**
5148
+ * Reference number for the host.
5149
+ */
5150
+ host_reference?: string;
5151
+ /**
5152
+ * Type of host.
5153
+ */
5154
+ host_type?: Host.HostType;
5155
+ /**
5156
+ * Name of the lodging property or host.
5157
+ */
5158
+ name?: string;
5159
+ /**
5160
+ * Total number of reservations for the host.
5161
+ */
5162
+ number_of_reservations?: number;
5163
+ /**
5164
+ * Property phone number.
5165
+ */
5166
+ property_phone_number?: string;
5167
+ /**
5168
+ * Host's registration date.
5169
+ */
5170
+ registered_at?: number;
5171
+ }
5172
+ interface Insurance {
5173
+ /**
5174
+ * Price of the insurance coverage in cents.
5175
+ */
5176
+ amount: number;
5177
+ /**
5178
+ * Currency of the insurance amount.
5179
+ */
5180
+ currency?: string;
5181
+ /**
5182
+ * Name of the insurance company.
5183
+ */
5184
+ insurance_company_name?: string;
5185
+ /**
5186
+ * Type of insurance coverage.
5187
+ */
5188
+ insurance_type: Insurance.InsuranceType;
5189
+ }
5190
+ interface Total {
5191
+ /**
5192
+ * Total price of the lodging reservation in cents.
5193
+ */
5194
+ amount: number;
5195
+ /**
5196
+ * Cash advances in cents.
5197
+ */
5198
+ cash_advances?: number;
5199
+ /**
5200
+ * Currency of the total amount.
5201
+ */
5202
+ currency?: string;
5203
+ /**
5204
+ * Discount details for the lodging.
5205
+ */
5206
+ discounts?: Total.Discounts;
5207
+ /**
5208
+ * Additional charges for the lodging.
5209
+ */
5210
+ extra_charges?: Array<Total.ExtraCharge>;
5211
+ /**
5212
+ * Prepaid amount in cents.
5213
+ */
5214
+ prepaid_amount?: number;
5215
+ /**
5216
+ * Tax breakdown for the lodging reservation.
5217
+ */
5218
+ tax?: Total.Tax;
5219
+ }
5220
+ namespace Accommodation {
5221
+ type AccommodationType = 'apartment' | 'cabana' | 'house' | 'penthouse' | 'room' | 'standard' | 'suite' | 'villa';
5222
+ }
5223
+ namespace Host {
5224
+ interface Address {
5225
+ /**
5226
+ * City, district, suburb, town, or village.
5227
+ */
5228
+ city: string;
5229
+ /**
5230
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
5231
+ */
5232
+ country: string;
5233
+ /**
5234
+ * Address line 1, such as the street, PO Box, or company name.
5235
+ */
5236
+ line1: string;
5237
+ /**
5238
+ * Address line 2, such as the apartment, suite, unit, or building.
5239
+ */
5240
+ line2?: string;
5241
+ /**
5242
+ * ZIP or postal code.
5243
+ */
5244
+ postal_code: string;
5245
+ /**
5246
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
5247
+ */
5248
+ state?: string;
5249
+ }
5250
+ type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
5251
+ }
5252
+ namespace Insurance {
5253
+ type InsuranceType = 'bankruptcy' | 'cancelation' | 'emergency' | 'medical';
5254
+ }
5255
+ namespace Total {
5256
+ interface Discounts {
5257
+ /**
5258
+ * Corporate client discount code.
5259
+ */
5260
+ corporate_client_code?: string;
5261
+ /**
5262
+ * Coupon code.
5263
+ */
5264
+ coupon?: string;
5265
+ }
5266
+ interface ExtraCharge {
5267
+ /**
5268
+ * Amount of the extra charge in cents.
5269
+ */
5270
+ amount?: number;
5271
+ /**
5272
+ * Type of extra charge.
5273
+ */
5274
+ type?: ExtraCharge.Type;
5275
+ }
5276
+ interface Tax {
5277
+ /**
5278
+ * Indicates whether the transaction is tax exempt.
5279
+ */
5280
+ tax_exempt_indicator?: boolean;
5281
+ /**
5282
+ * Tax details.
5283
+ */
5284
+ taxes?: Array<Tax.Tax>;
5285
+ }
5286
+ namespace ExtraCharge {
5287
+ type Type = 'gift_shop' | 'laundry' | 'mini_bar' | 'other' | 'phone' | 'restaurant';
5288
+ }
5289
+ namespace Tax {
5290
+ interface Tax {
5291
+ /**
5292
+ * Tax amount in cents.
5293
+ */
5294
+ amount?: number;
5295
+ /**
5296
+ * Tax rate.
5297
+ */
5298
+ rate?: number;
5299
+ /**
5300
+ * Type of tax applied.
5301
+ */
5302
+ type?: string;
5303
+ }
5304
+ }
5305
+ }
5306
+ }
5307
+ namespace Subscription {
5308
+ interface Affiliate {
5309
+ /**
5310
+ * The name of the affiliate that originated the purchase.
5311
+ */
5312
+ name: string;
5313
+ }
5314
+ interface BillingInterval {
5315
+ /**
5316
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
5317
+ */
5318
+ count: number;
5319
+ /**
5320
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
5321
+ */
5322
+ interval: BillingInterval.Interval;
5323
+ }
5324
+ namespace BillingInterval {
5325
+ type Interval = 'day' | 'month' | 'week' | 'year';
5326
+ }
5327
+ }
2321
5328
  }
2322
5329
  }
2323
5330
  export interface ChargeSearchParams {