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