stripe 18.6.0-beta.1 → 19.0.0

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