@whop/sdk 0.0.39 → 0.0.40

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 (567) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/client.d.mts +88 -40
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +88 -40
  5. package/client.d.ts.map +1 -1
  6. package/client.js +59 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +59 -0
  9. package/client.mjs.map +1 -1
  10. package/internal/types.d.mts +6 -6
  11. package/internal/types.d.mts.map +1 -1
  12. package/internal/types.d.ts +6 -6
  13. package/internal/types.d.ts.map +1 -1
  14. package/internal/utils/log.d.mts.map +1 -1
  15. package/internal/utils/log.d.ts.map +1 -1
  16. package/internal/utils/log.js +2 -0
  17. package/internal/utils/log.js.map +1 -1
  18. package/internal/utils/log.mjs +2 -0
  19. package/internal/utils/log.mjs.map +1 -1
  20. package/package.json +15 -9
  21. package/resources/accounts.d.mts +244 -0
  22. package/resources/accounts.d.mts.map +1 -0
  23. package/resources/accounts.d.ts +244 -0
  24. package/resources/accounts.d.ts.map +1 -0
  25. package/resources/accounts.js +46 -0
  26. package/resources/accounts.js.map +1 -0
  27. package/resources/accounts.mjs +42 -0
  28. package/resources/accounts.mjs.map +1 -0
  29. package/resources/ad-campaigns.d.mts +296 -0
  30. package/resources/ad-campaigns.d.mts.map +1 -0
  31. package/resources/ad-campaigns.d.ts +296 -0
  32. package/resources/ad-campaigns.d.ts.map +1 -0
  33. package/resources/ad-campaigns.js +104 -0
  34. package/resources/ad-campaigns.js.map +1 -0
  35. package/resources/ad-campaigns.mjs +100 -0
  36. package/resources/ad-campaigns.mjs.map +1 -0
  37. package/resources/ad-groups.d.mts +1461 -0
  38. package/resources/ad-groups.d.mts.map +1 -0
  39. package/resources/ad-groups.d.ts +1461 -0
  40. package/resources/ad-groups.d.ts.map +1 -0
  41. package/resources/ad-groups.js +121 -0
  42. package/resources/ad-groups.js.map +1 -0
  43. package/resources/ad-groups.mjs +117 -0
  44. package/resources/ad-groups.mjs.map +1 -0
  45. package/resources/ad-reports.d.mts +379 -0
  46. package/resources/ad-reports.d.mts.map +1 -0
  47. package/resources/ad-reports.d.ts +379 -0
  48. package/resources/ad-reports.d.ts.map +1 -0
  49. package/resources/ad-reports.js +26 -0
  50. package/resources/ad-reports.js.map +1 -0
  51. package/resources/ad-reports.mjs +22 -0
  52. package/resources/ad-reports.mjs.map +1 -0
  53. package/resources/ads.d.mts +234 -0
  54. package/resources/ads.d.mts.map +1 -0
  55. package/resources/ads.d.ts +234 -0
  56. package/resources/ads.d.ts.map +1 -0
  57. package/resources/ads.js +56 -0
  58. package/resources/ads.js.map +1 -0
  59. package/resources/ads.mjs +52 -0
  60. package/resources/ads.mjs.map +1 -0
  61. package/resources/affiliates/affiliates.d.mts +31 -31
  62. package/resources/affiliates/affiliates.d.mts.map +1 -1
  63. package/resources/affiliates/affiliates.d.ts +31 -31
  64. package/resources/affiliates/affiliates.d.ts.map +1 -1
  65. package/resources/affiliates/affiliates.js +21 -21
  66. package/resources/affiliates/affiliates.js.map +1 -1
  67. package/resources/affiliates/affiliates.mjs +21 -21
  68. package/resources/affiliates/affiliates.mjs.map +1 -1
  69. package/resources/affiliates/index.d.mts +2 -2
  70. package/resources/affiliates/index.d.mts.map +1 -1
  71. package/resources/affiliates/index.d.ts +2 -2
  72. package/resources/affiliates/index.d.ts.map +1 -1
  73. package/resources/affiliates/overrides.d.mts +37 -37
  74. package/resources/affiliates/overrides.d.mts.map +1 -1
  75. package/resources/affiliates/overrides.d.ts +37 -37
  76. package/resources/affiliates/overrides.d.ts.map +1 -1
  77. package/resources/affiliates/overrides.js +23 -23
  78. package/resources/affiliates/overrides.js.map +1 -1
  79. package/resources/affiliates/overrides.mjs +23 -23
  80. package/resources/affiliates/overrides.mjs.map +1 -1
  81. package/resources/ai-chats.d.mts +23 -23
  82. package/resources/ai-chats.d.mts.map +1 -1
  83. package/resources/ai-chats.d.ts +23 -23
  84. package/resources/ai-chats.d.ts.map +1 -1
  85. package/resources/ai-chats.js +6 -6
  86. package/resources/ai-chats.js.map +1 -1
  87. package/resources/ai-chats.mjs +6 -6
  88. package/resources/ai-chats.mjs.map +1 -1
  89. package/resources/app-builds.d.mts +54 -54
  90. package/resources/app-builds.d.mts.map +1 -1
  91. package/resources/app-builds.d.ts +54 -54
  92. package/resources/app-builds.d.ts.map +1 -1
  93. package/resources/app-builds.js +21 -21
  94. package/resources/app-builds.js.map +1 -1
  95. package/resources/app-builds.mjs +21 -21
  96. package/resources/app-builds.mjs.map +1 -1
  97. package/resources/apps.d.mts +57 -57
  98. package/resources/apps.d.mts.map +1 -1
  99. package/resources/apps.d.ts +57 -57
  100. package/resources/apps.d.ts.map +1 -1
  101. package/resources/apps.js +15 -15
  102. package/resources/apps.js.map +1 -1
  103. package/resources/apps.mjs +15 -15
  104. package/resources/apps.mjs.map +1 -1
  105. package/resources/authorized-users.d.mts +36 -36
  106. package/resources/authorized-users.d.mts.map +1 -1
  107. package/resources/authorized-users.d.ts +36 -36
  108. package/resources/authorized-users.d.ts.map +1 -1
  109. package/resources/authorized-users.js +21 -21
  110. package/resources/authorized-users.js.map +1 -1
  111. package/resources/authorized-users.mjs +21 -21
  112. package/resources/authorized-users.mjs.map +1 -1
  113. package/resources/bounties.d.mts +281 -0
  114. package/resources/bounties.d.mts.map +1 -0
  115. package/resources/bounties.d.ts +281 -0
  116. package/resources/bounties.d.ts.map +1 -0
  117. package/resources/bounties.js +63 -0
  118. package/resources/bounties.js.map +1 -0
  119. package/resources/bounties.mjs +59 -0
  120. package/resources/bounties.mjs.map +1 -0
  121. package/resources/chat-channels.d.mts +43 -43
  122. package/resources/chat-channels.d.mts.map +1 -1
  123. package/resources/chat-channels.d.ts +43 -43
  124. package/resources/chat-channels.d.ts.map +1 -1
  125. package/resources/chat-channels.js +24 -24
  126. package/resources/chat-channels.js.map +1 -1
  127. package/resources/chat-channels.mjs +24 -24
  128. package/resources/chat-channels.mjs.map +1 -1
  129. package/resources/checkout-configurations.d.mts +73 -45
  130. package/resources/checkout-configurations.d.mts.map +1 -1
  131. package/resources/checkout-configurations.d.ts +73 -45
  132. package/resources/checkout-configurations.d.ts.map +1 -1
  133. package/resources/checkout-configurations.js +11 -11
  134. package/resources/checkout-configurations.js.map +1 -1
  135. package/resources/checkout-configurations.mjs +11 -11
  136. package/resources/checkout-configurations.mjs.map +1 -1
  137. package/resources/companies.d.mts +98 -35
  138. package/resources/companies.d.mts.map +1 -1
  139. package/resources/companies.d.ts +98 -35
  140. package/resources/companies.d.ts.map +1 -1
  141. package/resources/companies.js +24 -17
  142. package/resources/companies.js.map +1 -1
  143. package/resources/companies.mjs +24 -17
  144. package/resources/companies.mjs.map +1 -1
  145. package/resources/company-token-transactions.d.mts +39 -39
  146. package/resources/company-token-transactions.d.mts.map +1 -1
  147. package/resources/company-token-transactions.d.ts +39 -39
  148. package/resources/company-token-transactions.d.ts.map +1 -1
  149. package/resources/company-token-transactions.js +14 -14
  150. package/resources/company-token-transactions.js.map +1 -1
  151. package/resources/company-token-transactions.mjs +14 -14
  152. package/resources/company-token-transactions.mjs.map +1 -1
  153. package/resources/conversions.d.mts +248 -0
  154. package/resources/conversions.d.mts.map +1 -0
  155. package/resources/conversions.d.ts +248 -0
  156. package/resources/conversions.d.ts.map +1 -0
  157. package/resources/conversions.js +30 -0
  158. package/resources/conversions.js.map +1 -0
  159. package/resources/conversions.mjs +26 -0
  160. package/resources/conversions.mjs.map +1 -0
  161. package/resources/course-chapters.d.mts +36 -36
  162. package/resources/course-chapters.d.mts.map +1 -1
  163. package/resources/course-chapters.d.ts +36 -36
  164. package/resources/course-chapters.d.ts.map +1 -1
  165. package/resources/course-chapters.js +23 -23
  166. package/resources/course-chapters.js.map +1 -1
  167. package/resources/course-chapters.mjs +23 -23
  168. package/resources/course-chapters.mjs.map +1 -1
  169. package/resources/course-lesson-interactions.d.mts +5 -5
  170. package/resources/course-lesson-interactions.d.mts.map +1 -1
  171. package/resources/course-lesson-interactions.d.ts +5 -5
  172. package/resources/course-lesson-interactions.d.ts.map +1 -1
  173. package/resources/course-lesson-interactions.js +7 -7
  174. package/resources/course-lesson-interactions.js.map +1 -1
  175. package/resources/course-lesson-interactions.mjs +7 -7
  176. package/resources/course-lesson-interactions.mjs.map +1 -1
  177. package/resources/course-lessons.d.mts +40 -40
  178. package/resources/course-lessons.d.mts.map +1 -1
  179. package/resources/course-lessons.d.ts +40 -40
  180. package/resources/course-lessons.d.ts.map +1 -1
  181. package/resources/course-lessons.js +22 -22
  182. package/resources/course-lessons.js.map +1 -1
  183. package/resources/course-lessons.mjs +22 -22
  184. package/resources/course-lessons.mjs.map +1 -1
  185. package/resources/course-students.d.mts +5 -5
  186. package/resources/course-students.d.mts.map +1 -1
  187. package/resources/course-students.d.ts +5 -5
  188. package/resources/course-students.d.ts.map +1 -1
  189. package/resources/course-students.js +10 -10
  190. package/resources/course-students.js.map +1 -1
  191. package/resources/course-students.mjs +10 -10
  192. package/resources/course-students.mjs.map +1 -1
  193. package/resources/courses.d.mts +40 -40
  194. package/resources/courses.d.mts.map +1 -1
  195. package/resources/courses.d.ts +40 -40
  196. package/resources/courses.d.ts.map +1 -1
  197. package/resources/courses.js +19 -19
  198. package/resources/courses.js.map +1 -1
  199. package/resources/courses.mjs +19 -19
  200. package/resources/courses.mjs.map +1 -1
  201. package/resources/deposits.d.mts +64 -0
  202. package/resources/deposits.d.mts.map +1 -0
  203. package/resources/deposits.d.ts +64 -0
  204. package/resources/deposits.d.ts.map +1 -0
  205. package/resources/deposits.js +16 -0
  206. package/resources/deposits.js.map +1 -0
  207. package/resources/deposits.mjs +12 -0
  208. package/resources/deposits.mjs.map +1 -0
  209. package/resources/dispute-alerts.d.mts +10 -10
  210. package/resources/dispute-alerts.d.mts.map +1 -1
  211. package/resources/dispute-alerts.d.ts +10 -10
  212. package/resources/dispute-alerts.d.ts.map +1 -1
  213. package/resources/dispute-alerts.js +13 -13
  214. package/resources/dispute-alerts.js.map +1 -1
  215. package/resources/dispute-alerts.mjs +13 -13
  216. package/resources/dispute-alerts.mjs.map +1 -1
  217. package/resources/disputes.d.mts +13 -15
  218. package/resources/disputes.d.mts.map +1 -1
  219. package/resources/disputes.d.ts +13 -15
  220. package/resources/disputes.d.ts.map +1 -1
  221. package/resources/disputes.js +11 -11
  222. package/resources/disputes.js.map +1 -1
  223. package/resources/disputes.mjs +11 -11
  224. package/resources/disputes.mjs.map +1 -1
  225. package/resources/dm-channels.d.mts +37 -37
  226. package/resources/dm-channels.d.mts.map +1 -1
  227. package/resources/dm-channels.d.ts +37 -37
  228. package/resources/dm-channels.d.ts.map +1 -1
  229. package/resources/dm-channels.js +19 -19
  230. package/resources/dm-channels.js.map +1 -1
  231. package/resources/dm-channels.mjs +19 -19
  232. package/resources/dm-channels.mjs.map +1 -1
  233. package/resources/dm-members.d.mts +38 -38
  234. package/resources/dm-members.d.mts.map +1 -1
  235. package/resources/dm-members.d.ts +38 -38
  236. package/resources/dm-members.d.ts.map +1 -1
  237. package/resources/dm-members.js +21 -21
  238. package/resources/dm-members.js.map +1 -1
  239. package/resources/dm-members.mjs +21 -21
  240. package/resources/dm-members.mjs.map +1 -1
  241. package/resources/entries.d.mts +5 -5
  242. package/resources/entries.d.mts.map +1 -1
  243. package/resources/entries.d.ts +5 -5
  244. package/resources/entries.d.ts.map +1 -1
  245. package/resources/entries.js +7 -7
  246. package/resources/entries.js.map +1 -1
  247. package/resources/entries.mjs +7 -7
  248. package/resources/entries.mjs.map +1 -1
  249. package/resources/experiences.d.mts +50 -50
  250. package/resources/experiences.d.mts.map +1 -1
  251. package/resources/experiences.d.ts +50 -50
  252. package/resources/experiences.d.ts.map +1 -1
  253. package/resources/experiences.js +17 -17
  254. package/resources/experiences.js.map +1 -1
  255. package/resources/experiences.mjs +17 -17
  256. package/resources/experiences.mjs.map +1 -1
  257. package/resources/fee-markups.d.mts +36 -36
  258. package/resources/fee-markups.d.mts.map +1 -1
  259. package/resources/fee-markups.d.ts +36 -36
  260. package/resources/fee-markups.d.ts.map +1 -1
  261. package/resources/fee-markups.js +18 -18
  262. package/resources/fee-markups.js.map +1 -1
  263. package/resources/fee-markups.mjs +18 -18
  264. package/resources/fee-markups.mjs.map +1 -1
  265. package/resources/files.d.mts +18 -1
  266. package/resources/files.d.mts.map +1 -1
  267. package/resources/files.d.ts +18 -1
  268. package/resources/files.d.ts.map +1 -1
  269. package/resources/forum-posts.d.mts +52 -48
  270. package/resources/forum-posts.d.mts.map +1 -1
  271. package/resources/forum-posts.d.ts +52 -48
  272. package/resources/forum-posts.d.ts.map +1 -1
  273. package/resources/forum-posts.js +21 -21
  274. package/resources/forum-posts.js.map +1 -1
  275. package/resources/forum-posts.mjs +21 -21
  276. package/resources/forum-posts.mjs.map +1 -1
  277. package/resources/forums.d.mts +33 -33
  278. package/resources/forums.d.mts.map +1 -1
  279. package/resources/forums.d.ts +33 -33
  280. package/resources/forums.d.ts.map +1 -1
  281. package/resources/forums.js +11 -11
  282. package/resources/forums.js.map +1 -1
  283. package/resources/forums.mjs +11 -11
  284. package/resources/forums.mjs.map +1 -1
  285. package/resources/index.d.mts +45 -35
  286. package/resources/index.d.mts.map +1 -1
  287. package/resources/index.d.ts +45 -35
  288. package/resources/index.d.ts.map +1 -1
  289. package/resources/index.js +22 -2
  290. package/resources/index.js.map +1 -1
  291. package/resources/index.mjs +10 -0
  292. package/resources/index.mjs.map +1 -1
  293. package/resources/invoices.d.mts +86 -81
  294. package/resources/invoices.d.mts.map +1 -1
  295. package/resources/invoices.d.ts +86 -81
  296. package/resources/invoices.d.ts.map +1 -1
  297. package/resources/invoices.js +40 -40
  298. package/resources/invoices.js.map +1 -1
  299. package/resources/invoices.mjs +40 -40
  300. package/resources/invoices.mjs.map +1 -1
  301. package/resources/leads.d.mts +53 -53
  302. package/resources/leads.d.mts.map +1 -1
  303. package/resources/leads.d.ts +53 -53
  304. package/resources/leads.d.ts.map +1 -1
  305. package/resources/leads.js +24 -24
  306. package/resources/leads.js.map +1 -1
  307. package/resources/leads.mjs +24 -24
  308. package/resources/leads.mjs.map +1 -1
  309. package/resources/ledger-accounts.d.mts +34 -1
  310. package/resources/ledger-accounts.d.mts.map +1 -1
  311. package/resources/ledger-accounts.d.ts +34 -1
  312. package/resources/ledger-accounts.d.ts.map +1 -1
  313. package/resources/members.d.mts +9 -7
  314. package/resources/members.d.mts.map +1 -1
  315. package/resources/members.d.ts +9 -7
  316. package/resources/members.d.ts.map +1 -1
  317. package/resources/members.js +7 -7
  318. package/resources/members.js.map +1 -1
  319. package/resources/members.mjs +7 -7
  320. package/resources/members.mjs.map +1 -1
  321. package/resources/memberships.d.mts +61 -47
  322. package/resources/memberships.d.mts.map +1 -1
  323. package/resources/memberships.d.ts +61 -47
  324. package/resources/memberships.d.ts.map +1 -1
  325. package/resources/memberships.js +38 -38
  326. package/resources/memberships.js.map +1 -1
  327. package/resources/memberships.mjs +38 -38
  328. package/resources/memberships.mjs.map +1 -1
  329. package/resources/messages.d.mts +36 -36
  330. package/resources/messages.d.mts.map +1 -1
  331. package/resources/messages.d.ts +36 -36
  332. package/resources/messages.d.ts.map +1 -1
  333. package/resources/messages.js +16 -16
  334. package/resources/messages.js.map +1 -1
  335. package/resources/messages.mjs +16 -16
  336. package/resources/messages.mjs.map +1 -1
  337. package/resources/payment-methods.d.mts +20 -20
  338. package/resources/payment-methods.d.mts.map +1 -1
  339. package/resources/payment-methods.d.ts +20 -20
  340. package/resources/payment-methods.d.ts.map +1 -1
  341. package/resources/payment-methods.js +10 -10
  342. package/resources/payment-methods.js.map +1 -1
  343. package/resources/payment-methods.mjs +10 -10
  344. package/resources/payment-methods.mjs.map +1 -1
  345. package/resources/payments.d.mts +172 -145
  346. package/resources/payments.d.mts.map +1 -1
  347. package/resources/payments.d.ts +172 -145
  348. package/resources/payments.d.ts.map +1 -1
  349. package/resources/payments.js +68 -68
  350. package/resources/payments.js.map +1 -1
  351. package/resources/payments.mjs +68 -68
  352. package/resources/payments.mjs.map +1 -1
  353. package/resources/payout-accounts.d.mts +1 -1
  354. package/resources/payout-accounts.d.ts +1 -1
  355. package/resources/payout-methods.d.mts +5 -5
  356. package/resources/payout-methods.d.mts.map +1 -1
  357. package/resources/payout-methods.d.ts +5 -5
  358. package/resources/payout-methods.d.ts.map +1 -1
  359. package/resources/payout-methods.js +10 -10
  360. package/resources/payout-methods.js.map +1 -1
  361. package/resources/payout-methods.mjs +10 -10
  362. package/resources/payout-methods.mjs.map +1 -1
  363. package/resources/plans.d.mts +128 -70
  364. package/resources/plans.d.mts.map +1 -1
  365. package/resources/plans.d.ts +128 -70
  366. package/resources/plans.d.ts.map +1 -1
  367. package/resources/plans.js +21 -21
  368. package/resources/plans.js.map +1 -1
  369. package/resources/plans.mjs +21 -21
  370. package/resources/plans.mjs.map +1 -1
  371. package/resources/products.d.mts +81 -65
  372. package/resources/products.d.mts.map +1 -1
  373. package/resources/products.d.ts +81 -65
  374. package/resources/products.d.ts.map +1 -1
  375. package/resources/products.js +25 -25
  376. package/resources/products.js.map +1 -1
  377. package/resources/products.mjs +25 -25
  378. package/resources/products.mjs.map +1 -1
  379. package/resources/promo-codes.d.mts +59 -59
  380. package/resources/promo-codes.d.mts.map +1 -1
  381. package/resources/promo-codes.d.ts +59 -59
  382. package/resources/promo-codes.d.ts.map +1 -1
  383. package/resources/promo-codes.js +22 -22
  384. package/resources/promo-codes.js.map +1 -1
  385. package/resources/promo-codes.mjs +22 -22
  386. package/resources/promo-codes.mjs.map +1 -1
  387. package/resources/reactions.d.mts +25 -25
  388. package/resources/reactions.d.mts.map +1 -1
  389. package/resources/reactions.d.ts +25 -25
  390. package/resources/reactions.d.ts.map +1 -1
  391. package/resources/reactions.js +11 -11
  392. package/resources/reactions.js.map +1 -1
  393. package/resources/reactions.mjs +11 -11
  394. package/resources/reactions.mjs.map +1 -1
  395. package/resources/refunds.d.mts +59 -10
  396. package/resources/refunds.d.mts.map +1 -1
  397. package/resources/refunds.d.ts +59 -10
  398. package/resources/refunds.d.ts.map +1 -1
  399. package/resources/refunds.js +12 -10
  400. package/resources/refunds.js.map +1 -1
  401. package/resources/refunds.mjs +12 -10
  402. package/resources/refunds.mjs.map +1 -1
  403. package/resources/resolution-center-cases.d.mts +6 -6
  404. package/resources/resolution-center-cases.d.mts.map +1 -1
  405. package/resources/resolution-center-cases.d.ts +6 -6
  406. package/resources/resolution-center-cases.d.ts.map +1 -1
  407. package/resources/resolution-center-cases.js +10 -10
  408. package/resources/resolution-center-cases.js.map +1 -1
  409. package/resources/resolution-center-cases.mjs +10 -10
  410. package/resources/resolution-center-cases.mjs.map +1 -1
  411. package/resources/reviews.d.mts +4 -4
  412. package/resources/reviews.d.mts.map +1 -1
  413. package/resources/reviews.d.ts +4 -4
  414. package/resources/reviews.d.ts.map +1 -1
  415. package/resources/reviews.js +6 -6
  416. package/resources/reviews.js.map +1 -1
  417. package/resources/reviews.mjs +6 -6
  418. package/resources/reviews.mjs.map +1 -1
  419. package/resources/setup-intents.d.mts +6 -6
  420. package/resources/setup-intents.d.mts.map +1 -1
  421. package/resources/setup-intents.d.ts +6 -6
  422. package/resources/setup-intents.d.ts.map +1 -1
  423. package/resources/setup-intents.js +11 -11
  424. package/resources/setup-intents.js.map +1 -1
  425. package/resources/setup-intents.mjs +11 -11
  426. package/resources/setup-intents.mjs.map +1 -1
  427. package/resources/shared.d.mts +89 -6
  428. package/resources/shared.d.mts.map +1 -1
  429. package/resources/shared.d.ts +89 -6
  430. package/resources/shared.d.ts.map +1 -1
  431. package/resources/shipments.d.mts +35 -35
  432. package/resources/shipments.d.mts.map +1 -1
  433. package/resources/shipments.d.ts +35 -35
  434. package/resources/shipments.d.ts.map +1 -1
  435. package/resources/shipments.js +20 -20
  436. package/resources/shipments.js.map +1 -1
  437. package/resources/shipments.mjs +20 -20
  438. package/resources/shipments.mjs.map +1 -1
  439. package/resources/support-channels.d.mts +35 -34
  440. package/resources/support-channels.d.mts.map +1 -1
  441. package/resources/support-channels.d.ts +35 -34
  442. package/resources/support-channels.d.ts.map +1 -1
  443. package/resources/support-channels.js +21 -21
  444. package/resources/support-channels.js.map +1 -1
  445. package/resources/support-channels.mjs +21 -21
  446. package/resources/support-channels.mjs.map +1 -1
  447. package/resources/swaps.d.mts +62 -0
  448. package/resources/swaps.d.mts.map +1 -0
  449. package/resources/swaps.d.ts +62 -0
  450. package/resources/swaps.d.ts.map +1 -0
  451. package/resources/swaps.js +15 -0
  452. package/resources/swaps.js.map +1 -0
  453. package/resources/swaps.mjs +11 -0
  454. package/resources/swaps.mjs.map +1 -0
  455. package/resources/transfers.d.mts +57 -55
  456. package/resources/transfers.d.mts.map +1 -1
  457. package/resources/transfers.d.ts +57 -55
  458. package/resources/transfers.d.ts.map +1 -1
  459. package/resources/transfers.js +19 -19
  460. package/resources/transfers.js.map +1 -1
  461. package/resources/transfers.mjs +19 -19
  462. package/resources/transfers.mjs.map +1 -1
  463. package/resources/users.d.mts +20 -20
  464. package/resources/users.d.mts.map +1 -1
  465. package/resources/users.d.ts +20 -20
  466. package/resources/users.d.ts.map +1 -1
  467. package/resources/users.js +16 -16
  468. package/resources/users.js.map +1 -1
  469. package/resources/users.mjs +16 -16
  470. package/resources/users.mjs.map +1 -1
  471. package/resources/verifications.d.mts +2 -2
  472. package/resources/verifications.d.ts +2 -2
  473. package/resources/wallets.d.mts +89 -0
  474. package/resources/wallets.d.mts.map +1 -0
  475. package/resources/wallets.d.ts +89 -0
  476. package/resources/wallets.d.ts.map +1 -0
  477. package/resources/wallets.js +28 -0
  478. package/resources/wallets.js.map +1 -0
  479. package/resources/wallets.mjs +24 -0
  480. package/resources/wallets.mjs.map +1 -0
  481. package/resources/webhooks.d.mts +2182 -1196
  482. package/resources/webhooks.d.mts.map +1 -1
  483. package/resources/webhooks.d.ts +2182 -1196
  484. package/resources/webhooks.d.ts.map +1 -1
  485. package/resources/webhooks.js +31 -31
  486. package/resources/webhooks.js.map +1 -1
  487. package/resources/webhooks.mjs +31 -31
  488. package/resources/webhooks.mjs.map +1 -1
  489. package/resources/withdrawals.d.mts +47 -47
  490. package/resources/withdrawals.d.mts.map +1 -1
  491. package/resources/withdrawals.d.ts +47 -47
  492. package/resources/withdrawals.d.ts.map +1 -1
  493. package/resources/withdrawals.js +21 -21
  494. package/resources/withdrawals.js.map +1 -1
  495. package/resources/withdrawals.mjs +21 -21
  496. package/resources/withdrawals.mjs.map +1 -1
  497. package/src/client.ts +277 -60
  498. package/src/internal/types.ts +6 -8
  499. package/src/internal/utils/log.ts +2 -0
  500. package/src/resources/accounts.ts +318 -0
  501. package/src/resources/ad-campaigns.ts +376 -0
  502. package/src/resources/ad-groups.ts +1958 -0
  503. package/src/resources/ad-reports.ts +484 -0
  504. package/src/resources/ads.ts +295 -0
  505. package/src/resources/affiliates/affiliates.ts +39 -39
  506. package/src/resources/affiliates/index.ts +2 -2
  507. package/src/resources/affiliates/overrides.ts +51 -51
  508. package/src/resources/ai-chats.ts +33 -33
  509. package/src/resources/app-builds.ts +68 -68
  510. package/src/resources/apps.ts +86 -86
  511. package/src/resources/authorized-users.ts +48 -48
  512. package/src/resources/bounties.ts +353 -0
  513. package/src/resources/chat-channels.ts +57 -57
  514. package/src/resources/checkout-configurations.ts +97 -63
  515. package/src/resources/companies.ts +123 -41
  516. package/src/resources/company-token-transactions.ts +55 -55
  517. package/src/resources/conversions.ts +316 -0
  518. package/src/resources/course-chapters.ts +47 -47
  519. package/src/resources/course-lesson-interactions.ts +12 -12
  520. package/src/resources/course-lessons.ts +54 -54
  521. package/src/resources/course-students.ts +12 -12
  522. package/src/resources/courses.ts +51 -51
  523. package/src/resources/deposits.ts +87 -0
  524. package/src/resources/dispute-alerts.ts +18 -18
  525. package/src/resources/disputes.ts +18 -20
  526. package/src/resources/dm-channels.ts +45 -45
  527. package/src/resources/dm-members.ts +45 -45
  528. package/src/resources/entries.ts +10 -10
  529. package/src/resources/experiences.ts +64 -64
  530. package/src/resources/fee-markups.ts +44 -44
  531. package/src/resources/files.ts +23 -1
  532. package/src/resources/forum-posts.ts +65 -60
  533. package/src/resources/forums.ts +44 -44
  534. package/src/resources/index.ts +129 -57
  535. package/src/resources/invoices.ts +113 -107
  536. package/src/resources/leads.ts +64 -64
  537. package/src/resources/ledger-accounts.ts +41 -1
  538. package/src/resources/members.ts +14 -12
  539. package/src/resources/memberships.ts +73 -61
  540. package/src/resources/messages.ts +48 -48
  541. package/src/resources/payment-methods.ts +30 -30
  542. package/src/resources/payments.ts +222 -183
  543. package/src/resources/payout-accounts.ts +1 -1
  544. package/src/resources/payout-methods.ts +11 -11
  545. package/src/resources/plans.ts +151 -88
  546. package/src/resources/products.ts +98 -84
  547. package/src/resources/promo-codes.ts +74 -74
  548. package/src/resources/reactions.ts +33 -33
  549. package/src/resources/refunds.ts +65 -15
  550. package/src/resources/resolution-center-cases.ts +11 -12
  551. package/src/resources/reviews.ts +7 -7
  552. package/src/resources/setup-intents.ts +13 -13
  553. package/src/resources/shared.ts +94 -5
  554. package/src/resources/shipments.ts +44 -44
  555. package/src/resources/support-channels.ts +46 -45
  556. package/src/resources/swaps.ts +87 -0
  557. package/src/resources/transfers.ts +68 -66
  558. package/src/resources/users.ts +29 -29
  559. package/src/resources/verifications.ts +2 -2
  560. package/src/resources/wallets.ts +136 -0
  561. package/src/resources/webhooks.ts +2449 -1277
  562. package/src/resources/withdrawals.ts +55 -55
  563. package/src/version.ts +1 -1
  564. package/version.d.mts +1 -1
  565. package/version.d.ts +1 -1
  566. package/version.js +1 -1
  567. package/version.mjs +1 -1
