stripe 20.1.2 → 20.2.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (472) hide show
  1. package/CHANGELOG.md +1988 -14
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -0
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +123 -1
  6. package/cjs/RequestSender.js +1 -9
  7. package/cjs/apiVersion.js +2 -3
  8. package/cjs/resources/AccountNotices.js +21 -0
  9. package/cjs/resources/BalanceTransfers.js +9 -0
  10. package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
  11. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  12. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  13. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  14. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +28 -0
  15. package/cjs/resources/ExternalAccounts.js +23 -0
  16. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  17. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  18. package/cjs/resources/FxQuotes.js +15 -0
  19. package/cjs/resources/Identity/BlocklistEntries.js +25 -0
  20. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  21. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  22. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  23. package/cjs/resources/Issuing/Programs.js +22 -0
  24. package/cjs/resources/Mandates.js +5 -0
  25. package/cjs/resources/Margins.js +22 -0
  26. package/cjs/resources/Orders.js +24 -0
  27. package/cjs/resources/PaymentIntents.js +8 -0
  28. package/cjs/resources/PaymentMethods.js +4 -0
  29. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  30. package/cjs/resources/ProductCatalog/TrialOffers.js +12 -0
  31. package/cjs/resources/Quotes.js +32 -0
  32. package/cjs/resources/Radar/AccountEvaluations.js +20 -0
  33. package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
  34. package/cjs/resources/SubscriptionSchedules.js +4 -0
  35. package/cjs/resources/Subscriptions.js +8 -0
  36. package/cjs/resources/Tax/Forms.js +20 -0
  37. package/cjs/resources/Tax/Locations.js +18 -0
  38. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  39. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +16 -0
  40. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
  41. package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
  42. package/cjs/resources/V2/Billing/BillSettings.js +27 -0
  43. package/cjs/resources/V2/Billing/Cadences.js +23 -0
  44. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
  45. package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
  46. package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
  47. package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
  48. package/cjs/resources/V2/Billing/Intents.js +36 -0
  49. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
  50. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
  51. package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
  52. package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
  53. package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
  54. package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +12 -0
  55. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +26 -0
  56. package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
  57. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
  58. package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
  59. package/cjs/resources/V2/Billing/Profiles.js +19 -0
  60. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
  61. package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
  62. package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
  63. package/cjs/resources/V2/Billing/RateCards.js +29 -0
  64. package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
  65. package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
  66. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
  67. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
  68. package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
  69. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  70. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +21 -0
  71. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
  72. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  73. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  74. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  75. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  76. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  77. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  78. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  79. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  80. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  81. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  82. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +20 -0
  83. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  84. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  85. package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
  86. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
  87. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
  88. package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
  89. package/cjs/resources/V2/Reporting/Reports.js +12 -0
  90. package/cjs/resources/V2/Tax/ManualRules.js +23 -0
  91. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  92. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
  93. package/cjs/resources.js +166 -4
  94. package/cjs/stripe.core.js +1 -1
  95. package/esm/Error.js +107 -0
  96. package/esm/RequestSender.js +1 -9
  97. package/esm/apiVersion.js +1 -2
  98. package/esm/resources/AccountNotices.js +18 -0
  99. package/esm/resources/BalanceTransfers.js +6 -0
  100. package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
  101. package/esm/resources/Capital/FinancingOffers.js +18 -0
  102. package/esm/resources/Capital/FinancingSummary.js +9 -0
  103. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  104. package/esm/resources/DelegatedCheckout/RequestedSessions.js +25 -0
  105. package/esm/resources/ExternalAccounts.js +20 -0
  106. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  107. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  108. package/esm/resources/FxQuotes.js +12 -0
  109. package/esm/resources/Identity/BlocklistEntries.js +22 -0
  110. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  111. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  112. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  113. package/esm/resources/Issuing/Programs.js +19 -0
  114. package/esm/resources/Mandates.js +5 -0
  115. package/esm/resources/Margins.js +19 -0
  116. package/esm/resources/Orders.js +21 -0
  117. package/esm/resources/PaymentIntents.js +8 -0
  118. package/esm/resources/PaymentMethods.js +4 -0
  119. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  120. package/esm/resources/ProductCatalog/TrialOffers.js +9 -0
  121. package/esm/resources/Quotes.js +32 -0
  122. package/esm/resources/Radar/AccountEvaluations.js +17 -0
  123. package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
  124. package/esm/resources/SubscriptionSchedules.js +4 -0
  125. package/esm/resources/Subscriptions.js +8 -0
  126. package/esm/resources/Tax/Forms.js +17 -0
  127. package/esm/resources/Tax/Locations.js +15 -0
  128. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  129. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +13 -0
  130. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
  131. package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
  132. package/esm/resources/V2/Billing/BillSettings.js +24 -0
  133. package/esm/resources/V2/Billing/Cadences.js +20 -0
  134. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
  135. package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
  136. package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
  137. package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
  138. package/esm/resources/V2/Billing/Intents.js +33 -0
  139. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
  140. package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
  141. package/esm/resources/V2/Billing/LicenseFees.js +24 -0
  142. package/esm/resources/V2/Billing/LicensedItems.js +22 -0
  143. package/esm/resources/V2/Billing/MeteredItems.js +19 -0
  144. package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +9 -0
  145. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +23 -0
  146. package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
  147. package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
  148. package/esm/resources/V2/Billing/PricingPlans.js +26 -0
  149. package/esm/resources/V2/Billing/Profiles.js +16 -0
  150. package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
  151. package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
  152. package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
  153. package/esm/resources/V2/Billing/RateCards.js +26 -0
  154. package/esm/resources/V2/Billing/ServiceActions.js +17 -0
  155. package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
  156. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
  157. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
  158. package/esm/resources/V2/Iam/ApiKeys.js +21 -0
  159. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  160. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +18 -0
  161. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
  162. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  163. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  164. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  165. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  166. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  167. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  168. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  169. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  170. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  171. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  172. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +17 -0
  173. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  174. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  175. package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
  176. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
  177. package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
  178. package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
  179. package/esm/resources/V2/Reporting/Reports.js +9 -0
  180. package/esm/resources/V2/Tax/ManualRules.js +20 -0
  181. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  182. package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
  183. package/esm/resources.js +156 -0
  184. package/esm/stripe.core.js +1 -1
  185. package/package.json +1 -1
  186. package/types/AccountLinksResource.d.ts +5 -1
  187. package/types/AccountNotices.d.ts +113 -0
  188. package/types/AccountNoticesResource.d.ts +98 -0
  189. package/types/AccountSessions.d.ts +63 -0
  190. package/types/AccountSessionsResource.d.ts +285 -0
  191. package/types/Accounts.d.ts +225 -1
  192. package/types/AccountsResource.d.ts +698 -12
  193. package/types/ApplicationFees.d.ts +6 -1
  194. package/types/Balance.d.ts +82 -0
  195. package/types/BalanceTransactions.d.ts +2 -1
  196. package/types/BalanceTransfers.d.ts +122 -0
  197. package/types/BalanceTransfersResource.d.ts +87 -0
  198. package/types/BankAccounts.d.ts +2 -0
  199. package/types/Billing/AlertTriggereds.d.ts +16 -1
  200. package/types/Billing/Alerts.d.ts +116 -1
  201. package/types/Billing/AlertsResource.d.ts +149 -2
  202. package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
  203. package/types/Billing/Analytics/MeterUsageResource.d.ts +694 -0
  204. package/types/Billing/Analytics/MeterUsageRows.d.ts +58 -0
  205. package/types/Billing/CreditBalanceSummary.d.ts +118 -2
  206. package/types/Billing/CreditBalanceSummaryResource.d.ts +12 -0
  207. package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
  208. package/types/Billing/CreditGrants.d.ts +71 -1
  209. package/types/Billing/CreditGrantsResource.d.ts +32 -1
  210. package/types/Billing/MeterEventSummaries.d.ts +7 -0
  211. package/types/Billing/Meters.d.ts +5 -0
  212. package/types/Billing/MetersResource.d.ts +17 -0
  213. package/types/Capabilities.d.ts +2 -0
  214. package/types/Capital/FinancingOffers.d.ts +188 -0
  215. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  216. package/types/Capital/FinancingSummary.d.ts +109 -0
  217. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  218. package/types/Capital/FinancingTransactions.d.ts +135 -0
  219. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  220. package/types/Cards.d.ts +19 -0
  221. package/types/Charges.d.ts +166 -0
  222. package/types/ChargesResource.d.ts +3855 -75
  223. package/types/Checkout/Sessions.d.ts +337 -2
  224. package/types/Checkout/SessionsResource.d.ts +450 -2
  225. package/types/ConfirmationTokens.d.ts +117 -0
  226. package/types/Coupons.d.ts +35 -0
  227. package/types/CouponsResource.d.ts +23 -0
  228. package/types/CreditNoteLineItems.d.ts +17 -0
  229. package/types/CustomerSessions.d.ts +41 -0
  230. package/types/CustomerSessionsResource.d.ts +41 -0
  231. package/types/CustomersResource.d.ts +7 -0
  232. package/types/DelegatedCheckout/RequestedSessions.d.ts +465 -0
  233. package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +703 -0
  234. package/types/Discounts.d.ts +10 -0
  235. package/types/Disputes.d.ts +40 -0
  236. package/types/DisputesResource.d.ts +11 -0
  237. package/types/Errors.d.ts +91 -0
  238. package/types/EventTypes.d.ts +630 -0
  239. package/types/Events.d.ts +96 -0
  240. package/types/ExternalAccountsResource.d.ts +304 -0
  241. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  242. package/types/FinancialConnections/Accounts.d.ts +34 -1
  243. package/types/FinancialConnections/AccountsResource.d.ts +35 -3
  244. package/types/FinancialConnections/Institutions.d.ts +98 -0
  245. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  246. package/types/FinancialConnections/Sessions.d.ts +49 -1
  247. package/types/FinancialConnections/SessionsResource.d.ts +38 -1
  248. package/types/FxQuotes.d.ts +155 -0
  249. package/types/FxQuotesResource.d.ts +130 -0
  250. package/types/Identity/BlocklistEntries.d.ts +78 -0
  251. package/types/Identity/BlocklistEntriesResource.d.ts +146 -0
  252. package/types/Identity/VerificationReports.d.ts +10 -0
  253. package/types/Identity/VerificationReportsResource.d.ts +5 -0
  254. package/types/InvoiceItems.d.ts +123 -3
  255. package/types/InvoiceItemsResource.d.ts +98 -0
  256. package/types/InvoiceLineItems.d.ts +169 -6
  257. package/types/Invoices.d.ts +216 -4
  258. package/types/InvoicesResource.d.ts +1955 -136
  259. package/types/Issuing/CardholdersResource.d.ts +2 -1
  260. package/types/Issuing/Cards.d.ts +10 -0
  261. package/types/Issuing/CardsResource.d.ts +33 -0
  262. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  263. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  264. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  265. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  266. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  267. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  268. package/types/Issuing/Programs.d.ts +42 -0
  269. package/types/Issuing/ProgramsResource.d.ts +96 -0
  270. package/types/Issuing/Settlements.d.ts +113 -0
  271. package/types/Issuing/Transactions.d.ts +5 -0
  272. package/types/Issuing/TransactionsResource.d.ts +5 -0
  273. package/types/LineItems.d.ts +45 -1
  274. package/types/Mandates.d.ts +69 -1
  275. package/types/MandatesResource.d.ts +31 -0
  276. package/types/Margins.d.ts +56 -0
  277. package/types/MarginsResource.d.ts +114 -0
  278. package/types/Orders.d.ts +1163 -0
  279. package/types/OrdersResource.d.ts +5505 -0
  280. package/types/PaymentAttemptRecords.d.ts +117 -0
  281. package/types/PaymentIntents.d.ts +728 -4
  282. package/types/PaymentIntentsResource.d.ts +19194 -6486
  283. package/types/PaymentLinks.d.ts +5 -0
  284. package/types/PaymentLinksResource.d.ts +29 -0
  285. package/types/PaymentMethodBalances.d.ts +63 -0
  286. package/types/PaymentMethodConfigurations.d.ts +180 -0
  287. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  288. package/types/PaymentMethods.d.ts +122 -0
  289. package/types/PaymentMethodsResource.d.ts +130 -0
  290. package/types/PaymentRecords.d.ts +117 -0
  291. package/types/Persons.d.ts +30 -0
  292. package/types/Plans.d.ts +5 -0
  293. package/types/PlansResource.d.ts +19 -0
  294. package/types/Prices.d.ts +27 -0
  295. package/types/PricesResource.d.ts +41 -0
  296. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  297. package/types/Privacy/RedactionJobs.d.ts +111 -0
  298. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  299. package/types/ProductCatalog/TrialOffers.d.ts +77 -0
  300. package/types/ProductCatalog/TrialOffersResource.d.ts +80 -0
  301. package/types/ProductsResource.d.ts +34 -0
  302. package/types/QuoteLines.d.ts +651 -0
  303. package/types/QuotePreviewInvoices.d.ts +1839 -0
  304. package/types/QuotePreviewSubscriptionSchedules.d.ts +1034 -0
  305. package/types/Quotes.d.ts +871 -1
  306. package/types/QuotesResource.d.ts +3245 -297
  307. package/types/Radar/AccountEvaluations.d.ts +88 -0
  308. package/types/Radar/AccountEvaluationsResource.d.ts +148 -0
  309. package/types/Refunds.d.ts +14 -0
  310. package/types/SetupAttempts.d.ts +42 -1
  311. package/types/SetupIntents.d.ts +159 -2
  312. package/types/SetupIntentsResource.d.ts +719 -3
  313. package/types/SharedPayment/GrantedTokens.d.ts +102 -0
  314. package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
  315. package/types/Sources.d.ts +29 -0
  316. package/types/SubscriptionItems.d.ts +39 -0
  317. package/types/SubscriptionItemsResource.d.ts +143 -0
  318. package/types/SubscriptionSchedules.d.ts +324 -0
  319. package/types/SubscriptionSchedulesResource.d.ts +1521 -65
  320. package/types/Subscriptions.d.ts +279 -1
  321. package/types/SubscriptionsResource.d.ts +807 -2
  322. package/types/Tax/CalculationLineItems.d.ts +14 -1
  323. package/types/Tax/Calculations.d.ts +17 -1
  324. package/types/Tax/CalculationsResource.d.ts +5 -0
  325. package/types/Tax/Forms.d.ts +220 -0
  326. package/types/Tax/FormsResource.d.ts +107 -0
  327. package/types/Tax/Locations.d.ts +34 -0
  328. package/types/Tax/LocationsResource.d.ts +117 -0
  329. package/types/Tax/Registrations.d.ts +81 -1
  330. package/types/Tax/RegistrationsResource.d.ts +9 -1
  331. package/types/Tax/Transactions.d.ts +9 -1
  332. package/types/TaxCodes.d.ts +18 -0
  333. package/types/Terminal/Configurations.d.ts +9 -0
  334. package/types/Terminal/ConfigurationsResource.d.ts +28 -0
  335. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  336. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  337. package/types/Terminal/Readers.d.ts +20 -0
  338. package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +130 -0
  339. package/types/TestHelpers/ConfirmationTokensResource.d.ts +103 -0
  340. package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +91 -0
  341. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  342. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  343. package/types/TokensResource.d.ts +68 -0
  344. package/types/Transfers.d.ts +9 -0
  345. package/types/TransfersResource.d.ts +7 -0
  346. package/types/TransitBalances.d.ts +40 -0
  347. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  348. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  349. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  350. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  351. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  352. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  353. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  354. package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
  355. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
  356. package/types/V2/Billing/BillSettings.d.ts +120 -0
  357. package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
  358. package/types/V2/Billing/Cadences.d.ts +735 -0
  359. package/types/V2/Billing/CadencesResource.d.ts +516 -0
  360. package/types/V2/Billing/CollectionSettingVersions.d.ts +318 -0
  361. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
  362. package/types/V2/Billing/CollectionSettings.d.ts +341 -0
  363. package/types/V2/Billing/CollectionSettingsResource.d.ts +683 -0
  364. package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
  365. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
  366. package/types/V2/Billing/IntentActions.d.ts +564 -0
  367. package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
  368. package/types/V2/Billing/Intents.d.ts +117 -0
  369. package/types/V2/Billing/IntentsResource.d.ts +674 -0
  370. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
  371. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
  372. package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
  373. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
  374. package/types/V2/Billing/LicenseFees.d.ts +164 -0
  375. package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
  376. package/types/V2/Billing/LicensedItems.d.ts +73 -0
  377. package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
  378. package/types/V2/Billing/MeteredItems.d.ts +101 -0
  379. package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
  380. package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
  381. package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +57 -0
  382. package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +40 -0
  383. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
  384. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +120 -0
  385. package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
  386. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
  387. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
  388. package/types/V2/Billing/PricingPlans.d.ts +84 -0
  389. package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
  390. package/types/V2/Billing/Profiles.d.ts +70 -0
  391. package/types/V2/Billing/ProfilesResource.d.ts +150 -0
  392. package/types/V2/Billing/RateCardRates.d.ts +144 -0
  393. package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
  394. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
  395. package/types/V2/Billing/RateCardVersions.d.ts +39 -0
  396. package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
  397. package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
  398. package/types/V2/Billing/RateCards.d.ts +98 -0
  399. package/types/V2/Billing/RateCardsResource.d.ts +162 -0
  400. package/types/V2/Billing/ServiceActions.d.ts +298 -0
  401. package/types/V2/Billing/ServiceActionsResource.d.ts +394 -0
  402. package/types/V2/Core/AccountLinks.d.ts +10 -2
  403. package/types/V2/Core/AccountLinksResource.d.ts +11 -2
  404. package/types/V2/Core/AccountTokensResource.d.ts +259 -0
  405. package/types/V2/Core/Accounts/PersonTokensResource.d.ts +2 -0
  406. package/types/V2/Core/Accounts/PersonsResource.d.ts +5 -0
  407. package/types/V2/Core/Accounts.d.ts +2437 -50
  408. package/types/V2/Core/AccountsResource.d.ts +2538 -368
  409. package/types/V2/Core/ClaimableSandboxes.d.ts +132 -0
  410. package/types/V2/Core/ClaimableSandboxesResource.d.ts +74 -0
  411. package/types/V2/Core/EventTypes.d.ts +5438 -9
  412. package/types/V2/Core/Events.d.ts +61 -0
  413. package/types/V2/Core/EventsResource.d.ts +11 -1
  414. package/types/V2/Core/Vault/GbBankAccounts.d.ts +181 -0
  415. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
  416. package/types/V2/Core/Vault/UsBankAccounts.d.ts +142 -0
  417. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
  418. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  419. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +46 -0
  420. package/types/V2/Iam/ApiKeys.d.ts +154 -0
  421. package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
  422. package/types/V2/MoneyManagement/Adjustments.d.ts +122 -0
  423. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  424. package/types/V2/MoneyManagement/CurrencyConversions.d.ts +98 -0
  425. package/types/V2/MoneyManagement/CurrencyConversionsResource.d.ts +141 -0
  426. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +216 -0
  427. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +179 -0
  428. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
  429. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
  430. package/types/V2/MoneyManagement/InboundTransfers.d.ts +250 -0
  431. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +156 -0
  432. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +230 -0
  433. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +134 -0
  434. package/types/V2/MoneyManagement/OutboundPayments.d.ts +450 -0
  435. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +292 -0
  436. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  437. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +332 -0
  438. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +296 -0
  439. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +225 -0
  440. package/types/V2/MoneyManagement/PayoutMethods.d.ts +227 -0
  441. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
  442. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  443. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +115 -0
  444. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +356 -0
  445. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  446. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +248 -0
  447. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  448. package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
  449. package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
  450. package/types/V2/MoneyManagement/TransactionEntries.d.ts +200 -0
  451. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  452. package/types/V2/MoneyManagement/Transactions.d.ts +227 -0
  453. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  454. package/types/V2/Payments/OffSessionPayments.d.ts +249 -0
  455. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +306 -0
  456. package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
  457. package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
  458. package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
  459. package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
  460. package/types/V2/Reporting/ReportRuns.d.ts +154 -0
  461. package/types/V2/Reporting/ReportRunsResource.d.ts +75 -0
  462. package/types/V2/Reporting/Reports.d.ts +120 -0
  463. package/types/V2/Reporting/ReportsResource.d.ts +30 -0
  464. package/types/V2/Tax/ManualRules.d.ts +142 -0
  465. package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
  466. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +85 -0
  467. package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
  468. package/types/WebhookEndpointsResource.d.ts +77 -2
  469. package/types/Webhooks.d.ts +2 -0
  470. package/types/apiVersion.d.ts +1 -2
  471. package/types/index.d.ts +260 -0
  472. package/types/lib.d.ts +10 -0
