@whop/sdk 0.0.27 → 0.0.28

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 (459) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/client.d.mts +4 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +4 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +7 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +7 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/access-tokens.d.mts +19 -20
  12. package/resources/access-tokens.d.mts.map +1 -1
  13. package/resources/access-tokens.d.ts +19 -20
  14. package/resources/access-tokens.d.ts.map +1 -1
  15. package/resources/access-tokens.js +4 -4
  16. package/resources/access-tokens.mjs +4 -4
  17. package/resources/account-links.d.mts +15 -13
  18. package/resources/account-links.d.mts.map +1 -1
  19. package/resources/account-links.d.ts +15 -13
  20. package/resources/account-links.d.ts.map +1 -1
  21. package/resources/account-links.js +2 -3
  22. package/resources/account-links.js.map +1 -1
  23. package/resources/account-links.mjs +2 -3
  24. package/resources/account-links.mjs.map +1 -1
  25. package/resources/ai-chats.d.mts +38 -26
  26. package/resources/ai-chats.d.mts.map +1 -1
  27. package/resources/ai-chats.d.ts +38 -26
  28. package/resources/ai-chats.d.ts.map +1 -1
  29. package/resources/ai-chats.js +5 -5
  30. package/resources/ai-chats.mjs +5 -5
  31. package/resources/app-builds.d.mts +35 -33
  32. package/resources/app-builds.d.mts.map +1 -1
  33. package/resources/app-builds.d.ts +35 -33
  34. package/resources/app-builds.d.ts.map +1 -1
  35. package/resources/app-builds.js +7 -4
  36. package/resources/app-builds.js.map +1 -1
  37. package/resources/app-builds.mjs +7 -4
  38. package/resources/app-builds.mjs.map +1 -1
  39. package/resources/apps.d.mts +81 -56
  40. package/resources/apps.d.mts.map +1 -1
  41. package/resources/apps.d.ts +81 -56
  42. package/resources/apps.d.ts.map +1 -1
  43. package/resources/apps.js +7 -4
  44. package/resources/apps.js.map +1 -1
  45. package/resources/apps.mjs +7 -4
  46. package/resources/apps.mjs.map +1 -1
  47. package/resources/authorized-users.d.mts +32 -26
  48. package/resources/authorized-users.d.mts.map +1 -1
  49. package/resources/authorized-users.d.ts +32 -26
  50. package/resources/authorized-users.d.ts.map +1 -1
  51. package/resources/authorized-users.js +3 -2
  52. package/resources/authorized-users.js.map +1 -1
  53. package/resources/authorized-users.mjs +3 -2
  54. package/resources/authorized-users.mjs.map +1 -1
  55. package/resources/chat-channels.d.mts +27 -19
  56. package/resources/chat-channels.d.mts.map +1 -1
  57. package/resources/chat-channels.d.ts +27 -19
  58. package/resources/chat-channels.d.ts.map +1 -1
  59. package/resources/chat-channels.js +5 -3
  60. package/resources/chat-channels.js.map +1 -1
  61. package/resources/chat-channels.mjs +5 -3
  62. package/resources/chat-channels.mjs.map +1 -1
  63. package/resources/checkout-configurations.d.mts +55 -46
  64. package/resources/checkout-configurations.d.mts.map +1 -1
  65. package/resources/checkout-configurations.d.ts +55 -46
  66. package/resources/checkout-configurations.d.ts.map +1 -1
  67. package/resources/checkout-configurations.js +3 -2
  68. package/resources/checkout-configurations.js.map +1 -1
  69. package/resources/checkout-configurations.mjs +3 -2
  70. package/resources/checkout-configurations.mjs.map +1 -1
  71. package/resources/companies.d.mts +65 -46
  72. package/resources/companies.d.mts.map +1 -1
  73. package/resources/companies.d.ts +65 -46
  74. package/resources/companies.d.ts.map +1 -1
  75. package/resources/companies.js +7 -8
  76. package/resources/companies.js.map +1 -1
  77. package/resources/companies.mjs +7 -8
  78. package/resources/companies.mjs.map +1 -1
  79. package/resources/company-token-transactions.d.mts +80 -57
  80. package/resources/company-token-transactions.d.mts.map +1 -1
  81. package/resources/company-token-transactions.d.ts +80 -57
  82. package/resources/company-token-transactions.d.ts.map +1 -1
  83. package/resources/company-token-transactions.js +6 -3
  84. package/resources/company-token-transactions.js.map +1 -1
  85. package/resources/company-token-transactions.mjs +6 -3
  86. package/resources/company-token-transactions.mjs.map +1 -1
  87. package/resources/course-chapters.d.mts +24 -19
  88. package/resources/course-chapters.d.mts.map +1 -1
  89. package/resources/course-chapters.d.ts +24 -19
  90. package/resources/course-chapters.d.ts.map +1 -1
  91. package/resources/course-chapters.js +5 -5
  92. package/resources/course-chapters.mjs +5 -5
  93. package/resources/course-lesson-interactions.d.mts +7 -6
  94. package/resources/course-lesson-interactions.d.mts.map +1 -1
  95. package/resources/course-lesson-interactions.d.ts +7 -6
  96. package/resources/course-lesson-interactions.d.ts.map +1 -1
  97. package/resources/course-lesson-interactions.js +3 -2
  98. package/resources/course-lesson-interactions.js.map +1 -1
  99. package/resources/course-lesson-interactions.mjs +3 -2
  100. package/resources/course-lesson-interactions.mjs.map +1 -1
  101. package/resources/course-lessons.d.mts +126 -84
  102. package/resources/course-lessons.d.mts.map +1 -1
  103. package/resources/course-lessons.d.ts +126 -84
  104. package/resources/course-lessons.d.ts.map +1 -1
  105. package/resources/course-lessons.js +12 -8
  106. package/resources/course-lessons.js.map +1 -1
  107. package/resources/course-lessons.mjs +12 -8
  108. package/resources/course-lessons.mjs.map +1 -1
  109. package/resources/course-students.d.mts +38 -29
  110. package/resources/course-students.d.mts.map +1 -1
  111. package/resources/course-students.d.ts +38 -29
  112. package/resources/course-students.d.ts.map +1 -1
  113. package/resources/course-students.js +3 -2
  114. package/resources/course-students.js.map +1 -1
  115. package/resources/course-students.mjs +3 -2
  116. package/resources/course-students.mjs.map +1 -1
  117. package/resources/courses.d.mts +132 -91
  118. package/resources/courses.d.mts.map +1 -1
  119. package/resources/courses.d.ts +132 -91
  120. package/resources/courses.d.ts.map +1 -1
  121. package/resources/courses.js +9 -5
  122. package/resources/courses.js.map +1 -1
  123. package/resources/courses.mjs +9 -5
  124. package/resources/courses.mjs.map +1 -1
  125. package/resources/disputes.d.mts +156 -102
  126. package/resources/disputes.d.mts.map +1 -1
  127. package/resources/disputes.d.ts +156 -102
  128. package/resources/disputes.d.ts.map +1 -1
  129. package/resources/disputes.js +4 -2
  130. package/resources/disputes.js.map +1 -1
  131. package/resources/disputes.mjs +4 -2
  132. package/resources/disputes.mjs.map +1 -1
  133. package/resources/dm-channels.d.mts +29 -16
  134. package/resources/dm-channels.d.mts.map +1 -1
  135. package/resources/dm-channels.d.ts +29 -16
  136. package/resources/dm-channels.d.ts.map +1 -1
  137. package/resources/dm-channels.js +9 -5
  138. package/resources/dm-channels.js.map +1 -1
  139. package/resources/dm-channels.mjs +9 -5
  140. package/resources/dm-channels.mjs.map +1 -1
  141. package/resources/dm-members.d.mts +30 -21
  142. package/resources/dm-members.d.mts.map +1 -1
  143. package/resources/dm-members.d.ts +30 -21
  144. package/resources/dm-members.d.ts.map +1 -1
  145. package/resources/dm-members.js +9 -5
  146. package/resources/dm-members.js.map +1 -1
  147. package/resources/dm-members.mjs +9 -5
  148. package/resources/dm-members.mjs.map +1 -1
  149. package/resources/entries.d.mts +29 -21
  150. package/resources/entries.d.mts.map +1 -1
  151. package/resources/entries.d.ts +29 -21
  152. package/resources/entries.d.ts.map +1 -1
  153. package/resources/entries.js +7 -4
  154. package/resources/entries.js.map +1 -1
  155. package/resources/entries.mjs +7 -4
  156. package/resources/entries.mjs.map +1 -1
  157. package/resources/experiences.d.mts +53 -45
  158. package/resources/experiences.d.mts.map +1 -1
  159. package/resources/experiences.d.ts +53 -45
  160. package/resources/experiences.d.ts.map +1 -1
  161. package/resources/experiences.js +6 -5
  162. package/resources/experiences.js.map +1 -1
  163. package/resources/experiences.mjs +6 -5
  164. package/resources/experiences.mjs.map +1 -1
  165. package/resources/fee-markups.d.mts +32 -21
  166. package/resources/fee-markups.d.mts.map +1 -1
  167. package/resources/fee-markups.d.ts +32 -21
  168. package/resources/fee-markups.d.ts.map +1 -1
  169. package/resources/fee-markups.js +6 -3
  170. package/resources/fee-markups.js.map +1 -1
  171. package/resources/fee-markups.mjs +6 -3
  172. package/resources/fee-markups.mjs.map +1 -1
  173. package/resources/files.d.mts +21 -17
  174. package/resources/files.d.mts.map +1 -1
  175. package/resources/files.d.ts +21 -17
  176. package/resources/files.d.ts.map +1 -1
  177. package/resources/files.js +3 -2
  178. package/resources/files.js.map +1 -1
  179. package/resources/files.mjs +3 -2
  180. package/resources/files.mjs.map +1 -1
  181. package/resources/forum-posts.d.mts +62 -43
  182. package/resources/forum-posts.d.mts.map +1 -1
  183. package/resources/forum-posts.d.ts +62 -43
  184. package/resources/forum-posts.d.ts.map +1 -1
  185. package/resources/forum-posts.js +8 -4
  186. package/resources/forum-posts.js.map +1 -1
  187. package/resources/forum-posts.mjs +8 -4
  188. package/resources/forum-posts.mjs.map +1 -1
  189. package/resources/forums.d.mts +20 -12
  190. package/resources/forums.d.mts.map +1 -1
  191. package/resources/forums.d.ts +20 -12
  192. package/resources/forums.d.ts.map +1 -1
  193. package/resources/forums.js +5 -3
  194. package/resources/forums.js.map +1 -1
  195. package/resources/forums.mjs +5 -3
  196. package/resources/forums.mjs.map +1 -1
  197. package/resources/index.d.mts +2 -2
  198. package/resources/index.d.mts.map +1 -1
  199. package/resources/index.d.ts +2 -2
  200. package/resources/index.d.ts.map +1 -1
  201. package/resources/index.js.map +1 -1
  202. package/resources/index.mjs.map +1 -1
  203. package/resources/invoices.d.mts +108 -80
  204. package/resources/invoices.d.mts.map +1 -1
  205. package/resources/invoices.d.ts +108 -80
  206. package/resources/invoices.d.ts.map +1 -1
  207. package/resources/invoices.js +7 -4
  208. package/resources/invoices.js.map +1 -1
  209. package/resources/invoices.mjs +7 -4
  210. package/resources/invoices.mjs.map +1 -1
  211. package/resources/leads.d.mts +64 -42
  212. package/resources/leads.d.mts.map +1 -1
  213. package/resources/leads.d.ts +64 -42
  214. package/resources/leads.d.ts.map +1 -1
  215. package/resources/leads.js +6 -4
  216. package/resources/leads.js.map +1 -1
  217. package/resources/leads.mjs +6 -4
  218. package/resources/leads.mjs.map +1 -1
  219. package/resources/ledger-accounts.d.mts +10 -8
  220. package/resources/ledger-accounts.d.mts.map +1 -1
  221. package/resources/ledger-accounts.d.ts +10 -8
  222. package/resources/ledger-accounts.d.ts.map +1 -1
  223. package/resources/ledger-accounts.js +1 -1
  224. package/resources/ledger-accounts.mjs +1 -1
  225. package/resources/members.d.mts +18 -19
  226. package/resources/members.d.mts.map +1 -1
  227. package/resources/members.d.ts +18 -19
  228. package/resources/members.d.ts.map +1 -1
  229. package/resources/members.js +3 -2
  230. package/resources/members.js.map +1 -1
  231. package/resources/members.mjs +3 -2
  232. package/resources/members.mjs.map +1 -1
  233. package/resources/memberships.d.mts +69 -51
  234. package/resources/memberships.d.mts.map +1 -1
  235. package/resources/memberships.d.ts +69 -51
  236. package/resources/memberships.d.ts.map +1 -1
  237. package/resources/memberships.js +12 -8
  238. package/resources/memberships.js.map +1 -1
  239. package/resources/memberships.mjs +12 -8
  240. package/resources/memberships.mjs.map +1 -1
  241. package/resources/messages.d.mts +46 -32
  242. package/resources/messages.d.mts.map +1 -1
  243. package/resources/messages.d.ts +46 -32
  244. package/resources/messages.d.ts.map +1 -1
  245. package/resources/messages.js +9 -5
  246. package/resources/messages.js.map +1 -1
  247. package/resources/messages.mjs +9 -5
  248. package/resources/messages.mjs.map +1 -1
  249. package/resources/notifications.d.mts +33 -25
  250. package/resources/notifications.d.mts.map +1 -1
  251. package/resources/notifications.d.ts +33 -25
  252. package/resources/notifications.d.ts.map +1 -1
  253. package/resources/notifications.js +2 -1
  254. package/resources/notifications.js.map +1 -1
  255. package/resources/notifications.mjs +2 -1
  256. package/resources/notifications.mjs.map +1 -1
  257. package/resources/payment-methods.d.mts +212 -114
  258. package/resources/payment-methods.d.mts.map +1 -1
  259. package/resources/payment-methods.d.ts +212 -114
  260. package/resources/payment-methods.d.ts.map +1 -1
  261. package/resources/payment-methods.js +5 -10
  262. package/resources/payment-methods.js.map +1 -1
  263. package/resources/payment-methods.mjs +5 -10
  264. package/resources/payment-methods.mjs.map +1 -1
  265. package/resources/payments.d.mts +73 -40
  266. package/resources/payments.d.mts.map +1 -1
  267. package/resources/payments.d.ts +73 -40
  268. package/resources/payments.d.ts.map +1 -1
  269. package/resources/payments.js +23 -10
  270. package/resources/payments.js.map +1 -1
  271. package/resources/payments.mjs +23 -10
  272. package/resources/payments.mjs.map +1 -1
  273. package/resources/payout-methods.d.mts +44 -29
  274. package/resources/payout-methods.d.mts.map +1 -1
  275. package/resources/payout-methods.d.ts +44 -29
  276. package/resources/payout-methods.d.ts.map +1 -1
  277. package/resources/payout-methods.js +3 -2
  278. package/resources/payout-methods.js.map +1 -1
  279. package/resources/payout-methods.mjs +3 -2
  280. package/resources/payout-methods.mjs.map +1 -1
  281. package/resources/plans.d.mts +121 -90
  282. package/resources/plans.d.mts.map +1 -1
  283. package/resources/plans.d.ts +121 -90
  284. package/resources/plans.d.ts.map +1 -1
  285. package/resources/plans.js +9 -5
  286. package/resources/plans.js.map +1 -1
  287. package/resources/plans.mjs +9 -5
  288. package/resources/plans.mjs.map +1 -1
  289. package/resources/products.d.mts +76 -65
  290. package/resources/products.d.mts.map +1 -1
  291. package/resources/products.d.ts +76 -65
  292. package/resources/products.d.ts.map +1 -1
  293. package/resources/products.js +7 -5
  294. package/resources/products.js.map +1 -1
  295. package/resources/products.mjs +7 -5
  296. package/resources/products.mjs.map +1 -1
  297. package/resources/promo-codes.d.mts +41 -31
  298. package/resources/promo-codes.d.mts.map +1 -1
  299. package/resources/promo-codes.d.ts +41 -31
  300. package/resources/promo-codes.d.ts.map +1 -1
  301. package/resources/promo-codes.js +7 -4
  302. package/resources/promo-codes.js.map +1 -1
  303. package/resources/promo-codes.mjs +7 -4
  304. package/resources/promo-codes.mjs.map +1 -1
  305. package/resources/reactions.d.mts +24 -18
  306. package/resources/reactions.d.mts.map +1 -1
  307. package/resources/reactions.d.ts +24 -18
  308. package/resources/reactions.d.ts.map +1 -1
  309. package/resources/reactions.js +7 -4
  310. package/resources/reactions.js.map +1 -1
  311. package/resources/reactions.mjs +7 -4
  312. package/resources/reactions.mjs.map +1 -1
  313. package/resources/refunds.d.mts +43 -29
  314. package/resources/refunds.d.mts.map +1 -1
  315. package/resources/refunds.d.ts +43 -29
  316. package/resources/refunds.d.ts.map +1 -1
  317. package/resources/refunds.js +3 -2
  318. package/resources/refunds.js.map +1 -1
  319. package/resources/refunds.mjs +3 -2
  320. package/resources/refunds.mjs.map +1 -1
  321. package/resources/reviews.d.mts +66 -50
  322. package/resources/reviews.d.mts.map +1 -1
  323. package/resources/reviews.d.ts +66 -50
  324. package/resources/reviews.d.ts.map +1 -1
  325. package/resources/reviews.js +3 -2
  326. package/resources/reviews.js.map +1 -1
  327. package/resources/reviews.mjs +3 -2
  328. package/resources/reviews.mjs.map +1 -1
  329. package/resources/setup-intents.d.mts +61 -43
  330. package/resources/setup-intents.d.mts.map +1 -1
  331. package/resources/setup-intents.d.ts +61 -43
  332. package/resources/setup-intents.d.ts.map +1 -1
  333. package/resources/setup-intents.js +4 -10
  334. package/resources/setup-intents.js.map +1 -1
  335. package/resources/setup-intents.mjs +4 -10
  336. package/resources/setup-intents.mjs.map +1 -1
  337. package/resources/shared.d.mts +695 -388
  338. package/resources/shared.d.mts.map +1 -1
  339. package/resources/shared.d.ts +695 -388
  340. package/resources/shared.d.ts.map +1 -1
  341. package/resources/shipments.d.mts +26 -17
  342. package/resources/shipments.d.mts.map +1 -1
  343. package/resources/shipments.d.ts +26 -17
  344. package/resources/shipments.d.ts.map +1 -1
  345. package/resources/shipments.js +5 -3
  346. package/resources/shipments.js.map +1 -1
  347. package/resources/shipments.mjs +5 -3
  348. package/resources/shipments.mjs.map +1 -1
  349. package/resources/support-channels.d.mts +27 -19
  350. package/resources/support-channels.d.mts.map +1 -1
  351. package/resources/support-channels.d.ts +27 -19
  352. package/resources/support-channels.d.ts.map +1 -1
  353. package/resources/support-channels.js +5 -4
  354. package/resources/support-channels.js.map +1 -1
  355. package/resources/support-channels.mjs +5 -4
  356. package/resources/support-channels.mjs.map +1 -1
  357. package/resources/topups.d.mts +11 -9
  358. package/resources/topups.d.mts.map +1 -1
  359. package/resources/topups.d.ts +11 -9
  360. package/resources/topups.d.ts.map +1 -1
  361. package/resources/topups.js +2 -1
  362. package/resources/topups.js.map +1 -1
  363. package/resources/topups.mjs +2 -1
  364. package/resources/topups.mjs.map +1 -1
  365. package/resources/transfers.d.mts +35 -29
  366. package/resources/transfers.d.mts.map +1 -1
  367. package/resources/transfers.d.ts +35 -29
  368. package/resources/transfers.d.ts.map +1 -1
  369. package/resources/transfers.js +5 -3
  370. package/resources/transfers.js.map +1 -1
  371. package/resources/transfers.mjs +5 -3
  372. package/resources/transfers.mjs.map +1 -1
  373. package/resources/users.d.mts +20 -16
  374. package/resources/users.d.mts.map +1 -1
  375. package/resources/users.d.ts +20 -16
  376. package/resources/users.d.ts.map +1 -1
  377. package/resources/users.js +4 -3
  378. package/resources/users.js.map +1 -1
  379. package/resources/users.mjs +4 -3
  380. package/resources/users.mjs.map +1 -1
  381. package/resources/verifications.d.mts +6 -4
  382. package/resources/verifications.d.mts.map +1 -1
  383. package/resources/verifications.d.ts +6 -4
  384. package/resources/verifications.d.ts.map +1 -1
  385. package/resources/verifications.js +1 -1
  386. package/resources/verifications.mjs +1 -1
  387. package/resources/webhooks.d.mts +136 -95
  388. package/resources/webhooks.d.mts.map +1 -1
  389. package/resources/webhooks.d.ts +136 -95
  390. package/resources/webhooks.d.ts.map +1 -1
  391. package/resources/webhooks.js +3 -2
  392. package/resources/webhooks.js.map +1 -1
  393. package/resources/webhooks.mjs +3 -2
  394. package/resources/webhooks.mjs.map +1 -1
  395. package/resources/withdrawals.d.mts +53 -44
  396. package/resources/withdrawals.d.mts.map +1 -1
  397. package/resources/withdrawals.d.ts +53 -44
  398. package/resources/withdrawals.d.ts.map +1 -1
  399. package/resources/withdrawals.js +3 -2
  400. package/resources/withdrawals.js.map +1 -1
  401. package/resources/withdrawals.mjs +3 -2
  402. package/resources/withdrawals.mjs.map +1 -1
  403. package/src/client.ts +13 -3
  404. package/src/resources/access-tokens.ts +19 -20
  405. package/src/resources/account-links.ts +15 -13
  406. package/src/resources/ai-chats.ts +39 -26
  407. package/src/resources/app-builds.ts +35 -33
  408. package/src/resources/apps.ts +84 -56
  409. package/src/resources/authorized-users.ts +32 -26
  410. package/src/resources/chat-channels.ts +27 -19
  411. package/src/resources/checkout-configurations.ts +56 -46
  412. package/src/resources/companies.ts +68 -46
  413. package/src/resources/company-token-transactions.ts +81 -58
  414. package/src/resources/course-chapters.ts +24 -19
  415. package/src/resources/course-lesson-interactions.ts +7 -6
  416. package/src/resources/course-lessons.ts +126 -84
  417. package/src/resources/course-students.ts +38 -29
  418. package/src/resources/courses.ts +132 -91
  419. package/src/resources/disputes.ts +156 -102
  420. package/src/resources/dm-channels.ts +29 -16
  421. package/src/resources/dm-members.ts +30 -21
  422. package/src/resources/entries.ts +29 -21
  423. package/src/resources/experiences.ts +53 -45
  424. package/src/resources/fee-markups.ts +32 -21
  425. package/src/resources/files.ts +21 -17
  426. package/src/resources/forum-posts.ts +63 -43
  427. package/src/resources/forums.ts +20 -12
  428. package/src/resources/index.ts +2 -1
  429. package/src/resources/invoices.ts +112 -80
  430. package/src/resources/leads.ts +64 -42
  431. package/src/resources/ledger-accounts.ts +10 -8
  432. package/src/resources/members.ts +18 -19
  433. package/src/resources/memberships.ts +69 -51
  434. package/src/resources/messages.ts +46 -32
  435. package/src/resources/notifications.ts +33 -25
  436. package/src/resources/payment-methods.ts +212 -114
  437. package/src/resources/payments.ts +77 -39
  438. package/src/resources/payout-methods.ts +44 -29
  439. package/src/resources/plans.ts +121 -90
  440. package/src/resources/products.ts +215 -68
  441. package/src/resources/promo-codes.ts +41 -31
  442. package/src/resources/reactions.ts +24 -18
  443. package/src/resources/refunds.ts +44 -29
  444. package/src/resources/reviews.ts +66 -50
  445. package/src/resources/setup-intents.ts +61 -43
  446. package/src/resources/shared.ts +2637 -387
  447. package/src/resources/shipments.ts +26 -17
  448. package/src/resources/support-channels.ts +27 -19
  449. package/src/resources/topups.ts +11 -9
  450. package/src/resources/transfers.ts +35 -29
  451. package/src/resources/users.ts +20 -16
  452. package/src/resources/verifications.ts +6 -4
  453. package/src/resources/webhooks.ts +136 -95
  454. package/src/resources/withdrawals.ts +53 -43
  455. package/src/version.ts +1 -1
  456. package/version.d.mts +1 -1
  457. package/version.d.ts +1 -1
  458. package/version.js +1 -1
  459. package/version.mjs +1 -1