@@ -17,6 +17,29 @@ import { RequestOptions } from "../internal/request-options.mjs";
17
17
  * Webhooks
18
18
  */
19
19
  export declare class Webhooks extends APIResource {
20
+ unwrap(body: string, { headers, key }: {
21
+ headers: Record<string, string>;
22
+ key?: string;
23
+ }): UnwrapWebhookEvent;
24
+ /**
25
+ * Returns a paginated list of webhook endpoints configured for a company, ordered
26
+ * by most recently created.
27
+ *
28
+ * Required permissions:
29
+ *
30
+ * - `developer:manage_webhook`
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * // Automatically fetches more pages as needed.
35
+ * for await (const webhookListResponse of client.webhooks.list(
36
+ * { company_id: 'biz_xxxxxxxxxxxxxx' },
37
+ * )) {
38
+ * // ...
39
+ * }
40
+ * ```
41
+ */
42
+ list(query: WebhookListParams, options?: RequestOptions): PagePromise<WebhookListResponsesCursorPage, WebhookListResponse>;
20
43
  /**
21
44
  * Creates a new webhook
22
45
  *
@@ -62,25 +85,6 @@ export declare class Webhooks extends APIResource {
62
85
  * ```
63
86
  */
64
87
  update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
65
- /**
66
- * Returns a paginated list of webhook endpoints configured for a company, ordered
67
- * by most recently created.
68
- *
69
- * Required permissions:
70
- *
71
- * - `developer:manage_webhook`
72
- *
73
- * @example
74
- * ```ts
75
- * // Automatically fetches more pages as needed.
76
- * for await (const webhookListResponse of client.webhooks.list(
77
- * { company_id: 'biz_xxxxxxxxxxxxxx' },
78
- * )) {
79
- * // ...
80
- * }
81
- * ```
82
- */
83
- list(query: WebhookListParams, options?: RequestOptions): PagePromise<WebhookListResponsesCursorPage, WebhookListResponse>;
84
88
  /**
85
89
  * Deletes a webhook
86
90
  *
@@ -96,10 +100,6 @@ export declare class Webhooks extends APIResource {
96
100
  * ```
97
101
  */
98
102
  delete(id: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
99
- unwrap(body: string, { headers, key }: {
100
- headers: Record<string, string>;
101
- key?: string;
102
- }): UnwrapWebhookEvent;
103
103
  }
104
104
  export type WebhookListResponsesCursorPage = CursorPage<WebhookListResponse>;
105
105
  /**
@@ -153,7 +153,7 @@ export interface Webhook {
153
153
  /**
154
154
  * The different event types available
155
155
  */
156
- export type WebhookEvent = 'invoice.created' | 'invoice.marked_uncollectible' | 'invoice.paid' | 'invoice.past_due' | 'invoice.voided' | 'membership.activated' | 'membership.deactivated' | 'entry.created' | 'entry.approved' | 'entry.denied' | 'entry.deleted' | 'setup_intent.requires_action' | 'setup_intent.succeeded' | 'setup_intent.canceled' | 'withdrawal.created' | 'withdrawal.updated' | 'course_lesson_interaction.completed' | 'payout_method.created' | 'verification.succeeded' | 'payout_account.status_updated' | 'resolution_center_case.created' | 'resolution_center_case.updated' | 'resolution_center_case.decided' | 'payment.created' | 'payment.succeeded' | 'payment.failed' | 'payment.pending' | 'dispute.created' | 'dispute.updated' | 'refund.created' | 'refund.updated' | 'dispute_alert.created' | 'membership.cancel_at_period_end_changed';
156
+ export type WebhookEvent = 'invoice.created' | 'invoice.marked_uncollectible' | 'invoice.paid' | 'invoice.past_due' | 'invoice.voided' | 'membership.activated' | 'membership.deactivated' | 'entry.created' | 'entry.approved' | 'entry.denied' | 'entry.deleted' | 'setup_intent.requires_action' | 'setup_intent.succeeded' | 'setup_intent.canceled' | 'withdrawal.created' | 'withdrawal.updated' | 'course_lesson_interaction.completed' | 'payout_method.created' | 'verification.succeeded' | 'identity_profile.approved' | 'identity_profile.rejected' | 'identity_profile.needs_action' | 'identity_profile.updated' | 'payout_account.status_updated' | 'resolution_center_case.created' | 'resolution_center_case.updated' | 'resolution_center_case.decided' | 'payment.created' | 'payment.succeeded' | 'payment.failed' | 'payment.pending' | 'dispute.created' | 'dispute.updated' | 'refund.created' | 'refund.updated' | 'dispute_alert.created' | 'membership.cancel_at_period_end_changed';
157
157
  /**
158
158
  * A webhook endpoint that receives event notifications for a company via HTTP
159
159
  * POST.
@@ -243,174 +243,7 @@ export interface WebhookListResponse {
243
243
  * Represents `true` or `false` values.
244
244
  */
245
245
  export type WebhookDeleteResponse = boolean;
246
- export interface InvoiceCreatedWebhookEvent {
247
- /**
248
- * A unique ID for every single webhook request
249
- */
250
- id: string;
251
- /**
252
- * The API version for this webhook
253
- */
254
- api_version: 'v1';
255
- /**
256
- * An invoice represents an itemized bill sent by a company to a customer for a
257
- * specific product and plan, tracking the amount owed, due date, and payment
258
- * status.
259
- */
260
- data: Shared.Invoice;
261
- /**
262
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
263
- */
264
- timestamp: string;
265
- /**
266
- * The webhook event type
267
- */
268
- type: 'invoice.created';
269
- /**
270
- * The company ID that this webhook event is associated with
271
- */
272
- company_id?: string | null;
273
- }
274
- export interface InvoiceMarkedUncollectibleWebhookEvent {
275
- /**
276
- * A unique ID for every single webhook request
277
- */
278
- id: string;
279
- /**
280
- * The API version for this webhook
281
- */
282
- api_version: 'v1';
283
- /**
284
- * An invoice represents an itemized bill sent by a company to a customer for a
285
- * specific product and plan, tracking the amount owed, due date, and payment
286
- * status.
287
- */
288
- data: Shared.Invoice;
289
- /**
290
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
291
- */
292
- timestamp: string;
293
- /**
294
- * The webhook event type
295
- */
296
- type: 'invoice.marked_uncollectible';
297
- /**
298
- * The company ID that this webhook event is associated with
299
- */
300
- company_id?: string | null;
301
- }
302
- export interface InvoicePaidWebhookEvent {
303
- /**
304
- * A unique ID for every single webhook request
305
- */
306
- id: string;
307
- /**
308
- * The API version for this webhook
309
- */
310
- api_version: 'v1';
311
- /**
312
- * An invoice represents an itemized bill sent by a company to a customer for a
313
- * specific product and plan, tracking the amount owed, due date, and payment
314
- * status.
315
- */
316
- data: Shared.Invoice;
317
- /**
318
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
319
- */
320
- timestamp: string;
321
- /**
322
- * The webhook event type
323
- */
324
- type: 'invoice.paid';
325
- /**
326
- * The company ID that this webhook event is associated with
327
- */
328
- company_id?: string | null;
329
- }
330
- export interface InvoicePastDueWebhookEvent {
331
- /**
332
- * A unique ID for every single webhook request
333
- */
334
- id: string;
335
- /**
336
- * The API version for this webhook
337
- */
338
- api_version: 'v1';
339
- /**
340
- * An invoice represents an itemized bill sent by a company to a customer for a
341
- * specific product and plan, tracking the amount owed, due date, and payment
342
- * status.
343
- */
344
- data: Shared.Invoice;
345
- /**
346
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
347
- */
348
- timestamp: string;
349
- /**
350
- * The webhook event type
351
- */
352
- type: 'invoice.past_due';
353
- /**
354
- * The company ID that this webhook event is associated with
355
- */
356
- company_id?: string | null;
357
- }
358
- export interface InvoiceVoidedWebhookEvent {
359
- /**
360
- * A unique ID for every single webhook request
361
- */
362
- id: string;
363
- /**
364
- * The API version for this webhook
365
- */
366
- api_version: 'v1';
367
- /**
368
- * An invoice represents an itemized bill sent by a company to a customer for a
369
- * specific product and plan, tracking the amount owed, due date, and payment
370
- * status.
371
- */
372
- data: Shared.Invoice;
373
- /**
374
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
375
- */
376
- timestamp: string;
377
- /**
378
- * The webhook event type
379
- */
380
- type: 'invoice.voided';
381
- /**
382
- * The company ID that this webhook event is associated with
383
- */
384
- company_id?: string | null;
385
- }
386
- export interface MembershipActivatedWebhookEvent {
387
- /**
388
- * A unique ID for every single webhook request
389
- */
390
- id: string;
391
- /**
392
- * The API version for this webhook
393
- */
394
- api_version: 'v1';
395
- /**
396
- * A membership represents an active relationship between a user and a product. It
397
- * tracks the user's access, billing status, and renewal schedule.
398
- */
399
- data: Shared.Membership;
400
- /**
401
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
402
- */
403
- timestamp: string;
404
- /**
405
- * The webhook event type
406
- */
407
- type: 'membership.activated';
408
- /**
409
- * The company ID that this webhook event is associated with
410
- */
411
- company_id?: string | null;
412
- }
413
- export interface MembershipDeactivatedWebhookEvent {
246
+ export interface CourseLessonInteractionCompletedWebhookEvent {
414
247
  /**
415
248
  * A unique ID for every single webhook request
416
249
  */
@@ -420,10 +253,10 @@ export interface MembershipDeactivatedWebhookEvent {
420
253
  */
421
254
  api_version: 'v1';
422
255
  /**
423
- * A membership represents an active relationship between a user and a product. It
424
- * tracks the user's access, billing status, and renewal schedule.
256
+ * A record of a user's progress on a specific lesson, tracking whether they have
257
+ * completed it.
425
258
  */
426
- data: Shared.Membership;
259
+ data: Shared.CourseLessonInteraction;
427
260
  /**
428
261
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
429
262
  */
@@ -431,13 +264,13 @@ export interface MembershipDeactivatedWebhookEvent {
431
264
  /**
432
265
  * The webhook event type
433
266
  */
434
- type: 'membership.deactivated';
267
+ type: 'course_lesson_interaction.completed';
435
268
  /**
436
269
  * The company ID that this webhook event is associated with
437
270
  */
438
271
  company_id?: string | null;
439
272
  }
440
- export interface EntryCreatedWebhookEvent {
273
+ export interface DisputeCreatedWebhookEvent {
441
274
  /**
442
275
  * A unique ID for every single webhook request
443
276
  */
@@ -447,9 +280,10 @@ export interface EntryCreatedWebhookEvent {
447
280
  */
448
281
  api_version: 'v1';
449
282
  /**
450
- * An entry represents a user's signup for a waitlisted plan.
283
+ * A dispute is a chargeback or payment challenge filed against a company,
284
+ * including evidence and response status.
451
285
  */
452
- data: Shared.Entry;
286
+ data: DisputesAPI.Dispute;
453
287
  /**
454
288
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
455
289
  */
@@ -457,13 +291,13 @@ export interface EntryCreatedWebhookEvent {
457
291
  /**
458
292
  * The webhook event type
459
293
  */
460
- type: 'entry.created';
294
+ type: 'dispute.created';
461
295
  /**
462
296
  * The company ID that this webhook event is associated with
463
297
  */
464
298
  company_id?: string | null;
465
299
  }
466
- export interface EntryApprovedWebhookEvent {
300
+ export interface DisputeUpdatedWebhookEvent {
467
301
  /**
468
302
  * A unique ID for every single webhook request
469
303
  */
@@ -473,9 +307,10 @@ export interface EntryApprovedWebhookEvent {
473
307
  */
474
308
  api_version: 'v1';
475
309
  /**
476
- * An entry represents a user's signup for a waitlisted plan.
310
+ * A dispute is a chargeback or payment challenge filed against a company,
311
+ * including evidence and response status.
477
312
  */
478
- data: Shared.Entry;
313
+ data: DisputesAPI.Dispute;
479
314
  /**
480
315
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
481
316
  */
@@ -483,13 +318,13 @@ export interface EntryApprovedWebhookEvent {
483
318
  /**
484
319
  * The webhook event type
485
320
  */
486
- type: 'entry.approved';
321
+ type: 'dispute.updated';
487
322
  /**
488
323
  * The company ID that this webhook event is associated with
489
324
  */
490
325
  company_id?: string | null;
491
326
  }
492
- export interface EntryDeniedWebhookEvent {
327
+ export interface DisputeAlertCreatedWebhookEvent {
493
328
  /**
494
329
  * A unique ID for every single webhook request
495
330
  */
@@ -499,9 +334,10 @@ export interface EntryDeniedWebhookEvent {
499
334
  */
500
335
  api_version: 'v1';
501
336
  /**
502
- * An entry represents a user's signup for a waitlisted plan.
337
+ * A dispute alert represents an early warning notification from a payment
338
+ * processor about a potential dispute or chargeback.
503
339
  */
504
- data: Shared.Entry;
340
+ data: DisputeAlertCreatedWebhookEvent.Data;
505
341
  /**
506
342
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
507
343
  */
@@ -509,39 +345,206 @@ export interface EntryDeniedWebhookEvent {
509
345
  /**
510
346
  * The webhook event type
511
347
  */
512
- type: 'entry.denied';
348
+ type: 'dispute_alert.created';
513
349
  /**
514
350
  * The company ID that this webhook event is associated with
515
351
  */
516
352
  company_id?: string | null;
517
353
  }
518
- export interface EntryDeletedWebhookEvent {
354
+ export declare namespace DisputeAlertCreatedWebhookEvent {
519
355
  /**
520
- * A unique ID for every single webhook request
356
+ * A dispute alert represents an early warning notification from a payment
357
+ * processor about a potential dispute or chargeback.
521
358
  */
522
- id: string;
523
- /**
524
- * The API version for this webhook
525
- */
526
- api_version: 'v1';
527
- /**
528
- * An entry represents a user's signup for a waitlisted plan.
529
- */
530
- data: Shared.Entry;
531
- /**
532
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
533
- */
534
- timestamp: string;
535
- /**
536
- * The webhook event type
537
- */
538
- type: 'entry.deleted';
539
- /**
540
- * The company ID that this webhook event is associated with
541
- */
542
- company_id?: string | null;
359
+ interface Data {
360
+ /**
361
+ * The unique identifier of the dispute alert.
362
+ */
363
+ id: string;
364
+ /**
365
+ * The type of the dispute alert.
366
+ */
367
+ alert_type: DisputeAlertsAPI.DisputeAlertType;
368
+ /**
369
+ * The alerted amount in the specified currency.
370
+ */
371
+ amount: number;
372
+ /**
373
+ * Whether this alert incurs a charge.
374
+ */
375
+ charge_for_alert: boolean;
376
+ /**
377
+ * The time the dispute alert was created.
378
+ */
379
+ created_at: string;
380
+ /**
381
+ * The three-letter ISO currency code for the alerted amount.
382
+ */
383
+ currency: Shared.Currency;
384
+ /**
385
+ * The dispute associated with the dispute alert.
386
+ */
387
+ dispute: Data.Dispute | null;
388
+ /**
389
+ * The payment associated with the dispute alert.
390
+ */
391
+ payment: Data.Payment | null;
392
+ /**
393
+ * The date of the original transaction.
394
+ */
395
+ transaction_date: string | null;
396
+ }
397
+ namespace Data {
398
+ /**
399
+ * The dispute associated with the dispute alert.
400
+ */
401
+ interface Dispute {
402
+ /**
403
+ * The unique identifier for the dispute.
404
+ */
405
+ id: string;
406
+ /**
407
+ * The disputed amount in the specified currency, formatted as a decimal.
408
+ */
409
+ amount: number;
410
+ /**
411
+ * The datetime the dispute was created.
412
+ */
413
+ created_at: string | null;
414
+ /**
415
+ * The three-letter ISO currency code for the disputed amount.
416
+ */
417
+ currency: Shared.Currency;
418
+ /**
419
+ * A human-readable reason for the dispute.
420
+ */
421
+ reason: string | null;
422
+ /**
423
+ * The current status of the dispute lifecycle, such as needs_response,
424
+ * under_review, won, or lost.
425
+ */
426
+ status: DisputesAPI.DisputeStatuses;
427
+ }
428
+ /**
429
+ * The payment associated with the dispute alert.
430
+ */
431
+ interface Payment {
432
+ /**
433
+ * The unique identifier for the payment.
434
+ */
435
+ id: string;
436
+ /**
437
+ * The reason why a specific payment was billed
438
+ */
439
+ billing_reason: PaymentsAPI.BillingReasons | null;
440
+ /**
441
+ * Possible card brands that a payment token can have
442
+ */
443
+ card_brand: PaymentsAPI.CardBrands | null;
444
+ /**
445
+ * The last four digits of the card used to make this payment. Null if the payment
446
+ * was not made with a card.
447
+ */
448
+ card_last4: string | null;
449
+ /**
450
+ * The datetime the payment was created.
451
+ */
452
+ created_at: string;
453
+ /**
454
+ * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
455
+ */
456
+ currency: Shared.Currency;
457
+ /**
458
+ * When an alert came in that this transaction will be disputed
459
+ */
460
+ dispute_alerted_at: string | null;
461
+ /**
462
+ * The member attached to this payment.
463
+ */
464
+ member: Payment.Member | null;
465
+ /**
466
+ * The membership attached to this payment.
467
+ */
468
+ membership: Payment.Membership | null;
469
+ /**
470
+ * The time at which this payment was successfully collected. Null if the payment
471
+ * has not yet succeeded. As a Unix timestamp.
472
+ */
473
+ paid_at: string | null;
474
+ /**
475
+ * The different types of payment methods that can be used.
476
+ */
477
+ payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
478
+ /**
479
+ * The subtotal to show to the creator (excluding buyer fees).
480
+ */
481
+ subtotal: number | null;
482
+ /**
483
+ * The total to show to the creator (excluding buyer fees).
484
+ */
485
+ total: number | null;
486
+ /**
487
+ * The total in USD to show to the creator (excluding buyer fees).
488
+ */
489
+ usd_total: number | null;
490
+ /**
491
+ * The user that made this payment.
492
+ */
493
+ user: Payment.User | null;
494
+ }
495
+ namespace Payment {
496
+ /**
497
+ * The member attached to this payment.
498
+ */
499
+ interface Member {
500
+ /**
501
+ * The unique identifier for the company member.
502
+ */
503
+ id: string;
504
+ /**
505
+ * The phone number for the member, if available.
506
+ */
507
+ phone: string | null;
508
+ }
509
+ /**
510
+ * The membership attached to this payment.
511
+ */
512
+ interface Membership {
513
+ /**
514
+ * The unique identifier for the membership.
515
+ */
516
+ id: string;
517
+ /**
518
+ * The state of the membership.
519
+ */
520
+ status: Shared.MembershipStatus;
521
+ }
522
+ /**
523
+ * The user that made this payment.
524
+ */
525
+ interface User {
526
+ /**
527
+ * The unique identifier for the user.
528
+ */
529
+ id: string;
530
+ /**
531
+ * The user's email address. Requires the member:email:read permission to access.
532
+ * Null if not authorized.
533
+ */
534
+ email: string | null;
535
+ /**
536
+ * The user's display name shown on their public profile.
537
+ */
538
+ name: string | null;
539
+ /**
540
+ * The user's unique username shown on their public profile.
541
+ */
542
+ username: string;
543
+ }
544
+ }
545
+ }
543
546
  }
544
- export interface SetupIntentRequiresActionWebhookEvent {
547
+ export interface EntryApprovedWebhookEvent {
545
548
  /**
546
549
  * A unique ID for every single webhook request
547
550
  */
@@ -551,10 +554,9 @@ export interface SetupIntentRequiresActionWebhookEvent {
551
554
  */
552
555
  api_version: 'v1';
553
556
  /**
554
- * A setup intent allows a user to save a payment method for future use without
555
- * making an immediate purchase.
557
+ * An entry represents a user's signup for a waitlisted plan.
556
558
  */
557
- data: SetupIntentsAPI.SetupIntent;
559
+ data: Shared.Entry;
558
560
  /**
559
561
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
560
562
  */
@@ -562,13 +564,13 @@ export interface SetupIntentRequiresActionWebhookEvent {
562
564
  /**
563
565
  * The webhook event type
564
566
  */
565
- type: 'setup_intent.requires_action';
567
+ type: 'entry.approved';
566
568
  /**
567
569
  * The company ID that this webhook event is associated with
568
570
  */
569
571
  company_id?: string | null;
570
572
  }
571
- export interface SetupIntentSucceededWebhookEvent {
573
+ export interface EntryCreatedWebhookEvent {
572
574
  /**
573
575
  * A unique ID for every single webhook request
574
576
  */
@@ -578,10 +580,9 @@ export interface SetupIntentSucceededWebhookEvent {
578
580
  */
579
581
  api_version: 'v1';
580
582
  /**
581
- * A setup intent allows a user to save a payment method for future use without
582
- * making an immediate purchase.
583
+ * An entry represents a user's signup for a waitlisted plan.
583
584
  */
584
- data: SetupIntentsAPI.SetupIntent;
585
+ data: Shared.Entry;
585
586
  /**
586
587
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
587
588
  */
@@ -589,13 +590,13 @@ export interface SetupIntentSucceededWebhookEvent {
589
590
  /**
590
591
  * The webhook event type
591
592
  */
592
- type: 'setup_intent.succeeded';
593
+ type: 'entry.created';
593
594
  /**
594
595
  * The company ID that this webhook event is associated with
595
596
  */
596
597
  company_id?: string | null;
597
598
  }
598
- export interface SetupIntentCanceledWebhookEvent {
599
+ export interface EntryDeletedWebhookEvent {
599
600
  /**
600
601
  * A unique ID for every single webhook request
601
602
  */
@@ -605,10 +606,9 @@ export interface SetupIntentCanceledWebhookEvent {
605
606
  */
606
607
  api_version: 'v1';
607
608
  /**
608
- * A setup intent allows a user to save a payment method for future use without
609
- * making an immediate purchase.
609
+ * An entry represents a user's signup for a waitlisted plan.
610
610
  */
611
- data: SetupIntentsAPI.SetupIntent;
611
+ data: Shared.Entry;
612
612
  /**
613
613
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
614
614
  */
@@ -616,13 +616,13 @@ export interface SetupIntentCanceledWebhookEvent {
616
616
  /**
617
617
  * The webhook event type
618
618
  */
619
- type: 'setup_intent.canceled';
619
+ type: 'entry.deleted';
620
620
  /**
621
621
  * The company ID that this webhook event is associated with
622
622
  */
623
623
  company_id?: string | null;
624
624
  }
625
- export interface WithdrawalCreatedWebhookEvent {
625
+ export interface EntryDeniedWebhookEvent {
626
626
  /**
627
627
  * A unique ID for every single webhook request
628
628
  */
@@ -632,10 +632,9 @@ export interface WithdrawalCreatedWebhookEvent {
632
632
  */
633
633
  api_version: 'v1';
634
634
  /**
635
- * A withdrawal represents a request to transfer funds from a ledger account to an
636
- * external payout method.
635
+ * An entry represents a user's signup for a waitlisted plan.
637
636
  */
638
- data: WithdrawalsAPI.Withdrawal;
637
+ data: Shared.Entry;
639
638
  /**
640
639
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
641
640
  */
@@ -643,13 +642,13 @@ export interface WithdrawalCreatedWebhookEvent {
643
642
  /**
644
643
  * The webhook event type
645
644
  */
646
- type: 'withdrawal.created';
645
+ type: 'entry.denied';
647
646
  /**
648
647
  * The company ID that this webhook event is associated with
649
648
  */
650
649
  company_id?: string | null;
651
650
  }
652
- export interface WithdrawalUpdatedWebhookEvent {
651
+ export interface IdentityProfileApprovedWebhookEvent {
653
652
  /**
654
653
  * A unique ID for every single webhook request
655
654
  */
@@ -659,10 +658,10 @@ export interface WithdrawalUpdatedWebhookEvent {
659
658
  */
660
659
  api_version: 'v1';
661
660
  /**
662
- * A withdrawal represents a request to transfer funds from a ledger account to an
663
- * external payout method.
661
+ * A consolidated identity or business profile synced from verification provider
662
+ * data.
664
663
  */
665
- data: WithdrawalsAPI.Withdrawal;
664
+ data: IdentityProfileApprovedWebhookEvent.Data;
666
665
  /**
667
666
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
668
667
  */
@@ -670,148 +669,209 @@ export interface WithdrawalUpdatedWebhookEvent {
670
669
  /**
671
670
  * The webhook event type
672
671
  */
673
- type: 'withdrawal.updated';
672
+ type: 'identity_profile.approved';
674
673
  /**
675
674
  * The company ID that this webhook event is associated with
676
675
  */
677
676
  company_id?: string | null;
678
677
  }
679
- export interface CourseLessonInteractionCompletedWebhookEvent {
678
+ export declare namespace IdentityProfileApprovedWebhookEvent {
680
679
  /**
681
- * A unique ID for every single webhook request
682
- */
683
- id: string;
684
- /**
685
- * The API version for this webhook
686
- */
687
- api_version: 'v1';
688
- /**
689
- * A record of a user's progress on a specific lesson, tracking whether they have
690
- * completed it.
691
- */
692
- data: Shared.CourseLessonInteraction;
693
- /**
694
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
695
- */
696
- timestamp: string;
697
- /**
698
- * The webhook event type
699
- */
700
- type: 'course_lesson_interaction.completed';
701
- /**
702
- * The company ID that this webhook event is associated with
703
- */
704
- company_id?: string | null;
705
- }
706
- export interface PayoutMethodCreatedWebhookEvent {
707
- /**
708
- * A unique ID for every single webhook request
709
- */
710
- id: string;
711
- /**
712
- * The API version for this webhook
713
- */
714
- api_version: 'v1';
715
- /**
716
- * A configured payout destination where a user receives earned funds, such as a
717
- * bank account or digital wallet.
718
- */
719
- data: PayoutMethodCreatedWebhookEvent.Data;
720
- /**
721
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
722
- */
723
- timestamp: string;
724
- /**
725
- * The webhook event type
726
- */
727
- type: 'payout_method.created';
728
- /**
729
- * The company ID that this webhook event is associated with
730
- */
731
- company_id?: string | null;
732
- }
733
- export declare namespace PayoutMethodCreatedWebhookEvent {
734
- /**
735
- * A configured payout destination where a user receives earned funds, such as a
736
- * bank account or digital wallet.
680
+ * A consolidated identity or business profile synced from verification provider
681
+ * data.
737
682
  */
738
683
  interface Data {
739
684
  /**
740
- * The unique identifier for the payout token.
685
+ * The tag of the identity profile (idpf_xxx).
741
686
  */
742
687
  id: string;
743
688
  /**
744
- * A masked identifier for the payout destination, such as the last four digits of
745
- * a bank account or an email address. Null if no reference is available.
689
+ * Registered business address reported by the identity provider. Present on
690
+ * `business` profiles.
746
691
  */
747
- account_reference: string | null;
692
+ business_address: Data.BusinessAddress | null;
748
693
  /**
749
- * The company associated with this payout destination. Null if not linked to a
750
- * specific company.
694
+ * Business entity name. Present on `business` profiles.
751
695
  */
752
- company: Data.Company | null;
696
+ business_name: string | null;
753
697
  /**
754
- * The datetime the payout token was created.
698
+ * Reported legal structure of a business profile (e.g. `corp`, `llc`).
699
+ * Provider-specific values; present on `business` profiles.
700
+ */
701
+ business_structure: string | null;
702
+ /**
703
+ * ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
704
+ * country of citizenship or residence reported by the identity provider; for
705
+ * businesses this is the country of incorporation.
706
+ */
707
+ country: string | null;
708
+ /**
709
+ * When the identity profile was first created.
755
710
  */
756
711
  created_at: string;
757
712
  /**
758
- * The three-letter ISO currency code that payouts are delivered in for this
759
- * destination.
713
+ * ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
714
+ * `individual` profiles.
760
715
  */
761
- currency: string;
716
+ date_of_birth: string | null;
762
717
  /**
763
- * The payout destination configuration linked to this token. Null if not yet
764
- * configured.
718
+ * Email address reported by the identity provider. Typically present on
719
+ * `individual` profiles.
765
720
  */
766
- destination: Data.Destination | null;
721
+ email: string | null;
767
722
  /**
768
- * The name of the bank or financial institution receiving payouts. Null if not
769
- * applicable or not provided.
723
+ * Individual's first name.
770
724
  */
771
- institution_name: string | null;
725
+ first_name: string | null;
772
726
  /**
773
- * Whether this is the default payout destination for the associated payout
774
- * account.
727
+ * Individual's last name.
775
728
  */
776
- is_default: boolean;
729
+ last_name: string | null;
777
730
  /**
778
- * A user-defined label to help identify this payout destination. Not sent to the
779
- * provider. Null if no nickname has been set.
731
+ * The companies this identity profile is currently linked to. Only populated for
732
+ * direct Whop user sessions; always empty when authenticated via API key, app, or
733
+ * OAuth scope (a single identity can be linked to companies the calling platform
734
+ * is not entitled to see).
780
735
  */
781
- nickname: string | null;
736
+ linked_companies: Array<Data.LinkedCompany>;
737
+ /**
738
+ * Residential address reported by the identity provider. Present on `individual`
739
+ * profiles.
740
+ */
741
+ personal_address: Data.PersonalAddress | null;
742
+ /**
743
+ * Phone number reported by the identity provider. Typically present on
744
+ * `individual` profiles.
745
+ */
746
+ phone: string | null;
747
+ /**
748
+ * Whether this is an 'individual' or 'business' profile.
749
+ */
750
+ profile_type: string;
751
+ /**
752
+ * Derived verification status across all linked verifications.
753
+ */
754
+ status: 'not_started' | 'pending' | 'approved' | 'rejected';
755
+ /**
756
+ * When the identity profile was last synced from a verification.
757
+ */
758
+ updated_at: string;
759
+ /**
760
+ * All verification attempts attached to this identity profile, ordered most-recent
761
+ * first.
762
+ */
763
+ verifications: Array<Data.Verification>;
782
764
  }
783
765
  namespace Data {
784
766
  /**
785
- * The company associated with this payout destination. Null if not linked to a
786
- * specific company.
767
+ * Registered business address reported by the identity provider. Present on
768
+ * `business` profiles.
787
769
  */
788
- interface Company {
770
+ interface BusinessAddress {
771
+ /**
772
+ * The city of the address.
773
+ */
774
+ city: string | null;
775
+ /**
776
+ * The country of the address.
777
+ */
778
+ country: string | null;
779
+ /**
780
+ * The line 1 of the address.
781
+ */
782
+ line1: string | null;
783
+ /**
784
+ * The line 2 of the address.
785
+ */
786
+ line2: string | null;
787
+ /**
788
+ * The postal code of the address.
789
+ */
790
+ postal_code: string | null;
791
+ /**
792
+ * The state of the address.
793
+ */
794
+ state: string | null;
795
+ }
796
+ /**
797
+ * A company is a seller on Whop. Companies own products, manage members, and
798
+ * receive payouts.
799
+ */
800
+ interface LinkedCompany {
789
801
  /**
790
802
  * The unique identifier for the company.
791
803
  */
792
804
  id: string;
805
+ /**
806
+ * The display name of the company shown to customers.
807
+ */
808
+ title: string;
793
809
  }
794
810
  /**
795
- * The payout destination configuration linked to this token. Null if not yet
796
- * configured.
811
+ * Residential address reported by the identity provider. Present on `individual`
812
+ * profiles.
797
813
  */
798
- interface Destination {
814
+ interface PersonalAddress {
799
815
  /**
800
- * The category of the payout destination
816
+ * The city of the address.
801
817
  */
802
- category: PayoutMethodsAPI.PayoutDestinationCategory;
818
+ city: string | null;
803
819
  /**
804
- * The country code of the payout destination
820
+ * The country of the address.
805
821
  */
806
- country_code: string;
822
+ country: string | null;
807
823
  /**
808
- * The name of the payer associated with the payout destination
824
+ * The line 1 of the address.
809
825
  */
810
- name: string;
826
+ line1: string | null;
827
+ /**
828
+ * The line 2 of the address.
829
+ */
830
+ line2: string | null;
831
+ /**
832
+ * The postal code of the address.
833
+ */
834
+ postal_code: string | null;
835
+ /**
836
+ * The state of the address.
837
+ */
838
+ state: string | null;
839
+ }
840
+ /**
841
+ * An identity verification session used to confirm a person or entity's identity
842
+ * for payout account eligibility.
843
+ */
844
+ interface Verification {
845
+ /**
846
+ * The numeric id of the verification record.
847
+ */
848
+ id: string;
849
+ /**
850
+ * When the verification record was created.
851
+ */
852
+ created_at: string;
853
+ /**
854
+ * An error code for a verification attempt.
855
+ */
856
+ last_error_code: VerificationsAPI.VerificationErrorCode | null;
857
+ /**
858
+ * A human-readable explanation of the most recent verification error. Null if no
859
+ * error has occurred.
860
+ */
861
+ last_error_reason: string | null;
862
+ /**
863
+ * A URL the user can visit to complete the verification process. Null if the
864
+ * session does not require user interaction.
865
+ */
866
+ session_url: string | null;
867
+ /**
868
+ * The current status of this verification session.
869
+ */
870
+ status: VerificationsAPI.VerificationStatus;
811
871
  }
812
872
  }
813
873
  }
814
- export interface VerificationSucceededWebhookEvent {
874
+ export interface IdentityProfileNeedsActionWebhookEvent {
815
875
  /**
816
876
  * A unique ID for every single webhook request
817
877
  */
@@ -821,10 +881,10 @@ export interface VerificationSucceededWebhookEvent {
821
881
  */
822
882
  api_version: 'v1';
823
883
  /**
824
- * An identity verification session used to confirm a person or entity's identity
825
- * for payout account eligibility.
884
+ * A consolidated identity or business profile synced from verification provider
885
+ * data.
826
886
  */
827
- data: VerificationSucceededWebhookEvent.Data;
887
+ data: IdentityProfileNeedsActionWebhookEvent.Data;
828
888
  /**
829
889
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
830
890
  */
@@ -832,107 +892,105 @@ export interface VerificationSucceededWebhookEvent {
832
892
  /**
833
893
  * The webhook event type
834
894
  */
835
- type: 'verification.succeeded';
895
+ type: 'identity_profile.needs_action';
836
896
  /**
837
897
  * The company ID that this webhook event is associated with
838
898
  */
839
899
  company_id?: string | null;
840
900
  }
841
- export declare namespace VerificationSucceededWebhookEvent {
901
+ export declare namespace IdentityProfileNeedsActionWebhookEvent {
842
902
  /**
843
- * An identity verification session used to confirm a person or entity's identity
844
- * for payout account eligibility.
903
+ * A consolidated identity or business profile synced from verification provider
904
+ * data.
845
905
  */
846
906
  interface Data {
847
907
  /**
848
- * The unique identifier for the verification.
908
+ * The tag of the identity profile (idpf_xxx).
849
909
  */
850
910
  id: string;
851
911
  /**
852
- * An error code for a verification attempt.
912
+ * Registered business address reported by the identity provider. Present on
913
+ * `business` profiles.
853
914
  */
854
- last_error_code: VerificationsAPI.VerificationErrorCode | null;
915
+ business_address: Data.BusinessAddress | null;
855
916
  /**
856
- * A human-readable explanation of the most recent verification error. Null if no
857
- * error has occurred.
917
+ * Business entity name. Present on `business` profiles.
858
918
  */
859
- last_error_reason: string | null;
919
+ business_name: string | null;
860
920
  /**
861
- * The current status of this verification session.
921
+ * Reported legal structure of a business profile (e.g. `corp`, `llc`).
922
+ * Provider-specific values; present on `business` profiles.
862
923
  */
863
- status: VerificationsAPI.VerificationStatus;
864
- }
865
- }
866
- export interface PayoutAccountStatusUpdatedWebhookEvent {
867
- /**
868
- * A unique ID for every single webhook request
869
- */
870
- id: string;
871
- /**
872
- * The API version for this webhook
873
- */
874
- api_version: 'v1';
875
- /**
876
- * An object representing an account used for payouts.
877
- */
878
- data: PayoutAccountStatusUpdatedWebhookEvent.Data;
879
- /**
880
- * The timestamp in ISO 8601 format that the webhook was sent at on the server
881
- */
882
- timestamp: string;
883
- /**
884
- * The webhook event type
885
- */
886
- type: 'payout_account.status_updated';
887
- /**
888
- * The company ID that this webhook event is associated with
889
- */
890
- company_id?: string | null;
891
- }
892
- export declare namespace PayoutAccountStatusUpdatedWebhookEvent {
893
- /**
894
- * An object representing an account used for payouts.
895
- */
896
- interface Data {
924
+ business_structure: string | null;
897
925
  /**
898
- * The unique identifier for the payout account.
926
+ * ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
927
+ * country of citizenship or residence reported by the identity provider; for
928
+ * businesses this is the country of incorporation.
899
929
  */
900
- id: string;
930
+ country: string | null;
901
931
  /**
902
- * The physical address associated with this payout account
932
+ * When the identity profile was first created.
903
933
  */
904
- address: Data.Address | null;
934
+ created_at: string;
905
935
  /**
906
- * The company's legal name
936
+ * ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
937
+ * `individual` profiles.
907
938
  */
908
- business_name: string | null;
939
+ date_of_birth: string | null;
909
940
  /**
910
- * The business representative for this payout account
941
+ * Email address reported by the identity provider. Typically present on
942
+ * `individual` profiles.
911
943
  */
912
- business_representative: Data.BusinessRepresentative | null;
944
+ email: string | null;
913
945
  /**
914
- * The email address of the representative
946
+ * Individual's first name.
915
947
  */
916
- email: string | null;
948
+ first_name: string | null;
917
949
  /**
918
- * The latest verification for the connected account.
950
+ * Individual's last name.
919
951
  */
920
- latest_verification: Data.LatestVerification | null;
952
+ last_name: string | null;
921
953
  /**
922
- * The business representative's phone
954
+ * The companies this identity profile is currently linked to. Only populated for
955
+ * direct Whop user sessions; always empty when authenticated via API key, app, or
956
+ * OAuth scope (a single identity can be linked to companies the calling platform
957
+ * is not entitled to see).
958
+ */
959
+ linked_companies: Array<Data.LinkedCompany>;
960
+ /**
961
+ * Residential address reported by the identity provider. Present on `individual`
962
+ * profiles.
963
+ */
964
+ personal_address: Data.PersonalAddress | null;
965
+ /**
966
+ * Phone number reported by the identity provider. Typically present on
967
+ * `individual` profiles.
923
968
  */
924
969
  phone: string | null;
925
970
  /**
926
- * The granular calculated statuses reflecting payout account KYC and withdrawal
927
- * readiness.
971
+ * Whether this is an 'individual' or 'business' profile.
928
972
  */
929
- status: PayoutAccountsAPI.PayoutAccountCalculatedStatuses | null;
973
+ profile_type: string;
974
+ /**
975
+ * Derived verification status across all linked verifications.
976
+ */
977
+ status: 'not_started' | 'pending' | 'approved' | 'rejected';
978
+ /**
979
+ * When the identity profile was last synced from a verification.
980
+ */
981
+ updated_at: string;
982
+ /**
983
+ * All verification attempts attached to this identity profile, ordered most-recent
984
+ * first.
985
+ */
986
+ verifications: Array<Data.Verification>;
930
987
  }
931
988
  namespace Data {
932
989
  /**
933
- * The physical address associated with this payout account
990
+ * Registered business address reported by the identity provider. Present on
991
+ * `business` profiles.
934
992
  */
935
- interface Address {
993
+ interface BusinessAddress {
936
994
  /**
937
995
  * The city of the address.
938
996
  */
@@ -959,35 +1017,62 @@ export declare namespace PayoutAccountStatusUpdatedWebhookEvent {
959
1017
  state: string | null;
960
1018
  }
961
1019
  /**
962
- * The business representative for this payout account
1020
+ * A company is a seller on Whop. Companies own products, manage members, and
1021
+ * receive payouts.
963
1022
  */
964
- interface BusinessRepresentative {
1023
+ interface LinkedCompany {
965
1024
  /**
966
- * The date of birth of the business representative in ISO 8601 format
967
- * (YYYY-MM-DD).
1025
+ * The unique identifier for the company.
968
1026
  */
969
- date_of_birth: string | null;
1027
+ id: string;
970
1028
  /**
971
- * The first name of the business representative.
1029
+ * The display name of the company shown to customers.
972
1030
  */
973
- first_name: string | null;
1031
+ title: string;
1032
+ }
1033
+ /**
1034
+ * Residential address reported by the identity provider. Present on `individual`
1035
+ * profiles.
1036
+ */
1037
+ interface PersonalAddress {
974
1038
  /**
975
- * The last name of the business representative.
1039
+ * The city of the address.
976
1040
  */
977
- last_name: string | null;
1041
+ city: string | null;
978
1042
  /**
979
- * The middle name of the business representative.
1043
+ * The country of the address.
980
1044
  */
981
- middle_name: string | null;
1045
+ country: string | null;
1046
+ /**
1047
+ * The line 1 of the address.
1048
+ */
1049
+ line1: string | null;
1050
+ /**
1051
+ * The line 2 of the address.
1052
+ */
1053
+ line2: string | null;
1054
+ /**
1055
+ * The postal code of the address.
1056
+ */
1057
+ postal_code: string | null;
1058
+ /**
1059
+ * The state of the address.
1060
+ */
1061
+ state: string | null;
982
1062
  }
983
1063
  /**
984
- * The latest verification for the connected account.
1064
+ * An identity verification session used to confirm a person or entity's identity
1065
+ * for payout account eligibility.
985
1066
  */
986
- interface LatestVerification {
1067
+ interface Verification {
987
1068
  /**
988
- * The unique identifier for the verification.
1069
+ * The numeric id of the verification record.
989
1070
  */
990
1071
  id: string;
1072
+ /**
1073
+ * When the verification record was created.
1074
+ */
1075
+ created_at: string;
991
1076
  /**
992
1077
  * An error code for a verification attempt.
993
1078
  */
@@ -997,6 +1082,11 @@ export declare namespace PayoutAccountStatusUpdatedWebhookEvent {
997
1082
  * error has occurred.
998
1083
  */
999
1084
  last_error_reason: string | null;
1085
+ /**
1086
+ * A URL the user can visit to complete the verification process. Null if the
1087
+ * session does not require user interaction.
1088
+ */
1089
+ session_url: string | null;
1000
1090
  /**
1001
1091
  * The current status of this verification session.
1002
1092
  */
@@ -1004,7 +1094,7 @@ export declare namespace PayoutAccountStatusUpdatedWebhookEvent {
1004
1094
  }
1005
1095
  }
1006
1096
  }
1007
- export interface ResolutionCenterCaseCreatedWebhookEvent {
1097
+ export interface IdentityProfileRejectedWebhookEvent {
1008
1098
  /**
1009
1099
  * A unique ID for every single webhook request
1010
1100
  */
@@ -1014,10 +1104,10 @@ export interface ResolutionCenterCaseCreatedWebhookEvent {
1014
1104
  */
1015
1105
  api_version: 'v1';
1016
1106
  /**
1017
- * A resolution center case is a dispute or support case between a user and a
1018
- * company, tracking the issue, status, and outcome.
1107
+ * A consolidated identity or business profile synced from verification provider
1108
+ * data.
1019
1109
  */
1020
- data: ResolutionCenterCaseCreatedWebhookEvent.Data;
1110
+ data: IdentityProfileRejectedWebhookEvent.Data;
1021
1111
  /**
1022
1112
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1023
1113
  */
@@ -1025,193 +1115,209 @@ export interface ResolutionCenterCaseCreatedWebhookEvent {
1025
1115
  /**
1026
1116
  * The webhook event type
1027
1117
  */
1028
- type: 'resolution_center_case.created';
1118
+ type: 'identity_profile.rejected';
1029
1119
  /**
1030
1120
  * The company ID that this webhook event is associated with
1031
1121
  */
1032
1122
  company_id?: string | null;
1033
1123
  }
1034
- export declare namespace ResolutionCenterCaseCreatedWebhookEvent {
1124
+ export declare namespace IdentityProfileRejectedWebhookEvent {
1035
1125
  /**
1036
- * A resolution center case is a dispute or support case between a user and a
1037
- * company, tracking the issue, status, and outcome.
1126
+ * A consolidated identity or business profile synced from verification provider
1127
+ * data.
1038
1128
  */
1039
1129
  interface Data {
1040
1130
  /**
1041
- * The unique identifier for the resolution.
1131
+ * The tag of the identity profile (idpf_xxx).
1042
1132
  */
1043
1133
  id: string;
1044
1134
  /**
1045
- * The company involved in this resolution case. Null if the company no longer
1046
- * exists.
1135
+ * Registered business address reported by the identity provider. Present on
1136
+ * `business` profiles.
1047
1137
  */
1048
- company: Data.Company | null;
1138
+ business_address: Data.BusinessAddress | null;
1049
1139
  /**
1050
- * The datetime the resolution was created.
1140
+ * Business entity name. Present on `business` profiles.
1051
1141
  */
1052
- created_at: string;
1142
+ business_name: string | null;
1053
1143
  /**
1054
- * Whether the customer has filed an appeal after the initial resolution decision.
1144
+ * Reported legal structure of a business profile (e.g. `corp`, `llc`).
1145
+ * Provider-specific values; present on `business` profiles.
1055
1146
  */
1056
- customer_appealed: boolean;
1147
+ business_structure: string | null;
1057
1148
  /**
1058
- * The list of actions currently available to the customer.
1149
+ * ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
1150
+ * country of citizenship or residence reported by the identity provider; for
1151
+ * businesses this is the country of incorporation.
1059
1152
  */
1060
- customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
1153
+ country: string | null;
1061
1154
  /**
1062
- * The deadline by which the next response is required. Null if no deadline is
1063
- * currently active. As a Unix timestamp.
1155
+ * When the identity profile was first created.
1064
1156
  */
1065
- due_date: string | null;
1157
+ created_at: string;
1066
1158
  /**
1067
- * The category of the dispute.
1159
+ * ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
1160
+ * `individual` profiles.
1068
1161
  */
1069
- issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
1162
+ date_of_birth: string | null;
1070
1163
  /**
1071
- * The membership record associated with the disputed payment. Null if the
1072
- * membership no longer exists.
1164
+ * Email address reported by the identity provider. Typically present on
1165
+ * `individual` profiles.
1073
1166
  */
1074
- member: Data.Member | null;
1167
+ email: string | null;
1075
1168
  /**
1076
- * Whether the merchant has filed an appeal after the initial resolution decision.
1169
+ * Individual's first name.
1077
1170
  */
1078
- merchant_appealed: boolean;
1171
+ first_name: string | null;
1079
1172
  /**
1080
- * The list of actions currently available to the merchant.
1173
+ * Individual's last name.
1081
1174
  */
1082
- merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
1175
+ last_name: string | null;
1083
1176
  /**
1084
- * The payment record that is the subject of this resolution case.
1177
+ * The companies this identity profile is currently linked to. Only populated for
1178
+ * direct Whop user sessions; always empty when authenticated via API key, app, or
1179
+ * OAuth scope (a single identity can be linked to companies the calling platform
1180
+ * is not entitled to see).
1085
1181
  */
1086
- payment: Data.Payment;
1182
+ linked_companies: Array<Data.LinkedCompany>;
1087
1183
  /**
1088
- * The list of actions currently available to the Whop platform for moderating this
1089
- * resolution.
1184
+ * Residential address reported by the identity provider. Present on `individual`
1185
+ * profiles.
1090
1186
  */
1091
- platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
1187
+ personal_address: Data.PersonalAddress | null;
1092
1188
  /**
1093
- * The most recent 50 messages, actions, and status changes that have occurred
1094
- * during this resolution case.
1189
+ * Phone number reported by the identity provider. Typically present on
1190
+ * `individual` profiles.
1095
1191
  */
1096
- resolution_events: Array<Data.ResolutionEvent>;
1192
+ phone: string | null;
1097
1193
  /**
1098
- * The current status of the resolution case, indicating which party needs to
1099
- * respond or if the case is closed.
1194
+ * Whether this is an 'individual' or 'business' profile.
1100
1195
  */
1101
- status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
1196
+ profile_type: string;
1102
1197
  /**
1103
- * The datetime the resolution was last updated.
1198
+ * Derived verification status across all linked verifications.
1199
+ */
1200
+ status: 'not_started' | 'pending' | 'approved' | 'rejected';
1201
+ /**
1202
+ * When the identity profile was last synced from a verification.
1104
1203
  */
1105
1204
  updated_at: string;
1106
1205
  /**
1107
- * The customer (buyer) who filed this resolution case.
1206
+ * All verification attempts attached to this identity profile, ordered most-recent
1207
+ * first.
1108
1208
  */
1109
- user: Data.User;
1209
+ verifications: Array<Data.Verification>;
1110
1210
  }
1111
1211
  namespace Data {
1112
1212
  /**
1113
- * The company involved in this resolution case. Null if the company no longer
1114
- * exists.
1213
+ * Registered business address reported by the identity provider. Present on
1214
+ * `business` profiles.
1115
1215
  */
1116
- interface Company {
1216
+ interface BusinessAddress {
1117
1217
  /**
1118
- * The unique identifier for the company.
1218
+ * The city of the address.
1119
1219
  */
1120
- id: string;
1220
+ city: string | null;
1121
1221
  /**
1122
- * The display name of the company shown to customers.
1222
+ * The country of the address.
1123
1223
  */
1124
- title: string;
1224
+ country: string | null;
1225
+ /**
1226
+ * The line 1 of the address.
1227
+ */
1228
+ line1: string | null;
1229
+ /**
1230
+ * The line 2 of the address.
1231
+ */
1232
+ line2: string | null;
1233
+ /**
1234
+ * The postal code of the address.
1235
+ */
1236
+ postal_code: string | null;
1237
+ /**
1238
+ * The state of the address.
1239
+ */
1240
+ state: string | null;
1125
1241
  }
1126
1242
  /**
1127
- * The membership record associated with the disputed payment. Null if the
1128
- * membership no longer exists.
1243
+ * A company is a seller on Whop. Companies own products, manage members, and
1244
+ * receive payouts.
1129
1245
  */
1130
- interface Member {
1246
+ interface LinkedCompany {
1131
1247
  /**
1132
- * The unique identifier for the extra public member.
1248
+ * The unique identifier for the company.
1133
1249
  */
1134
1250
  id: string;
1251
+ /**
1252
+ * The display name of the company shown to customers.
1253
+ */
1254
+ title: string;
1135
1255
  }
1136
1256
  /**
1137
- * The payment record that is the subject of this resolution case.
1257
+ * Residential address reported by the identity provider. Present on `individual`
1258
+ * profiles.
1138
1259
  */
1139
- interface Payment {
1260
+ interface PersonalAddress {
1140
1261
  /**
1141
- * The unique identifier for the payment.
1262
+ * The city of the address.
1142
1263
  */
1143
- id: string;
1264
+ city: string | null;
1144
1265
  /**
1145
- * The datetime the payment was created.
1266
+ * The country of the address.
1146
1267
  */
1147
- created_at: string;
1268
+ country: string | null;
1148
1269
  /**
1149
- * The available currencies on the platform
1270
+ * The line 1 of the address.
1150
1271
  */
1151
- currency: Shared.Currency | null;
1272
+ line1: string | null;
1152
1273
  /**
1153
- * The time at which this payment was successfully collected. Null if the payment
1154
- * has not yet succeeded. As a Unix timestamp.
1274
+ * The line 2 of the address.
1155
1275
  */
1156
- paid_at: string | null;
1276
+ line2: string | null;
1157
1277
  /**
1158
- * The payment amount before taxes and discounts are applied. In the currency
1159
- * specified by the currency field.
1278
+ * The postal code of the address.
1160
1279
  */
1161
- subtotal: number | null;
1280
+ postal_code: string | null;
1162
1281
  /**
1163
- * The total amount charged to the customer for this payment, including taxes and
1164
- * after any discounts. In the currency specified by the currency field.
1282
+ * The state of the address.
1165
1283
  */
1166
- total: number;
1284
+ state: string | null;
1167
1285
  }
1168
1286
  /**
1169
- * A resolution event is a message or action within a resolution case, such as a
1170
- * response, escalation, or status change.
1287
+ * An identity verification session used to confirm a person or entity's identity
1288
+ * for payout account eligibility.
1171
1289
  */
1172
- interface ResolutionEvent {
1290
+ interface Verification {
1173
1291
  /**
1174
- * The unique identifier for the resolution event.
1292
+ * The numeric id of the verification record.
1175
1293
  */
1176
1294
  id: string;
1177
1295
  /**
1178
- * The type of action recorded in this event.
1179
- */
1180
- action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
1181
- /**
1182
- * The datetime the resolution event was created.
1296
+ * When the verification record was created.
1183
1297
  */
1184
1298
  created_at: string;
1185
1299
  /**
1186
- * The message body or additional context provided with this resolution event. Null
1187
- * if no details were included.
1188
- */
1189
- details: string | null;
1190
- /**
1191
- * The party who performed this action.
1300
+ * An error code for a verification attempt.
1192
1301
  */
1193
- reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
1194
- }
1195
- /**
1196
- * The customer (buyer) who filed this resolution case.
1197
- */
1198
- interface User {
1302
+ last_error_code: VerificationsAPI.VerificationErrorCode | null;
1199
1303
  /**
1200
- * The unique identifier for the user.
1304
+ * A human-readable explanation of the most recent verification error. Null if no
1305
+ * error has occurred.
1201
1306
  */
1202
- id: string;
1307
+ last_error_reason: string | null;
1203
1308
  /**
1204
- * The user's display name shown on their public profile.
1309
+ * A URL the user can visit to complete the verification process. Null if the
1310
+ * session does not require user interaction.
1205
1311
  */
1206
- name: string | null;
1312
+ session_url: string | null;
1207
1313
  /**
1208
- * The user's unique username shown on their public profile.
1314
+ * The current status of this verification session.
1209
1315
  */
1210
- username: string;
1316
+ status: VerificationsAPI.VerificationStatus;
1211
1317
  }
1212
1318
  }
1213
1319
  }
1214
- export interface ResolutionCenterCaseUpdatedWebhookEvent {
1320
+ export interface IdentityProfileUpdatedWebhookEvent {
1215
1321
  /**
1216
1322
  * A unique ID for every single webhook request
1217
1323
  */
@@ -1221,10 +1327,10 @@ export interface ResolutionCenterCaseUpdatedWebhookEvent {
1221
1327
  */
1222
1328
  api_version: 'v1';
1223
1329
  /**
1224
- * A resolution center case is a dispute or support case between a user and a
1225
- * company, tracking the issue, status, and outcome.
1330
+ * A consolidated identity or business profile synced from verification provider
1331
+ * data.
1226
1332
  */
1227
- data: ResolutionCenterCaseUpdatedWebhookEvent.Data;
1333
+ data: IdentityProfileUpdatedWebhookEvent.Data;
1228
1334
  /**
1229
1335
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1230
1336
  */
@@ -1232,193 +1338,209 @@ export interface ResolutionCenterCaseUpdatedWebhookEvent {
1232
1338
  /**
1233
1339
  * The webhook event type
1234
1340
  */
1235
- type: 'resolution_center_case.updated';
1341
+ type: 'identity_profile.updated';
1236
1342
  /**
1237
1343
  * The company ID that this webhook event is associated with
1238
1344
  */
1239
1345
  company_id?: string | null;
1240
1346
  }
1241
- export declare namespace ResolutionCenterCaseUpdatedWebhookEvent {
1347
+ export declare namespace IdentityProfileUpdatedWebhookEvent {
1242
1348
  /**
1243
- * A resolution center case is a dispute or support case between a user and a
1244
- * company, tracking the issue, status, and outcome.
1349
+ * A consolidated identity or business profile synced from verification provider
1350
+ * data.
1245
1351
  */
1246
1352
  interface Data {
1247
1353
  /**
1248
- * The unique identifier for the resolution.
1354
+ * The tag of the identity profile (idpf_xxx).
1249
1355
  */
1250
1356
  id: string;
1251
1357
  /**
1252
- * The company involved in this resolution case. Null if the company no longer
1253
- * exists.
1358
+ * Registered business address reported by the identity provider. Present on
1359
+ * `business` profiles.
1254
1360
  */
1255
- company: Data.Company | null;
1361
+ business_address: Data.BusinessAddress | null;
1256
1362
  /**
1257
- * The datetime the resolution was created.
1363
+ * Business entity name. Present on `business` profiles.
1258
1364
  */
1259
- created_at: string;
1365
+ business_name: string | null;
1260
1366
  /**
1261
- * Whether the customer has filed an appeal after the initial resolution decision.
1367
+ * Reported legal structure of a business profile (e.g. `corp`, `llc`).
1368
+ * Provider-specific values; present on `business` profiles.
1262
1369
  */
1263
- customer_appealed: boolean;
1370
+ business_structure: string | null;
1264
1371
  /**
1265
- * The list of actions currently available to the customer.
1372
+ * ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
1373
+ * country of citizenship or residence reported by the identity provider; for
1374
+ * businesses this is the country of incorporation.
1266
1375
  */
1267
- customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
1376
+ country: string | null;
1268
1377
  /**
1269
- * The deadline by which the next response is required. Null if no deadline is
1270
- * currently active. As a Unix timestamp.
1378
+ * When the identity profile was first created.
1271
1379
  */
1272
- due_date: string | null;
1380
+ created_at: string;
1273
1381
  /**
1274
- * The category of the dispute.
1382
+ * ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
1383
+ * `individual` profiles.
1275
1384
  */
1276
- issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
1385
+ date_of_birth: string | null;
1277
1386
  /**
1278
- * The membership record associated with the disputed payment. Null if the
1279
- * membership no longer exists.
1387
+ * Email address reported by the identity provider. Typically present on
1388
+ * `individual` profiles.
1280
1389
  */
1281
- member: Data.Member | null;
1390
+ email: string | null;
1282
1391
  /**
1283
- * Whether the merchant has filed an appeal after the initial resolution decision.
1392
+ * Individual's first name.
1284
1393
  */
1285
- merchant_appealed: boolean;
1394
+ first_name: string | null;
1286
1395
  /**
1287
- * The list of actions currently available to the merchant.
1396
+ * Individual's last name.
1288
1397
  */
1289
- merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
1398
+ last_name: string | null;
1290
1399
  /**
1291
- * The payment record that is the subject of this resolution case.
1400
+ * The companies this identity profile is currently linked to. Only populated for
1401
+ * direct Whop user sessions; always empty when authenticated via API key, app, or
1402
+ * OAuth scope (a single identity can be linked to companies the calling platform
1403
+ * is not entitled to see).
1292
1404
  */
1293
- payment: Data.Payment;
1405
+ linked_companies: Array<Data.LinkedCompany>;
1294
1406
  /**
1295
- * The list of actions currently available to the Whop platform for moderating this
1296
- * resolution.
1407
+ * Residential address reported by the identity provider. Present on `individual`
1408
+ * profiles.
1297
1409
  */
1298
- platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
1410
+ personal_address: Data.PersonalAddress | null;
1299
1411
  /**
1300
- * The most recent 50 messages, actions, and status changes that have occurred
1301
- * during this resolution case.
1412
+ * Phone number reported by the identity provider. Typically present on
1413
+ * `individual` profiles.
1302
1414
  */
1303
- resolution_events: Array<Data.ResolutionEvent>;
1415
+ phone: string | null;
1304
1416
  /**
1305
- * The current status of the resolution case, indicating which party needs to
1306
- * respond or if the case is closed.
1417
+ * Whether this is an 'individual' or 'business' profile.
1307
1418
  */
1308
- status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
1419
+ profile_type: string;
1309
1420
  /**
1310
- * The datetime the resolution was last updated.
1421
+ * Derived verification status across all linked verifications.
1422
+ */
1423
+ status: 'not_started' | 'pending' | 'approved' | 'rejected';
1424
+ /**
1425
+ * When the identity profile was last synced from a verification.
1311
1426
  */
1312
1427
  updated_at: string;
1313
1428
  /**
1314
- * The customer (buyer) who filed this resolution case.
1429
+ * All verification attempts attached to this identity profile, ordered most-recent
1430
+ * first.
1315
1431
  */
1316
- user: Data.User;
1432
+ verifications: Array<Data.Verification>;
1317
1433
  }
1318
1434
  namespace Data {
1319
1435
  /**
1320
- * The company involved in this resolution case. Null if the company no longer
1321
- * exists.
1436
+ * Registered business address reported by the identity provider. Present on
1437
+ * `business` profiles.
1322
1438
  */
1323
- interface Company {
1439
+ interface BusinessAddress {
1324
1440
  /**
1325
- * The unique identifier for the company.
1441
+ * The city of the address.
1326
1442
  */
1327
- id: string;
1443
+ city: string | null;
1328
1444
  /**
1329
- * The display name of the company shown to customers.
1445
+ * The country of the address.
1330
1446
  */
1331
- title: string;
1332
- }
1333
- /**
1334
- * The membership record associated with the disputed payment. Null if the
1335
- * membership no longer exists.
1447
+ country: string | null;
1448
+ /**
1449
+ * The line 1 of the address.
1450
+ */
1451
+ line1: string | null;
1452
+ /**
1453
+ * The line 2 of the address.
1454
+ */
1455
+ line2: string | null;
1456
+ /**
1457
+ * The postal code of the address.
1458
+ */
1459
+ postal_code: string | null;
1460
+ /**
1461
+ * The state of the address.
1462
+ */
1463
+ state: string | null;
1464
+ }
1465
+ /**
1466
+ * A company is a seller on Whop. Companies own products, manage members, and
1467
+ * receive payouts.
1336
1468
  */
1337
- interface Member {
1469
+ interface LinkedCompany {
1338
1470
  /**
1339
- * The unique identifier for the extra public member.
1471
+ * The unique identifier for the company.
1340
1472
  */
1341
1473
  id: string;
1474
+ /**
1475
+ * The display name of the company shown to customers.
1476
+ */
1477
+ title: string;
1342
1478
  }
1343
1479
  /**
1344
- * The payment record that is the subject of this resolution case.
1480
+ * Residential address reported by the identity provider. Present on `individual`
1481
+ * profiles.
1345
1482
  */
1346
- interface Payment {
1483
+ interface PersonalAddress {
1347
1484
  /**
1348
- * The unique identifier for the payment.
1485
+ * The city of the address.
1349
1486
  */
1350
- id: string;
1487
+ city: string | null;
1351
1488
  /**
1352
- * The datetime the payment was created.
1489
+ * The country of the address.
1353
1490
  */
1354
- created_at: string;
1491
+ country: string | null;
1355
1492
  /**
1356
- * The available currencies on the platform
1493
+ * The line 1 of the address.
1357
1494
  */
1358
- currency: Shared.Currency | null;
1495
+ line1: string | null;
1359
1496
  /**
1360
- * The time at which this payment was successfully collected. Null if the payment
1361
- * has not yet succeeded. As a Unix timestamp.
1497
+ * The line 2 of the address.
1362
1498
  */
1363
- paid_at: string | null;
1499
+ line2: string | null;
1364
1500
  /**
1365
- * The payment amount before taxes and discounts are applied. In the currency
1366
- * specified by the currency field.
1501
+ * The postal code of the address.
1367
1502
  */
1368
- subtotal: number | null;
1503
+ postal_code: string | null;
1369
1504
  /**
1370
- * The total amount charged to the customer for this payment, including taxes and
1371
- * after any discounts. In the currency specified by the currency field.
1505
+ * The state of the address.
1372
1506
  */
1373
- total: number;
1507
+ state: string | null;
1374
1508
  }
1375
1509
  /**
1376
- * A resolution event is a message or action within a resolution case, such as a
1377
- * response, escalation, or status change.
1510
+ * An identity verification session used to confirm a person or entity's identity
1511
+ * for payout account eligibility.
1378
1512
  */
1379
- interface ResolutionEvent {
1513
+ interface Verification {
1380
1514
  /**
1381
- * The unique identifier for the resolution event.
1515
+ * The numeric id of the verification record.
1382
1516
  */
1383
1517
  id: string;
1384
1518
  /**
1385
- * The type of action recorded in this event.
1386
- */
1387
- action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
1388
- /**
1389
- * The datetime the resolution event was created.
1519
+ * When the verification record was created.
1390
1520
  */
1391
1521
  created_at: string;
1392
1522
  /**
1393
- * The message body or additional context provided with this resolution event. Null
1394
- * if no details were included.
1395
- */
1396
- details: string | null;
1397
- /**
1398
- * The party who performed this action.
1523
+ * An error code for a verification attempt.
1399
1524
  */
1400
- reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
1401
- }
1402
- /**
1403
- * The customer (buyer) who filed this resolution case.
1404
- */
1405
- interface User {
1525
+ last_error_code: VerificationsAPI.VerificationErrorCode | null;
1406
1526
  /**
1407
- * The unique identifier for the user.
1527
+ * A human-readable explanation of the most recent verification error. Null if no
1528
+ * error has occurred.
1408
1529
  */
1409
- id: string;
1530
+ last_error_reason: string | null;
1410
1531
  /**
1411
- * The user's display name shown on their public profile.
1532
+ * A URL the user can visit to complete the verification process. Null if the
1533
+ * session does not require user interaction.
1412
1534
  */
1413
- name: string | null;
1535
+ session_url: string | null;
1414
1536
  /**
1415
- * The user's unique username shown on their public profile.
1537
+ * The current status of this verification session.
1416
1538
  */
1417
- username: string;
1539
+ status: VerificationsAPI.VerificationStatus;
1418
1540
  }
1419
1541
  }
1420
1542
  }
1421
- export interface ResolutionCenterCaseDecidedWebhookEvent {
1543
+ export interface InvoiceCreatedWebhookEvent {
1422
1544
  /**
1423
1545
  * A unique ID for every single webhook request
1424
1546
  */
@@ -1428,10 +1550,11 @@ export interface ResolutionCenterCaseDecidedWebhookEvent {
1428
1550
  */
1429
1551
  api_version: 'v1';
1430
1552
  /**
1431
- * A resolution center case is a dispute or support case between a user and a
1432
- * company, tracking the issue, status, and outcome.
1553
+ * An invoice represents an itemized bill sent by a company to a customer for a
1554
+ * specific product and plan, tracking the amount owed, due date, and payment
1555
+ * status.
1433
1556
  */
1434
- data: ResolutionCenterCaseDecidedWebhookEvent.Data;
1557
+ data: Shared.Invoice;
1435
1558
  /**
1436
1559
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1437
1560
  */
@@ -1439,193 +1562,41 @@ export interface ResolutionCenterCaseDecidedWebhookEvent {
1439
1562
  /**
1440
1563
  * The webhook event type
1441
1564
  */
1442
- type: 'resolution_center_case.decided';
1565
+ type: 'invoice.created';
1443
1566
  /**
1444
1567
  * The company ID that this webhook event is associated with
1445
1568
  */
1446
1569
  company_id?: string | null;
1447
1570
  }
1448
- export declare namespace ResolutionCenterCaseDecidedWebhookEvent {
1571
+ export interface InvoiceMarkedUncollectibleWebhookEvent {
1449
1572
  /**
1450
- * A resolution center case is a dispute or support case between a user and a
1451
- * company, tracking the issue, status, and outcome.
1573
+ * A unique ID for every single webhook request
1452
1574
  */
1453
- interface Data {
1454
- /**
1455
- * The unique identifier for the resolution.
1456
- */
1457
- id: string;
1458
- /**
1459
- * The company involved in this resolution case. Null if the company no longer
1460
- * exists.
1461
- */
1462
- company: Data.Company | null;
1463
- /**
1464
- * The datetime the resolution was created.
1465
- */
1466
- created_at: string;
1467
- /**
1468
- * Whether the customer has filed an appeal after the initial resolution decision.
1469
- */
1470
- customer_appealed: boolean;
1471
- /**
1472
- * The list of actions currently available to the customer.
1473
- */
1474
- customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
1475
- /**
1476
- * The deadline by which the next response is required. Null if no deadline is
1477
- * currently active. As a Unix timestamp.
1478
- */
1479
- due_date: string | null;
1480
- /**
1481
- * The category of the dispute.
1482
- */
1483
- issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
1484
- /**
1485
- * The membership record associated with the disputed payment. Null if the
1486
- * membership no longer exists.
1487
- */
1488
- member: Data.Member | null;
1489
- /**
1490
- * Whether the merchant has filed an appeal after the initial resolution decision.
1491
- */
1492
- merchant_appealed: boolean;
1493
- /**
1494
- * The list of actions currently available to the merchant.
1495
- */
1496
- merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
1497
- /**
1498
- * The payment record that is the subject of this resolution case.
1499
- */
1500
- payment: Data.Payment;
1501
- /**
1502
- * The list of actions currently available to the Whop platform for moderating this
1503
- * resolution.
1504
- */
1505
- platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
1506
- /**
1507
- * The most recent 50 messages, actions, and status changes that have occurred
1508
- * during this resolution case.
1509
- */
1510
- resolution_events: Array<Data.ResolutionEvent>;
1511
- /**
1512
- * The current status of the resolution case, indicating which party needs to
1513
- * respond or if the case is closed.
1514
- */
1515
- status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
1516
- /**
1517
- * The datetime the resolution was last updated.
1518
- */
1519
- updated_at: string;
1520
- /**
1521
- * The customer (buyer) who filed this resolution case.
1522
- */
1523
- user: Data.User;
1524
- }
1525
- namespace Data {
1526
- /**
1527
- * The company involved in this resolution case. Null if the company no longer
1528
- * exists.
1529
- */
1530
- interface Company {
1531
- /**
1532
- * The unique identifier for the company.
1533
- */
1534
- id: string;
1535
- /**
1536
- * The display name of the company shown to customers.
1537
- */
1538
- title: string;
1539
- }
1540
- /**
1541
- * The membership record associated with the disputed payment. Null if the
1542
- * membership no longer exists.
1543
- */
1544
- interface Member {
1545
- /**
1546
- * The unique identifier for the extra public member.
1547
- */
1548
- id: string;
1549
- }
1550
- /**
1551
- * The payment record that is the subject of this resolution case.
1552
- */
1553
- interface Payment {
1554
- /**
1555
- * The unique identifier for the payment.
1556
- */
1557
- id: string;
1558
- /**
1559
- * The datetime the payment was created.
1560
- */
1561
- created_at: string;
1562
- /**
1563
- * The available currencies on the platform
1564
- */
1565
- currency: Shared.Currency | null;
1566
- /**
1567
- * The time at which this payment was successfully collected. Null if the payment
1568
- * has not yet succeeded. As a Unix timestamp.
1569
- */
1570
- paid_at: string | null;
1571
- /**
1572
- * The payment amount before taxes and discounts are applied. In the currency
1573
- * specified by the currency field.
1574
- */
1575
- subtotal: number | null;
1576
- /**
1577
- * The total amount charged to the customer for this payment, including taxes and
1578
- * after any discounts. In the currency specified by the currency field.
1579
- */
1580
- total: number;
1581
- }
1582
- /**
1583
- * A resolution event is a message or action within a resolution case, such as a
1584
- * response, escalation, or status change.
1585
- */
1586
- interface ResolutionEvent {
1587
- /**
1588
- * The unique identifier for the resolution event.
1589
- */
1590
- id: string;
1591
- /**
1592
- * The type of action recorded in this event.
1593
- */
1594
- action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
1595
- /**
1596
- * The datetime the resolution event was created.
1597
- */
1598
- created_at: string;
1599
- /**
1600
- * The message body or additional context provided with this resolution event. Null
1601
- * if no details were included.
1602
- */
1603
- details: string | null;
1604
- /**
1605
- * The party who performed this action.
1606
- */
1607
- reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
1608
- }
1609
- /**
1610
- * The customer (buyer) who filed this resolution case.
1611
- */
1612
- interface User {
1613
- /**
1614
- * The unique identifier for the user.
1615
- */
1616
- id: string;
1617
- /**
1618
- * The user's display name shown on their public profile.
1619
- */
1620
- name: string | null;
1621
- /**
1622
- * The user's unique username shown on their public profile.
1623
- */
1624
- username: string;
1625
- }
1626
- }
1575
+ id: string;
1576
+ /**
1577
+ * The API version for this webhook
1578
+ */
1579
+ api_version: 'v1';
1580
+ /**
1581
+ * An invoice represents an itemized bill sent by a company to a customer for a
1582
+ * specific product and plan, tracking the amount owed, due date, and payment
1583
+ * status.
1584
+ */
1585
+ data: Shared.Invoice;
1586
+ /**
1587
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
1588
+ */
1589
+ timestamp: string;
1590
+ /**
1591
+ * The webhook event type
1592
+ */
1593
+ type: 'invoice.marked_uncollectible';
1594
+ /**
1595
+ * The company ID that this webhook event is associated with
1596
+ */
1597
+ company_id?: string | null;
1627
1598
  }
1628
- export interface PaymentCreatedWebhookEvent {
1599
+ export interface InvoicePaidWebhookEvent {
1629
1600
  /**
1630
1601
  * A unique ID for every single webhook request
1631
1602
  */
@@ -1635,10 +1606,11 @@ export interface PaymentCreatedWebhookEvent {
1635
1606
  */
1636
1607
  api_version: 'v1';
1637
1608
  /**
1638
- * A payment represents a completed or attempted charge. Payments track the amount,
1639
- * status, currency, and payment method used.
1609
+ * An invoice represents an itemized bill sent by a company to a customer for a
1610
+ * specific product and plan, tracking the amount owed, due date, and payment
1611
+ * status.
1640
1612
  */
1641
- data: Shared.Payment;
1613
+ data: Shared.Invoice;
1642
1614
  /**
1643
1615
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1644
1616
  */
@@ -1646,13 +1618,13 @@ export interface PaymentCreatedWebhookEvent {
1646
1618
  /**
1647
1619
  * The webhook event type
1648
1620
  */
1649
- type: 'payment.created';
1621
+ type: 'invoice.paid';
1650
1622
  /**
1651
1623
  * The company ID that this webhook event is associated with
1652
1624
  */
1653
1625
  company_id?: string | null;
1654
1626
  }
1655
- export interface PaymentSucceededWebhookEvent {
1627
+ export interface InvoicePastDueWebhookEvent {
1656
1628
  /**
1657
1629
  * A unique ID for every single webhook request
1658
1630
  */
@@ -1662,10 +1634,11 @@ export interface PaymentSucceededWebhookEvent {
1662
1634
  */
1663
1635
  api_version: 'v1';
1664
1636
  /**
1665
- * A payment represents a completed or attempted charge. Payments track the amount,
1666
- * status, currency, and payment method used.
1637
+ * An invoice represents an itemized bill sent by a company to a customer for a
1638
+ * specific product and plan, tracking the amount owed, due date, and payment
1639
+ * status.
1667
1640
  */
1668
- data: Shared.Payment;
1641
+ data: Shared.Invoice;
1669
1642
  /**
1670
1643
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1671
1644
  */
@@ -1673,13 +1646,122 @@ export interface PaymentSucceededWebhookEvent {
1673
1646
  /**
1674
1647
  * The webhook event type
1675
1648
  */
1676
- type: 'payment.succeeded';
1649
+ type: 'invoice.past_due';
1677
1650
  /**
1678
1651
  * The company ID that this webhook event is associated with
1679
1652
  */
1680
1653
  company_id?: string | null;
1681
1654
  }
1682
- export interface PaymentFailedWebhookEvent {
1655
+ export interface InvoiceVoidedWebhookEvent {
1656
+ /**
1657
+ * A unique ID for every single webhook request
1658
+ */
1659
+ id: string;
1660
+ /**
1661
+ * The API version for this webhook
1662
+ */
1663
+ api_version: 'v1';
1664
+ /**
1665
+ * An invoice represents an itemized bill sent by a company to a customer for a
1666
+ * specific product and plan, tracking the amount owed, due date, and payment
1667
+ * status.
1668
+ */
1669
+ data: Shared.Invoice;
1670
+ /**
1671
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
1672
+ */
1673
+ timestamp: string;
1674
+ /**
1675
+ * The webhook event type
1676
+ */
1677
+ type: 'invoice.voided';
1678
+ /**
1679
+ * The company ID that this webhook event is associated with
1680
+ */
1681
+ company_id?: string | null;
1682
+ }
1683
+ export interface MembershipActivatedWebhookEvent {
1684
+ /**
1685
+ * A unique ID for every single webhook request
1686
+ */
1687
+ id: string;
1688
+ /**
1689
+ * The API version for this webhook
1690
+ */
1691
+ api_version: 'v1';
1692
+ /**
1693
+ * A membership represents an active relationship between a user and a product. It
1694
+ * tracks the user's access, billing status, and renewal schedule.
1695
+ */
1696
+ data: Shared.Membership;
1697
+ /**
1698
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
1699
+ */
1700
+ timestamp: string;
1701
+ /**
1702
+ * The webhook event type
1703
+ */
1704
+ type: 'membership.activated';
1705
+ /**
1706
+ * The company ID that this webhook event is associated with
1707
+ */
1708
+ company_id?: string | null;
1709
+ }
1710
+ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
1711
+ /**
1712
+ * A unique ID for every single webhook request
1713
+ */
1714
+ id: string;
1715
+ /**
1716
+ * The API version for this webhook
1717
+ */
1718
+ api_version: 'v1';
1719
+ /**
1720
+ * A membership represents an active relationship between a user and a product. It
1721
+ * tracks the user's access, billing status, and renewal schedule.
1722
+ */
1723
+ data: Shared.Membership;
1724
+ /**
1725
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
1726
+ */
1727
+ timestamp: string;
1728
+ /**
1729
+ * The webhook event type
1730
+ */
1731
+ type: 'membership.cancel_at_period_end_changed';
1732
+ /**
1733
+ * The company ID that this webhook event is associated with
1734
+ */
1735
+ company_id?: string | null;
1736
+ }
1737
+ export interface MembershipDeactivatedWebhookEvent {
1738
+ /**
1739
+ * A unique ID for every single webhook request
1740
+ */
1741
+ id: string;
1742
+ /**
1743
+ * The API version for this webhook
1744
+ */
1745
+ api_version: 'v1';
1746
+ /**
1747
+ * A membership represents an active relationship between a user and a product. It
1748
+ * tracks the user's access, billing status, and renewal schedule.
1749
+ */
1750
+ data: Shared.Membership;
1751
+ /**
1752
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
1753
+ */
1754
+ timestamp: string;
1755
+ /**
1756
+ * The webhook event type
1757
+ */
1758
+ type: 'membership.deactivated';
1759
+ /**
1760
+ * The company ID that this webhook event is associated with
1761
+ */
1762
+ company_id?: string | null;
1763
+ }
1764
+ export interface PaymentCreatedWebhookEvent {
1683
1765
  /**
1684
1766
  * A unique ID for every single webhook request
1685
1767
  */
@@ -1700,13 +1782,13 @@ export interface PaymentFailedWebhookEvent {
1700
1782
  /**
1701
1783
  * The webhook event type
1702
1784
  */
1703
- type: 'payment.failed';
1785
+ type: 'payment.created';
1704
1786
  /**
1705
1787
  * The company ID that this webhook event is associated with
1706
1788
  */
1707
1789
  company_id?: string | null;
1708
1790
  }
1709
- export interface PaymentPendingWebhookEvent {
1791
+ export interface PaymentFailedWebhookEvent {
1710
1792
  /**
1711
1793
  * A unique ID for every single webhook request
1712
1794
  */
@@ -1727,13 +1809,13 @@ export interface PaymentPendingWebhookEvent {
1727
1809
  /**
1728
1810
  * The webhook event type
1729
1811
  */
1730
- type: 'payment.pending';
1812
+ type: 'payment.failed';
1731
1813
  /**
1732
1814
  * The company ID that this webhook event is associated with
1733
1815
  */
1734
1816
  company_id?: string | null;
1735
1817
  }
1736
- export interface DisputeCreatedWebhookEvent {
1818
+ export interface PaymentPendingWebhookEvent {
1737
1819
  /**
1738
1820
  * A unique ID for every single webhook request
1739
1821
  */
@@ -1743,10 +1825,10 @@ export interface DisputeCreatedWebhookEvent {
1743
1825
  */
1744
1826
  api_version: 'v1';
1745
1827
  /**
1746
- * A dispute is a chargeback or payment challenge filed against a company,
1747
- * including evidence and response status.
1828
+ * A payment represents a completed or attempted charge. Payments track the amount,
1829
+ * status, currency, and payment method used.
1748
1830
  */
1749
- data: DisputesAPI.Dispute;
1831
+ data: Shared.Payment;
1750
1832
  /**
1751
1833
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1752
1834
  */
@@ -1754,13 +1836,13 @@ export interface DisputeCreatedWebhookEvent {
1754
1836
  /**
1755
1837
  * The webhook event type
1756
1838
  */
1757
- type: 'dispute.created';
1839
+ type: 'payment.pending';
1758
1840
  /**
1759
1841
  * The company ID that this webhook event is associated with
1760
1842
  */
1761
1843
  company_id?: string | null;
1762
1844
  }
1763
- export interface DisputeUpdatedWebhookEvent {
1845
+ export interface PaymentSucceededWebhookEvent {
1764
1846
  /**
1765
1847
  * A unique ID for every single webhook request
1766
1848
  */
@@ -1770,10 +1852,10 @@ export interface DisputeUpdatedWebhookEvent {
1770
1852
  */
1771
1853
  api_version: 'v1';
1772
1854
  /**
1773
- * A dispute is a chargeback or payment challenge filed against a company,
1774
- * including evidence and response status.
1855
+ * A payment represents a completed or attempted charge. Payments track the amount,
1856
+ * status, currency, and payment method used.
1775
1857
  */
1776
- data: DisputesAPI.Dispute;
1858
+ data: Shared.Payment;
1777
1859
  /**
1778
1860
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1779
1861
  */
@@ -1781,13 +1863,13 @@ export interface DisputeUpdatedWebhookEvent {
1781
1863
  /**
1782
1864
  * The webhook event type
1783
1865
  */
1784
- type: 'dispute.updated';
1866
+ type: 'payment.succeeded';
1785
1867
  /**
1786
1868
  * The company ID that this webhook event is associated with
1787
1869
  */
1788
1870
  company_id?: string | null;
1789
1871
  }
1790
- export interface RefundCreatedWebhookEvent {
1872
+ export interface PayoutAccountStatusUpdatedWebhookEvent {
1791
1873
  /**
1792
1874
  * A unique ID for every single webhook request
1793
1875
  */
@@ -1797,10 +1879,9 @@ export interface RefundCreatedWebhookEvent {
1797
1879
  */
1798
1880
  api_version: 'v1';
1799
1881
  /**
1800
- * A refund represents a full or partial reversal of a payment, including the
1801
- * amount, status, and payment provider.
1882
+ * An object representing an account used for payouts.
1802
1883
  */
1803
- data: RefundCreatedWebhookEvent.Data;
1884
+ data: PayoutAccountStatusUpdatedWebhookEvent.Data;
1804
1885
  /**
1805
1886
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
1806
1887
  */
@@ -1808,203 +1889,236 @@ export interface RefundCreatedWebhookEvent {
1808
1889
  /**
1809
1890
  * The webhook event type
1810
1891
  */
1811
- type: 'refund.created';
1892
+ type: 'payout_account.status_updated';
1812
1893
  /**
1813
1894
  * The company ID that this webhook event is associated with
1814
1895
  */
1815
1896
  company_id?: string | null;
1816
1897
  }
1817
- export declare namespace RefundCreatedWebhookEvent {
1898
+ export declare namespace PayoutAccountStatusUpdatedWebhookEvent {
1818
1899
  /**
1819
- * A refund represents a full or partial reversal of a payment, including the
1820
- * amount, status, and payment provider.
1900
+ * An object representing an account used for payouts.
1821
1901
  */
1822
1902
  interface Data {
1823
1903
  /**
1824
- * The unique identifier for the refund.
1904
+ * The unique identifier for the payout account.
1825
1905
  */
1826
1906
  id: string;
1827
1907
  /**
1828
- * The refunded amount as a decimal in the specified currency, such as 10.43 for
1829
- * $10.43 USD.
1908
+ * The physical address associated with this payout account
1830
1909
  */
1831
- amount: number;
1910
+ address: Data.Address | null;
1832
1911
  /**
1833
- * The datetime the refund was created.
1912
+ * The company's legal name
1834
1913
  */
1835
- created_at: string;
1914
+ business_name: string | null;
1836
1915
  /**
1837
- * The three-letter ISO currency code for the refunded amount.
1916
+ * The business representative for this payout account
1838
1917
  */
1839
- currency: Shared.Currency;
1918
+ business_representative: Data.BusinessRepresentative | null;
1840
1919
  /**
1841
- * The original payment that this refund was issued against. Null if the payment is
1842
- * no longer available.
1920
+ * The email address of the representative
1843
1921
  */
1844
- payment: Data.Payment | null;
1922
+ email: string | null;
1845
1923
  /**
1846
- * The payment provider that processed the refund.
1924
+ * The latest verification for the connected account.
1847
1925
  */
1848
- provider: RefundsAPI.PaymentProvider;
1926
+ latest_verification: Data.LatestVerification | null;
1849
1927
  /**
1850
- * The timestamp when the refund was created in the payment provider's system. Null
1851
- * if not available from the provider.
1928
+ * The business representative's phone
1852
1929
  */
1853
- provider_created_at: string | null;
1930
+ phone: string | null;
1854
1931
  /**
1855
- * The status of the refund reference.
1932
+ * The granular calculated statuses reflecting payout account KYC and withdrawal
1933
+ * readiness.
1856
1934
  */
1857
- reference_status: RefundsAPI.RefundReferenceStatus | null;
1858
- /**
1859
- * The type of refund reference that was made available by the payment provider.
1860
- */
1861
- reference_type: RefundsAPI.RefundReferenceType | null;
1862
- /**
1863
- * The tracking reference value from the payment processor, used to trace the
1864
- * refund through banking networks. Null if no reference was provided.
1865
- */
1866
- reference_value: string | null;
1867
- /**
1868
- * The current processing status of the refund, such as pending, succeeded, or
1869
- * failed.
1870
- */
1871
- status: RefundsAPI.RefundStatus;
1935
+ status: PayoutAccountsAPI.PayoutAccountCalculatedStatuses | null;
1872
1936
  }
1873
1937
  namespace Data {
1874
1938
  /**
1875
- * The original payment that this refund was issued against. Null if the payment is
1876
- * no longer available.
1939
+ * The physical address associated with this payout account
1877
1940
  */
1878
- interface Payment {
1879
- /**
1880
- * The unique identifier for the payment.
1881
- */
1882
- id: string;
1883
- /**
1884
- * The reason why a specific payment was billed
1885
- */
1886
- billing_reason: PaymentsAPI.BillingReasons | null;
1887
- /**
1888
- * Possible card brands that a payment token can have
1889
- */
1890
- card_brand: PaymentsAPI.CardBrands | null;
1941
+ interface Address {
1891
1942
  /**
1892
- * The last four digits of the card used to make this payment. Null if the payment
1893
- * was not made with a card.
1943
+ * The city of the address.
1894
1944
  */
1895
- card_last4: string | null;
1945
+ city: string | null;
1896
1946
  /**
1897
- * The datetime the payment was created.
1947
+ * The country of the address.
1898
1948
  */
1899
- created_at: string;
1949
+ country: string | null;
1900
1950
  /**
1901
- * The available currencies on the platform
1951
+ * The line 1 of the address.
1902
1952
  */
1903
- currency: Shared.Currency | null;
1953
+ line1: string | null;
1904
1954
  /**
1905
- * When an alert came in that this transaction will be disputed
1955
+ * The line 2 of the address.
1906
1956
  */
1907
- dispute_alerted_at: string | null;
1957
+ line2: string | null;
1908
1958
  /**
1909
- * The member attached to this payment.
1959
+ * The postal code of the address.
1910
1960
  */
1911
- member: Payment.Member | null;
1961
+ postal_code: string | null;
1912
1962
  /**
1913
- * The membership attached to this payment.
1963
+ * The state of the address.
1914
1964
  */
1915
- membership: Payment.Membership | null;
1965
+ state: string | null;
1966
+ }
1967
+ /**
1968
+ * The business representative for this payout account
1969
+ */
1970
+ interface BusinessRepresentative {
1916
1971
  /**
1917
- * The time at which this payment was successfully collected. Null if the payment
1918
- * has not yet succeeded. As a Unix timestamp.
1972
+ * The date of birth of the business representative in ISO 8601 format
1973
+ * (YYYY-MM-DD).
1919
1974
  */
1920
- paid_at: string | null;
1975
+ date_of_birth: string | null;
1921
1976
  /**
1922
- * The different types of payment methods that can be used.
1977
+ * The first name of the business representative.
1923
1978
  */
1924
- payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
1979
+ first_name: string | null;
1925
1980
  /**
1926
- * The subtotal to show to the creator (excluding buyer fees).
1981
+ * The last name of the business representative.
1927
1982
  */
1928
- subtotal: number | null;
1983
+ last_name: string | null;
1929
1984
  /**
1930
- * The calculated amount of the sales/VAT tax (if applicable).
1985
+ * The middle name of the business representative.
1931
1986
  */
1932
- tax_amount: number | null;
1987
+ middle_name: string | null;
1988
+ }
1989
+ /**
1990
+ * The latest verification for the connected account.
1991
+ */
1992
+ interface LatestVerification {
1933
1993
  /**
1934
- * The type of tax inclusivity applied to the receipt, for determining whether the
1935
- * tax is included in the final price, or paid on top.
1994
+ * The numeric id of the verification record.
1936
1995
  */
1937
- tax_behavior: PaymentsAPI.ReceiptTaxBehavior | null;
1996
+ id: string;
1938
1997
  /**
1939
- * The amount of tax that has been refunded (if applicable).
1998
+ * An error code for a verification attempt.
1940
1999
  */
1941
- tax_refunded_amount: number | null;
2000
+ last_error_code: VerificationsAPI.VerificationErrorCode | null;
1942
2001
  /**
1943
- * The total to show to the creator (excluding buyer fees).
2002
+ * A human-readable explanation of the most recent verification error. Null if no
2003
+ * error has occurred.
1944
2004
  */
1945
- total: number | null;
2005
+ last_error_reason: string | null;
1946
2006
  /**
1947
- * The total in USD to show to the creator (excluding buyer fees).
2007
+ * The current status of this verification session.
1948
2008
  */
1949
- usd_total: number | null;
2009
+ status: VerificationsAPI.VerificationStatus;
2010
+ }
2011
+ }
2012
+ }
2013
+ export interface PayoutMethodCreatedWebhookEvent {
2014
+ /**
2015
+ * A unique ID for every single webhook request
2016
+ */
2017
+ id: string;
2018
+ /**
2019
+ * The API version for this webhook
2020
+ */
2021
+ api_version: 'v1';
2022
+ /**
2023
+ * A configured payout destination where a user receives earned funds, such as a
2024
+ * bank account or digital wallet.
2025
+ */
2026
+ data: PayoutMethodCreatedWebhookEvent.Data;
2027
+ /**
2028
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
2029
+ */
2030
+ timestamp: string;
2031
+ /**
2032
+ * The webhook event type
2033
+ */
2034
+ type: 'payout_method.created';
2035
+ /**
2036
+ * The company ID that this webhook event is associated with
2037
+ */
2038
+ company_id?: string | null;
2039
+ }
2040
+ export declare namespace PayoutMethodCreatedWebhookEvent {
2041
+ /**
2042
+ * A configured payout destination where a user receives earned funds, such as a
2043
+ * bank account or digital wallet.
2044
+ */
2045
+ interface Data {
2046
+ /**
2047
+ * The unique identifier for the payout token.
2048
+ */
2049
+ id: string;
2050
+ /**
2051
+ * A masked identifier for the payout destination, such as the last four digits of
2052
+ * a bank account or an email address. Null if no reference is available.
2053
+ */
2054
+ account_reference: string | null;
2055
+ /**
2056
+ * The company associated with this payout destination. Null if not linked to a
2057
+ * specific company.
2058
+ */
2059
+ company: Data.Company | null;
2060
+ /**
2061
+ * The datetime the payout token was created.
2062
+ */
2063
+ created_at: string;
2064
+ /**
2065
+ * The three-letter ISO currency code that payouts are delivered in for this
2066
+ * destination.
2067
+ */
2068
+ currency: string;
2069
+ /**
2070
+ * The payout destination configuration linked to this token. Null if not yet
2071
+ * configured.
2072
+ */
2073
+ destination: Data.Destination | null;
2074
+ /**
2075
+ * The name of the bank or financial institution receiving payouts. Null if not
2076
+ * applicable or not provided.
2077
+ */
2078
+ institution_name: string | null;
2079
+ /**
2080
+ * Whether this is the default payout destination for the associated payout
2081
+ * account.
2082
+ */
2083
+ is_default: boolean;
2084
+ /**
2085
+ * A user-defined label to help identify this payout destination. Not sent to the
2086
+ * provider. Null if no nickname has been set.
2087
+ */
2088
+ nickname: string | null;
2089
+ }
2090
+ namespace Data {
2091
+ /**
2092
+ * The company associated with this payout destination. Null if not linked to a
2093
+ * specific company.
2094
+ */
2095
+ interface Company {
1950
2096
  /**
1951
- * The user that made this payment.
2097
+ * The unique identifier for the company.
1952
2098
  */
1953
- user: Payment.User | null;
2099
+ id: string;
1954
2100
  }
1955
- namespace Payment {
2101
+ /**
2102
+ * The payout destination configuration linked to this token. Null if not yet
2103
+ * configured.
2104
+ */
2105
+ interface Destination {
1956
2106
  /**
1957
- * The member attached to this payment.
2107
+ * The category of the payout destination
1958
2108
  */
1959
- interface Member {
1960
- /**
1961
- * The unique identifier for the company member.
1962
- */
1963
- id: string;
1964
- /**
1965
- * The phone number for the member, if available.
1966
- */
1967
- phone: string | null;
1968
- }
2109
+ category: PayoutMethodsAPI.PayoutDestinationCategory;
1969
2110
  /**
1970
- * The membership attached to this payment.
2111
+ * The country code of the payout destination
1971
2112
  */
1972
- interface Membership {
1973
- /**
1974
- * The unique identifier for the membership.
1975
- */
1976
- id: string;
1977
- /**
1978
- * The state of the membership.
1979
- */
1980
- status: Shared.MembershipStatus;
1981
- }
2113
+ country_code: string;
1982
2114
  /**
1983
- * The user that made this payment.
2115
+ * The name of the payer associated with the payout destination
1984
2116
  */
1985
- interface User {
1986
- /**
1987
- * The unique identifier for the user.
1988
- */
1989
- id: string;
1990
- /**
1991
- * The user's email address. Requires the member:email:read permission to access.
1992
- * Null if not authorized.
1993
- */
1994
- email: string | null;
1995
- /**
1996
- * The user's display name shown on their public profile.
1997
- */
1998
- name: string | null;
1999
- /**
2000
- * The user's unique username shown on their public profile.
2001
- */
2002
- username: string;
2003
- }
2117
+ name: string;
2004
2118
  }
2005
2119
  }
2006
2120
  }
2007
- export interface RefundUpdatedWebhookEvent {
2121
+ export interface RefundCreatedWebhookEvent {
2008
2122
  /**
2009
2123
  * A unique ID for every single webhook request
2010
2124
  */
@@ -2017,7 +2131,7 @@ export interface RefundUpdatedWebhookEvent {
2017
2131
  * A refund represents a full or partial reversal of a payment, including the
2018
2132
  * amount, status, and payment provider.
2019
2133
  */
2020
- data: RefundUpdatedWebhookEvent.Data;
2134
+ data: RefundCreatedWebhookEvent.Data;
2021
2135
  /**
2022
2136
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
2023
2137
  */
@@ -2025,13 +2139,13 @@ export interface RefundUpdatedWebhookEvent {
2025
2139
  /**
2026
2140
  * The webhook event type
2027
2141
  */
2028
- type: 'refund.updated';
2142
+ type: 'refund.created';
2029
2143
  /**
2030
2144
  * The company ID that this webhook event is associated with
2031
2145
  */
2032
2146
  company_id?: string | null;
2033
2147
  }
2034
- export declare namespace RefundUpdatedWebhookEvent {
2148
+ export declare namespace RefundCreatedWebhookEvent {
2035
2149
  /**
2036
2150
  * A refund represents a full or partial reversal of a payment, including the
2037
2151
  * amount, status, and payment provider.
@@ -2115,9 +2229,9 @@ export declare namespace RefundUpdatedWebhookEvent {
2115
2229
  */
2116
2230
  created_at: string;
2117
2231
  /**
2118
- * The available currencies on the platform
2232
+ * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
2119
2233
  */
2120
- currency: Shared.Currency | null;
2234
+ currency: Shared.Currency;
2121
2235
  /**
2122
2236
  * When an alert came in that this transaction will be disputed
2123
2237
  */
@@ -2131,7 +2245,14 @@ export declare namespace RefundUpdatedWebhookEvent {
2131
2245
  */
2132
2246
  membership: Payment.Membership | null;
2133
2247
  /**
2134
- * The time at which this payment was successfully collected. Null if the payment
2248
+ * The custom metadata stored on this payment. This will be copied over to the
2249
+ * checkout configuration for which this payment was made
2250
+ */
2251
+ metadata: {
2252
+ [key: string]: unknown;
2253
+ } | null;
2254
+ /**
2255
+ * The time at which this payment was successfully collected. Null if the payment
2135
2256
  * has not yet succeeded. As a Unix timestamp.
2136
2257
  */
2137
2258
  paid_at: string | null;
@@ -2139,6 +2260,14 @@ export declare namespace RefundUpdatedWebhookEvent {
2139
2260
  * The different types of payment methods that can be used.
2140
2261
  */
2141
2262
  payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
2263
+ /**
2264
+ * The plan attached to this payment.
2265
+ */
2266
+ plan: Payment.Plan | null;
2267
+ /**
2268
+ * The product this payment was made for
2269
+ */
2270
+ product: Payment.Product | null;
2142
2271
  /**
2143
2272
  * The subtotal to show to the creator (excluding buyer fees).
2144
2273
  */
@@ -2196,6 +2325,38 @@ export declare namespace RefundUpdatedWebhookEvent {
2196
2325
  */
2197
2326
  status: Shared.MembershipStatus;
2198
2327
  }
2328
+ /**
2329
+ * The plan attached to this payment.
2330
+ */
2331
+ interface Plan {
2332
+ /**
2333
+ * The unique identifier for the plan.
2334
+ */
2335
+ id: string;
2336
+ /**
2337
+ * Custom key-value pairs stored on the plan. Included in webhook payloads for
2338
+ * payment and membership events.
2339
+ */
2340
+ metadata: {
2341
+ [key: string]: unknown;
2342
+ } | null;
2343
+ }
2344
+ /**
2345
+ * The product this payment was made for
2346
+ */
2347
+ interface Product {
2348
+ /**
2349
+ * The unique identifier for the product.
2350
+ */
2351
+ id: string;
2352
+ /**
2353
+ * Custom key-value pairs stored on the product. Included in webhook payloads for
2354
+ * payment and membership events.
2355
+ */
2356
+ metadata: {
2357
+ [key: string]: unknown;
2358
+ } | null;
2359
+ }
2199
2360
  /**
2200
2361
  * The user that made this payment.
2201
2362
  */
@@ -2221,7 +2382,1025 @@ export declare namespace RefundUpdatedWebhookEvent {
2221
2382
  }
2222
2383
  }
2223
2384
  }
2224
- export interface DisputeAlertCreatedWebhookEvent {
2385
+ export interface RefundUpdatedWebhookEvent {
2386
+ /**
2387
+ * A unique ID for every single webhook request
2388
+ */
2389
+ id: string;
2390
+ /**
2391
+ * The API version for this webhook
2392
+ */
2393
+ api_version: 'v1';
2394
+ /**
2395
+ * A refund represents a full or partial reversal of a payment, including the
2396
+ * amount, status, and payment provider.
2397
+ */
2398
+ data: RefundUpdatedWebhookEvent.Data;
2399
+ /**
2400
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
2401
+ */
2402
+ timestamp: string;
2403
+ /**
2404
+ * The webhook event type
2405
+ */
2406
+ type: 'refund.updated';
2407
+ /**
2408
+ * The company ID that this webhook event is associated with
2409
+ */
2410
+ company_id?: string | null;
2411
+ }
2412
+ export declare namespace RefundUpdatedWebhookEvent {
2413
+ /**
2414
+ * A refund represents a full or partial reversal of a payment, including the
2415
+ * amount, status, and payment provider.
2416
+ */
2417
+ interface Data {
2418
+ /**
2419
+ * The unique identifier for the refund.
2420
+ */
2421
+ id: string;
2422
+ /**
2423
+ * The refunded amount as a decimal in the specified currency, such as 10.43 for
2424
+ * $10.43 USD.
2425
+ */
2426
+ amount: number;
2427
+ /**
2428
+ * The datetime the refund was created.
2429
+ */
2430
+ created_at: string;
2431
+ /**
2432
+ * The three-letter ISO currency code for the refunded amount.
2433
+ */
2434
+ currency: Shared.Currency;
2435
+ /**
2436
+ * The original payment that this refund was issued against. Null if the payment is
2437
+ * no longer available.
2438
+ */
2439
+ payment: Data.Payment | null;
2440
+ /**
2441
+ * The payment provider that processed the refund.
2442
+ */
2443
+ provider: RefundsAPI.PaymentProvider;
2444
+ /**
2445
+ * The timestamp when the refund was created in the payment provider's system. Null
2446
+ * if not available from the provider.
2447
+ */
2448
+ provider_created_at: string | null;
2449
+ /**
2450
+ * The status of the refund reference.
2451
+ */
2452
+ reference_status: RefundsAPI.RefundReferenceStatus | null;
2453
+ /**
2454
+ * The type of refund reference that was made available by the payment provider.
2455
+ */
2456
+ reference_type: RefundsAPI.RefundReferenceType | null;
2457
+ /**
2458
+ * The tracking reference value from the payment processor, used to trace the
2459
+ * refund through banking networks. Null if no reference was provided.
2460
+ */
2461
+ reference_value: string | null;
2462
+ /**
2463
+ * The current processing status of the refund, such as pending, succeeded, or
2464
+ * failed.
2465
+ */
2466
+ status: RefundsAPI.RefundStatus;
2467
+ }
2468
+ namespace Data {
2469
+ /**
2470
+ * The original payment that this refund was issued against. Null if the payment is
2471
+ * no longer available.
2472
+ */
2473
+ interface Payment {
2474
+ /**
2475
+ * The unique identifier for the payment.
2476
+ */
2477
+ id: string;
2478
+ /**
2479
+ * The reason why a specific payment was billed
2480
+ */
2481
+ billing_reason: PaymentsAPI.BillingReasons | null;
2482
+ /**
2483
+ * Possible card brands that a payment token can have
2484
+ */
2485
+ card_brand: PaymentsAPI.CardBrands | null;
2486
+ /**
2487
+ * The last four digits of the card used to make this payment. Null if the payment
2488
+ * was not made with a card.
2489
+ */
2490
+ card_last4: string | null;
2491
+ /**
2492
+ * The datetime the payment was created.
2493
+ */
2494
+ created_at: string;
2495
+ /**
2496
+ * The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
2497
+ */
2498
+ currency: Shared.Currency;
2499
+ /**
2500
+ * When an alert came in that this transaction will be disputed
2501
+ */
2502
+ dispute_alerted_at: string | null;
2503
+ /**
2504
+ * The member attached to this payment.
2505
+ */
2506
+ member: Payment.Member | null;
2507
+ /**
2508
+ * The membership attached to this payment.
2509
+ */
2510
+ membership: Payment.Membership | null;
2511
+ /**
2512
+ * The custom metadata stored on this payment. This will be copied over to the
2513
+ * checkout configuration for which this payment was made
2514
+ */
2515
+ metadata: {
2516
+ [key: string]: unknown;
2517
+ } | null;
2518
+ /**
2519
+ * The time at which this payment was successfully collected. Null if the payment
2520
+ * has not yet succeeded. As a Unix timestamp.
2521
+ */
2522
+ paid_at: string | null;
2523
+ /**
2524
+ * The different types of payment methods that can be used.
2525
+ */
2526
+ payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
2527
+ /**
2528
+ * The plan attached to this payment.
2529
+ */
2530
+ plan: Payment.Plan | null;
2531
+ /**
2532
+ * The product this payment was made for
2533
+ */
2534
+ product: Payment.Product | null;
2535
+ /**
2536
+ * The subtotal to show to the creator (excluding buyer fees).
2537
+ */
2538
+ subtotal: number | null;
2539
+ /**
2540
+ * The calculated amount of the sales/VAT tax (if applicable).
2541
+ */
2542
+ tax_amount: number | null;
2543
+ /**
2544
+ * The type of tax inclusivity applied to the receipt, for determining whether the
2545
+ * tax is included in the final price, or paid on top.
2546
+ */
2547
+ tax_behavior: PaymentsAPI.ReceiptTaxBehavior | null;
2548
+ /**
2549
+ * The amount of tax that has been refunded (if applicable).
2550
+ */
2551
+ tax_refunded_amount: number | null;
2552
+ /**
2553
+ * The total to show to the creator (excluding buyer fees).
2554
+ */
2555
+ total: number | null;
2556
+ /**
2557
+ * The total in USD to show to the creator (excluding buyer fees).
2558
+ */
2559
+ usd_total: number | null;
2560
+ /**
2561
+ * The user that made this payment.
2562
+ */
2563
+ user: Payment.User | null;
2564
+ }
2565
+ namespace Payment {
2566
+ /**
2567
+ * The member attached to this payment.
2568
+ */
2569
+ interface Member {
2570
+ /**
2571
+ * The unique identifier for the company member.
2572
+ */
2573
+ id: string;
2574
+ /**
2575
+ * The phone number for the member, if available.
2576
+ */
2577
+ phone: string | null;
2578
+ }
2579
+ /**
2580
+ * The membership attached to this payment.
2581
+ */
2582
+ interface Membership {
2583
+ /**
2584
+ * The unique identifier for the membership.
2585
+ */
2586
+ id: string;
2587
+ /**
2588
+ * The state of the membership.
2589
+ */
2590
+ status: Shared.MembershipStatus;
2591
+ }
2592
+ /**
2593
+ * The plan attached to this payment.
2594
+ */
2595
+ interface Plan {
2596
+ /**
2597
+ * The unique identifier for the plan.
2598
+ */
2599
+ id: string;
2600
+ /**
2601
+ * Custom key-value pairs stored on the plan. Included in webhook payloads for
2602
+ * payment and membership events.
2603
+ */
2604
+ metadata: {
2605
+ [key: string]: unknown;
2606
+ } | null;
2607
+ }
2608
+ /**
2609
+ * The product this payment was made for
2610
+ */
2611
+ interface Product {
2612
+ /**
2613
+ * The unique identifier for the product.
2614
+ */
2615
+ id: string;
2616
+ /**
2617
+ * Custom key-value pairs stored on the product. Included in webhook payloads for
2618
+ * payment and membership events.
2619
+ */
2620
+ metadata: {
2621
+ [key: string]: unknown;
2622
+ } | null;
2623
+ }
2624
+ /**
2625
+ * The user that made this payment.
2626
+ */
2627
+ interface User {
2628
+ /**
2629
+ * The unique identifier for the user.
2630
+ */
2631
+ id: string;
2632
+ /**
2633
+ * The user's email address. Requires the member:email:read permission to access.
2634
+ * Null if not authorized.
2635
+ */
2636
+ email: string | null;
2637
+ /**
2638
+ * The user's display name shown on their public profile.
2639
+ */
2640
+ name: string | null;
2641
+ /**
2642
+ * The user's unique username shown on their public profile.
2643
+ */
2644
+ username: string;
2645
+ }
2646
+ }
2647
+ }
2648
+ }
2649
+ export interface ResolutionCenterCaseCreatedWebhookEvent {
2650
+ /**
2651
+ * A unique ID for every single webhook request
2652
+ */
2653
+ id: string;
2654
+ /**
2655
+ * The API version for this webhook
2656
+ */
2657
+ api_version: 'v1';
2658
+ /**
2659
+ * A resolution center case is a dispute or support case between a user and a
2660
+ * company, tracking the issue, status, and outcome.
2661
+ */
2662
+ data: ResolutionCenterCaseCreatedWebhookEvent.Data;
2663
+ /**
2664
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
2665
+ */
2666
+ timestamp: string;
2667
+ /**
2668
+ * The webhook event type
2669
+ */
2670
+ type: 'resolution_center_case.created';
2671
+ /**
2672
+ * The company ID that this webhook event is associated with
2673
+ */
2674
+ company_id?: string | null;
2675
+ }
2676
+ export declare namespace ResolutionCenterCaseCreatedWebhookEvent {
2677
+ /**
2678
+ * A resolution center case is a dispute or support case between a user and a
2679
+ * company, tracking the issue, status, and outcome.
2680
+ */
2681
+ interface Data {
2682
+ /**
2683
+ * The unique identifier for the resolution.
2684
+ */
2685
+ id: string;
2686
+ /**
2687
+ * The company involved in this resolution case. Null if the company no longer
2688
+ * exists.
2689
+ */
2690
+ company: Data.Company | null;
2691
+ /**
2692
+ * The datetime the resolution was created.
2693
+ */
2694
+ created_at: string;
2695
+ /**
2696
+ * Whether the customer has filed an appeal after the initial resolution decision.
2697
+ */
2698
+ customer_appealed: boolean;
2699
+ /**
2700
+ * The list of actions currently available to the customer.
2701
+ */
2702
+ customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
2703
+ /**
2704
+ * The deadline by which the next response is required. Null if no deadline is
2705
+ * currently active. As a Unix timestamp.
2706
+ */
2707
+ due_date: string | null;
2708
+ /**
2709
+ * The category of the dispute.
2710
+ */
2711
+ issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
2712
+ /**
2713
+ * The membership record associated with the disputed payment. Null if the
2714
+ * membership no longer exists.
2715
+ */
2716
+ member: Data.Member | null;
2717
+ /**
2718
+ * Whether the merchant has filed an appeal after the initial resolution decision.
2719
+ */
2720
+ merchant_appealed: boolean;
2721
+ /**
2722
+ * The list of actions currently available to the merchant.
2723
+ */
2724
+ merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
2725
+ /**
2726
+ * The payment record that is the subject of this resolution case.
2727
+ */
2728
+ payment: Data.Payment;
2729
+ /**
2730
+ * The list of actions currently available to the Whop platform for moderating this
2731
+ * resolution.
2732
+ */
2733
+ platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
2734
+ /**
2735
+ * The most recent 50 messages, actions, and status changes that have occurred
2736
+ * during this resolution case.
2737
+ */
2738
+ resolution_events: Array<Data.ResolutionEvent>;
2739
+ /**
2740
+ * The current status of the resolution case, indicating which party needs to
2741
+ * respond or if the case is closed.
2742
+ */
2743
+ status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
2744
+ /**
2745
+ * The datetime the resolution was last updated.
2746
+ */
2747
+ updated_at: string;
2748
+ /**
2749
+ * The customer (buyer) who filed this resolution case.
2750
+ */
2751
+ user: Data.User;
2752
+ }
2753
+ namespace Data {
2754
+ /**
2755
+ * The company involved in this resolution case. Null if the company no longer
2756
+ * exists.
2757
+ */
2758
+ interface Company {
2759
+ /**
2760
+ * The unique identifier for the company.
2761
+ */
2762
+ id: string;
2763
+ /**
2764
+ * The display name of the company shown to customers.
2765
+ */
2766
+ title: string;
2767
+ }
2768
+ /**
2769
+ * The membership record associated with the disputed payment. Null if the
2770
+ * membership no longer exists.
2771
+ */
2772
+ interface Member {
2773
+ /**
2774
+ * The unique identifier for the extra public member.
2775
+ */
2776
+ id: string;
2777
+ }
2778
+ /**
2779
+ * The payment record that is the subject of this resolution case.
2780
+ */
2781
+ interface Payment {
2782
+ /**
2783
+ * The unique identifier for the payment.
2784
+ */
2785
+ id: string;
2786
+ /**
2787
+ * The datetime the payment was created.
2788
+ */
2789
+ created_at: string;
2790
+ /**
2791
+ * The available currencies on the platform
2792
+ */
2793
+ currency: Shared.Currency | null;
2794
+ /**
2795
+ * The time at which this payment was successfully collected. Null if the payment
2796
+ * has not yet succeeded. As a Unix timestamp.
2797
+ */
2798
+ paid_at: string | null;
2799
+ /**
2800
+ * The payment amount before taxes and discounts are applied. In the currency
2801
+ * specified by the currency field.
2802
+ */
2803
+ subtotal: number | null;
2804
+ /**
2805
+ * The total amount charged to the customer for this payment, including taxes and
2806
+ * after any discounts. In the currency specified by the currency field.
2807
+ */
2808
+ total: number;
2809
+ }
2810
+ /**
2811
+ * A resolution event is a message or action within a resolution case, such as a
2812
+ * response, escalation, or status change.
2813
+ */
2814
+ interface ResolutionEvent {
2815
+ /**
2816
+ * The unique identifier for the resolution event.
2817
+ */
2818
+ id: string;
2819
+ /**
2820
+ * The type of action recorded in this event.
2821
+ */
2822
+ action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
2823
+ /**
2824
+ * The datetime the resolution event was created.
2825
+ */
2826
+ created_at: string;
2827
+ /**
2828
+ * The message body or additional context provided with this resolution event. Null
2829
+ * if no details were included.
2830
+ */
2831
+ details: string | null;
2832
+ /**
2833
+ * The party who performed this action.
2834
+ */
2835
+ reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
2836
+ }
2837
+ /**
2838
+ * The customer (buyer) who filed this resolution case.
2839
+ */
2840
+ interface User {
2841
+ /**
2842
+ * The unique identifier for the user.
2843
+ */
2844
+ id: string;
2845
+ /**
2846
+ * The user's display name shown on their public profile.
2847
+ */
2848
+ name: string | null;
2849
+ /**
2850
+ * The user's unique username shown on their public profile.
2851
+ */
2852
+ username: string;
2853
+ }
2854
+ }
2855
+ }
2856
+ export interface ResolutionCenterCaseDecidedWebhookEvent {
2857
+ /**
2858
+ * A unique ID for every single webhook request
2859
+ */
2860
+ id: string;
2861
+ /**
2862
+ * The API version for this webhook
2863
+ */
2864
+ api_version: 'v1';
2865
+ /**
2866
+ * A resolution center case is a dispute or support case between a user and a
2867
+ * company, tracking the issue, status, and outcome.
2868
+ */
2869
+ data: ResolutionCenterCaseDecidedWebhookEvent.Data;
2870
+ /**
2871
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
2872
+ */
2873
+ timestamp: string;
2874
+ /**
2875
+ * The webhook event type
2876
+ */
2877
+ type: 'resolution_center_case.decided';
2878
+ /**
2879
+ * The company ID that this webhook event is associated with
2880
+ */
2881
+ company_id?: string | null;
2882
+ }
2883
+ export declare namespace ResolutionCenterCaseDecidedWebhookEvent {
2884
+ /**
2885
+ * A resolution center case is a dispute or support case between a user and a
2886
+ * company, tracking the issue, status, and outcome.
2887
+ */
2888
+ interface Data {
2889
+ /**
2890
+ * The unique identifier for the resolution.
2891
+ */
2892
+ id: string;
2893
+ /**
2894
+ * The company involved in this resolution case. Null if the company no longer
2895
+ * exists.
2896
+ */
2897
+ company: Data.Company | null;
2898
+ /**
2899
+ * The datetime the resolution was created.
2900
+ */
2901
+ created_at: string;
2902
+ /**
2903
+ * Whether the customer has filed an appeal after the initial resolution decision.
2904
+ */
2905
+ customer_appealed: boolean;
2906
+ /**
2907
+ * The list of actions currently available to the customer.
2908
+ */
2909
+ customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
2910
+ /**
2911
+ * The deadline by which the next response is required. Null if no deadline is
2912
+ * currently active. As a Unix timestamp.
2913
+ */
2914
+ due_date: string | null;
2915
+ /**
2916
+ * The category of the dispute.
2917
+ */
2918
+ issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
2919
+ /**
2920
+ * The membership record associated with the disputed payment. Null if the
2921
+ * membership no longer exists.
2922
+ */
2923
+ member: Data.Member | null;
2924
+ /**
2925
+ * Whether the merchant has filed an appeal after the initial resolution decision.
2926
+ */
2927
+ merchant_appealed: boolean;
2928
+ /**
2929
+ * The list of actions currently available to the merchant.
2930
+ */
2931
+ merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
2932
+ /**
2933
+ * The payment record that is the subject of this resolution case.
2934
+ */
2935
+ payment: Data.Payment;
2936
+ /**
2937
+ * The list of actions currently available to the Whop platform for moderating this
2938
+ * resolution.
2939
+ */
2940
+ platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
2941
+ /**
2942
+ * The most recent 50 messages, actions, and status changes that have occurred
2943
+ * during this resolution case.
2944
+ */
2945
+ resolution_events: Array<Data.ResolutionEvent>;
2946
+ /**
2947
+ * The current status of the resolution case, indicating which party needs to
2948
+ * respond or if the case is closed.
2949
+ */
2950
+ status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
2951
+ /**
2952
+ * The datetime the resolution was last updated.
2953
+ */
2954
+ updated_at: string;
2955
+ /**
2956
+ * The customer (buyer) who filed this resolution case.
2957
+ */
2958
+ user: Data.User;
2959
+ }
2960
+ namespace Data {
2961
+ /**
2962
+ * The company involved in this resolution case. Null if the company no longer
2963
+ * exists.
2964
+ */
2965
+ interface Company {
2966
+ /**
2967
+ * The unique identifier for the company.
2968
+ */
2969
+ id: string;
2970
+ /**
2971
+ * The display name of the company shown to customers.
2972
+ */
2973
+ title: string;
2974
+ }
2975
+ /**
2976
+ * The membership record associated with the disputed payment. Null if the
2977
+ * membership no longer exists.
2978
+ */
2979
+ interface Member {
2980
+ /**
2981
+ * The unique identifier for the extra public member.
2982
+ */
2983
+ id: string;
2984
+ }
2985
+ /**
2986
+ * The payment record that is the subject of this resolution case.
2987
+ */
2988
+ interface Payment {
2989
+ /**
2990
+ * The unique identifier for the payment.
2991
+ */
2992
+ id: string;
2993
+ /**
2994
+ * The datetime the payment was created.
2995
+ */
2996
+ created_at: string;
2997
+ /**
2998
+ * The available currencies on the platform
2999
+ */
3000
+ currency: Shared.Currency | null;
3001
+ /**
3002
+ * The time at which this payment was successfully collected. Null if the payment
3003
+ * has not yet succeeded. As a Unix timestamp.
3004
+ */
3005
+ paid_at: string | null;
3006
+ /**
3007
+ * The payment amount before taxes and discounts are applied. In the currency
3008
+ * specified by the currency field.
3009
+ */
3010
+ subtotal: number | null;
3011
+ /**
3012
+ * The total amount charged to the customer for this payment, including taxes and
3013
+ * after any discounts. In the currency specified by the currency field.
3014
+ */
3015
+ total: number;
3016
+ }
3017
+ /**
3018
+ * A resolution event is a message or action within a resolution case, such as a
3019
+ * response, escalation, or status change.
3020
+ */
3021
+ interface ResolutionEvent {
3022
+ /**
3023
+ * The unique identifier for the resolution event.
3024
+ */
3025
+ id: string;
3026
+ /**
3027
+ * The type of action recorded in this event.
3028
+ */
3029
+ action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
3030
+ /**
3031
+ * The datetime the resolution event was created.
3032
+ */
3033
+ created_at: string;
3034
+ /**
3035
+ * The message body or additional context provided with this resolution event. Null
3036
+ * if no details were included.
3037
+ */
3038
+ details: string | null;
3039
+ /**
3040
+ * The party who performed this action.
3041
+ */
3042
+ reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
3043
+ }
3044
+ /**
3045
+ * The customer (buyer) who filed this resolution case.
3046
+ */
3047
+ interface User {
3048
+ /**
3049
+ * The unique identifier for the user.
3050
+ */
3051
+ id: string;
3052
+ /**
3053
+ * The user's display name shown on their public profile.
3054
+ */
3055
+ name: string | null;
3056
+ /**
3057
+ * The user's unique username shown on their public profile.
3058
+ */
3059
+ username: string;
3060
+ }
3061
+ }
3062
+ }
3063
+ export interface ResolutionCenterCaseUpdatedWebhookEvent {
3064
+ /**
3065
+ * A unique ID for every single webhook request
3066
+ */
3067
+ id: string;
3068
+ /**
3069
+ * The API version for this webhook
3070
+ */
3071
+ api_version: 'v1';
3072
+ /**
3073
+ * A resolution center case is a dispute or support case between a user and a
3074
+ * company, tracking the issue, status, and outcome.
3075
+ */
3076
+ data: ResolutionCenterCaseUpdatedWebhookEvent.Data;
3077
+ /**
3078
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
3079
+ */
3080
+ timestamp: string;
3081
+ /**
3082
+ * The webhook event type
3083
+ */
3084
+ type: 'resolution_center_case.updated';
3085
+ /**
3086
+ * The company ID that this webhook event is associated with
3087
+ */
3088
+ company_id?: string | null;
3089
+ }
3090
+ export declare namespace ResolutionCenterCaseUpdatedWebhookEvent {
3091
+ /**
3092
+ * A resolution center case is a dispute or support case between a user and a
3093
+ * company, tracking the issue, status, and outcome.
3094
+ */
3095
+ interface Data {
3096
+ /**
3097
+ * The unique identifier for the resolution.
3098
+ */
3099
+ id: string;
3100
+ /**
3101
+ * The company involved in this resolution case. Null if the company no longer
3102
+ * exists.
3103
+ */
3104
+ company: Data.Company | null;
3105
+ /**
3106
+ * The datetime the resolution was created.
3107
+ */
3108
+ created_at: string;
3109
+ /**
3110
+ * Whether the customer has filed an appeal after the initial resolution decision.
3111
+ */
3112
+ customer_appealed: boolean;
3113
+ /**
3114
+ * The list of actions currently available to the customer.
3115
+ */
3116
+ customer_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseCustomerResponse>;
3117
+ /**
3118
+ * The deadline by which the next response is required. Null if no deadline is
3119
+ * currently active. As a Unix timestamp.
3120
+ */
3121
+ due_date: string | null;
3122
+ /**
3123
+ * The category of the dispute.
3124
+ */
3125
+ issue: ResolutionCenterCasesAPI.ResolutionCenterCaseIssueType;
3126
+ /**
3127
+ * The membership record associated with the disputed payment. Null if the
3128
+ * membership no longer exists.
3129
+ */
3130
+ member: Data.Member | null;
3131
+ /**
3132
+ * Whether the merchant has filed an appeal after the initial resolution decision.
3133
+ */
3134
+ merchant_appealed: boolean;
3135
+ /**
3136
+ * The list of actions currently available to the merchant.
3137
+ */
3138
+ merchant_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCaseMerchantResponse>;
3139
+ /**
3140
+ * The payment record that is the subject of this resolution case.
3141
+ */
3142
+ payment: Data.Payment;
3143
+ /**
3144
+ * The list of actions currently available to the Whop platform for moderating this
3145
+ * resolution.
3146
+ */
3147
+ platform_response_actions: Array<ResolutionCenterCasesAPI.ResolutionCenterCasePlatformResponse>;
3148
+ /**
3149
+ * The most recent 50 messages, actions, and status changes that have occurred
3150
+ * during this resolution case.
3151
+ */
3152
+ resolution_events: Array<Data.ResolutionEvent>;
3153
+ /**
3154
+ * The current status of the resolution case, indicating which party needs to
3155
+ * respond or if the case is closed.
3156
+ */
3157
+ status: ResolutionCenterCasesAPI.ResolutionCenterCaseStatus;
3158
+ /**
3159
+ * The datetime the resolution was last updated.
3160
+ */
3161
+ updated_at: string;
3162
+ /**
3163
+ * The customer (buyer) who filed this resolution case.
3164
+ */
3165
+ user: Data.User;
3166
+ }
3167
+ namespace Data {
3168
+ /**
3169
+ * The company involved in this resolution case. Null if the company no longer
3170
+ * exists.
3171
+ */
3172
+ interface Company {
3173
+ /**
3174
+ * The unique identifier for the company.
3175
+ */
3176
+ id: string;
3177
+ /**
3178
+ * The display name of the company shown to customers.
3179
+ */
3180
+ title: string;
3181
+ }
3182
+ /**
3183
+ * The membership record associated with the disputed payment. Null if the
3184
+ * membership no longer exists.
3185
+ */
3186
+ interface Member {
3187
+ /**
3188
+ * The unique identifier for the extra public member.
3189
+ */
3190
+ id: string;
3191
+ }
3192
+ /**
3193
+ * The payment record that is the subject of this resolution case.
3194
+ */
3195
+ interface Payment {
3196
+ /**
3197
+ * The unique identifier for the payment.
3198
+ */
3199
+ id: string;
3200
+ /**
3201
+ * The datetime the payment was created.
3202
+ */
3203
+ created_at: string;
3204
+ /**
3205
+ * The available currencies on the platform
3206
+ */
3207
+ currency: Shared.Currency | null;
3208
+ /**
3209
+ * The time at which this payment was successfully collected. Null if the payment
3210
+ * has not yet succeeded. As a Unix timestamp.
3211
+ */
3212
+ paid_at: string | null;
3213
+ /**
3214
+ * The payment amount before taxes and discounts are applied. In the currency
3215
+ * specified by the currency field.
3216
+ */
3217
+ subtotal: number | null;
3218
+ /**
3219
+ * The total amount charged to the customer for this payment, including taxes and
3220
+ * after any discounts. In the currency specified by the currency field.
3221
+ */
3222
+ total: number;
3223
+ }
3224
+ /**
3225
+ * A resolution event is a message or action within a resolution case, such as a
3226
+ * response, escalation, or status change.
3227
+ */
3228
+ interface ResolutionEvent {
3229
+ /**
3230
+ * The unique identifier for the resolution event.
3231
+ */
3232
+ id: string;
3233
+ /**
3234
+ * The type of action recorded in this event.
3235
+ */
3236
+ action: 'created' | 'responded' | 'accepted' | 'denied' | 'appealed' | 'withdrew' | 'requested_more_info' | 'escalated' | 'dispute_opened' | 'dispute_customer_won' | 'dispute_merchant_won';
3237
+ /**
3238
+ * The datetime the resolution event was created.
3239
+ */
3240
+ created_at: string;
3241
+ /**
3242
+ * The message body or additional context provided with this resolution event. Null
3243
+ * if no details were included.
3244
+ */
3245
+ details: string | null;
3246
+ /**
3247
+ * The party who performed this action.
3248
+ */
3249
+ reporter_type: 'merchant' | 'customer' | 'platform' | 'system';
3250
+ }
3251
+ /**
3252
+ * The customer (buyer) who filed this resolution case.
3253
+ */
3254
+ interface User {
3255
+ /**
3256
+ * The unique identifier for the user.
3257
+ */
3258
+ id: string;
3259
+ /**
3260
+ * The user's display name shown on their public profile.
3261
+ */
3262
+ name: string | null;
3263
+ /**
3264
+ * The user's unique username shown on their public profile.
3265
+ */
3266
+ username: string;
3267
+ }
3268
+ }
3269
+ }
3270
+ export interface SetupIntentCanceledWebhookEvent {
3271
+ /**
3272
+ * A unique ID for every single webhook request
3273
+ */
3274
+ id: string;
3275
+ /**
3276
+ * The API version for this webhook
3277
+ */
3278
+ api_version: 'v1';
3279
+ /**
3280
+ * A setup intent allows a user to save a payment method for future use without
3281
+ * making an immediate purchase.
3282
+ */
3283
+ data: SetupIntentsAPI.SetupIntent;
3284
+ /**
3285
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
3286
+ */
3287
+ timestamp: string;
3288
+ /**
3289
+ * The webhook event type
3290
+ */
3291
+ type: 'setup_intent.canceled';
3292
+ /**
3293
+ * The company ID that this webhook event is associated with
3294
+ */
3295
+ company_id?: string | null;
3296
+ }
3297
+ export interface SetupIntentRequiresActionWebhookEvent {
3298
+ /**
3299
+ * A unique ID for every single webhook request
3300
+ */
3301
+ id: string;
3302
+ /**
3303
+ * The API version for this webhook
3304
+ */
3305
+ api_version: 'v1';
3306
+ /**
3307
+ * A setup intent allows a user to save a payment method for future use without
3308
+ * making an immediate purchase.
3309
+ */
3310
+ data: SetupIntentsAPI.SetupIntent;
3311
+ /**
3312
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
3313
+ */
3314
+ timestamp: string;
3315
+ /**
3316
+ * The webhook event type
3317
+ */
3318
+ type: 'setup_intent.requires_action';
3319
+ /**
3320
+ * The company ID that this webhook event is associated with
3321
+ */
3322
+ company_id?: string | null;
3323
+ }
3324
+ export interface SetupIntentSucceededWebhookEvent {
3325
+ /**
3326
+ * A unique ID for every single webhook request
3327
+ */
3328
+ id: string;
3329
+ /**
3330
+ * The API version for this webhook
3331
+ */
3332
+ api_version: 'v1';
3333
+ /**
3334
+ * A setup intent allows a user to save a payment method for future use without
3335
+ * making an immediate purchase.
3336
+ */
3337
+ data: SetupIntentsAPI.SetupIntent;
3338
+ /**
3339
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
3340
+ */
3341
+ timestamp: string;
3342
+ /**
3343
+ * The webhook event type
3344
+ */
3345
+ type: 'setup_intent.succeeded';
3346
+ /**
3347
+ * The company ID that this webhook event is associated with
3348
+ */
3349
+ company_id?: string | null;
3350
+ }
3351
+ export interface VerificationSucceededWebhookEvent {
3352
+ /**
3353
+ * A unique ID for every single webhook request
3354
+ */
3355
+ id: string;
3356
+ /**
3357
+ * The API version for this webhook
3358
+ */
3359
+ api_version: 'v1';
3360
+ /**
3361
+ * An identity verification session used to confirm a person or entity's identity
3362
+ * for payout account eligibility.
3363
+ */
3364
+ data: VerificationSucceededWebhookEvent.Data;
3365
+ /**
3366
+ * The timestamp in ISO 8601 format that the webhook was sent at on the server
3367
+ */
3368
+ timestamp: string;
3369
+ /**
3370
+ * The webhook event type
3371
+ */
3372
+ type: 'verification.succeeded';
3373
+ /**
3374
+ * The company ID that this webhook event is associated with
3375
+ */
3376
+ company_id?: string | null;
3377
+ }
3378
+ export declare namespace VerificationSucceededWebhookEvent {
3379
+ /**
3380
+ * An identity verification session used to confirm a person or entity's identity
3381
+ * for payout account eligibility.
3382
+ */
3383
+ interface Data {
3384
+ /**
3385
+ * The numeric id of the verification record.
3386
+ */
3387
+ id: string;
3388
+ /**
3389
+ * An error code for a verification attempt.
3390
+ */
3391
+ last_error_code: VerificationsAPI.VerificationErrorCode | null;
3392
+ /**
3393
+ * A human-readable explanation of the most recent verification error. Null if no
3394
+ * error has occurred.
3395
+ */
3396
+ last_error_reason: string | null;
3397
+ /**
3398
+ * The current status of this verification session.
3399
+ */
3400
+ status: VerificationsAPI.VerificationStatus;
3401
+ }
3402
+ }
3403
+ export interface WithdrawalCreatedWebhookEvent {
2225
3404
  /**
2226
3405
  * A unique ID for every single webhook request
2227
3406
  */
@@ -2231,10 +3410,10 @@ export interface DisputeAlertCreatedWebhookEvent {
2231
3410
  */
2232
3411
  api_version: 'v1';
2233
3412
  /**
2234
- * A dispute alert represents an early warning notification from a payment
2235
- * processor about a potential dispute or chargeback.
3413
+ * A withdrawal represents a request to transfer funds from a ledger account to an
3414
+ * external payout method.
2236
3415
  */
2237
- data: DisputeAlertCreatedWebhookEvent.Data;
3416
+ data: WithdrawalsAPI.Withdrawal;
2238
3417
  /**
2239
3418
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
2240
3419
  */
@@ -2242,206 +3421,13 @@ export interface DisputeAlertCreatedWebhookEvent {
2242
3421
  /**
2243
3422
  * The webhook event type
2244
3423
  */
2245
- type: 'dispute_alert.created';
3424
+ type: 'withdrawal.created';
2246
3425
  /**
2247
3426
  * The company ID that this webhook event is associated with
2248
3427
  */
2249
3428
  company_id?: string | null;
2250
3429
  }
2251
- export declare namespace DisputeAlertCreatedWebhookEvent {
2252
- /**
2253
- * A dispute alert represents an early warning notification from a payment
2254
- * processor about a potential dispute or chargeback.
2255
- */
2256
- interface Data {
2257
- /**
2258
- * The unique identifier of the dispute alert.
2259
- */
2260
- id: string;
2261
- /**
2262
- * The type of the dispute alert.
2263
- */
2264
- alert_type: DisputeAlertsAPI.DisputeAlertType;
2265
- /**
2266
- * The alerted amount in the specified currency.
2267
- */
2268
- amount: number;
2269
- /**
2270
- * Whether this alert incurs a charge.
2271
- */
2272
- charge_for_alert: boolean;
2273
- /**
2274
- * The time the dispute alert was created.
2275
- */
2276
- created_at: string;
2277
- /**
2278
- * The three-letter ISO currency code for the alerted amount.
2279
- */
2280
- currency: Shared.Currency;
2281
- /**
2282
- * The dispute associated with the dispute alert.
2283
- */
2284
- dispute: Data.Dispute | null;
2285
- /**
2286
- * The payment associated with the dispute alert.
2287
- */
2288
- payment: Data.Payment | null;
2289
- /**
2290
- * The date of the original transaction.
2291
- */
2292
- transaction_date: string | null;
2293
- }
2294
- namespace Data {
2295
- /**
2296
- * The dispute associated with the dispute alert.
2297
- */
2298
- interface Dispute {
2299
- /**
2300
- * The unique identifier for the dispute.
2301
- */
2302
- id: string;
2303
- /**
2304
- * The disputed amount in the specified currency, formatted as a decimal.
2305
- */
2306
- amount: number;
2307
- /**
2308
- * The datetime the dispute was created.
2309
- */
2310
- created_at: string | null;
2311
- /**
2312
- * The three-letter ISO currency code for the disputed amount.
2313
- */
2314
- currency: Shared.Currency;
2315
- /**
2316
- * A human-readable reason for the dispute.
2317
- */
2318
- reason: string | null;
2319
- /**
2320
- * The current status of the dispute lifecycle, such as needs_response,
2321
- * under_review, won, or lost.
2322
- */
2323
- status: DisputesAPI.DisputeStatuses;
2324
- }
2325
- /**
2326
- * The payment associated with the dispute alert.
2327
- */
2328
- interface Payment {
2329
- /**
2330
- * The unique identifier for the payment.
2331
- */
2332
- id: string;
2333
- /**
2334
- * The reason why a specific payment was billed
2335
- */
2336
- billing_reason: PaymentsAPI.BillingReasons | null;
2337
- /**
2338
- * Possible card brands that a payment token can have
2339
- */
2340
- card_brand: PaymentsAPI.CardBrands | null;
2341
- /**
2342
- * The last four digits of the card used to make this payment. Null if the payment
2343
- * was not made with a card.
2344
- */
2345
- card_last4: string | null;
2346
- /**
2347
- * The datetime the payment was created.
2348
- */
2349
- created_at: string;
2350
- /**
2351
- * The available currencies on the platform
2352
- */
2353
- currency: Shared.Currency | null;
2354
- /**
2355
- * When an alert came in that this transaction will be disputed
2356
- */
2357
- dispute_alerted_at: string | null;
2358
- /**
2359
- * The member attached to this payment.
2360
- */
2361
- member: Payment.Member | null;
2362
- /**
2363
- * The membership attached to this payment.
2364
- */
2365
- membership: Payment.Membership | null;
2366
- /**
2367
- * The time at which this payment was successfully collected. Null if the payment
2368
- * has not yet succeeded. As a Unix timestamp.
2369
- */
2370
- paid_at: string | null;
2371
- /**
2372
- * The different types of payment methods that can be used.
2373
- */
2374
- payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
2375
- /**
2376
- * The subtotal to show to the creator (excluding buyer fees).
2377
- */
2378
- subtotal: number | null;
2379
- /**
2380
- * The total to show to the creator (excluding buyer fees).
2381
- */
2382
- total: number | null;
2383
- /**
2384
- * The total in USD to show to the creator (excluding buyer fees).
2385
- */
2386
- usd_total: number | null;
2387
- /**
2388
- * The user that made this payment.
2389
- */
2390
- user: Payment.User | null;
2391
- }
2392
- namespace Payment {
2393
- /**
2394
- * The member attached to this payment.
2395
- */
2396
- interface Member {
2397
- /**
2398
- * The unique identifier for the company member.
2399
- */
2400
- id: string;
2401
- /**
2402
- * The phone number for the member, if available.
2403
- */
2404
- phone: string | null;
2405
- }
2406
- /**
2407
- * The membership attached to this payment.
2408
- */
2409
- interface Membership {
2410
- /**
2411
- * The unique identifier for the membership.
2412
- */
2413
- id: string;
2414
- /**
2415
- * The state of the membership.
2416
- */
2417
- status: Shared.MembershipStatus;
2418
- }
2419
- /**
2420
- * The user that made this payment.
2421
- */
2422
- interface User {
2423
- /**
2424
- * The unique identifier for the user.
2425
- */
2426
- id: string;
2427
- /**
2428
- * The user's email address. Requires the member:email:read permission to access.
2429
- * Null if not authorized.
2430
- */
2431
- email: string | null;
2432
- /**
2433
- * The user's display name shown on their public profile.
2434
- */
2435
- name: string | null;
2436
- /**
2437
- * The user's unique username shown on their public profile.
2438
- */
2439
- username: string;
2440
- }
2441
- }
2442
- }
2443
- }
2444
- export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
3430
+ export interface WithdrawalUpdatedWebhookEvent {
2445
3431
  /**
2446
3432
  * A unique ID for every single webhook request
2447
3433
  */
@@ -2451,10 +3437,10 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
2451
3437
  */
2452
3438
  api_version: 'v1';
2453
3439
  /**
2454
- * A membership represents an active relationship between a user and a product. It
2455
- * tracks the user's access, billing status, and renewal schedule.
3440
+ * A withdrawal represents a request to transfer funds from a ledger account to an
3441
+ * external payout method.
2456
3442
  */
2457
- data: Shared.Membership;
3443
+ data: WithdrawalsAPI.Withdrawal;
2458
3444
  /**
2459
3445
  * The timestamp in ISO 8601 format that the webhook was sent at on the server
2460
3446
  */
@@ -2462,13 +3448,31 @@ export interface MembershipCancelAtPeriodEndChangedWebhookEvent {
2462
3448
  /**
2463
3449
  * The webhook event type
2464
3450
  */
2465
- type: 'membership.cancel_at_period_end_changed';
3451
+ type: 'withdrawal.updated';
2466
3452
  /**
2467
3453
  * The company ID that this webhook event is associated with
2468
3454
  */
2469
3455
  company_id?: string | null;
2470
3456
  }
2471
- export type UnwrapWebhookEvent = InvoiceCreatedWebhookEvent | InvoiceMarkedUncollectibleWebhookEvent | InvoicePaidWebhookEvent | InvoicePastDueWebhookEvent | InvoiceVoidedWebhookEvent | MembershipActivatedWebhookEvent | MembershipDeactivatedWebhookEvent | EntryCreatedWebhookEvent | EntryApprovedWebhookEvent | EntryDeniedWebhookEvent | EntryDeletedWebhookEvent | SetupIntentRequiresActionWebhookEvent | SetupIntentSucceededWebhookEvent | SetupIntentCanceledWebhookEvent | WithdrawalCreatedWebhookEvent | WithdrawalUpdatedWebhookEvent | CourseLessonInteractionCompletedWebhookEvent | PayoutMethodCreatedWebhookEvent | VerificationSucceededWebhookEvent | PayoutAccountStatusUpdatedWebhookEvent | ResolutionCenterCaseCreatedWebhookEvent | ResolutionCenterCaseUpdatedWebhookEvent | ResolutionCenterCaseDecidedWebhookEvent | PaymentCreatedWebhookEvent | PaymentSucceededWebhookEvent | PaymentFailedWebhookEvent | PaymentPendingWebhookEvent | DisputeCreatedWebhookEvent | DisputeUpdatedWebhookEvent | RefundCreatedWebhookEvent | RefundUpdatedWebhookEvent | DisputeAlertCreatedWebhookEvent | MembershipCancelAtPeriodEndChangedWebhookEvent;
3457
+ export type UnwrapWebhookEvent = CourseLessonInteractionCompletedWebhookEvent | DisputeCreatedWebhookEvent | DisputeUpdatedWebhookEvent | DisputeAlertCreatedWebhookEvent | EntryApprovedWebhookEvent | EntryCreatedWebhookEvent | EntryDeletedWebhookEvent | EntryDeniedWebhookEvent | IdentityProfileApprovedWebhookEvent | IdentityProfileNeedsActionWebhookEvent | IdentityProfileRejectedWebhookEvent | IdentityProfileUpdatedWebhookEvent | InvoiceCreatedWebhookEvent | InvoiceMarkedUncollectibleWebhookEvent | InvoicePaidWebhookEvent | InvoicePastDueWebhookEvent | InvoiceVoidedWebhookEvent | MembershipActivatedWebhookEvent | MembershipCancelAtPeriodEndChangedWebhookEvent | MembershipDeactivatedWebhookEvent | PaymentCreatedWebhookEvent | PaymentFailedWebhookEvent | PaymentPendingWebhookEvent | PaymentSucceededWebhookEvent | PayoutAccountStatusUpdatedWebhookEvent | PayoutMethodCreatedWebhookEvent | RefundCreatedWebhookEvent | RefundUpdatedWebhookEvent | ResolutionCenterCaseCreatedWebhookEvent | ResolutionCenterCaseDecidedWebhookEvent | ResolutionCenterCaseUpdatedWebhookEvent | SetupIntentCanceledWebhookEvent | SetupIntentRequiresActionWebhookEvent | SetupIntentSucceededWebhookEvent | VerificationSucceededWebhookEvent | WithdrawalCreatedWebhookEvent | WithdrawalUpdatedWebhookEvent;
3458
+ export interface WebhookListParams extends CursorPageParams {
3459
+ /**
3460
+ * The unique identifier of the company to list webhooks for.
3461
+ */
3462
+ company_id: string;
3463
+ /**
3464
+ * Returns the elements in the list that come before the specified cursor.
3465
+ */
3466
+ before?: string | null;
3467
+ /**
3468
+ * Returns the first _n_ elements from the list.
3469
+ */
3470
+ first?: number | null;
3471
+ /**
3472
+ * Returns the last _n_ elements from the list.
3473
+ */
3474
+ last?: number | null;
3475
+ }
2472
3476
  export interface WebhookCreateParams {
2473
3477
  /**
2474
3478
  * The URL to send the webhook to.
@@ -2519,25 +3523,7 @@ export interface WebhookUpdateParams {
2519
3523
  */
2520
3524
  url?: string | null;
2521
3525
  }
2522
- export interface WebhookListParams extends CursorPageParams {
2523
- /**
2524
- * The unique identifier of the company to list webhooks for.
2525
- */
2526
- company_id: string;
2527
- /**
2528
- * Returns the elements in the list that come before the specified cursor.
2529
- */
2530
- before?: string | null;
2531
- /**
2532
- * Returns the first _n_ elements from the list.
2533
- */
2534
- first?: number | null;
2535
- /**
2536
- * Returns the last _n_ elements from the list.
2537
- */
2538
- last?: number | null;
2539
- }
2540
3526
  export declare namespace Webhooks {
2541
- export { type APIVersion as APIVersion, type Webhook as Webhook, type WebhookEvent as WebhookEvent, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent, type InvoiceMarkedUncollectibleWebhookEvent as InvoiceMarkedUncollectibleWebhookEvent, type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent, type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent, type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent, type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent, type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent, type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent, type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent, type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent, type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent, type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent, type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent, type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent, type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent, type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent, type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent, type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent, type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent, type PayoutAccountStatusUpdatedWebhookEvent as PayoutAccountStatusUpdatedWebhookEvent, type ResolutionCenterCaseCreatedWebhookEvent as ResolutionCenterCaseCreatedWebhookEvent, type ResolutionCenterCaseUpdatedWebhookEvent as ResolutionCenterCaseUpdatedWebhookEvent, type ResolutionCenterCaseDecidedWebhookEvent as ResolutionCenterCaseDecidedWebhookEvent, type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent, type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent, type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent, type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent, type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent, type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent, type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent, type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent, type DisputeAlertCreatedWebhookEvent as DisputeAlertCreatedWebhookEvent, type MembershipCancelAtPeriodEndChangedWebhookEvent as MembershipCancelAtPeriodEndChangedWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, type WebhookListResponsesCursorPage as WebhookListResponsesCursorPage, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, };
3527
+ export { type APIVersion as APIVersion, type Webhook as Webhook, type WebhookEvent as WebhookEvent, type WebhookCreateResponse as WebhookCreateResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent, type DisputeCreatedWebhookEvent as DisputeCreatedWebhookEvent, type DisputeUpdatedWebhookEvent as DisputeUpdatedWebhookEvent, type DisputeAlertCreatedWebhookEvent as DisputeAlertCreatedWebhookEvent, type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent, type EntryCreatedWebhookEvent as EntryCreatedWebhookEvent, type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent, type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent, type IdentityProfileApprovedWebhookEvent as IdentityProfileApprovedWebhookEvent, type IdentityProfileNeedsActionWebhookEvent as IdentityProfileNeedsActionWebhookEvent, type IdentityProfileRejectedWebhookEvent as IdentityProfileRejectedWebhookEvent, type IdentityProfileUpdatedWebhookEvent as IdentityProfileUpdatedWebhookEvent, type InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent, type InvoiceMarkedUncollectibleWebhookEvent as InvoiceMarkedUncollectibleWebhookEvent, type InvoicePaidWebhookEvent as InvoicePaidWebhookEvent, type InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent, type InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent, type MembershipActivatedWebhookEvent as MembershipActivatedWebhookEvent, type MembershipCancelAtPeriodEndChangedWebhookEvent as MembershipCancelAtPeriodEndChangedWebhookEvent, type MembershipDeactivatedWebhookEvent as MembershipDeactivatedWebhookEvent, type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent, type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent, type PaymentPendingWebhookEvent as PaymentPendingWebhookEvent, type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent, type PayoutAccountStatusUpdatedWebhookEvent as PayoutAccountStatusUpdatedWebhookEvent, type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent, type RefundCreatedWebhookEvent as RefundCreatedWebhookEvent, type RefundUpdatedWebhookEvent as RefundUpdatedWebhookEvent, type ResolutionCenterCaseCreatedWebhookEvent as ResolutionCenterCaseCreatedWebhookEvent, type ResolutionCenterCaseDecidedWebhookEvent as ResolutionCenterCaseDecidedWebhookEvent, type ResolutionCenterCaseUpdatedWebhookEvent as ResolutionCenterCaseUpdatedWebhookEvent, type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent, type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent, type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent, type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent, type WithdrawalCreatedWebhookEvent as WithdrawalCreatedWebhookEvent, type WithdrawalUpdatedWebhookEvent as WithdrawalUpdatedWebhookEvent, type UnwrapWebhookEvent as UnwrapWebhookEvent, type WebhookListResponsesCursorPage as WebhookListResponsesCursorPage, type WebhookListParams as WebhookListParams, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, };
2542
3528
  }
2543
3529
  //# sourceMappingURL=webhooks.d.mts.map