@@ -188,6 +188,11 @@ declare module 'stripe' {
188
188
  */
189
189
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
190
190
 
191
+ /**
192
+ * Provides industry-specific information about the charge.
193
+ */
194
+ payment_details?: ChargeUpdateParams.PaymentDetails;
195
+
191
196
  /**
192
197
  * 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.
193
198
  */
@@ -216,111 +221,3886 @@ declare module 'stripe' {
216
221
  type UserReport = 'fraudulent' | 'safe';
217
222
  }
218
223
 
219
- interface Shipping {
224
+ interface PaymentDetails {
220
225
  /**
221
- * Shipping address.
226
+ * Car rental details for this PaymentIntent.
222
227
  */
223
- address: Stripe.AddressParam;
228
+ car_rental?: PaymentDetails.CarRental;
224
229
 
225
230
  /**
226
- * The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
231
+ * Car rental data for this PaymentIntent.
227
232
  */
228
- carrier?: string;
233
+ car_rental_data?: Stripe.Emptyable<
234
+ Array<PaymentDetails.CarRentalDatum>
235
+ >;
229
236
 
230
237
  /**
231
- * Recipient name.
238
+ * A unique value to identify the customer. This field is available only for card payments.
239
+ *
240
+ * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
232
241
  */
233
- name: string;
242
+ customer_reference?: Stripe.Emptyable<string>;
234
243
 
235
244
  /**
236
- * Recipient phone (including extension).
245
+ * Event details for this PaymentIntent
237
246
  */
238
- phone?: string;
247
+ event_details?: PaymentDetails.EventDetails;
239
248
 
240
249
  /**
241
- * The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
250
+ * Flight reservation details for this PaymentIntent
242
251
  */
243
- tracking_number?: string;
252
+ flight?: PaymentDetails.Flight;
253
+
254
+ /**
255
+ * Flight data for this PaymentIntent.
256
+ */
257
+ flight_data?: Stripe.Emptyable<Array<PaymentDetails.FlightDatum>>;
258
+
259
+ /**
260
+ * Lodging reservation details for this PaymentIntent
261
+ */
262
+ lodging?: PaymentDetails.Lodging;
263
+
264
+ /**
265
+ * Lodging data for this PaymentIntent.
266
+ */
267
+ lodging_data?: Stripe.Emptyable<Array<PaymentDetails.LodgingDatum>>;
268
+
269
+ /**
270
+ * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
271
+ *
272
+ * Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
273
+ *
274
+ * 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.
275
+ */
276
+ order_reference?: Stripe.Emptyable<string>;
277
+
278
+ /**
279
+ * Subscription details for this PaymentIntent
280
+ */
281
+ subscription?: PaymentDetails.Subscription;
244
282
  }
245
- }
246
283
 
247
- interface ChargeListParams extends PaginationParams {
248
- /**
249
- * Only return charges that were created during the given date interval.
250
- */
251
- created?: Stripe.RangeQueryParam | number;
284
+ namespace PaymentDetails {
285
+ interface CarRental {
286
+ /**
287
+ * Affiliate details for this purchase.
288
+ */
289
+ affiliate?: CarRental.Affiliate;
252
290
 
253
- /**
254
- * Only return charges for the customer specified by this customer ID.
255
- */
256
- customer?: string;
291
+ /**
292
+ * The booking number associated with the car rental.
293
+ */
294
+ booking_number: string;
257
295
 
258
- /**
259
- * Specifies which fields in the response should be expanded.
260
- */
261
- expand?: Array<string>;
296
+ /**
297
+ * Class code of the car.
298
+ */
299
+ car_class_code?: string;
262
300
 
263
- /**
264
- * Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
265
- */
266
- payment_intent?: string;
301
+ /**
302
+ * Make of the car.
303
+ */
304
+ car_make?: string;
267
305
 
268
- /**
269
- * Only return charges for this transfer group, limited to 100.
270
- */
271
- transfer_group?: string;
272
- }
306
+ /**
307
+ * Model of the car.
308
+ */
309
+ car_model?: string;
273
310
 
274
- interface ChargeCaptureParams {
275
- /**
276
- * The amount to capture, which must be less than or equal to the original amount.
277
- */
278
- amount?: number;
311
+ /**
312
+ * The name of the rental car company.
313
+ */
314
+ company?: string;
279
315
 
280
- /**
281
- * An application fee to add on to this charge.
282
- */
283
- application_fee?: number;
316
+ /**
317
+ * The customer service phone number of the car rental company.
318
+ */
319
+ customer_service_phone_number?: string;
284
320
 
285
- /**
286
- * An application fee amount to add on to this charge, which must be less than or equal to the original amount.
287
- */
288
- application_fee_amount?: number;
321
+ /**
322
+ * Number of days the car is being rented.
323
+ */
324
+ days_rented: number;
289
325
 
290
- /**
291
- * Specifies which fields in the response should be expanded.
292
- */
293
- expand?: Array<string>;
326
+ /**
327
+ * Delivery details for this purchase.
328
+ */
329
+ delivery?: CarRental.Delivery;
294
330
 
295
- /**
296
- * The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
297
- */
298
- receipt_email?: string;
331
+ /**
332
+ * The details of the distance traveled during the rental period.
333
+ */
334
+ distance?: CarRental.Distance;
299
335
 
300
- /**
301
- * 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).
302
- *
303
- * 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.
304
- */
305
- statement_descriptor?: string;
336
+ /**
337
+ * The details of the passengers in the travel reservation
338
+ */
339
+ drivers?: Array<CarRental.Driver>;
306
340
 
307
- /**
308
- * 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.
309
- */
310
- statement_descriptor_suffix?: string;
341
+ /**
342
+ * List of additional charges being billed.
343
+ */
344
+ extra_charges?: Array<CarRental.ExtraCharge>;
311
345
 
312
- /**
313
- * 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.
314
- */
315
- transfer_data?: ChargeCaptureParams.TransferData;
346
+ /**
347
+ * Indicates if the customer did not keep nor cancel their booking.
348
+ */
349
+ no_show?: boolean;
316
350
 
317
- /**
318
- * 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.
319
- */
320
- transfer_group?: string;
321
- }
351
+ /**
352
+ * Car pick-up address.
353
+ */
354
+ pickup_address?: Stripe.AddressParam;
355
+
356
+ /**
357
+ * Car pick-up time. Measured in seconds since the Unix epoch.
358
+ */
359
+ pickup_at: number;
360
+
361
+ /**
362
+ * Name of the pickup location.
363
+ */
364
+ pickup_location_name?: string;
365
+
366
+ /**
367
+ * Rental rate.
368
+ */
369
+ rate_amount?: number;
370
+
371
+ /**
372
+ * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
373
+ */
374
+ rate_interval?: CarRental.RateInterval;
375
+
376
+ /**
377
+ * The name of the person or entity renting the car.
378
+ */
379
+ renter_name?: string;
380
+
381
+ /**
382
+ * Car return address.
383
+ */
384
+ return_address?: Stripe.AddressParam;
385
+
386
+ /**
387
+ * Car return time. Measured in seconds since the Unix epoch.
388
+ */
389
+ return_at: number;
390
+
391
+ /**
392
+ * Name of the return location.
393
+ */
394
+ return_location_name?: string;
395
+
396
+ /**
397
+ * Indicates whether the goods or services are tax-exempt or tax is not collected.
398
+ */
399
+ tax_exempt?: boolean;
400
+
401
+ /**
402
+ * The vehicle identification number.
403
+ */
404
+ vehicle_identification_number?: string;
405
+ }
406
+
407
+ namespace CarRental {
408
+ interface Affiliate {
409
+ /**
410
+ * The name of the affiliate that originated the purchase.
411
+ */
412
+ name: string;
413
+ }
414
+
415
+ interface Delivery {
416
+ /**
417
+ * The delivery method for the payment
418
+ */
419
+ mode?: Delivery.Mode;
420
+
421
+ /**
422
+ * Details of the recipient.
423
+ */
424
+ recipient?: Delivery.Recipient;
425
+ }
426
+
427
+ namespace Delivery {
428
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
429
+
430
+ interface Recipient {
431
+ /**
432
+ * The email of the recipient the ticket is delivered to.
433
+ */
434
+ email?: string;
435
+
436
+ /**
437
+ * The name of the recipient the ticket is delivered to.
438
+ */
439
+ name?: string;
440
+
441
+ /**
442
+ * The phone number of the recipient the ticket is delivered to.
443
+ */
444
+ phone?: string;
445
+ }
446
+ }
447
+
448
+ interface Distance {
449
+ /**
450
+ * Distance traveled.
451
+ */
452
+ amount?: number;
453
+
454
+ /**
455
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
456
+ */
457
+ unit?: Distance.Unit;
458
+ }
459
+
460
+ namespace Distance {
461
+ type Unit = 'kilometers' | 'miles';
462
+ }
463
+
464
+ interface Driver {
465
+ /**
466
+ * Driver's identification number.
467
+ */
468
+ driver_identification_number?: string;
469
+
470
+ /**
471
+ * Driver's tax number.
472
+ */
473
+ driver_tax_number?: string;
474
+
475
+ /**
476
+ * Full name of the person or entity on the car reservation.
477
+ */
478
+ name: string;
479
+ }
480
+
481
+ type ExtraCharge =
482
+ | 'extra_mileage'
483
+ | 'gas'
484
+ | 'late_return'
485
+ | 'one_way_service'
486
+ | 'parking_violation';
487
+
488
+ type RateInterval = 'day' | 'month' | 'week';
489
+ }
490
+
491
+ interface CarRentalDatum {
492
+ /**
493
+ * Affiliate (such as travel agency) details for the rental.
494
+ */
495
+ affiliate?: CarRentalDatum.Affiliate;
496
+
497
+ /**
498
+ * Booking confirmation number for the car rental.
499
+ */
500
+ booking_number?: string;
501
+
502
+ /**
503
+ * Name of the car rental company.
504
+ */
505
+ carrier_name?: string;
506
+
507
+ /**
508
+ * Customer service phone number for the car rental company.
509
+ */
510
+ customer_service_phone_number?: string;
511
+
512
+ /**
513
+ * Number of days the car is being rented.
514
+ */
515
+ days_rented?: number;
516
+
517
+ /**
518
+ * Distance details for the rental.
519
+ */
520
+ distance?: CarRentalDatum.Distance;
521
+
522
+ /**
523
+ * List of drivers for the rental.
524
+ */
525
+ drivers?: Array<CarRentalDatum.Driver>;
526
+
527
+ /**
528
+ * Drop-off location details.
529
+ */
530
+ drop_off: CarRentalDatum.DropOff;
531
+
532
+ /**
533
+ * Insurance details for the rental.
534
+ */
535
+ insurances?: Array<CarRentalDatum.Insurance>;
536
+
537
+ /**
538
+ * Indicates if the customer was a no-show.
539
+ */
540
+ no_show_indicator?: boolean;
541
+
542
+ /**
543
+ * Pickup location details.
544
+ */
545
+ pickup: CarRentalDatum.Pickup;
546
+
547
+ /**
548
+ * Name of the person renting the vehicle.
549
+ */
550
+ renter_name?: string;
551
+
552
+ /**
553
+ * Total cost breakdown for the rental.
554
+ */
555
+ total: CarRentalDatum.Total;
556
+
557
+ /**
558
+ * Vehicle details for the rental.
559
+ */
560
+ vehicle?: CarRentalDatum.Vehicle;
561
+ }
562
+
563
+ namespace CarRentalDatum {
564
+ interface Affiliate {
565
+ /**
566
+ * Affiliate partner code.
567
+ */
568
+ code?: string;
569
+
570
+ /**
571
+ * Name of affiliate partner.
572
+ */
573
+ name?: string;
574
+ }
575
+
576
+ interface Distance {
577
+ /**
578
+ * Distance traveled.
579
+ */
580
+ amount: number;
581
+
582
+ /**
583
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
584
+ */
585
+ unit: Distance.Unit;
586
+ }
587
+
588
+ namespace Distance {
589
+ type Unit = 'kilometers' | 'miles';
590
+ }
591
+
592
+ interface Driver {
593
+ /**
594
+ * Driver's date of birth.
595
+ */
596
+ date_of_birth?: Driver.DateOfBirth;
597
+
598
+ /**
599
+ * Driver's identification number.
600
+ */
601
+ driver_identification_number?: string;
602
+
603
+ /**
604
+ * Driver's tax number.
605
+ */
606
+ driver_tax_number?: string;
607
+
608
+ /**
609
+ * Driver's full name.
610
+ */
611
+ name: string;
612
+ }
613
+
614
+ namespace Driver {
615
+ interface DateOfBirth {
616
+ /**
617
+ * Day of birth (1-31).
618
+ */
619
+ day: number;
620
+
621
+ /**
622
+ * Month of birth (1-12).
623
+ */
624
+ month: number;
625
+
626
+ /**
627
+ * Year of birth (must be greater than 1900).
628
+ */
629
+ year: number;
630
+ }
631
+ }
632
+
633
+ interface DropOff {
634
+ /**
635
+ * Address of the rental location.
636
+ */
637
+ address: DropOff.Address;
638
+
639
+ /**
640
+ * Location name.
641
+ */
642
+ location_name?: string;
643
+
644
+ /**
645
+ * Timestamp for the location.
646
+ */
647
+ time: number;
648
+ }
649
+
650
+ namespace DropOff {
651
+ interface Address {
652
+ /**
653
+ * City, district, suburb, town, or village.
654
+ */
655
+ city: string;
656
+
657
+ /**
658
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
659
+ */
660
+ country: string;
661
+
662
+ /**
663
+ * Address line 1, such as the street, PO Box, or company name.
664
+ */
665
+ line1: string;
666
+
667
+ /**
668
+ * Address line 2, such as the apartment, suite, unit, or building.
669
+ */
670
+ line2?: string;
671
+
672
+ /**
673
+ * ZIP or postal code.
674
+ */
675
+ postal_code: string;
676
+
677
+ /**
678
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
679
+ */
680
+ state?: string;
681
+ }
682
+ }
683
+
684
+ interface Insurance {
685
+ /**
686
+ * Amount of the insurance coverage in cents.
687
+ */
688
+ amount: number;
689
+
690
+ /**
691
+ * Currency of the insurance amount.
692
+ */
693
+ currency?: string;
694
+
695
+ /**
696
+ * Name of the insurance company.
697
+ */
698
+ insurance_company_name?: string;
699
+
700
+ /**
701
+ * Type of insurance coverage.
702
+ */
703
+ insurance_type: Insurance.InsuranceType;
704
+ }
705
+
706
+ namespace Insurance {
707
+ type InsuranceType =
708
+ | 'liability_supplement'
709
+ | 'loss_damage_waiver'
710
+ | 'other'
711
+ | 'partial_damage_waiver'
712
+ | 'personal_accident'
713
+ | 'personal_effects';
714
+ }
715
+
716
+ interface Pickup {
717
+ /**
718
+ * Address of the rental location.
719
+ */
720
+ address: Pickup.Address;
721
+
722
+ /**
723
+ * Location name.
724
+ */
725
+ location_name?: string;
726
+
727
+ /**
728
+ * Timestamp for the location.
729
+ */
730
+ time: number;
731
+ }
732
+
733
+ namespace Pickup {
734
+ interface Address {
735
+ /**
736
+ * City, district, suburb, town, or village.
737
+ */
738
+ city: string;
739
+
740
+ /**
741
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
742
+ */
743
+ country: string;
744
+
745
+ /**
746
+ * Address line 1, such as the street, PO Box, or company name.
747
+ */
748
+ line1: string;
749
+
750
+ /**
751
+ * Address line 2, such as the apartment, suite, unit, or building.
752
+ */
753
+ line2?: string;
754
+
755
+ /**
756
+ * ZIP or postal code.
757
+ */
758
+ postal_code: string;
759
+
760
+ /**
761
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
762
+ */
763
+ state?: string;
764
+ }
765
+ }
766
+
767
+ interface Total {
768
+ /**
769
+ * Total amount in cents.
770
+ */
771
+ amount: number;
772
+
773
+ /**
774
+ * Currency of the amount.
775
+ */
776
+ currency?: string;
777
+
778
+ /**
779
+ * Discount details for the rental.
780
+ */
781
+ discounts?: Total.Discounts;
782
+
783
+ /**
784
+ * Additional charges for the rental.
785
+ */
786
+ extra_charges?: Array<Total.ExtraCharge>;
787
+
788
+ /**
789
+ * Rate per unit for the rental.
790
+ */
791
+ rate_per_unit?: number;
792
+
793
+ /**
794
+ * Unit of measurement for the rate.
795
+ */
796
+ rate_unit?: Total.RateUnit;
797
+
798
+ /**
799
+ * Tax breakdown for the rental.
800
+ */
801
+ tax?: Total.Tax;
802
+ }
803
+
804
+ namespace Total {
805
+ interface Discounts {
806
+ /**
807
+ * Corporate client discount code.
808
+ */
809
+ corporate_client_code?: string;
810
+
811
+ /**
812
+ * Coupon code applied to the rental.
813
+ */
814
+ coupon?: string;
815
+
816
+ /**
817
+ * Maximum number of free miles or kilometers included.
818
+ */
819
+ maximum_free_miles_or_kilometers?: number;
820
+ }
821
+
822
+ interface ExtraCharge {
823
+ /**
824
+ * Amount of the extra charge in cents.
825
+ */
826
+ amount: number;
827
+
828
+ /**
829
+ * Type of extra charge.
830
+ */
831
+ type: ExtraCharge.Type;
832
+ }
833
+
834
+ namespace ExtraCharge {
835
+ type Type =
836
+ | 'extra_mileage'
837
+ | 'gas'
838
+ | 'gps'
839
+ | 'late_charge'
840
+ | 'one_way_drop_off'
841
+ | 'other'
842
+ | 'parking'
843
+ | 'phone'
844
+ | 'regular_mileage'
845
+ | 'towing';
846
+ }
847
+
848
+ type RateUnit =
849
+ | 'days'
850
+ | 'kilometers'
851
+ | 'miles'
852
+ | 'months'
853
+ | 'weeks';
854
+
855
+ interface Tax {
856
+ /**
857
+ * Indicates if the transaction is tax exempt.
858
+ */
859
+ tax_exempt_indicator?: boolean;
860
+
861
+ /**
862
+ * Array of tax details.
863
+ */
864
+ taxes?: Array<Tax.Tax>;
865
+ }
866
+
867
+ namespace Tax {
868
+ interface Tax {
869
+ /**
870
+ * Tax amount.
871
+ */
872
+ amount?: number;
873
+
874
+ /**
875
+ * Tax rate applied.
876
+ */
877
+ rate?: number;
878
+
879
+ /**
880
+ * Type of tax applied.
881
+ */
882
+ type?: string;
883
+ }
884
+ }
885
+ }
886
+
887
+ interface Vehicle {
888
+ /**
889
+ * Make of the rental vehicle.
890
+ */
891
+ make?: string;
892
+
893
+ /**
894
+ * Model of the rental vehicle.
895
+ */
896
+ model?: string;
897
+
898
+ /**
899
+ * Odometer reading at the time of rental.
900
+ */
901
+ odometer?: number;
902
+
903
+ /**
904
+ * Type of the rental vehicle.
905
+ */
906
+ type?: Vehicle.Type;
907
+
908
+ /**
909
+ * Class of the rental vehicle.
910
+ */
911
+ vehicle_class?: Vehicle.VehicleClass;
912
+
913
+ /**
914
+ * Vehicle identification number (VIN).
915
+ */
916
+ vehicle_identification_number?: string;
917
+ }
918
+
919
+ namespace Vehicle {
920
+ type Type =
921
+ | 'cargo_van'
922
+ | 'compact'
923
+ | 'economy'
924
+ | 'exotic'
925
+ | 'exotic_suv'
926
+ | 'fifteen_passenger_van'
927
+ | 'four_wheel_drive'
928
+ | 'full_size'
929
+ | 'intermediate'
930
+ | 'large_suv'
931
+ | 'large_truck'
932
+ | 'luxury'
933
+ | 'medium_suv'
934
+ | 'midsize'
935
+ | 'mini'
936
+ | 'minivan'
937
+ | 'miscellaneous'
938
+ | 'moped'
939
+ | 'moving_van'
940
+ | 'premium'
941
+ | 'regular'
942
+ | 'small_medium_truck'
943
+ | 'small_suv'
944
+ | 'special'
945
+ | 'standard'
946
+ | 'stretch'
947
+ | 'subcompact'
948
+ | 'taxi'
949
+ | 'twelve_foot_truck'
950
+ | 'twelve_passenger_van'
951
+ | 'twenty_foot_truck'
952
+ | 'twenty_four_foot_truck'
953
+ | 'twenty_six_foot_truck'
954
+ | 'unique';
955
+
956
+ type VehicleClass =
957
+ | 'business'
958
+ | 'economy'
959
+ | 'first_class'
960
+ | 'premium_economy';
961
+ }
962
+ }
963
+
964
+ interface EventDetails {
965
+ /**
966
+ * Indicates if the tickets are digitally checked when entering the venue.
967
+ */
968
+ access_controlled_venue?: boolean;
969
+
970
+ /**
971
+ * The event location's address.
972
+ */
973
+ address?: Stripe.AddressParam;
974
+
975
+ /**
976
+ * Affiliate details for this purchase.
977
+ */
978
+ affiliate?: EventDetails.Affiliate;
979
+
980
+ /**
981
+ * The name of the company
982
+ */
983
+ company?: string;
984
+
985
+ /**
986
+ * Delivery details for this purchase.
987
+ */
988
+ delivery?: EventDetails.Delivery;
989
+
990
+ /**
991
+ * Event end time. Measured in seconds since the Unix epoch.
992
+ */
993
+ ends_at?: number;
994
+
995
+ /**
996
+ * Type of the event entertainment (concert, sports event etc)
997
+ */
998
+ genre?: string;
999
+
1000
+ /**
1001
+ * The name of the event.
1002
+ */
1003
+ name: string;
1004
+
1005
+ /**
1006
+ * Event start time. Measured in seconds since the Unix epoch.
1007
+ */
1008
+ starts_at?: number;
1009
+ }
1010
+
1011
+ namespace EventDetails {
1012
+ interface Affiliate {
1013
+ /**
1014
+ * The name of the affiliate that originated the purchase.
1015
+ */
1016
+ name: string;
1017
+ }
1018
+
1019
+ interface Delivery {
1020
+ /**
1021
+ * The delivery method for the payment
1022
+ */
1023
+ mode?: Delivery.Mode;
1024
+
1025
+ /**
1026
+ * Details of the recipient.
1027
+ */
1028
+ recipient?: Delivery.Recipient;
1029
+ }
1030
+
1031
+ namespace Delivery {
1032
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
1033
+
1034
+ interface Recipient {
1035
+ /**
1036
+ * The email of the recipient the ticket is delivered to.
1037
+ */
1038
+ email?: string;
1039
+
1040
+ /**
1041
+ * The name of the recipient the ticket is delivered to.
1042
+ */
1043
+ name?: string;
1044
+
1045
+ /**
1046
+ * The phone number of the recipient the ticket is delivered to.
1047
+ */
1048
+ phone?: string;
1049
+ }
1050
+ }
1051
+ }
1052
+
1053
+ interface Flight {
1054
+ /**
1055
+ * Affiliate details for this purchase.
1056
+ */
1057
+ affiliate?: Flight.Affiliate;
1058
+
1059
+ /**
1060
+ * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
1061
+ */
1062
+ agency_number?: string;
1063
+
1064
+ /**
1065
+ * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
1066
+ */
1067
+ carrier?: string;
1068
+
1069
+ /**
1070
+ * Delivery details for this purchase.
1071
+ */
1072
+ delivery?: Flight.Delivery;
1073
+
1074
+ /**
1075
+ * The name of the person or entity on the reservation.
1076
+ */
1077
+ passenger_name?: string;
1078
+
1079
+ /**
1080
+ * The details of the passengers in the travel reservation.
1081
+ */
1082
+ passengers?: Array<Flight.Passenger>;
1083
+
1084
+ /**
1085
+ * The individual flight segments associated with the trip.
1086
+ */
1087
+ segments: Array<Flight.Segment>;
1088
+
1089
+ /**
1090
+ * The ticket number associated with the travel reservation.
1091
+ */
1092
+ ticket_number?: string;
1093
+ }
1094
+
1095
+ namespace Flight {
1096
+ interface Affiliate {
1097
+ /**
1098
+ * The name of the affiliate that originated the purchase.
1099
+ */
1100
+ name: string;
1101
+ }
1102
+
1103
+ interface Delivery {
1104
+ /**
1105
+ * The delivery method for the payment
1106
+ */
1107
+ mode?: Delivery.Mode;
1108
+
1109
+ /**
1110
+ * Details of the recipient.
1111
+ */
1112
+ recipient?: Delivery.Recipient;
1113
+ }
1114
+
1115
+ namespace Delivery {
1116
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
1117
+
1118
+ interface Recipient {
1119
+ /**
1120
+ * The email of the recipient the ticket is delivered to.
1121
+ */
1122
+ email?: string;
1123
+
1124
+ /**
1125
+ * The name of the recipient the ticket is delivered to.
1126
+ */
1127
+ name?: string;
1128
+
1129
+ /**
1130
+ * The phone number of the recipient the ticket is delivered to.
1131
+ */
1132
+ phone?: string;
1133
+ }
1134
+ }
1135
+
1136
+ interface Passenger {
1137
+ /**
1138
+ * Full name of the person or entity on the flight reservation.
1139
+ */
1140
+ name: string;
1141
+ }
1142
+
1143
+ interface Segment {
1144
+ /**
1145
+ * The flight segment amount.
1146
+ */
1147
+ amount?: number;
1148
+
1149
+ /**
1150
+ * The International Air Transport Association (IATA) airport code for the arrival airport.
1151
+ */
1152
+ arrival_airport?: string;
1153
+
1154
+ /**
1155
+ * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
1156
+ */
1157
+ arrives_at?: number;
1158
+
1159
+ /**
1160
+ * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
1161
+ */
1162
+ carrier?: string;
1163
+
1164
+ /**
1165
+ * The departure time for the flight segment. Measured in seconds since the Unix epoch.
1166
+ */
1167
+ departs_at: number;
1168
+
1169
+ /**
1170
+ * The International Air Transport Association (IATA) airport code for the departure airport.
1171
+ */
1172
+ departure_airport?: string;
1173
+
1174
+ /**
1175
+ * The flight number associated with the segment
1176
+ */
1177
+ flight_number?: string;
1178
+
1179
+ /**
1180
+ * The fare class for the segment.
1181
+ */
1182
+ service_class?: Segment.ServiceClass;
1183
+ }
1184
+
1185
+ namespace Segment {
1186
+ type ServiceClass =
1187
+ | 'business'
1188
+ | 'economy'
1189
+ | 'first'
1190
+ | 'premium_economy';
1191
+ }
1192
+ }
1193
+
1194
+ interface FlightDatum {
1195
+ /**
1196
+ * Affiliate details if applicable.
1197
+ */
1198
+ affiliate?: FlightDatum.Affiliate;
1199
+
1200
+ /**
1201
+ * Reservation reference.
1202
+ */
1203
+ booking_number?: string;
1204
+
1205
+ /**
1206
+ * Computerized reservation system used to make the reservation and purchase the ticket.
1207
+ */
1208
+ computerized_reservation_system?: string;
1209
+
1210
+ /**
1211
+ * Ticket restrictions.
1212
+ */
1213
+ endorsements_and_restrictions?: string;
1214
+
1215
+ /**
1216
+ * List of insurances.
1217
+ */
1218
+ insurances?: Array<FlightDatum.Insurance>;
1219
+
1220
+ /**
1221
+ * List of passengers.
1222
+ */
1223
+ passengers?: Array<FlightDatum.Passenger>;
1224
+
1225
+ /**
1226
+ * List of flight segments.
1227
+ */
1228
+ segments: Array<FlightDatum.Segment>;
1229
+
1230
+ /**
1231
+ * Electronic ticket indicator.
1232
+ */
1233
+ ticket_electronically_issued_indicator?: boolean;
1234
+
1235
+ /**
1236
+ * Total cost breakdown.
1237
+ */
1238
+ total: FlightDatum.Total;
1239
+
1240
+ /**
1241
+ * Type of flight transaction.
1242
+ */
1243
+ transaction_type?: FlightDatum.TransactionType;
1244
+ }
1245
+
1246
+ namespace FlightDatum {
1247
+ interface Affiliate {
1248
+ /**
1249
+ * Affiliate partner code.
1250
+ */
1251
+ code?: string;
1252
+
1253
+ /**
1254
+ * Name of affiliate partner.
1255
+ */
1256
+ name?: string;
1257
+
1258
+ /**
1259
+ * Code provided by the company to a travel agent authorizing ticket issuance.
1260
+ */
1261
+ travel_authorization_code?: string;
1262
+ }
1263
+
1264
+ interface Insurance {
1265
+ /**
1266
+ * Insurance cost.
1267
+ */
1268
+ amount: number;
1269
+
1270
+ /**
1271
+ * Insurance currency.
1272
+ */
1273
+ currency?: string;
1274
+
1275
+ /**
1276
+ * Insurance company name.
1277
+ */
1278
+ insurance_company_name?: string;
1279
+
1280
+ /**
1281
+ * Type of insurance.
1282
+ */
1283
+ insurance_type: Insurance.InsuranceType;
1284
+ }
1285
+
1286
+ namespace Insurance {
1287
+ type InsuranceType =
1288
+ | 'baggage'
1289
+ | 'bankruptcy'
1290
+ | 'cancelation'
1291
+ | 'emergency'
1292
+ | 'medical';
1293
+ }
1294
+
1295
+ interface Passenger {
1296
+ /**
1297
+ * Passenger's full name.
1298
+ */
1299
+ name: string;
1300
+ }
1301
+
1302
+ interface Segment {
1303
+ /**
1304
+ * Segment fare amount.
1305
+ */
1306
+ amount?: number;
1307
+
1308
+ /**
1309
+ * Arrival details.
1310
+ */
1311
+ arrival: Segment.Arrival;
1312
+
1313
+ /**
1314
+ * Airline carrier code.
1315
+ */
1316
+ carrier_code: string;
1317
+
1318
+ /**
1319
+ * Carrier name.
1320
+ */
1321
+ carrier_name?: string;
1322
+
1323
+ /**
1324
+ * Segment currency.
1325
+ */
1326
+ currency?: string;
1327
+
1328
+ /**
1329
+ * Departure details.
1330
+ */
1331
+ departure: Segment.Departure;
1332
+
1333
+ /**
1334
+ * Exchange ticket number.
1335
+ */
1336
+ exchange_ticket_number?: string;
1337
+
1338
+ /**
1339
+ * Fare basis code.
1340
+ */
1341
+ fare_basis_code?: string;
1342
+
1343
+ /**
1344
+ * Additional fees.
1345
+ */
1346
+ fees?: number;
1347
+
1348
+ /**
1349
+ * Flight number.
1350
+ */
1351
+ flight_number?: string;
1352
+
1353
+ /**
1354
+ * Stopover indicator.
1355
+ */
1356
+ is_stop_over_indicator?: boolean;
1357
+
1358
+ /**
1359
+ * Refundable ticket indicator.
1360
+ */
1361
+ refundable?: boolean;
1362
+
1363
+ /**
1364
+ * Class of service.
1365
+ */
1366
+ service_class: Segment.ServiceClass;
1367
+
1368
+ /**
1369
+ * Tax amount for segment.
1370
+ */
1371
+ tax_amount?: number;
1372
+
1373
+ /**
1374
+ * Ticket number.
1375
+ */
1376
+ ticket_number?: string;
1377
+ }
1378
+
1379
+ namespace Segment {
1380
+ interface Arrival {
1381
+ /**
1382
+ * Arrival airport IATA code.
1383
+ */
1384
+ airport: string;
1385
+
1386
+ /**
1387
+ * Arrival date/time.
1388
+ */
1389
+ arrives_at?: number;
1390
+
1391
+ /**
1392
+ * Arrival city.
1393
+ */
1394
+ city?: string;
1395
+
1396
+ /**
1397
+ * Arrival country.
1398
+ */
1399
+ country?: string;
1400
+ }
1401
+
1402
+ interface Departure {
1403
+ /**
1404
+ * Departure airport IATA code.
1405
+ */
1406
+ airport: string;
1407
+
1408
+ /**
1409
+ * Departure city.
1410
+ */
1411
+ city?: string;
1412
+
1413
+ /**
1414
+ * Departure country.
1415
+ */
1416
+ country?: string;
1417
+
1418
+ /**
1419
+ * Departure date/time.
1420
+ */
1421
+ departs_at: number;
1422
+ }
1423
+
1424
+ type ServiceClass =
1425
+ | 'business'
1426
+ | 'economy'
1427
+ | 'first_class'
1428
+ | 'premium_economy';
1429
+ }
1430
+
1431
+ interface Total {
1432
+ /**
1433
+ * Total flight amount.
1434
+ */
1435
+ amount: number;
1436
+
1437
+ /**
1438
+ * Reason for credit.
1439
+ */
1440
+ credit_reason?: Total.CreditReason;
1441
+
1442
+ /**
1443
+ * Total currency.
1444
+ */
1445
+ currency?: string;
1446
+
1447
+ /**
1448
+ * Discount details.
1449
+ */
1450
+ discounts?: Total.Discounts;
1451
+
1452
+ /**
1453
+ * Additional charges.
1454
+ */
1455
+ extra_charges?: Array<Total.ExtraCharge>;
1456
+
1457
+ /**
1458
+ * Tax breakdown.
1459
+ */
1460
+ tax?: Total.Tax;
1461
+ }
1462
+
1463
+ namespace Total {
1464
+ type CreditReason =
1465
+ | 'other'
1466
+ | 'partial_ticket_refund'
1467
+ | 'passenger_transport_ancillary_cancellation'
1468
+ | 'ticket_and_ancillary_cancellation'
1469
+ | 'ticket_cancellation';
1470
+
1471
+ interface Discounts {
1472
+ /**
1473
+ * Corporate client discount code.
1474
+ */
1475
+ corporate_client_code?: string;
1476
+ }
1477
+
1478
+ interface ExtraCharge {
1479
+ /**
1480
+ * Amount of additional charges.
1481
+ */
1482
+ amount?: number;
1483
+
1484
+ /**
1485
+ * Type of additional charges.
1486
+ */
1487
+ type?: ExtraCharge.Type;
1488
+ }
1489
+
1490
+ namespace ExtraCharge {
1491
+ type Type =
1492
+ | 'additional_fees'
1493
+ | 'ancillary_service_charges'
1494
+ | 'exchange_fee';
1495
+ }
1496
+
1497
+ interface Tax {
1498
+ /**
1499
+ * Array of tax details.
1500
+ */
1501
+ taxes?: Array<Tax.Tax>;
1502
+ }
1503
+
1504
+ namespace Tax {
1505
+ interface Tax {
1506
+ /**
1507
+ * Tax amount.
1508
+ */
1509
+ amount?: number;
1510
+
1511
+ /**
1512
+ * Tax rate.
1513
+ */
1514
+ rate?: number;
1515
+
1516
+ /**
1517
+ * Type of tax.
1518
+ */
1519
+ type?: string;
1520
+ }
1521
+ }
1522
+ }
1523
+
1524
+ type TransactionType =
1525
+ | 'exchange_ticket'
1526
+ | 'miscellaneous'
1527
+ | 'refund'
1528
+ | 'ticket_purchase';
1529
+ }
1530
+
1531
+ interface Lodging {
1532
+ /**
1533
+ * The lodging location's address.
1534
+ */
1535
+ address?: Stripe.AddressParam;
1536
+
1537
+ /**
1538
+ * The number of adults on the booking
1539
+ */
1540
+ adults?: number;
1541
+
1542
+ /**
1543
+ * Affiliate details for this purchase.
1544
+ */
1545
+ affiliate?: Lodging.Affiliate;
1546
+
1547
+ /**
1548
+ * The booking number associated with the lodging reservation.
1549
+ */
1550
+ booking_number?: string;
1551
+
1552
+ /**
1553
+ * The lodging category
1554
+ */
1555
+ category?: Lodging.Category;
1556
+
1557
+ /**
1558
+ * Lodging check-in time. Measured in seconds since the Unix epoch.
1559
+ */
1560
+ checkin_at: number;
1561
+
1562
+ /**
1563
+ * Lodging check-out time. Measured in seconds since the Unix epoch.
1564
+ */
1565
+ checkout_at: number;
1566
+
1567
+ /**
1568
+ * The customer service phone number of the lodging company.
1569
+ */
1570
+ customer_service_phone_number?: string;
1571
+
1572
+ /**
1573
+ * The daily lodging room rate.
1574
+ */
1575
+ daily_room_rate_amount?: number;
1576
+
1577
+ /**
1578
+ * Delivery details for this purchase.
1579
+ */
1580
+ delivery?: Lodging.Delivery;
1581
+
1582
+ /**
1583
+ * List of additional charges being billed.
1584
+ */
1585
+ extra_charges?: Array<Lodging.ExtraCharge>;
1586
+
1587
+ /**
1588
+ * Indicates whether the lodging location is compliant with the Fire Safety Act.
1589
+ */
1590
+ fire_safety_act_compliance?: boolean;
1591
+
1592
+ /**
1593
+ * The name of the lodging location.
1594
+ */
1595
+ name?: string;
1596
+
1597
+ /**
1598
+ * Indicates if the customer did not keep their booking while failing to cancel the reservation.
1599
+ */
1600
+ no_show?: boolean;
1601
+
1602
+ /**
1603
+ * The number of rooms on the booking
1604
+ */
1605
+ number_of_rooms?: number;
1606
+
1607
+ /**
1608
+ * The details of the passengers in the travel reservation
1609
+ */
1610
+ passengers?: Array<Lodging.Passenger>;
1611
+
1612
+ /**
1613
+ * The phone number of the lodging location.
1614
+ */
1615
+ property_phone_number?: string;
1616
+
1617
+ /**
1618
+ * The room class for this purchase.
1619
+ */
1620
+ room_class?: string;
1621
+
1622
+ /**
1623
+ * The number of room nights
1624
+ */
1625
+ room_nights?: number;
1626
+
1627
+ /**
1628
+ * The total tax amount associating with the room reservation.
1629
+ */
1630
+ total_room_tax_amount?: number;
1631
+
1632
+ /**
1633
+ * The total tax amount
1634
+ */
1635
+ total_tax_amount?: number;
1636
+ }
1637
+
1638
+ namespace Lodging {
1639
+ interface Affiliate {
1640
+ /**
1641
+ * The name of the affiliate that originated the purchase.
1642
+ */
1643
+ name: string;
1644
+ }
1645
+
1646
+ type Category = 'hotel' | 'vacation_rental';
1647
+
1648
+ interface Delivery {
1649
+ /**
1650
+ * The delivery method for the payment
1651
+ */
1652
+ mode?: Delivery.Mode;
1653
+
1654
+ /**
1655
+ * Details of the recipient.
1656
+ */
1657
+ recipient?: Delivery.Recipient;
1658
+ }
1659
+
1660
+ namespace Delivery {
1661
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
1662
+
1663
+ interface Recipient {
1664
+ /**
1665
+ * The email of the recipient the ticket is delivered to.
1666
+ */
1667
+ email?: string;
1668
+
1669
+ /**
1670
+ * The name of the recipient the ticket is delivered to.
1671
+ */
1672
+ name?: string;
1673
+
1674
+ /**
1675
+ * The phone number of the recipient the ticket is delivered to.
1676
+ */
1677
+ phone?: string;
1678
+ }
1679
+ }
1680
+
1681
+ type ExtraCharge =
1682
+ | 'gift_shop'
1683
+ | 'laundry'
1684
+ | 'mini_bar'
1685
+ | 'other'
1686
+ | 'restaurant'
1687
+ | 'telephone';
1688
+
1689
+ interface Passenger {
1690
+ /**
1691
+ * Full name of the person or entity on the lodging reservation.
1692
+ */
1693
+ name: string;
1694
+ }
1695
+ }
1696
+
1697
+ interface LodgingDatum {
1698
+ /**
1699
+ * Accommodation details for the lodging.
1700
+ */
1701
+ accommodation?: LodgingDatum.Accommodation;
1702
+
1703
+ /**
1704
+ * Affiliate details if applicable.
1705
+ */
1706
+ affiliate?: LodgingDatum.Affiliate;
1707
+
1708
+ /**
1709
+ * Booking confirmation number for the lodging.
1710
+ */
1711
+ booking_number?: string;
1712
+
1713
+ /**
1714
+ * Check-in date.
1715
+ */
1716
+ checkin_at: number;
1717
+
1718
+ /**
1719
+ * Check-out date.
1720
+ */
1721
+ checkout_at: number;
1722
+
1723
+ /**
1724
+ * Customer service phone number for the lodging company.
1725
+ */
1726
+ customer_service_phone_number?: string;
1727
+
1728
+ /**
1729
+ * Whether the lodging is compliant with any hotel fire safety regulations.
1730
+ */
1731
+ fire_safety_act_compliance_indicator?: boolean;
1732
+
1733
+ /**
1734
+ * List of guests for the lodging.
1735
+ */
1736
+ guests?: Array<LodgingDatum.Guest>;
1737
+
1738
+ /**
1739
+ * Host details for the lodging.
1740
+ */
1741
+ host?: LodgingDatum.Host;
1742
+
1743
+ /**
1744
+ * List of insurances for the lodging.
1745
+ */
1746
+ insurances?: Array<LodgingDatum.Insurance>;
1747
+
1748
+ /**
1749
+ * Whether the renter is a no-show.
1750
+ */
1751
+ no_show_indicator?: boolean;
1752
+
1753
+ /**
1754
+ * Renter ID number for the lodging.
1755
+ */
1756
+ renter_id_number?: string;
1757
+
1758
+ /**
1759
+ * Renter name for the lodging.
1760
+ */
1761
+ renter_name?: string;
1762
+
1763
+ /**
1764
+ * Total details for the lodging.
1765
+ */
1766
+ total: LodgingDatum.Total;
1767
+ }
1768
+
1769
+ namespace LodgingDatum {
1770
+ interface Accommodation {
1771
+ /**
1772
+ * Type of accommodation.
1773
+ */
1774
+ accommodation_type?: Accommodation.AccommodationType;
1775
+
1776
+ /**
1777
+ * Bed type.
1778
+ */
1779
+ bed_type?: string;
1780
+
1781
+ /**
1782
+ * Daily accommodation rate in cents.
1783
+ */
1784
+ daily_rate_amount?: number;
1785
+
1786
+ /**
1787
+ * Number of nights.
1788
+ */
1789
+ nights?: number;
1790
+
1791
+ /**
1792
+ * Number of rooms, cabanas, apartments, and so on.
1793
+ */
1794
+ number_of_rooms?: number;
1795
+
1796
+ /**
1797
+ * Rate type.
1798
+ */
1799
+ rate_type?: string;
1800
+
1801
+ /**
1802
+ * Whether smoking is allowed.
1803
+ */
1804
+ smoking_indicator?: boolean;
1805
+ }
1806
+
1807
+ namespace Accommodation {
1808
+ type AccommodationType =
1809
+ | 'apartment'
1810
+ | 'cabana'
1811
+ | 'house'
1812
+ | 'penthouse'
1813
+ | 'room'
1814
+ | 'standard'
1815
+ | 'suite'
1816
+ | 'villa';
1817
+ }
1818
+
1819
+ interface Affiliate {
1820
+ /**
1821
+ * Affiliate partner code.
1822
+ */
1823
+ code?: string;
1824
+
1825
+ /**
1826
+ * Affiliate partner name.
1827
+ */
1828
+ name?: string;
1829
+ }
1830
+
1831
+ interface Guest {
1832
+ /**
1833
+ * Guest's full name.
1834
+ */
1835
+ name: string;
1836
+ }
1837
+
1838
+ interface Host {
1839
+ /**
1840
+ * Address of the host.
1841
+ */
1842
+ address?: Host.Address;
1843
+
1844
+ /**
1845
+ * Host's country of domicile.
1846
+ */
1847
+ country_of_domicile?: string;
1848
+
1849
+ /**
1850
+ * Reference number for the host.
1851
+ */
1852
+ host_reference?: string;
1853
+
1854
+ /**
1855
+ * Type of host.
1856
+ */
1857
+ host_type?: Host.HostType;
1858
+
1859
+ /**
1860
+ * Name of the lodging property or host.
1861
+ */
1862
+ name?: string;
1863
+
1864
+ /**
1865
+ * Total number of reservations for the host.
1866
+ */
1867
+ number_of_reservations?: number;
1868
+
1869
+ /**
1870
+ * Property phone number.
1871
+ */
1872
+ property_phone_number?: string;
1873
+
1874
+ /**
1875
+ * Host's registration date.
1876
+ */
1877
+ registered_at?: number;
1878
+ }
1879
+
1880
+ namespace Host {
1881
+ interface Address {
1882
+ /**
1883
+ * City, district, suburb, town, or village.
1884
+ */
1885
+ city: string;
1886
+
1887
+ /**
1888
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1889
+ */
1890
+ country: string;
1891
+
1892
+ /**
1893
+ * Address line 1, such as the street, PO Box, or company name.
1894
+ */
1895
+ line1: string;
1896
+
1897
+ /**
1898
+ * Address line 2, such as the apartment, suite, unit, or building.
1899
+ */
1900
+ line2?: string;
1901
+
1902
+ /**
1903
+ * ZIP or postal code.
1904
+ */
1905
+ postal_code: string;
1906
+
1907
+ /**
1908
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
1909
+ */
1910
+ state?: string;
1911
+ }
1912
+
1913
+ type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
1914
+ }
1915
+
1916
+ interface Insurance {
1917
+ /**
1918
+ * Price of the insurance coverage in cents.
1919
+ */
1920
+ amount: number;
1921
+
1922
+ /**
1923
+ * Currency of the insurance amount.
1924
+ */
1925
+ currency?: string;
1926
+
1927
+ /**
1928
+ * Name of the insurance company.
1929
+ */
1930
+ insurance_company_name?: string;
1931
+
1932
+ /**
1933
+ * Type of insurance coverage.
1934
+ */
1935
+ insurance_type: Insurance.InsuranceType;
1936
+ }
1937
+
1938
+ namespace Insurance {
1939
+ type InsuranceType =
1940
+ | 'bankruptcy'
1941
+ | 'cancelation'
1942
+ | 'emergency'
1943
+ | 'medical';
1944
+ }
1945
+
1946
+ interface Total {
1947
+ /**
1948
+ * Total price of the lodging reservation in cents.
1949
+ */
1950
+ amount: number;
1951
+
1952
+ /**
1953
+ * Cash advances in cents.
1954
+ */
1955
+ cash_advances?: number;
1956
+
1957
+ /**
1958
+ * Currency of the total amount.
1959
+ */
1960
+ currency?: string;
1961
+
1962
+ /**
1963
+ * Discount details for the lodging.
1964
+ */
1965
+ discounts?: Total.Discounts;
1966
+
1967
+ /**
1968
+ * Additional charges for the lodging.
1969
+ */
1970
+ extra_charges?: Array<Total.ExtraCharge>;
1971
+
1972
+ /**
1973
+ * Prepaid amount in cents.
1974
+ */
1975
+ prepaid_amount?: number;
1976
+
1977
+ /**
1978
+ * Tax breakdown for the lodging reservation.
1979
+ */
1980
+ tax?: Total.Tax;
1981
+ }
1982
+
1983
+ namespace Total {
1984
+ interface Discounts {
1985
+ /**
1986
+ * Corporate client discount code.
1987
+ */
1988
+ corporate_client_code?: string;
1989
+
1990
+ /**
1991
+ * Coupon code.
1992
+ */
1993
+ coupon?: string;
1994
+ }
1995
+
1996
+ interface ExtraCharge {
1997
+ /**
1998
+ * Amount of the extra charge in cents.
1999
+ */
2000
+ amount?: number;
2001
+
2002
+ /**
2003
+ * Type of extra charge.
2004
+ */
2005
+ type?: ExtraCharge.Type;
2006
+ }
2007
+
2008
+ namespace ExtraCharge {
2009
+ type Type =
2010
+ | 'gift_shop'
2011
+ | 'laundry'
2012
+ | 'mini_bar'
2013
+ | 'other'
2014
+ | 'phone'
2015
+ | 'restaurant';
2016
+ }
2017
+
2018
+ interface Tax {
2019
+ /**
2020
+ * Indicates whether the transaction is tax exempt.
2021
+ */
2022
+ tax_exempt_indicator?: boolean;
2023
+
2024
+ /**
2025
+ * Tax details.
2026
+ */
2027
+ taxes?: Array<Tax.Tax>;
2028
+ }
2029
+
2030
+ namespace Tax {
2031
+ interface Tax {
2032
+ /**
2033
+ * Tax amount in cents.
2034
+ */
2035
+ amount?: number;
2036
+
2037
+ /**
2038
+ * Tax rate.
2039
+ */
2040
+ rate?: number;
2041
+
2042
+ /**
2043
+ * Type of tax applied.
2044
+ */
2045
+ type?: string;
2046
+ }
2047
+ }
2048
+ }
2049
+ }
2050
+
2051
+ interface Subscription {
2052
+ /**
2053
+ * Affiliate details for this purchase.
2054
+ */
2055
+ affiliate?: Subscription.Affiliate;
2056
+
2057
+ /**
2058
+ * Info whether the subscription will be auto renewed upon expiry.
2059
+ */
2060
+ auto_renewal?: boolean;
2061
+
2062
+ /**
2063
+ * Subscription billing details for this purchase.
2064
+ */
2065
+ billing_interval?: Subscription.BillingInterval;
2066
+
2067
+ /**
2068
+ * Subscription end time. Measured in seconds since the Unix epoch.
2069
+ */
2070
+ ends_at?: number;
2071
+
2072
+ /**
2073
+ * Name of the product on subscription. e.g. Apple Music Subscription
2074
+ */
2075
+ name: string;
2076
+
2077
+ /**
2078
+ * Subscription start time. Measured in seconds since the Unix epoch.
2079
+ */
2080
+ starts_at?: number;
2081
+ }
2082
+
2083
+ namespace Subscription {
2084
+ interface Affiliate {
2085
+ /**
2086
+ * The name of the affiliate that originated the purchase.
2087
+ */
2088
+ name: string;
2089
+ }
2090
+
2091
+ interface BillingInterval {
2092
+ /**
2093
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2094
+ */
2095
+ count: number;
2096
+
2097
+ /**
2098
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2099
+ */
2100
+ interval: BillingInterval.Interval;
2101
+ }
2102
+
2103
+ namespace BillingInterval {
2104
+ type Interval = 'day' | 'month' | 'week' | 'year';
2105
+ }
2106
+ }
2107
+ }
2108
+
2109
+ interface Shipping {
2110
+ /**
2111
+ * Shipping address.
2112
+ */
2113
+ address: Stripe.AddressParam;
2114
+
2115
+ /**
2116
+ * The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2117
+ */
2118
+ carrier?: string;
2119
+
2120
+ /**
2121
+ * Recipient name.
2122
+ */
2123
+ name: string;
2124
+
2125
+ /**
2126
+ * Recipient phone (including extension).
2127
+ */
2128
+ phone?: string;
2129
+
2130
+ /**
2131
+ * The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
2132
+ */
2133
+ tracking_number?: string;
2134
+ }
2135
+ }
2136
+
2137
+ interface ChargeListParams extends PaginationParams {
2138
+ /**
2139
+ * Only return charges that were created during the given date interval.
2140
+ */
2141
+ created?: Stripe.RangeQueryParam | number;
2142
+
2143
+ /**
2144
+ * Only return charges for the customer specified by this customer ID.
2145
+ */
2146
+ customer?: string;
2147
+
2148
+ /**
2149
+ * Specifies which fields in the response should be expanded.
2150
+ */
2151
+ expand?: Array<string>;
2152
+
2153
+ /**
2154
+ * Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
2155
+ */
2156
+ payment_intent?: string;
2157
+
2158
+ /**
2159
+ * Only return charges for this transfer group, limited to 100.
2160
+ */
2161
+ transfer_group?: string;
2162
+ }
2163
+
2164
+ interface ChargeCaptureParams {
2165
+ /**
2166
+ * The amount to capture, which must be less than or equal to the original amount.
2167
+ */
2168
+ amount?: number;
2169
+
2170
+ /**
2171
+ * An application fee to add on to this charge.
2172
+ */
2173
+ application_fee?: number;
2174
+
2175
+ /**
2176
+ * An application fee amount to add on to this charge, which must be less than or equal to the original amount.
2177
+ */
2178
+ application_fee_amount?: number;
2179
+
2180
+ /**
2181
+ * Specifies which fields in the response should be expanded.
2182
+ */
2183
+ expand?: Array<string>;
2184
+
2185
+ /**
2186
+ * Provides industry-specific information about the charge.
2187
+ */
2188
+ payment_details?: ChargeCaptureParams.PaymentDetails;
2189
+
2190
+ /**
2191
+ * 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.
2192
+ */
2193
+ receipt_email?: string;
2194
+
2195
+ /**
2196
+ * 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).
2197
+ *
2198
+ * 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.
2199
+ */
2200
+ statement_descriptor?: string;
2201
+
2202
+ /**
2203
+ * 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.
2204
+ */
2205
+ statement_descriptor_suffix?: string;
2206
+
2207
+ /**
2208
+ * 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.
2209
+ */
2210
+ transfer_data?: ChargeCaptureParams.TransferData;
2211
+
2212
+ /**
2213
+ * 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.
2214
+ */
2215
+ transfer_group?: string;
2216
+ }
2217
+
2218
+ namespace ChargeCaptureParams {
2219
+ interface PaymentDetails {
2220
+ /**
2221
+ * Car rental details for this PaymentIntent.
2222
+ */
2223
+ car_rental?: PaymentDetails.CarRental;
2224
+
2225
+ /**
2226
+ * Car rental data for this PaymentIntent.
2227
+ */
2228
+ car_rental_data?: Stripe.Emptyable<
2229
+ Array<PaymentDetails.CarRentalDatum>
2230
+ >;
2231
+
2232
+ /**
2233
+ * A unique value to identify the customer. This field is available only for card payments.
2234
+ *
2235
+ * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
2236
+ */
2237
+ customer_reference?: Stripe.Emptyable<string>;
2238
+
2239
+ /**
2240
+ * Event details for this PaymentIntent
2241
+ */
2242
+ event_details?: PaymentDetails.EventDetails;
2243
+
2244
+ /**
2245
+ * Flight reservation details for this PaymentIntent
2246
+ */
2247
+ flight?: PaymentDetails.Flight;
2248
+
2249
+ /**
2250
+ * Flight data for this PaymentIntent.
2251
+ */
2252
+ flight_data?: Stripe.Emptyable<Array<PaymentDetails.FlightDatum>>;
2253
+
2254
+ /**
2255
+ * Lodging reservation details for this PaymentIntent
2256
+ */
2257
+ lodging?: PaymentDetails.Lodging;
2258
+
2259
+ /**
2260
+ * Lodging data for this PaymentIntent.
2261
+ */
2262
+ lodging_data?: Stripe.Emptyable<Array<PaymentDetails.LodgingDatum>>;
2263
+
2264
+ /**
2265
+ * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
2266
+ *
2267
+ * Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
2268
+ *
2269
+ * 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.
2270
+ */
2271
+ order_reference?: Stripe.Emptyable<string>;
2272
+
2273
+ /**
2274
+ * Subscription details for this PaymentIntent
2275
+ */
2276
+ subscription?: PaymentDetails.Subscription;
2277
+ }
2278
+
2279
+ namespace PaymentDetails {
2280
+ interface CarRental {
2281
+ /**
2282
+ * Affiliate details for this purchase.
2283
+ */
2284
+ affiliate?: CarRental.Affiliate;
2285
+
2286
+ /**
2287
+ * The booking number associated with the car rental.
2288
+ */
2289
+ booking_number: string;
2290
+
2291
+ /**
2292
+ * Class code of the car.
2293
+ */
2294
+ car_class_code?: string;
2295
+
2296
+ /**
2297
+ * Make of the car.
2298
+ */
2299
+ car_make?: string;
2300
+
2301
+ /**
2302
+ * Model of the car.
2303
+ */
2304
+ car_model?: string;
2305
+
2306
+ /**
2307
+ * The name of the rental car company.
2308
+ */
2309
+ company?: string;
2310
+
2311
+ /**
2312
+ * The customer service phone number of the car rental company.
2313
+ */
2314
+ customer_service_phone_number?: string;
2315
+
2316
+ /**
2317
+ * Number of days the car is being rented.
2318
+ */
2319
+ days_rented: number;
2320
+
2321
+ /**
2322
+ * Delivery details for this purchase.
2323
+ */
2324
+ delivery?: CarRental.Delivery;
2325
+
2326
+ /**
2327
+ * The details of the distance traveled during the rental period.
2328
+ */
2329
+ distance?: CarRental.Distance;
2330
+
2331
+ /**
2332
+ * The details of the passengers in the travel reservation
2333
+ */
2334
+ drivers?: Array<CarRental.Driver>;
2335
+
2336
+ /**
2337
+ * List of additional charges being billed.
2338
+ */
2339
+ extra_charges?: Array<CarRental.ExtraCharge>;
2340
+
2341
+ /**
2342
+ * Indicates if the customer did not keep nor cancel their booking.
2343
+ */
2344
+ no_show?: boolean;
2345
+
2346
+ /**
2347
+ * Car pick-up address.
2348
+ */
2349
+ pickup_address?: Stripe.AddressParam;
2350
+
2351
+ /**
2352
+ * Car pick-up time. Measured in seconds since the Unix epoch.
2353
+ */
2354
+ pickup_at: number;
2355
+
2356
+ /**
2357
+ * Name of the pickup location.
2358
+ */
2359
+ pickup_location_name?: string;
2360
+
2361
+ /**
2362
+ * Rental rate.
2363
+ */
2364
+ rate_amount?: number;
2365
+
2366
+ /**
2367
+ * The frequency at which the rate amount is applied. One of `day`, `week` or `month`
2368
+ */
2369
+ rate_interval?: CarRental.RateInterval;
2370
+
2371
+ /**
2372
+ * The name of the person or entity renting the car.
2373
+ */
2374
+ renter_name?: string;
2375
+
2376
+ /**
2377
+ * Car return address.
2378
+ */
2379
+ return_address?: Stripe.AddressParam;
2380
+
2381
+ /**
2382
+ * Car return time. Measured in seconds since the Unix epoch.
2383
+ */
2384
+ return_at: number;
2385
+
2386
+ /**
2387
+ * Name of the return location.
2388
+ */
2389
+ return_location_name?: string;
2390
+
2391
+ /**
2392
+ * Indicates whether the goods or services are tax-exempt or tax is not collected.
2393
+ */
2394
+ tax_exempt?: boolean;
2395
+
2396
+ /**
2397
+ * The vehicle identification number.
2398
+ */
2399
+ vehicle_identification_number?: string;
2400
+ }
2401
+
2402
+ namespace CarRental {
2403
+ interface Affiliate {
2404
+ /**
2405
+ * The name of the affiliate that originated the purchase.
2406
+ */
2407
+ name: string;
2408
+ }
2409
+
2410
+ interface Delivery {
2411
+ /**
2412
+ * The delivery method for the payment
2413
+ */
2414
+ mode?: Delivery.Mode;
2415
+
2416
+ /**
2417
+ * Details of the recipient.
2418
+ */
2419
+ recipient?: Delivery.Recipient;
2420
+ }
2421
+
2422
+ namespace Delivery {
2423
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
2424
+
2425
+ interface Recipient {
2426
+ /**
2427
+ * The email of the recipient the ticket is delivered to.
2428
+ */
2429
+ email?: string;
2430
+
2431
+ /**
2432
+ * The name of the recipient the ticket is delivered to.
2433
+ */
2434
+ name?: string;
2435
+
2436
+ /**
2437
+ * The phone number of the recipient the ticket is delivered to.
2438
+ */
2439
+ phone?: string;
2440
+ }
2441
+ }
2442
+
2443
+ interface Distance {
2444
+ /**
2445
+ * Distance traveled.
2446
+ */
2447
+ amount?: number;
2448
+
2449
+ /**
2450
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
2451
+ */
2452
+ unit?: Distance.Unit;
2453
+ }
2454
+
2455
+ namespace Distance {
2456
+ type Unit = 'kilometers' | 'miles';
2457
+ }
2458
+
2459
+ interface Driver {
2460
+ /**
2461
+ * Driver's identification number.
2462
+ */
2463
+ driver_identification_number?: string;
2464
+
2465
+ /**
2466
+ * Driver's tax number.
2467
+ */
2468
+ driver_tax_number?: string;
2469
+
2470
+ /**
2471
+ * Full name of the person or entity on the car reservation.
2472
+ */
2473
+ name: string;
2474
+ }
2475
+
2476
+ type ExtraCharge =
2477
+ | 'extra_mileage'
2478
+ | 'gas'
2479
+ | 'late_return'
2480
+ | 'one_way_service'
2481
+ | 'parking_violation';
2482
+
2483
+ type RateInterval = 'day' | 'month' | 'week';
2484
+ }
2485
+
2486
+ interface CarRentalDatum {
2487
+ /**
2488
+ * Affiliate (such as travel agency) details for the rental.
2489
+ */
2490
+ affiliate?: CarRentalDatum.Affiliate;
2491
+
2492
+ /**
2493
+ * Booking confirmation number for the car rental.
2494
+ */
2495
+ booking_number?: string;
2496
+
2497
+ /**
2498
+ * Name of the car rental company.
2499
+ */
2500
+ carrier_name?: string;
2501
+
2502
+ /**
2503
+ * Customer service phone number for the car rental company.
2504
+ */
2505
+ customer_service_phone_number?: string;
2506
+
2507
+ /**
2508
+ * Number of days the car is being rented.
2509
+ */
2510
+ days_rented?: number;
2511
+
2512
+ /**
2513
+ * Distance details for the rental.
2514
+ */
2515
+ distance?: CarRentalDatum.Distance;
2516
+
2517
+ /**
2518
+ * List of drivers for the rental.
2519
+ */
2520
+ drivers?: Array<CarRentalDatum.Driver>;
2521
+
2522
+ /**
2523
+ * Drop-off location details.
2524
+ */
2525
+ drop_off: CarRentalDatum.DropOff;
2526
+
2527
+ /**
2528
+ * Insurance details for the rental.
2529
+ */
2530
+ insurances?: Array<CarRentalDatum.Insurance>;
2531
+
2532
+ /**
2533
+ * Indicates if the customer was a no-show.
2534
+ */
2535
+ no_show_indicator?: boolean;
2536
+
2537
+ /**
2538
+ * Pickup location details.
2539
+ */
2540
+ pickup: CarRentalDatum.Pickup;
2541
+
2542
+ /**
2543
+ * Name of the person renting the vehicle.
2544
+ */
2545
+ renter_name?: string;
2546
+
2547
+ /**
2548
+ * Total cost breakdown for the rental.
2549
+ */
2550
+ total: CarRentalDatum.Total;
2551
+
2552
+ /**
2553
+ * Vehicle details for the rental.
2554
+ */
2555
+ vehicle?: CarRentalDatum.Vehicle;
2556
+ }
2557
+
2558
+ namespace CarRentalDatum {
2559
+ interface Affiliate {
2560
+ /**
2561
+ * Affiliate partner code.
2562
+ */
2563
+ code?: string;
2564
+
2565
+ /**
2566
+ * Name of affiliate partner.
2567
+ */
2568
+ name?: string;
2569
+ }
2570
+
2571
+ interface Distance {
2572
+ /**
2573
+ * Distance traveled.
2574
+ */
2575
+ amount: number;
2576
+
2577
+ /**
2578
+ * Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
2579
+ */
2580
+ unit: Distance.Unit;
2581
+ }
2582
+
2583
+ namespace Distance {
2584
+ type Unit = 'kilometers' | 'miles';
2585
+ }
2586
+
2587
+ interface Driver {
2588
+ /**
2589
+ * Driver's date of birth.
2590
+ */
2591
+ date_of_birth?: Driver.DateOfBirth;
2592
+
2593
+ /**
2594
+ * Driver's identification number.
2595
+ */
2596
+ driver_identification_number?: string;
2597
+
2598
+ /**
2599
+ * Driver's tax number.
2600
+ */
2601
+ driver_tax_number?: string;
2602
+
2603
+ /**
2604
+ * Driver's full name.
2605
+ */
2606
+ name: string;
2607
+ }
2608
+
2609
+ namespace Driver {
2610
+ interface DateOfBirth {
2611
+ /**
2612
+ * Day of birth (1-31).
2613
+ */
2614
+ day: number;
2615
+
2616
+ /**
2617
+ * Month of birth (1-12).
2618
+ */
2619
+ month: number;
2620
+
2621
+ /**
2622
+ * Year of birth (must be greater than 1900).
2623
+ */
2624
+ year: number;
2625
+ }
2626
+ }
2627
+
2628
+ interface DropOff {
2629
+ /**
2630
+ * Address of the rental location.
2631
+ */
2632
+ address: DropOff.Address;
2633
+
2634
+ /**
2635
+ * Location name.
2636
+ */
2637
+ location_name?: string;
2638
+
2639
+ /**
2640
+ * Timestamp for the location.
2641
+ */
2642
+ time: number;
2643
+ }
2644
+
2645
+ namespace DropOff {
2646
+ interface Address {
2647
+ /**
2648
+ * City, district, suburb, town, or village.
2649
+ */
2650
+ city: string;
2651
+
2652
+ /**
2653
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2654
+ */
2655
+ country: string;
2656
+
2657
+ /**
2658
+ * Address line 1, such as the street, PO Box, or company name.
2659
+ */
2660
+ line1: string;
2661
+
2662
+ /**
2663
+ * Address line 2, such as the apartment, suite, unit, or building.
2664
+ */
2665
+ line2?: string;
2666
+
2667
+ /**
2668
+ * ZIP or postal code.
2669
+ */
2670
+ postal_code: string;
2671
+
2672
+ /**
2673
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
2674
+ */
2675
+ state?: string;
2676
+ }
2677
+ }
2678
+
2679
+ interface Insurance {
2680
+ /**
2681
+ * Amount of the insurance coverage in cents.
2682
+ */
2683
+ amount: number;
2684
+
2685
+ /**
2686
+ * Currency of the insurance amount.
2687
+ */
2688
+ currency?: string;
2689
+
2690
+ /**
2691
+ * Name of the insurance company.
2692
+ */
2693
+ insurance_company_name?: string;
2694
+
2695
+ /**
2696
+ * Type of insurance coverage.
2697
+ */
2698
+ insurance_type: Insurance.InsuranceType;
2699
+ }
2700
+
2701
+ namespace Insurance {
2702
+ type InsuranceType =
2703
+ | 'liability_supplement'
2704
+ | 'loss_damage_waiver'
2705
+ | 'other'
2706
+ | 'partial_damage_waiver'
2707
+ | 'personal_accident'
2708
+ | 'personal_effects';
2709
+ }
2710
+
2711
+ interface Pickup {
2712
+ /**
2713
+ * Address of the rental location.
2714
+ */
2715
+ address: Pickup.Address;
2716
+
2717
+ /**
2718
+ * Location name.
2719
+ */
2720
+ location_name?: string;
2721
+
2722
+ /**
2723
+ * Timestamp for the location.
2724
+ */
2725
+ time: number;
2726
+ }
2727
+
2728
+ namespace Pickup {
2729
+ interface Address {
2730
+ /**
2731
+ * City, district, suburb, town, or village.
2732
+ */
2733
+ city: string;
2734
+
2735
+ /**
2736
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2737
+ */
2738
+ country: string;
2739
+
2740
+ /**
2741
+ * Address line 1, such as the street, PO Box, or company name.
2742
+ */
2743
+ line1: string;
2744
+
2745
+ /**
2746
+ * Address line 2, such as the apartment, suite, unit, or building.
2747
+ */
2748
+ line2?: string;
2749
+
2750
+ /**
2751
+ * ZIP or postal code.
2752
+ */
2753
+ postal_code: string;
2754
+
2755
+ /**
2756
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
2757
+ */
2758
+ state?: string;
2759
+ }
2760
+ }
2761
+
2762
+ interface Total {
2763
+ /**
2764
+ * Total amount in cents.
2765
+ */
2766
+ amount: number;
2767
+
2768
+ /**
2769
+ * Currency of the amount.
2770
+ */
2771
+ currency?: string;
2772
+
2773
+ /**
2774
+ * Discount details for the rental.
2775
+ */
2776
+ discounts?: Total.Discounts;
2777
+
2778
+ /**
2779
+ * Additional charges for the rental.
2780
+ */
2781
+ extra_charges?: Array<Total.ExtraCharge>;
2782
+
2783
+ /**
2784
+ * Rate per unit for the rental.
2785
+ */
2786
+ rate_per_unit?: number;
2787
+
2788
+ /**
2789
+ * Unit of measurement for the rate.
2790
+ */
2791
+ rate_unit?: Total.RateUnit;
2792
+
2793
+ /**
2794
+ * Tax breakdown for the rental.
2795
+ */
2796
+ tax?: Total.Tax;
2797
+ }
2798
+
2799
+ namespace Total {
2800
+ interface Discounts {
2801
+ /**
2802
+ * Corporate client discount code.
2803
+ */
2804
+ corporate_client_code?: string;
2805
+
2806
+ /**
2807
+ * Coupon code applied to the rental.
2808
+ */
2809
+ coupon?: string;
2810
+
2811
+ /**
2812
+ * Maximum number of free miles or kilometers included.
2813
+ */
2814
+ maximum_free_miles_or_kilometers?: number;
2815
+ }
2816
+
2817
+ interface ExtraCharge {
2818
+ /**
2819
+ * Amount of the extra charge in cents.
2820
+ */
2821
+ amount: number;
2822
+
2823
+ /**
2824
+ * Type of extra charge.
2825
+ */
2826
+ type: ExtraCharge.Type;
2827
+ }
2828
+
2829
+ namespace ExtraCharge {
2830
+ type Type =
2831
+ | 'extra_mileage'
2832
+ | 'gas'
2833
+ | 'gps'
2834
+ | 'late_charge'
2835
+ | 'one_way_drop_off'
2836
+ | 'other'
2837
+ | 'parking'
2838
+ | 'phone'
2839
+ | 'regular_mileage'
2840
+ | 'towing';
2841
+ }
2842
+
2843
+ type RateUnit =
2844
+ | 'days'
2845
+ | 'kilometers'
2846
+ | 'miles'
2847
+ | 'months'
2848
+ | 'weeks';
2849
+
2850
+ interface Tax {
2851
+ /**
2852
+ * Indicates if the transaction is tax exempt.
2853
+ */
2854
+ tax_exempt_indicator?: boolean;
2855
+
2856
+ /**
2857
+ * Array of tax details.
2858
+ */
2859
+ taxes?: Array<Tax.Tax>;
2860
+ }
2861
+
2862
+ namespace Tax {
2863
+ interface Tax {
2864
+ /**
2865
+ * Tax amount.
2866
+ */
2867
+ amount?: number;
2868
+
2869
+ /**
2870
+ * Tax rate applied.
2871
+ */
2872
+ rate?: number;
2873
+
2874
+ /**
2875
+ * Type of tax applied.
2876
+ */
2877
+ type?: string;
2878
+ }
2879
+ }
2880
+ }
2881
+
2882
+ interface Vehicle {
2883
+ /**
2884
+ * Make of the rental vehicle.
2885
+ */
2886
+ make?: string;
2887
+
2888
+ /**
2889
+ * Model of the rental vehicle.
2890
+ */
2891
+ model?: string;
2892
+
2893
+ /**
2894
+ * Odometer reading at the time of rental.
2895
+ */
2896
+ odometer?: number;
2897
+
2898
+ /**
2899
+ * Type of the rental vehicle.
2900
+ */
2901
+ type?: Vehicle.Type;
2902
+
2903
+ /**
2904
+ * Class of the rental vehicle.
2905
+ */
2906
+ vehicle_class?: Vehicle.VehicleClass;
2907
+
2908
+ /**
2909
+ * Vehicle identification number (VIN).
2910
+ */
2911
+ vehicle_identification_number?: string;
2912
+ }
2913
+
2914
+ namespace Vehicle {
2915
+ type Type =
2916
+ | 'cargo_van'
2917
+ | 'compact'
2918
+ | 'economy'
2919
+ | 'exotic'
2920
+ | 'exotic_suv'
2921
+ | 'fifteen_passenger_van'
2922
+ | 'four_wheel_drive'
2923
+ | 'full_size'
2924
+ | 'intermediate'
2925
+ | 'large_suv'
2926
+ | 'large_truck'
2927
+ | 'luxury'
2928
+ | 'medium_suv'
2929
+ | 'midsize'
2930
+ | 'mini'
2931
+ | 'minivan'
2932
+ | 'miscellaneous'
2933
+ | 'moped'
2934
+ | 'moving_van'
2935
+ | 'premium'
2936
+ | 'regular'
2937
+ | 'small_medium_truck'
2938
+ | 'small_suv'
2939
+ | 'special'
2940
+ | 'standard'
2941
+ | 'stretch'
2942
+ | 'subcompact'
2943
+ | 'taxi'
2944
+ | 'twelve_foot_truck'
2945
+ | 'twelve_passenger_van'
2946
+ | 'twenty_foot_truck'
2947
+ | 'twenty_four_foot_truck'
2948
+ | 'twenty_six_foot_truck'
2949
+ | 'unique';
2950
+
2951
+ type VehicleClass =
2952
+ | 'business'
2953
+ | 'economy'
2954
+ | 'first_class'
2955
+ | 'premium_economy';
2956
+ }
2957
+ }
2958
+
2959
+ interface EventDetails {
2960
+ /**
2961
+ * Indicates if the tickets are digitally checked when entering the venue.
2962
+ */
2963
+ access_controlled_venue?: boolean;
2964
+
2965
+ /**
2966
+ * The event location's address.
2967
+ */
2968
+ address?: Stripe.AddressParam;
2969
+
2970
+ /**
2971
+ * Affiliate details for this purchase.
2972
+ */
2973
+ affiliate?: EventDetails.Affiliate;
2974
+
2975
+ /**
2976
+ * The name of the company
2977
+ */
2978
+ company?: string;
2979
+
2980
+ /**
2981
+ * Delivery details for this purchase.
2982
+ */
2983
+ delivery?: EventDetails.Delivery;
2984
+
2985
+ /**
2986
+ * Event end time. Measured in seconds since the Unix epoch.
2987
+ */
2988
+ ends_at?: number;
2989
+
2990
+ /**
2991
+ * Type of the event entertainment (concert, sports event etc)
2992
+ */
2993
+ genre?: string;
2994
+
2995
+ /**
2996
+ * The name of the event.
2997
+ */
2998
+ name: string;
2999
+
3000
+ /**
3001
+ * Event start time. Measured in seconds since the Unix epoch.
3002
+ */
3003
+ starts_at?: number;
3004
+ }
3005
+
3006
+ namespace EventDetails {
3007
+ interface Affiliate {
3008
+ /**
3009
+ * The name of the affiliate that originated the purchase.
3010
+ */
3011
+ name: string;
3012
+ }
3013
+
3014
+ interface Delivery {
3015
+ /**
3016
+ * The delivery method for the payment
3017
+ */
3018
+ mode?: Delivery.Mode;
3019
+
3020
+ /**
3021
+ * Details of the recipient.
3022
+ */
3023
+ recipient?: Delivery.Recipient;
3024
+ }
3025
+
3026
+ namespace Delivery {
3027
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3028
+
3029
+ interface Recipient {
3030
+ /**
3031
+ * The email of the recipient the ticket is delivered to.
3032
+ */
3033
+ email?: string;
3034
+
3035
+ /**
3036
+ * The name of the recipient the ticket is delivered to.
3037
+ */
3038
+ name?: string;
3039
+
3040
+ /**
3041
+ * The phone number of the recipient the ticket is delivered to.
3042
+ */
3043
+ phone?: string;
3044
+ }
3045
+ }
3046
+ }
3047
+
3048
+ interface Flight {
3049
+ /**
3050
+ * Affiliate details for this purchase.
3051
+ */
3052
+ affiliate?: Flight.Affiliate;
3053
+
3054
+ /**
3055
+ * The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.
3056
+ */
3057
+ agency_number?: string;
3058
+
3059
+ /**
3060
+ * The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.
3061
+ */
3062
+ carrier?: string;
3063
+
3064
+ /**
3065
+ * Delivery details for this purchase.
3066
+ */
3067
+ delivery?: Flight.Delivery;
3068
+
3069
+ /**
3070
+ * The name of the person or entity on the reservation.
3071
+ */
3072
+ passenger_name?: string;
3073
+
3074
+ /**
3075
+ * The details of the passengers in the travel reservation.
3076
+ */
3077
+ passengers?: Array<Flight.Passenger>;
3078
+
3079
+ /**
3080
+ * The individual flight segments associated with the trip.
3081
+ */
3082
+ segments: Array<Flight.Segment>;
3083
+
3084
+ /**
3085
+ * The ticket number associated with the travel reservation.
3086
+ */
3087
+ ticket_number?: string;
3088
+ }
3089
+
3090
+ namespace Flight {
3091
+ interface Affiliate {
3092
+ /**
3093
+ * The name of the affiliate that originated the purchase.
3094
+ */
3095
+ name: string;
3096
+ }
3097
+
3098
+ interface Delivery {
3099
+ /**
3100
+ * The delivery method for the payment
3101
+ */
3102
+ mode?: Delivery.Mode;
3103
+
3104
+ /**
3105
+ * Details of the recipient.
3106
+ */
3107
+ recipient?: Delivery.Recipient;
3108
+ }
3109
+
3110
+ namespace Delivery {
3111
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3112
+
3113
+ interface Recipient {
3114
+ /**
3115
+ * The email of the recipient the ticket is delivered to.
3116
+ */
3117
+ email?: string;
3118
+
3119
+ /**
3120
+ * The name of the recipient the ticket is delivered to.
3121
+ */
3122
+ name?: string;
3123
+
3124
+ /**
3125
+ * The phone number of the recipient the ticket is delivered to.
3126
+ */
3127
+ phone?: string;
3128
+ }
3129
+ }
3130
+
3131
+ interface Passenger {
3132
+ /**
3133
+ * Full name of the person or entity on the flight reservation.
3134
+ */
3135
+ name: string;
3136
+ }
3137
+
3138
+ interface Segment {
3139
+ /**
3140
+ * The flight segment amount.
3141
+ */
3142
+ amount?: number;
3143
+
3144
+ /**
3145
+ * The International Air Transport Association (IATA) airport code for the arrival airport.
3146
+ */
3147
+ arrival_airport?: string;
3148
+
3149
+ /**
3150
+ * The arrival time for the flight segment. Measured in seconds since the Unix epoch.
3151
+ */
3152
+ arrives_at?: number;
3153
+
3154
+ /**
3155
+ * The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.
3156
+ */
3157
+ carrier?: string;
3158
+
3159
+ /**
3160
+ * The departure time for the flight segment. Measured in seconds since the Unix epoch.
3161
+ */
3162
+ departs_at: number;
3163
+
3164
+ /**
3165
+ * The International Air Transport Association (IATA) airport code for the departure airport.
3166
+ */
3167
+ departure_airport?: string;
3168
+
3169
+ /**
3170
+ * The flight number associated with the segment
3171
+ */
3172
+ flight_number?: string;
3173
+
3174
+ /**
3175
+ * The fare class for the segment.
3176
+ */
3177
+ service_class?: Segment.ServiceClass;
3178
+ }
3179
+
3180
+ namespace Segment {
3181
+ type ServiceClass =
3182
+ | 'business'
3183
+ | 'economy'
3184
+ | 'first'
3185
+ | 'premium_economy';
3186
+ }
3187
+ }
3188
+
3189
+ interface FlightDatum {
3190
+ /**
3191
+ * Affiliate details if applicable.
3192
+ */
3193
+ affiliate?: FlightDatum.Affiliate;
3194
+
3195
+ /**
3196
+ * Reservation reference.
3197
+ */
3198
+ booking_number?: string;
3199
+
3200
+ /**
3201
+ * Computerized reservation system used to make the reservation and purchase the ticket.
3202
+ */
3203
+ computerized_reservation_system?: string;
3204
+
3205
+ /**
3206
+ * Ticket restrictions.
3207
+ */
3208
+ endorsements_and_restrictions?: string;
3209
+
3210
+ /**
3211
+ * List of insurances.
3212
+ */
3213
+ insurances?: Array<FlightDatum.Insurance>;
3214
+
3215
+ /**
3216
+ * List of passengers.
3217
+ */
3218
+ passengers?: Array<FlightDatum.Passenger>;
3219
+
3220
+ /**
3221
+ * List of flight segments.
3222
+ */
3223
+ segments: Array<FlightDatum.Segment>;
3224
+
3225
+ /**
3226
+ * Electronic ticket indicator.
3227
+ */
3228
+ ticket_electronically_issued_indicator?: boolean;
3229
+
3230
+ /**
3231
+ * Total cost breakdown.
3232
+ */
3233
+ total: FlightDatum.Total;
3234
+
3235
+ /**
3236
+ * Type of flight transaction.
3237
+ */
3238
+ transaction_type?: FlightDatum.TransactionType;
3239
+ }
3240
+
3241
+ namespace FlightDatum {
3242
+ interface Affiliate {
3243
+ /**
3244
+ * Affiliate partner code.
3245
+ */
3246
+ code?: string;
3247
+
3248
+ /**
3249
+ * Name of affiliate partner.
3250
+ */
3251
+ name?: string;
3252
+
3253
+ /**
3254
+ * Code provided by the company to a travel agent authorizing ticket issuance.
3255
+ */
3256
+ travel_authorization_code?: string;
3257
+ }
3258
+
3259
+ interface Insurance {
3260
+ /**
3261
+ * Insurance cost.
3262
+ */
3263
+ amount: number;
3264
+
3265
+ /**
3266
+ * Insurance currency.
3267
+ */
3268
+ currency?: string;
3269
+
3270
+ /**
3271
+ * Insurance company name.
3272
+ */
3273
+ insurance_company_name?: string;
3274
+
3275
+ /**
3276
+ * Type of insurance.
3277
+ */
3278
+ insurance_type: Insurance.InsuranceType;
3279
+ }
3280
+
3281
+ namespace Insurance {
3282
+ type InsuranceType =
3283
+ | 'baggage'
3284
+ | 'bankruptcy'
3285
+ | 'cancelation'
3286
+ | 'emergency'
3287
+ | 'medical';
3288
+ }
3289
+
3290
+ interface Passenger {
3291
+ /**
3292
+ * Passenger's full name.
3293
+ */
3294
+ name: string;
3295
+ }
3296
+
3297
+ interface Segment {
3298
+ /**
3299
+ * Segment fare amount.
3300
+ */
3301
+ amount?: number;
3302
+
3303
+ /**
3304
+ * Arrival details.
3305
+ */
3306
+ arrival: Segment.Arrival;
3307
+
3308
+ /**
3309
+ * Airline carrier code.
3310
+ */
3311
+ carrier_code: string;
3312
+
3313
+ /**
3314
+ * Carrier name.
3315
+ */
3316
+ carrier_name?: string;
3317
+
3318
+ /**
3319
+ * Segment currency.
3320
+ */
3321
+ currency?: string;
3322
+
3323
+ /**
3324
+ * Departure details.
3325
+ */
3326
+ departure: Segment.Departure;
3327
+
3328
+ /**
3329
+ * Exchange ticket number.
3330
+ */
3331
+ exchange_ticket_number?: string;
3332
+
3333
+ /**
3334
+ * Fare basis code.
3335
+ */
3336
+ fare_basis_code?: string;
3337
+
3338
+ /**
3339
+ * Additional fees.
3340
+ */
3341
+ fees?: number;
3342
+
3343
+ /**
3344
+ * Flight number.
3345
+ */
3346
+ flight_number?: string;
3347
+
3348
+ /**
3349
+ * Stopover indicator.
3350
+ */
3351
+ is_stop_over_indicator?: boolean;
3352
+
3353
+ /**
3354
+ * Refundable ticket indicator.
3355
+ */
3356
+ refundable?: boolean;
3357
+
3358
+ /**
3359
+ * Class of service.
3360
+ */
3361
+ service_class: Segment.ServiceClass;
3362
+
3363
+ /**
3364
+ * Tax amount for segment.
3365
+ */
3366
+ tax_amount?: number;
3367
+
3368
+ /**
3369
+ * Ticket number.
3370
+ */
3371
+ ticket_number?: string;
3372
+ }
3373
+
3374
+ namespace Segment {
3375
+ interface Arrival {
3376
+ /**
3377
+ * Arrival airport IATA code.
3378
+ */
3379
+ airport: string;
3380
+
3381
+ /**
3382
+ * Arrival date/time.
3383
+ */
3384
+ arrives_at?: number;
3385
+
3386
+ /**
3387
+ * Arrival city.
3388
+ */
3389
+ city?: string;
3390
+
3391
+ /**
3392
+ * Arrival country.
3393
+ */
3394
+ country?: string;
3395
+ }
3396
+
3397
+ interface Departure {
3398
+ /**
3399
+ * Departure airport IATA code.
3400
+ */
3401
+ airport: string;
3402
+
3403
+ /**
3404
+ * Departure city.
3405
+ */
3406
+ city?: string;
3407
+
3408
+ /**
3409
+ * Departure country.
3410
+ */
3411
+ country?: string;
3412
+
3413
+ /**
3414
+ * Departure date/time.
3415
+ */
3416
+ departs_at: number;
3417
+ }
3418
+
3419
+ type ServiceClass =
3420
+ | 'business'
3421
+ | 'economy'
3422
+ | 'first_class'
3423
+ | 'premium_economy';
3424
+ }
3425
+
3426
+ interface Total {
3427
+ /**
3428
+ * Total flight amount.
3429
+ */
3430
+ amount: number;
3431
+
3432
+ /**
3433
+ * Reason for credit.
3434
+ */
3435
+ credit_reason?: Total.CreditReason;
3436
+
3437
+ /**
3438
+ * Total currency.
3439
+ */
3440
+ currency?: string;
3441
+
3442
+ /**
3443
+ * Discount details.
3444
+ */
3445
+ discounts?: Total.Discounts;
3446
+
3447
+ /**
3448
+ * Additional charges.
3449
+ */
3450
+ extra_charges?: Array<Total.ExtraCharge>;
3451
+
3452
+ /**
3453
+ * Tax breakdown.
3454
+ */
3455
+ tax?: Total.Tax;
3456
+ }
3457
+
3458
+ namespace Total {
3459
+ type CreditReason =
3460
+ | 'other'
3461
+ | 'partial_ticket_refund'
3462
+ | 'passenger_transport_ancillary_cancellation'
3463
+ | 'ticket_and_ancillary_cancellation'
3464
+ | 'ticket_cancellation';
3465
+
3466
+ interface Discounts {
3467
+ /**
3468
+ * Corporate client discount code.
3469
+ */
3470
+ corporate_client_code?: string;
3471
+ }
3472
+
3473
+ interface ExtraCharge {
3474
+ /**
3475
+ * Amount of additional charges.
3476
+ */
3477
+ amount?: number;
3478
+
3479
+ /**
3480
+ * Type of additional charges.
3481
+ */
3482
+ type?: ExtraCharge.Type;
3483
+ }
3484
+
3485
+ namespace ExtraCharge {
3486
+ type Type =
3487
+ | 'additional_fees'
3488
+ | 'ancillary_service_charges'
3489
+ | 'exchange_fee';
3490
+ }
3491
+
3492
+ interface Tax {
3493
+ /**
3494
+ * Array of tax details.
3495
+ */
3496
+ taxes?: Array<Tax.Tax>;
3497
+ }
3498
+
3499
+ namespace Tax {
3500
+ interface Tax {
3501
+ /**
3502
+ * Tax amount.
3503
+ */
3504
+ amount?: number;
3505
+
3506
+ /**
3507
+ * Tax rate.
3508
+ */
3509
+ rate?: number;
3510
+
3511
+ /**
3512
+ * Type of tax.
3513
+ */
3514
+ type?: string;
3515
+ }
3516
+ }
3517
+ }
3518
+
3519
+ type TransactionType =
3520
+ | 'exchange_ticket'
3521
+ | 'miscellaneous'
3522
+ | 'refund'
3523
+ | 'ticket_purchase';
3524
+ }
3525
+
3526
+ interface Lodging {
3527
+ /**
3528
+ * The lodging location's address.
3529
+ */
3530
+ address?: Stripe.AddressParam;
3531
+
3532
+ /**
3533
+ * The number of adults on the booking
3534
+ */
3535
+ adults?: number;
3536
+
3537
+ /**
3538
+ * Affiliate details for this purchase.
3539
+ */
3540
+ affiliate?: Lodging.Affiliate;
3541
+
3542
+ /**
3543
+ * The booking number associated with the lodging reservation.
3544
+ */
3545
+ booking_number?: string;
3546
+
3547
+ /**
3548
+ * The lodging category
3549
+ */
3550
+ category?: Lodging.Category;
3551
+
3552
+ /**
3553
+ * Lodging check-in time. Measured in seconds since the Unix epoch.
3554
+ */
3555
+ checkin_at: number;
3556
+
3557
+ /**
3558
+ * Lodging check-out time. Measured in seconds since the Unix epoch.
3559
+ */
3560
+ checkout_at: number;
3561
+
3562
+ /**
3563
+ * The customer service phone number of the lodging company.
3564
+ */
3565
+ customer_service_phone_number?: string;
3566
+
3567
+ /**
3568
+ * The daily lodging room rate.
3569
+ */
3570
+ daily_room_rate_amount?: number;
3571
+
3572
+ /**
3573
+ * Delivery details for this purchase.
3574
+ */
3575
+ delivery?: Lodging.Delivery;
3576
+
3577
+ /**
3578
+ * List of additional charges being billed.
3579
+ */
3580
+ extra_charges?: Array<Lodging.ExtraCharge>;
3581
+
3582
+ /**
3583
+ * Indicates whether the lodging location is compliant with the Fire Safety Act.
3584
+ */
3585
+ fire_safety_act_compliance?: boolean;
3586
+
3587
+ /**
3588
+ * The name of the lodging location.
3589
+ */
3590
+ name?: string;
3591
+
3592
+ /**
3593
+ * Indicates if the customer did not keep their booking while failing to cancel the reservation.
3594
+ */
3595
+ no_show?: boolean;
3596
+
3597
+ /**
3598
+ * The number of rooms on the booking
3599
+ */
3600
+ number_of_rooms?: number;
3601
+
3602
+ /**
3603
+ * The details of the passengers in the travel reservation
3604
+ */
3605
+ passengers?: Array<Lodging.Passenger>;
3606
+
3607
+ /**
3608
+ * The phone number of the lodging location.
3609
+ */
3610
+ property_phone_number?: string;
3611
+
3612
+ /**
3613
+ * The room class for this purchase.
3614
+ */
3615
+ room_class?: string;
3616
+
3617
+ /**
3618
+ * The number of room nights
3619
+ */
3620
+ room_nights?: number;
3621
+
3622
+ /**
3623
+ * The total tax amount associating with the room reservation.
3624
+ */
3625
+ total_room_tax_amount?: number;
3626
+
3627
+ /**
3628
+ * The total tax amount
3629
+ */
3630
+ total_tax_amount?: number;
3631
+ }
3632
+
3633
+ namespace Lodging {
3634
+ interface Affiliate {
3635
+ /**
3636
+ * The name of the affiliate that originated the purchase.
3637
+ */
3638
+ name: string;
3639
+ }
3640
+
3641
+ type Category = 'hotel' | 'vacation_rental';
3642
+
3643
+ interface Delivery {
3644
+ /**
3645
+ * The delivery method for the payment
3646
+ */
3647
+ mode?: Delivery.Mode;
3648
+
3649
+ /**
3650
+ * Details of the recipient.
3651
+ */
3652
+ recipient?: Delivery.Recipient;
3653
+ }
3654
+
3655
+ namespace Delivery {
3656
+ type Mode = 'email' | 'phone' | 'pickup' | 'post';
3657
+
3658
+ interface Recipient {
3659
+ /**
3660
+ * The email of the recipient the ticket is delivered to.
3661
+ */
3662
+ email?: string;
3663
+
3664
+ /**
3665
+ * The name of the recipient the ticket is delivered to.
3666
+ */
3667
+ name?: string;
3668
+
3669
+ /**
3670
+ * The phone number of the recipient the ticket is delivered to.
3671
+ */
3672
+ phone?: string;
3673
+ }
3674
+ }
3675
+
3676
+ type ExtraCharge =
3677
+ | 'gift_shop'
3678
+ | 'laundry'
3679
+ | 'mini_bar'
3680
+ | 'other'
3681
+ | 'restaurant'
3682
+ | 'telephone';
3683
+
3684
+ interface Passenger {
3685
+ /**
3686
+ * Full name of the person or entity on the lodging reservation.
3687
+ */
3688
+ name: string;
3689
+ }
3690
+ }
3691
+
3692
+ interface LodgingDatum {
3693
+ /**
3694
+ * Accommodation details for the lodging.
3695
+ */
3696
+ accommodation?: LodgingDatum.Accommodation;
3697
+
3698
+ /**
3699
+ * Affiliate details if applicable.
3700
+ */
3701
+ affiliate?: LodgingDatum.Affiliate;
3702
+
3703
+ /**
3704
+ * Booking confirmation number for the lodging.
3705
+ */
3706
+ booking_number?: string;
3707
+
3708
+ /**
3709
+ * Check-in date.
3710
+ */
3711
+ checkin_at: number;
3712
+
3713
+ /**
3714
+ * Check-out date.
3715
+ */
3716
+ checkout_at: number;
3717
+
3718
+ /**
3719
+ * Customer service phone number for the lodging company.
3720
+ */
3721
+ customer_service_phone_number?: string;
3722
+
3723
+ /**
3724
+ * Whether the lodging is compliant with any hotel fire safety regulations.
3725
+ */
3726
+ fire_safety_act_compliance_indicator?: boolean;
3727
+
3728
+ /**
3729
+ * List of guests for the lodging.
3730
+ */
3731
+ guests?: Array<LodgingDatum.Guest>;
3732
+
3733
+ /**
3734
+ * Host details for the lodging.
3735
+ */
3736
+ host?: LodgingDatum.Host;
3737
+
3738
+ /**
3739
+ * List of insurances for the lodging.
3740
+ */
3741
+ insurances?: Array<LodgingDatum.Insurance>;
3742
+
3743
+ /**
3744
+ * Whether the renter is a no-show.
3745
+ */
3746
+ no_show_indicator?: boolean;
3747
+
3748
+ /**
3749
+ * Renter ID number for the lodging.
3750
+ */
3751
+ renter_id_number?: string;
3752
+
3753
+ /**
3754
+ * Renter name for the lodging.
3755
+ */
3756
+ renter_name?: string;
3757
+
3758
+ /**
3759
+ * Total details for the lodging.
3760
+ */
3761
+ total: LodgingDatum.Total;
3762
+ }
3763
+
3764
+ namespace LodgingDatum {
3765
+ interface Accommodation {
3766
+ /**
3767
+ * Type of accommodation.
3768
+ */
3769
+ accommodation_type?: Accommodation.AccommodationType;
3770
+
3771
+ /**
3772
+ * Bed type.
3773
+ */
3774
+ bed_type?: string;
3775
+
3776
+ /**
3777
+ * Daily accommodation rate in cents.
3778
+ */
3779
+ daily_rate_amount?: number;
3780
+
3781
+ /**
3782
+ * Number of nights.
3783
+ */
3784
+ nights?: number;
3785
+
3786
+ /**
3787
+ * Number of rooms, cabanas, apartments, and so on.
3788
+ */
3789
+ number_of_rooms?: number;
3790
+
3791
+ /**
3792
+ * Rate type.
3793
+ */
3794
+ rate_type?: string;
3795
+
3796
+ /**
3797
+ * Whether smoking is allowed.
3798
+ */
3799
+ smoking_indicator?: boolean;
3800
+ }
3801
+
3802
+ namespace Accommodation {
3803
+ type AccommodationType =
3804
+ | 'apartment'
3805
+ | 'cabana'
3806
+ | 'house'
3807
+ | 'penthouse'
3808
+ | 'room'
3809
+ | 'standard'
3810
+ | 'suite'
3811
+ | 'villa';
3812
+ }
3813
+
3814
+ interface Affiliate {
3815
+ /**
3816
+ * Affiliate partner code.
3817
+ */
3818
+ code?: string;
3819
+
3820
+ /**
3821
+ * Affiliate partner name.
3822
+ */
3823
+ name?: string;
3824
+ }
3825
+
3826
+ interface Guest {
3827
+ /**
3828
+ * Guest's full name.
3829
+ */
3830
+ name: string;
3831
+ }
3832
+
3833
+ interface Host {
3834
+ /**
3835
+ * Address of the host.
3836
+ */
3837
+ address?: Host.Address;
3838
+
3839
+ /**
3840
+ * Host's country of domicile.
3841
+ */
3842
+ country_of_domicile?: string;
3843
+
3844
+ /**
3845
+ * Reference number for the host.
3846
+ */
3847
+ host_reference?: string;
3848
+
3849
+ /**
3850
+ * Type of host.
3851
+ */
3852
+ host_type?: Host.HostType;
3853
+
3854
+ /**
3855
+ * Name of the lodging property or host.
3856
+ */
3857
+ name?: string;
3858
+
3859
+ /**
3860
+ * Total number of reservations for the host.
3861
+ */
3862
+ number_of_reservations?: number;
3863
+
3864
+ /**
3865
+ * Property phone number.
3866
+ */
3867
+ property_phone_number?: string;
3868
+
3869
+ /**
3870
+ * Host's registration date.
3871
+ */
3872
+ registered_at?: number;
3873
+ }
3874
+
3875
+ namespace Host {
3876
+ interface Address {
3877
+ /**
3878
+ * City, district, suburb, town, or village.
3879
+ */
3880
+ city: string;
3881
+
3882
+ /**
3883
+ * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
3884
+ */
3885
+ country: string;
3886
+
3887
+ /**
3888
+ * Address line 1, such as the street, PO Box, or company name.
3889
+ */
3890
+ line1: string;
3891
+
3892
+ /**
3893
+ * Address line 2, such as the apartment, suite, unit, or building.
3894
+ */
3895
+ line2?: string;
3896
+
3897
+ /**
3898
+ * ZIP or postal code.
3899
+ */
3900
+ postal_code: string;
3901
+
3902
+ /**
3903
+ * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
3904
+ */
3905
+ state?: string;
3906
+ }
3907
+
3908
+ type HostType = 'hostel' | 'hotel' | 'owner' | 'rental_agency';
3909
+ }
3910
+
3911
+ interface Insurance {
3912
+ /**
3913
+ * Price of the insurance coverage in cents.
3914
+ */
3915
+ amount: number;
3916
+
3917
+ /**
3918
+ * Currency of the insurance amount.
3919
+ */
3920
+ currency?: string;
3921
+
3922
+ /**
3923
+ * Name of the insurance company.
3924
+ */
3925
+ insurance_company_name?: string;
3926
+
3927
+ /**
3928
+ * Type of insurance coverage.
3929
+ */
3930
+ insurance_type: Insurance.InsuranceType;
3931
+ }
3932
+
3933
+ namespace Insurance {
3934
+ type InsuranceType =
3935
+ | 'bankruptcy'
3936
+ | 'cancelation'
3937
+ | 'emergency'
3938
+ | 'medical';
3939
+ }
3940
+
3941
+ interface Total {
3942
+ /**
3943
+ * Total price of the lodging reservation in cents.
3944
+ */
3945
+ amount: number;
3946
+
3947
+ /**
3948
+ * Cash advances in cents.
3949
+ */
3950
+ cash_advances?: number;
3951
+
3952
+ /**
3953
+ * Currency of the total amount.
3954
+ */
3955
+ currency?: string;
3956
+
3957
+ /**
3958
+ * Discount details for the lodging.
3959
+ */
3960
+ discounts?: Total.Discounts;
3961
+
3962
+ /**
3963
+ * Additional charges for the lodging.
3964
+ */
3965
+ extra_charges?: Array<Total.ExtraCharge>;
3966
+
3967
+ /**
3968
+ * Prepaid amount in cents.
3969
+ */
3970
+ prepaid_amount?: number;
3971
+
3972
+ /**
3973
+ * Tax breakdown for the lodging reservation.
3974
+ */
3975
+ tax?: Total.Tax;
3976
+ }
3977
+
3978
+ namespace Total {
3979
+ interface Discounts {
3980
+ /**
3981
+ * Corporate client discount code.
3982
+ */
3983
+ corporate_client_code?: string;
3984
+
3985
+ /**
3986
+ * Coupon code.
3987
+ */
3988
+ coupon?: string;
3989
+ }
3990
+
3991
+ interface ExtraCharge {
3992
+ /**
3993
+ * Amount of the extra charge in cents.
3994
+ */
3995
+ amount?: number;
3996
+
3997
+ /**
3998
+ * Type of extra charge.
3999
+ */
4000
+ type?: ExtraCharge.Type;
4001
+ }
4002
+
4003
+ namespace ExtraCharge {
4004
+ type Type =
4005
+ | 'gift_shop'
4006
+ | 'laundry'
4007
+ | 'mini_bar'
4008
+ | 'other'
4009
+ | 'phone'
4010
+ | 'restaurant';
4011
+ }
4012
+
4013
+ interface Tax {
4014
+ /**
4015
+ * Indicates whether the transaction is tax exempt.
4016
+ */
4017
+ tax_exempt_indicator?: boolean;
4018
+
4019
+ /**
4020
+ * Tax details.
4021
+ */
4022
+ taxes?: Array<Tax.Tax>;
4023
+ }
4024
+
4025
+ namespace Tax {
4026
+ interface Tax {
4027
+ /**
4028
+ * Tax amount in cents.
4029
+ */
4030
+ amount?: number;
4031
+
4032
+ /**
4033
+ * Tax rate.
4034
+ */
4035
+ rate?: number;
4036
+
4037
+ /**
4038
+ * Type of tax applied.
4039
+ */
4040
+ type?: string;
4041
+ }
4042
+ }
4043
+ }
4044
+ }
4045
+
4046
+ interface Subscription {
4047
+ /**
4048
+ * Affiliate details for this purchase.
4049
+ */
4050
+ affiliate?: Subscription.Affiliate;
4051
+
4052
+ /**
4053
+ * Info whether the subscription will be auto renewed upon expiry.
4054
+ */
4055
+ auto_renewal?: boolean;
4056
+
4057
+ /**
4058
+ * Subscription billing details for this purchase.
4059
+ */
4060
+ billing_interval?: Subscription.BillingInterval;
4061
+
4062
+ /**
4063
+ * Subscription end time. Measured in seconds since the Unix epoch.
4064
+ */
4065
+ ends_at?: number;
4066
+
4067
+ /**
4068
+ * Name of the product on subscription. e.g. Apple Music Subscription
4069
+ */
4070
+ name: string;
4071
+
4072
+ /**
4073
+ * Subscription start time. Measured in seconds since the Unix epoch.
4074
+ */
4075
+ starts_at?: number;
4076
+ }
4077
+
4078
+ namespace Subscription {
4079
+ interface Affiliate {
4080
+ /**
4081
+ * The name of the affiliate that originated the purchase.
4082
+ */
4083
+ name: string;
4084
+ }
4085
+
4086
+ interface BillingInterval {
4087
+ /**
4088
+ * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
4089
+ */
4090
+ count: number;
4091
+
4092
+ /**
4093
+ * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
4094
+ */
4095
+ interval: BillingInterval.Interval;
4096
+ }
4097
+
4098
+ namespace BillingInterval {
4099
+ type Interval = 'day' | 'month' | 'week' | 'year';
4100
+ }
4101
+ }
4102
+ }
322
4103
 
323
- namespace ChargeCaptureParams {
324
4104
  interface TransferData {
325
4105
  /**
326
4106
  * The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.