@@ -10,11 +10,7 @@ import { path } from '../internal/utils/path';
10
10
 
11
11
  export class PaymentMethods extends APIResource {
12
12
  /**
13
- * A payment method is a stored representation of how a customer intends to pay,
14
- * such as a card, bank account, or digital wallet. It holds the necessary billing
15
- * details and can be attached to a member for future one-time or recurring
16
- * charges. This lets you reuse the same payment credentials across multiple
17
- * payments. You must provide exactly one of company_id or member_id.
13
+ * Retrieves the details of an existing payment method.
18
14
  *
19
15
  * Required permissions:
20
16
  *
@@ -29,11 +25,10 @@ export class PaymentMethods extends APIResource {
29
25
  }
30
26
 
31
27
  /**
32
- * A payment method is a stored representation of how a customer intends to pay,
33
- * such as a card, bank account, or digital wallet. It holds the necessary billing
34
- * details and can be attached to a member for future one-time or recurring
35
- * charges. This lets you reuse the same payment credentials across multiple
36
- * payments.
28
+ * Returns a paginated list of payment methods for a member or company, with
29
+ * optional filtering by creation date. A payment method is a stored representation
30
+ * of how a customer intends to pay, such as a card, bank account, or digital
31
+ * wallet.
37
32
  *
38
33
  * Required permissions:
39
34
  *
@@ -53,7 +48,7 @@ export class PaymentMethods extends APIResource {
53
48
  export type PaymentMethodListResponsesCursorPage = CursorPage<PaymentMethodListResponse>;
54
49
 
55
50
  /**
56
- * A payment method with no additional properties
51
+ * A saved payment method with no type-specific details available.
57
52
  */
58
53
  export type PaymentMethodRetrieveResponse =
59
54
  | PaymentMethodRetrieveResponse.BasePaymentMethod
@@ -65,21 +60,26 @@ export type PaymentMethodRetrieveResponse =
65
60
 
66
61
  export namespace PaymentMethodRetrieveResponse {
67
62
  /**
68
- * A payment method with no additional properties
63
+ * A saved payment method with no type-specific details available.
69
64
  */
70
65
  export interface BasePaymentMethod {
71
66
  /**
72
- * The ID of the payment method
67
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
68
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
69
+ * as a String; however, it is not intended to be human-readable. When expected as
70
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
71
+ * input value will be accepted as an ID.
73
72
  */
74
73
  id: string;
75
74
 
76
75
  /**
77
- * When the payment method was created
76
+ * The time of the event in ISO 8601 UTC format with millisecond precision
78
77
  */
79
78
  created_at: string;
80
79
 
81
80
  /**
82
- * The type of the payment method
81
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
82
+ * cashapp, ideal, sepa_debit).
83
83
  */
84
84
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
85
85
 
@@ -90,26 +90,33 @@ export namespace PaymentMethodRetrieveResponse {
90
90
  }
91
91
 
92
92
  /**
93
- * The card for the payment method
93
+ * A saved card payment method, including brand, last four digits, and expiration
94
+ * details.
94
95
  */
95
96
  export interface CardPaymentMethod {
96
97
  /**
97
- * The ID of the payment method
98
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
99
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
100
+ * as a String; however, it is not intended to be human-readable. When expected as
101
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
102
+ * input value will be accepted as an ID.
98
103
  */
99
104
  id: string;
100
105
 
101
106
  /**
102
- * The card details associated with this payment method
107
+ * The card-specific details for this payment method, including brand, last four
108
+ * digits, and expiration.
103
109
  */
104
110
  card: CardPaymentMethod.Card;
105
111
 
106
112
  /**
107
- * When the payment method was created
113
+ * The time of the event in ISO 8601 UTC format with millisecond precision
108
114
  */
109
115
  created_at: string;
110
116
 
111
117
  /**
112
- * The type of the payment method
118
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
119
+ * cashapp, ideal, sepa_debit).
113
120
  */
114
121
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
115
122
 
@@ -121,7 +128,8 @@ export namespace PaymentMethodRetrieveResponse {
121
128
 
122
129
  export namespace CardPaymentMethod {
123
130
  /**
124
- * The card details associated with this payment method
131
+ * The card-specific details for this payment method, including brand, last four
132
+ * digits, and expiration.
125
133
  */
126
134
  export interface Card {
127
135
  /**
@@ -130,38 +138,45 @@ export namespace PaymentMethodRetrieveResponse {
130
138
  brand: PaymentsAPI.CardBrands | null;
131
139
 
132
140
  /**
133
- * Card expiration month, like 03 for March.
141
+ * The two-digit expiration month of the card (1-12). Null if not available.
134
142
  */
135
143
  exp_month: number | null;
136
144
 
137
145
  /**
138
- * Card expiration year, like 27 for 2027.
146
+ * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
147
+ * available.
139
148
  */
140
149
  exp_year: number | null;
141
150
 
142
151
  /**
143
- * Last four digits of the card.
152
+ * The last four digits of the card number. Null if not available.
144
153
  */
145
154
  last4: string | null;
146
155
  }
147
156
  }
148
157
 
149
158
  /**
150
- * The bank account for the payment method
159
+ * A saved US bank account payment method, including bank name, last four digits,
160
+ * and account type.
151
161
  */
152
162
  export interface UsBankAccountPaymentMethod {
153
163
  /**
154
- * The ID of the payment method
164
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
165
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
166
+ * as a String; however, it is not intended to be human-readable. When expected as
167
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
168
+ * input value will be accepted as an ID.
155
169
  */
156
170
  id: string;
157
171
 
158
172
  /**
159
- * When the payment method was created
173
+ * The time of the event in ISO 8601 UTC format with millisecond precision
160
174
  */
161
175
  created_at: string;
162
176
 
163
177
  /**
164
- * The type of the payment method
178
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
179
+ * cashapp, ideal, sepa_debit).
165
180
  */
166
181
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
167
182
 
@@ -171,54 +186,63 @@ export namespace PaymentMethodRetrieveResponse {
171
186
  typename: 'UsBankAccountPaymentMethod';
172
187
 
173
188
  /**
174
- * The bank details associated with this payment method
189
+ * The bank account-specific details for this payment method, including bank name
190
+ * and last four digits.
175
191
  */
176
192
  us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
177
193
  }
178
194
 
179
195
  export namespace UsBankAccountPaymentMethod {
180
196
  /**
181
- * The bank details associated with this payment method
197
+ * The bank account-specific details for this payment method, including bank name
198
+ * and last four digits.
182
199
  */
183
200
  export interface UsBankAccount {
184
201
  /**
185
- * The type of account
202
+ * The type of bank account (e.g., checking, savings).
186
203
  */
187
204
  account_type: string;
188
205
 
189
206
  /**
190
- * The name of the bank
207
+ * The name of the financial institution holding the account.
191
208
  */
192
209
  bank_name: string;
193
210
 
194
211
  /**
195
- * The last 4 digits of the account number
212
+ * The last four digits of the bank account number.
196
213
  */
197
214
  last4: string;
198
215
  }
199
216
  }
200
217
 
201
218
  /**
202
- * The Cash App details for the payment method
219
+ * A saved Cash App payment method, including the buyer's cashtag and unique
220
+ * identifier.
203
221
  */
204
222
  export interface CashappPaymentMethod {
205
223
  /**
206
- * The ID of the payment method
224
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
225
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
226
+ * as a String; however, it is not intended to be human-readable. When expected as
227
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
228
+ * input value will be accepted as an ID.
207
229
  */
208
230
  id: string;
209
231
 
210
232
  /**
211
- * The Cash App details associated with this payment method
233
+ * The Cash App-specific details for this payment method, including cashtag and
234
+ * buyer ID.
212
235
  */
213
236
  cashapp: CashappPaymentMethod.Cashapp;
214
237
 
215
238
  /**
216
- * When the payment method was created
239
+ * The time of the event in ISO 8601 UTC format with millisecond precision
217
240
  */
218
241
  created_at: string;
219
242
 
220
243
  /**
221
- * The type of the payment method
244
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
245
+ * cashapp, ideal, sepa_debit).
222
246
  */
223
247
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
224
248
 
@@ -230,42 +254,49 @@ export namespace PaymentMethodRetrieveResponse {
230
254
 
231
255
  export namespace CashappPaymentMethod {
232
256
  /**
233
- * The Cash App details associated with this payment method
257
+ * The Cash App-specific details for this payment method, including cashtag and
258
+ * buyer ID.
234
259
  */
235
260
  export interface Cashapp {
236
261
  /**
237
- * A unique and immutable identifier assigned by Cash App to every buyer.
262
+ * The unique and immutable identifier assigned by Cash App to the buyer. Null if
263
+ * not available.
238
264
  */
239
265
  buyer_id: string | null;
240
266
 
241
267
  /**
242
- * A public identifier for buyers using Cash App.
268
+ * The public cashtag handle of the buyer on Cash App. Null if not available.
243
269
  */
244
270
  cashtag: string | null;
245
271
  }
246
272
  }
247
273
 
248
274
  /**
249
- * The iDEAL details for the payment method
275
+ * A saved iDEAL payment method, including the customer's bank name and BIC code.
250
276
  */
251
277
  export interface IdealPaymentMethod {
252
278
  /**
253
- * The ID of the payment method
279
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
280
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
281
+ * as a String; however, it is not intended to be human-readable. When expected as
282
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
283
+ * input value will be accepted as an ID.
254
284
  */
255
285
  id: string;
256
286
 
257
287
  /**
258
- * When the payment method was created
288
+ * The time of the event in ISO 8601 UTC format with millisecond precision
259
289
  */
260
290
  created_at: string;
261
291
 
262
292
  /**
263
- * The iDEAL details associated with this payment method
293
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
264
294
  */
265
295
  ideal: IdealPaymentMethod.Ideal;
266
296
 
267
297
  /**
268
- * The type of the payment method
298
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
299
+ * cashapp, ideal, sepa_debit).
269
300
  */
270
301
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
271
302
 
@@ -277,42 +308,51 @@ export namespace PaymentMethodRetrieveResponse {
277
308
 
278
309
  export namespace IdealPaymentMethod {
279
310
  /**
280
- * The iDEAL details associated with this payment method
311
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
281
312
  */
282
313
  export interface Ideal {
283
314
  /**
284
- * The customer's bank.
315
+ * The name of the customer's bank used for the iDEAL transaction. Null if not
316
+ * available.
285
317
  */
286
318
  bank: string | null;
287
319
 
288
320
  /**
289
- * The Bank Identifier Code of the customer's bank.
321
+ * The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not
322
+ * available.
290
323
  */
291
324
  bic: string | null;
292
325
  }
293
326
  }
294
327
 
295
328
  /**
296
- * The SEPA Direct Debit details for the payment method
329
+ * A saved SEPA Direct Debit payment method, including the bank code, country, and
330
+ * last four IBAN digits.
297
331
  */
298
332
  export interface SepaDebitPaymentMethod {
299
333
  /**
300
- * The ID of the payment method
334
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
335
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
336
+ * as a String; however, it is not intended to be human-readable. When expected as
337
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
338
+ * input value will be accepted as an ID.
301
339
  */
302
340
  id: string;
303
341
 
304
342
  /**
305
- * When the payment method was created
343
+ * The time of the event in ISO 8601 UTC format with millisecond precision
306
344
  */
307
345
  created_at: string;
308
346
 
309
347
  /**
310
- * The type of the payment method
348
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
349
+ * cashapp, ideal, sepa_debit).
311
350
  */
312
351
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
313
352
 
314
353
  /**
315
- * The SEPA Direct Debit details associated with this payment method
354
+ * The SEPA Direct Debit-specific details for this payment method, including bank
355
+ * code and last four IBAN digits.
316
356
  */
317
357
  sepa_debit: SepaDebitPaymentMethod.SepaDebit;
318
358
 
@@ -324,26 +364,31 @@ export namespace PaymentMethodRetrieveResponse {
324
364
 
325
365
  export namespace SepaDebitPaymentMethod {
326
366
  /**
327
- * The SEPA Direct Debit details associated with this payment method
367
+ * The SEPA Direct Debit-specific details for this payment method, including bank
368
+ * code and last four IBAN digits.
328
369
  */
329
370
  export interface SepaDebit {
330
371
  /**
331
- * Bank code of the bank associated with the account.
372
+ * The bank code of the financial institution associated with this SEPA account.
373
+ * Null if not available.
332
374
  */
333
375
  bank_code: string | null;
334
376
 
335
377
  /**
336
- * Branch code of the bank associated with the account.
378
+ * The branch code of the financial institution associated with this SEPA account.
379
+ * Null if not available.
337
380
  */
338
381
  branch_code: string | null;
339
382
 
340
383
  /**
341
- * Two-letter ISO code representing the country the bank account is located in.
384
+ * The two-letter ISO country code where the bank account is located. Null if not
385
+ * available.
342
386
  */
343
387
  country: string | null;
344
388
 
345
389
  /**
346
- * Last four digits of the IBAN.
390
+ * The last four digits of the IBAN associated with this SEPA account. Null if not
391
+ * available.
347
392
  */
348
393
  last4: string | null;
349
394
  }
@@ -351,7 +396,7 @@ export namespace PaymentMethodRetrieveResponse {
351
396
  }
352
397
 
353
398
  /**
354
- * A payment method with no additional properties
399
+ * A saved payment method with no type-specific details available.
355
400
  */
356
401
  export type PaymentMethodListResponse =
357
402
  | PaymentMethodListResponse.BasePaymentMethod
@@ -363,21 +408,26 @@ export type PaymentMethodListResponse =
363
408
 
364
409
  export namespace PaymentMethodListResponse {
365
410
  /**
366
- * A payment method with no additional properties
411
+ * A saved payment method with no type-specific details available.
367
412
  */
368
413
  export interface BasePaymentMethod {
369
414
  /**
370
- * The ID of the payment method
415
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
416
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
417
+ * as a String; however, it is not intended to be human-readable. When expected as
418
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
419
+ * input value will be accepted as an ID.
371
420
  */
372
421
  id: string;
373
422
 
374
423
  /**
375
- * When the payment method was created
424
+ * The time of the event in ISO 8601 UTC format with millisecond precision
376
425
  */
377
426
  created_at: string;
378
427
 
379
428
  /**
380
- * The type of the payment method
429
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
430
+ * cashapp, ideal, sepa_debit).
381
431
  */
382
432
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
383
433
 
@@ -388,26 +438,33 @@ export namespace PaymentMethodListResponse {
388
438
  }
389
439
 
390
440
  /**
391
- * The card for the payment method
441
+ * A saved card payment method, including brand, last four digits, and expiration
442
+ * details.
392
443
  */
393
444
  export interface CardPaymentMethod {
394
445
  /**
395
- * The ID of the payment method
446
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
447
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
448
+ * as a String; however, it is not intended to be human-readable. When expected as
449
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
450
+ * input value will be accepted as an ID.
396
451
  */
397
452
  id: string;
398
453
 
399
454
  /**
400
- * The card details associated with this payment method
455
+ * The card-specific details for this payment method, including brand, last four
456
+ * digits, and expiration.
401
457
  */
402
458
  card: CardPaymentMethod.Card;
403
459
 
404
460
  /**
405
- * When the payment method was created
461
+ * The time of the event in ISO 8601 UTC format with millisecond precision
406
462
  */
407
463
  created_at: string;
408
464
 
409
465
  /**
410
- * The type of the payment method
466
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
467
+ * cashapp, ideal, sepa_debit).
411
468
  */
412
469
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
413
470
 
@@ -419,7 +476,8 @@ export namespace PaymentMethodListResponse {
419
476
 
420
477
  export namespace CardPaymentMethod {
421
478
  /**
422
- * The card details associated with this payment method
479
+ * The card-specific details for this payment method, including brand, last four
480
+ * digits, and expiration.
423
481
  */
424
482
  export interface Card {
425
483
  /**
@@ -428,38 +486,45 @@ export namespace PaymentMethodListResponse {
428
486
  brand: PaymentsAPI.CardBrands | null;
429
487
 
430
488
  /**
431
- * Card expiration month, like 03 for March.
489
+ * The two-digit expiration month of the card (1-12). Null if not available.
432
490
  */
433
491
  exp_month: number | null;
434
492
 
435
493
  /**
436
- * Card expiration year, like 27 for 2027.
494
+ * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
495
+ * available.
437
496
  */
438
497
  exp_year: number | null;
439
498
 
440
499
  /**
441
- * Last four digits of the card.
500
+ * The last four digits of the card number. Null if not available.
442
501
  */
443
502
  last4: string | null;
444
503
  }
445
504
  }
446
505
 
447
506
  /**
448
- * The bank account for the payment method
507
+ * A saved US bank account payment method, including bank name, last four digits,
508
+ * and account type.
449
509
  */
450
510
  export interface UsBankAccountPaymentMethod {
451
511
  /**
452
- * The ID of the payment method
512
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
513
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
514
+ * as a String; however, it is not intended to be human-readable. When expected as
515
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
516
+ * input value will be accepted as an ID.
453
517
  */
454
518
  id: string;
455
519
 
456
520
  /**
457
- * When the payment method was created
521
+ * The time of the event in ISO 8601 UTC format with millisecond precision
458
522
  */
459
523
  created_at: string;
460
524
 
461
525
  /**
462
- * The type of the payment method
526
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
527
+ * cashapp, ideal, sepa_debit).
463
528
  */
464
529
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
465
530
 
@@ -469,54 +534,63 @@ export namespace PaymentMethodListResponse {
469
534
  typename: 'UsBankAccountPaymentMethod';
470
535
 
471
536
  /**
472
- * The bank details associated with this payment method
537
+ * The bank account-specific details for this payment method, including bank name
538
+ * and last four digits.
473
539
  */
474
540
  us_bank_account: UsBankAccountPaymentMethod.UsBankAccount;
475
541
  }
476
542
 
477
543
  export namespace UsBankAccountPaymentMethod {
478
544
  /**
479
- * The bank details associated with this payment method
545
+ * The bank account-specific details for this payment method, including bank name
546
+ * and last four digits.
480
547
  */
481
548
  export interface UsBankAccount {
482
549
  /**
483
- * The type of account
550
+ * The type of bank account (e.g., checking, savings).
484
551
  */
485
552
  account_type: string;
486
553
 
487
554
  /**
488
- * The name of the bank
555
+ * The name of the financial institution holding the account.
489
556
  */
490
557
  bank_name: string;
491
558
 
492
559
  /**
493
- * The last 4 digits of the account number
560
+ * The last four digits of the bank account number.
494
561
  */
495
562
  last4: string;
496
563
  }
497
564
  }
498
565
 
499
566
  /**
500
- * The Cash App details for the payment method
567
+ * A saved Cash App payment method, including the buyer's cashtag and unique
568
+ * identifier.
501
569
  */
502
570
  export interface CashappPaymentMethod {
503
571
  /**
504
- * The ID of the payment method
572
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
573
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
574
+ * as a String; however, it is not intended to be human-readable. When expected as
575
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
576
+ * input value will be accepted as an ID.
505
577
  */
506
578
  id: string;
507
579
 
508
580
  /**
509
- * The Cash App details associated with this payment method
581
+ * The Cash App-specific details for this payment method, including cashtag and
582
+ * buyer ID.
510
583
  */
511
584
  cashapp: CashappPaymentMethod.Cashapp;
512
585
 
513
586
  /**
514
- * When the payment method was created
587
+ * The time of the event in ISO 8601 UTC format with millisecond precision
515
588
  */
516
589
  created_at: string;
517
590
 
518
591
  /**
519
- * The type of the payment method
592
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
593
+ * cashapp, ideal, sepa_debit).
520
594
  */
521
595
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
522
596
 
@@ -528,42 +602,49 @@ export namespace PaymentMethodListResponse {
528
602
 
529
603
  export namespace CashappPaymentMethod {
530
604
  /**
531
- * The Cash App details associated with this payment method
605
+ * The Cash App-specific details for this payment method, including cashtag and
606
+ * buyer ID.
532
607
  */
533
608
  export interface Cashapp {
534
609
  /**
535
- * A unique and immutable identifier assigned by Cash App to every buyer.
610
+ * The unique and immutable identifier assigned by Cash App to the buyer. Null if
611
+ * not available.
536
612
  */
537
613
  buyer_id: string | null;
538
614
 
539
615
  /**
540
- * A public identifier for buyers using Cash App.
616
+ * The public cashtag handle of the buyer on Cash App. Null if not available.
541
617
  */
542
618
  cashtag: string | null;
543
619
  }
544
620
  }
545
621
 
546
622
  /**
547
- * The iDEAL details for the payment method
623
+ * A saved iDEAL payment method, including the customer's bank name and BIC code.
548
624
  */
549
625
  export interface IdealPaymentMethod {
550
626
  /**
551
- * The ID of the payment method
627
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
628
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
629
+ * as a String; however, it is not intended to be human-readable. When expected as
630
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
631
+ * input value will be accepted as an ID.
552
632
  */
553
633
  id: string;
554
634
 
555
635
  /**
556
- * When the payment method was created
636
+ * The time of the event in ISO 8601 UTC format with millisecond precision
557
637
  */
558
638
  created_at: string;
559
639
 
560
640
  /**
561
- * The iDEAL details associated with this payment method
641
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
562
642
  */
563
643
  ideal: IdealPaymentMethod.Ideal;
564
644
 
565
645
  /**
566
- * The type of the payment method
646
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
647
+ * cashapp, ideal, sepa_debit).
567
648
  */
568
649
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
569
650
 
@@ -575,42 +656,51 @@ export namespace PaymentMethodListResponse {
575
656
 
576
657
  export namespace IdealPaymentMethod {
577
658
  /**
578
- * The iDEAL details associated with this payment method
659
+ * The iDEAL-specific details for this payment method, including bank name and BIC.
579
660
  */
580
661
  export interface Ideal {
581
662
  /**
582
- * The customer's bank.
663
+ * The name of the customer's bank used for the iDEAL transaction. Null if not
664
+ * available.
583
665
  */
584
666
  bank: string | null;
585
667
 
586
668
  /**
587
- * The Bank Identifier Code of the customer's bank.
669
+ * The Bank Identifier Code (BIC/SWIFT) of the customer's bank. Null if not
670
+ * available.
588
671
  */
589
672
  bic: string | null;
590
673
  }
591
674
  }
592
675
 
593
676
  /**
594
- * The SEPA Direct Debit details for the payment method
677
+ * A saved SEPA Direct Debit payment method, including the bank code, country, and
678
+ * last four IBAN digits.
595
679
  */
596
680
  export interface SepaDebitPaymentMethod {
597
681
  /**
598
- * The ID of the payment method
682
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
683
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
684
+ * as a String; however, it is not intended to be human-readable. When expected as
685
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
686
+ * input value will be accepted as an ID.
599
687
  */
600
688
  id: string;
601
689
 
602
690
  /**
603
- * When the payment method was created
691
+ * The time of the event in ISO 8601 UTC format with millisecond precision
604
692
  */
605
693
  created_at: string;
606
694
 
607
695
  /**
608
- * The type of the payment method
696
+ * The type of payment instrument stored on file (e.g., card, us_bank_account,
697
+ * cashapp, ideal, sepa_debit).
609
698
  */
610
699
  payment_method_type: PaymentsAPI.PaymentMethodTypes;
611
700
 
612
701
  /**
613
- * The SEPA Direct Debit details associated with this payment method
702
+ * The SEPA Direct Debit-specific details for this payment method, including bank
703
+ * code and last four IBAN digits.
614
704
  */
615
705
  sepa_debit: SepaDebitPaymentMethod.SepaDebit;
616
706
 
@@ -622,26 +712,31 @@ export namespace PaymentMethodListResponse {
622
712
 
623
713
  export namespace SepaDebitPaymentMethod {
624
714
  /**
625
- * The SEPA Direct Debit details associated with this payment method
715
+ * The SEPA Direct Debit-specific details for this payment method, including bank
716
+ * code and last four IBAN digits.
626
717
  */
627
718
  export interface SepaDebit {
628
719
  /**
629
- * Bank code of the bank associated with the account.
720
+ * The bank code of the financial institution associated with this SEPA account.
721
+ * Null if not available.
630
722
  */
631
723
  bank_code: string | null;
632
724
 
633
725
  /**
634
- * Branch code of the bank associated with the account.
726
+ * The branch code of the financial institution associated with this SEPA account.
727
+ * Null if not available.
635
728
  */
636
729
  branch_code: string | null;
637
730
 
638
731
  /**
639
- * Two-letter ISO code representing the country the bank account is located in.
732
+ * The two-letter ISO country code where the bank account is located. Null if not
733
+ * available.
640
734
  */
641
735
  country: string | null;
642
736
 
643
737
  /**
644
- * Last four digits of the IBAN.
738
+ * The last four digits of the IBAN associated with this SEPA account. Null if not
739
+ * available.
645
740
  */
646
741
  last4: string | null;
647
742
  }
@@ -650,12 +745,14 @@ export namespace PaymentMethodListResponse {
650
745
 
651
746
  export interface PaymentMethodRetrieveParams {
652
747
  /**
653
- * The ID of the Company. Provide either this or member_id (not both).
748
+ * The unique identifier of the company. Provide either this or member_id, not
749
+ * both.
654
750
  */
655
751
  company_id?: string | null;
656
752
 
657
753
  /**
658
- * The ID of the Member. Provide either this or company_id (not both).
754
+ * The unique identifier of the member. Provide either this or company_id, not
755
+ * both.
659
756
  */
660
757
  member_id?: string | null;
661
758
  }
@@ -667,17 +764,18 @@ export interface PaymentMethodListParams extends CursorPageParams {
667
764
  before?: string | null;
668
765
 
669
766
  /**
670
- * The ID of the Company. Provide either this or member_id (not both).
767
+ * The unique identifier of the company. Provide either this or member_id, not
768
+ * both.
671
769
  */
672
770
  company_id?: string | null;
673
771
 
674
772
  /**
675
- * The minimum creation date to filter by
773
+ * Only return payment methods created after this timestamp.
676
774
  */
677
775
  created_after?: string | null;
678
776
 
679
777
  /**
680
- * The maximum creation date to filter by
778
+ * Only return payment methods created before this timestamp.
681
779
  */
682
780
  created_before?: string | null;
683
781
 
@@ -697,7 +795,7 @@ export interface PaymentMethodListParams extends CursorPageParams {
697
795
  last?: number | null;
698
796
 
699
797
  /**
700
- * The ID of the Member to list payment methods for
798
+ * The unique identifier of the member to list payment methods for.
701
799
  */
702
800
  member_id?: string | null;
703
801
  }