@whop/sdk 0.0.27 → 0.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (459) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/client.d.mts +4 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +4 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +7 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +7 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/access-tokens.d.mts +19 -20
  12. package/resources/access-tokens.d.mts.map +1 -1
  13. package/resources/access-tokens.d.ts +19 -20
  14. package/resources/access-tokens.d.ts.map +1 -1
  15. package/resources/access-tokens.js +4 -4
  16. package/resources/access-tokens.mjs +4 -4
  17. package/resources/account-links.d.mts +15 -13
  18. package/resources/account-links.d.mts.map +1 -1
  19. package/resources/account-links.d.ts +15 -13
  20. package/resources/account-links.d.ts.map +1 -1
  21. package/resources/account-links.js +2 -3
  22. package/resources/account-links.js.map +1 -1
  23. package/resources/account-links.mjs +2 -3
  24. package/resources/account-links.mjs.map +1 -1
  25. package/resources/ai-chats.d.mts +38 -26
  26. package/resources/ai-chats.d.mts.map +1 -1
  27. package/resources/ai-chats.d.ts +38 -26
  28. package/resources/ai-chats.d.ts.map +1 -1
  29. package/resources/ai-chats.js +5 -5
  30. package/resources/ai-chats.mjs +5 -5
  31. package/resources/app-builds.d.mts +35 -33
  32. package/resources/app-builds.d.mts.map +1 -1
  33. package/resources/app-builds.d.ts +35 -33
  34. package/resources/app-builds.d.ts.map +1 -1
  35. package/resources/app-builds.js +7 -4
  36. package/resources/app-builds.js.map +1 -1
  37. package/resources/app-builds.mjs +7 -4
  38. package/resources/app-builds.mjs.map +1 -1
  39. package/resources/apps.d.mts +81 -56
  40. package/resources/apps.d.mts.map +1 -1
  41. package/resources/apps.d.ts +81 -56
  42. package/resources/apps.d.ts.map +1 -1
  43. package/resources/apps.js +7 -4
  44. package/resources/apps.js.map +1 -1
  45. package/resources/apps.mjs +7 -4
  46. package/resources/apps.mjs.map +1 -1
  47. package/resources/authorized-users.d.mts +32 -26
  48. package/resources/authorized-users.d.mts.map +1 -1
  49. package/resources/authorized-users.d.ts +32 -26
  50. package/resources/authorized-users.d.ts.map +1 -1
  51. package/resources/authorized-users.js +3 -2
  52. package/resources/authorized-users.js.map +1 -1
  53. package/resources/authorized-users.mjs +3 -2
  54. package/resources/authorized-users.mjs.map +1 -1
  55. package/resources/chat-channels.d.mts +27 -19
  56. package/resources/chat-channels.d.mts.map +1 -1
  57. package/resources/chat-channels.d.ts +27 -19
  58. package/resources/chat-channels.d.ts.map +1 -1
  59. package/resources/chat-channels.js +5 -3
  60. package/resources/chat-channels.js.map +1 -1
  61. package/resources/chat-channels.mjs +5 -3
  62. package/resources/chat-channels.mjs.map +1 -1
  63. package/resources/checkout-configurations.d.mts +55 -46
  64. package/resources/checkout-configurations.d.mts.map +1 -1
  65. package/resources/checkout-configurations.d.ts +55 -46
  66. package/resources/checkout-configurations.d.ts.map +1 -1
  67. package/resources/checkout-configurations.js +3 -2
  68. package/resources/checkout-configurations.js.map +1 -1
  69. package/resources/checkout-configurations.mjs +3 -2
  70. package/resources/checkout-configurations.mjs.map +1 -1
  71. package/resources/companies.d.mts +65 -46
  72. package/resources/companies.d.mts.map +1 -1
  73. package/resources/companies.d.ts +65 -46
  74. package/resources/companies.d.ts.map +1 -1
  75. package/resources/companies.js +7 -8
  76. package/resources/companies.js.map +1 -1
  77. package/resources/companies.mjs +7 -8
  78. package/resources/companies.mjs.map +1 -1
  79. package/resources/company-token-transactions.d.mts +80 -57
  80. package/resources/company-token-transactions.d.mts.map +1 -1
  81. package/resources/company-token-transactions.d.ts +80 -57
  82. package/resources/company-token-transactions.d.ts.map +1 -1
  83. package/resources/company-token-transactions.js +6 -3
  84. package/resources/company-token-transactions.js.map +1 -1
  85. package/resources/company-token-transactions.mjs +6 -3
  86. package/resources/company-token-transactions.mjs.map +1 -1
  87. package/resources/course-chapters.d.mts +24 -19
  88. package/resources/course-chapters.d.mts.map +1 -1
  89. package/resources/course-chapters.d.ts +24 -19
  90. package/resources/course-chapters.d.ts.map +1 -1
  91. package/resources/course-chapters.js +5 -5
  92. package/resources/course-chapters.mjs +5 -5
  93. package/resources/course-lesson-interactions.d.mts +7 -6
  94. package/resources/course-lesson-interactions.d.mts.map +1 -1
  95. package/resources/course-lesson-interactions.d.ts +7 -6
  96. package/resources/course-lesson-interactions.d.ts.map +1 -1
  97. package/resources/course-lesson-interactions.js +3 -2
  98. package/resources/course-lesson-interactions.js.map +1 -1
  99. package/resources/course-lesson-interactions.mjs +3 -2
  100. package/resources/course-lesson-interactions.mjs.map +1 -1
  101. package/resources/course-lessons.d.mts +126 -84
  102. package/resources/course-lessons.d.mts.map +1 -1
  103. package/resources/course-lessons.d.ts +126 -84
  104. package/resources/course-lessons.d.ts.map +1 -1
  105. package/resources/course-lessons.js +12 -8
  106. package/resources/course-lessons.js.map +1 -1
  107. package/resources/course-lessons.mjs +12 -8
  108. package/resources/course-lessons.mjs.map +1 -1
  109. package/resources/course-students.d.mts +38 -29
  110. package/resources/course-students.d.mts.map +1 -1
  111. package/resources/course-students.d.ts +38 -29
  112. package/resources/course-students.d.ts.map +1 -1
  113. package/resources/course-students.js +3 -2
  114. package/resources/course-students.js.map +1 -1
  115. package/resources/course-students.mjs +3 -2
  116. package/resources/course-students.mjs.map +1 -1
  117. package/resources/courses.d.mts +132 -91
  118. package/resources/courses.d.mts.map +1 -1
  119. package/resources/courses.d.ts +132 -91
  120. package/resources/courses.d.ts.map +1 -1
  121. package/resources/courses.js +9 -5
  122. package/resources/courses.js.map +1 -1
  123. package/resources/courses.mjs +9 -5
  124. package/resources/courses.mjs.map +1 -1
  125. package/resources/disputes.d.mts +156 -102
  126. package/resources/disputes.d.mts.map +1 -1
  127. package/resources/disputes.d.ts +156 -102
  128. package/resources/disputes.d.ts.map +1 -1
  129. package/resources/disputes.js +4 -2
  130. package/resources/disputes.js.map +1 -1
  131. package/resources/disputes.mjs +4 -2
  132. package/resources/disputes.mjs.map +1 -1
  133. package/resources/dm-channels.d.mts +29 -16
  134. package/resources/dm-channels.d.mts.map +1 -1
  135. package/resources/dm-channels.d.ts +29 -16
  136. package/resources/dm-channels.d.ts.map +1 -1
  137. package/resources/dm-channels.js +9 -5
  138. package/resources/dm-channels.js.map +1 -1
  139. package/resources/dm-channels.mjs +9 -5
  140. package/resources/dm-channels.mjs.map +1 -1
  141. package/resources/dm-members.d.mts +30 -21
  142. package/resources/dm-members.d.mts.map +1 -1
  143. package/resources/dm-members.d.ts +30 -21
  144. package/resources/dm-members.d.ts.map +1 -1
  145. package/resources/dm-members.js +9 -5
  146. package/resources/dm-members.js.map +1 -1
  147. package/resources/dm-members.mjs +9 -5
  148. package/resources/dm-members.mjs.map +1 -1
  149. package/resources/entries.d.mts +29 -21
  150. package/resources/entries.d.mts.map +1 -1
  151. package/resources/entries.d.ts +29 -21
  152. package/resources/entries.d.ts.map +1 -1
  153. package/resources/entries.js +7 -4
  154. package/resources/entries.js.map +1 -1
  155. package/resources/entries.mjs +7 -4
  156. package/resources/entries.mjs.map +1 -1
  157. package/resources/experiences.d.mts +53 -45
  158. package/resources/experiences.d.mts.map +1 -1
  159. package/resources/experiences.d.ts +53 -45
  160. package/resources/experiences.d.ts.map +1 -1
  161. package/resources/experiences.js +6 -5
  162. package/resources/experiences.js.map +1 -1
  163. package/resources/experiences.mjs +6 -5
  164. package/resources/experiences.mjs.map +1 -1
  165. package/resources/fee-markups.d.mts +32 -21
  166. package/resources/fee-markups.d.mts.map +1 -1
  167. package/resources/fee-markups.d.ts +32 -21
  168. package/resources/fee-markups.d.ts.map +1 -1
  169. package/resources/fee-markups.js +6 -3
  170. package/resources/fee-markups.js.map +1 -1
  171. package/resources/fee-markups.mjs +6 -3
  172. package/resources/fee-markups.mjs.map +1 -1
  173. package/resources/files.d.mts +21 -17
  174. package/resources/files.d.mts.map +1 -1
  175. package/resources/files.d.ts +21 -17
  176. package/resources/files.d.ts.map +1 -1
  177. package/resources/files.js +3 -2
  178. package/resources/files.js.map +1 -1
  179. package/resources/files.mjs +3 -2
  180. package/resources/files.mjs.map +1 -1
  181. package/resources/forum-posts.d.mts +62 -43
  182. package/resources/forum-posts.d.mts.map +1 -1
  183. package/resources/forum-posts.d.ts +62 -43
  184. package/resources/forum-posts.d.ts.map +1 -1
  185. package/resources/forum-posts.js +8 -4
  186. package/resources/forum-posts.js.map +1 -1
  187. package/resources/forum-posts.mjs +8 -4
  188. package/resources/forum-posts.mjs.map +1 -1
  189. package/resources/forums.d.mts +20 -12
  190. package/resources/forums.d.mts.map +1 -1
  191. package/resources/forums.d.ts +20 -12
  192. package/resources/forums.d.ts.map +1 -1
  193. package/resources/forums.js +5 -3
  194. package/resources/forums.js.map +1 -1
  195. package/resources/forums.mjs +5 -3
  196. package/resources/forums.mjs.map +1 -1
  197. package/resources/index.d.mts +2 -2
  198. package/resources/index.d.mts.map +1 -1
  199. package/resources/index.d.ts +2 -2
  200. package/resources/index.d.ts.map +1 -1
  201. package/resources/index.js.map +1 -1
  202. package/resources/index.mjs.map +1 -1
  203. package/resources/invoices.d.mts +108 -80
  204. package/resources/invoices.d.mts.map +1 -1
  205. package/resources/invoices.d.ts +108 -80
  206. package/resources/invoices.d.ts.map +1 -1
  207. package/resources/invoices.js +7 -4
  208. package/resources/invoices.js.map +1 -1
  209. package/resources/invoices.mjs +7 -4
  210. package/resources/invoices.mjs.map +1 -1
  211. package/resources/leads.d.mts +64 -42
  212. package/resources/leads.d.mts.map +1 -1
  213. package/resources/leads.d.ts +64 -42
  214. package/resources/leads.d.ts.map +1 -1
  215. package/resources/leads.js +6 -4
  216. package/resources/leads.js.map +1 -1
  217. package/resources/leads.mjs +6 -4
  218. package/resources/leads.mjs.map +1 -1
  219. package/resources/ledger-accounts.d.mts +10 -8
  220. package/resources/ledger-accounts.d.mts.map +1 -1
  221. package/resources/ledger-accounts.d.ts +10 -8
  222. package/resources/ledger-accounts.d.ts.map +1 -1
  223. package/resources/ledger-accounts.js +1 -1
  224. package/resources/ledger-accounts.mjs +1 -1
  225. package/resources/members.d.mts +18 -19
  226. package/resources/members.d.mts.map +1 -1
  227. package/resources/members.d.ts +18 -19
  228. package/resources/members.d.ts.map +1 -1
  229. package/resources/members.js +3 -2
  230. package/resources/members.js.map +1 -1
  231. package/resources/members.mjs +3 -2
  232. package/resources/members.mjs.map +1 -1
  233. package/resources/memberships.d.mts +69 -51
  234. package/resources/memberships.d.mts.map +1 -1
  235. package/resources/memberships.d.ts +69 -51
  236. package/resources/memberships.d.ts.map +1 -1
  237. package/resources/memberships.js +12 -8
  238. package/resources/memberships.js.map +1 -1
  239. package/resources/memberships.mjs +12 -8
  240. package/resources/memberships.mjs.map +1 -1
  241. package/resources/messages.d.mts +46 -32
  242. package/resources/messages.d.mts.map +1 -1
  243. package/resources/messages.d.ts +46 -32
  244. package/resources/messages.d.ts.map +1 -1
  245. package/resources/messages.js +9 -5
  246. package/resources/messages.js.map +1 -1
  247. package/resources/messages.mjs +9 -5
  248. package/resources/messages.mjs.map +1 -1
  249. package/resources/notifications.d.mts +33 -25
  250. package/resources/notifications.d.mts.map +1 -1
  251. package/resources/notifications.d.ts +33 -25
  252. package/resources/notifications.d.ts.map +1 -1
  253. package/resources/notifications.js +2 -1
  254. package/resources/notifications.js.map +1 -1
  255. package/resources/notifications.mjs +2 -1
  256. package/resources/notifications.mjs.map +1 -1
  257. package/resources/payment-methods.d.mts +212 -114
  258. package/resources/payment-methods.d.mts.map +1 -1
  259. package/resources/payment-methods.d.ts +212 -114
  260. package/resources/payment-methods.d.ts.map +1 -1
  261. package/resources/payment-methods.js +5 -10
  262. package/resources/payment-methods.js.map +1 -1
  263. package/resources/payment-methods.mjs +5 -10
  264. package/resources/payment-methods.mjs.map +1 -1
  265. package/resources/payments.d.mts +73 -40
  266. package/resources/payments.d.mts.map +1 -1
  267. package/resources/payments.d.ts +73 -40
  268. package/resources/payments.d.ts.map +1 -1
  269. package/resources/payments.js +23 -10
  270. package/resources/payments.js.map +1 -1
  271. package/resources/payments.mjs +23 -10
  272. package/resources/payments.mjs.map +1 -1
  273. package/resources/payout-methods.d.mts +44 -29
  274. package/resources/payout-methods.d.mts.map +1 -1
  275. package/resources/payout-methods.d.ts +44 -29
  276. package/resources/payout-methods.d.ts.map +1 -1
  277. package/resources/payout-methods.js +3 -2
  278. package/resources/payout-methods.js.map +1 -1
  279. package/resources/payout-methods.mjs +3 -2
  280. package/resources/payout-methods.mjs.map +1 -1
  281. package/resources/plans.d.mts +121 -90
  282. package/resources/plans.d.mts.map +1 -1
  283. package/resources/plans.d.ts +121 -90
  284. package/resources/plans.d.ts.map +1 -1
  285. package/resources/plans.js +9 -5
  286. package/resources/plans.js.map +1 -1
  287. package/resources/plans.mjs +9 -5
  288. package/resources/plans.mjs.map +1 -1
  289. package/resources/products.d.mts +76 -65
  290. package/resources/products.d.mts.map +1 -1
  291. package/resources/products.d.ts +76 -65
  292. package/resources/products.d.ts.map +1 -1
  293. package/resources/products.js +7 -5
  294. package/resources/products.js.map +1 -1
  295. package/resources/products.mjs +7 -5
  296. package/resources/products.mjs.map +1 -1
  297. package/resources/promo-codes.d.mts +41 -31
  298. package/resources/promo-codes.d.mts.map +1 -1
  299. package/resources/promo-codes.d.ts +41 -31
  300. package/resources/promo-codes.d.ts.map +1 -1
  301. package/resources/promo-codes.js +7 -4
  302. package/resources/promo-codes.js.map +1 -1
  303. package/resources/promo-codes.mjs +7 -4
  304. package/resources/promo-codes.mjs.map +1 -1
  305. package/resources/reactions.d.mts +24 -18
  306. package/resources/reactions.d.mts.map +1 -1
  307. package/resources/reactions.d.ts +24 -18
  308. package/resources/reactions.d.ts.map +1 -1
  309. package/resources/reactions.js +7 -4
  310. package/resources/reactions.js.map +1 -1
  311. package/resources/reactions.mjs +7 -4
  312. package/resources/reactions.mjs.map +1 -1
  313. package/resources/refunds.d.mts +43 -29
  314. package/resources/refunds.d.mts.map +1 -1
  315. package/resources/refunds.d.ts +43 -29
  316. package/resources/refunds.d.ts.map +1 -1
  317. package/resources/refunds.js +3 -2
  318. package/resources/refunds.js.map +1 -1
  319. package/resources/refunds.mjs +3 -2
  320. package/resources/refunds.mjs.map +1 -1
  321. package/resources/reviews.d.mts +66 -50
  322. package/resources/reviews.d.mts.map +1 -1
  323. package/resources/reviews.d.ts +66 -50
  324. package/resources/reviews.d.ts.map +1 -1
  325. package/resources/reviews.js +3 -2
  326. package/resources/reviews.js.map +1 -1
  327. package/resources/reviews.mjs +3 -2
  328. package/resources/reviews.mjs.map +1 -1
  329. package/resources/setup-intents.d.mts +61 -43
  330. package/resources/setup-intents.d.mts.map +1 -1
  331. package/resources/setup-intents.d.ts +61 -43
  332. package/resources/setup-intents.d.ts.map +1 -1
  333. package/resources/setup-intents.js +4 -10
  334. package/resources/setup-intents.js.map +1 -1
  335. package/resources/setup-intents.mjs +4 -10
  336. package/resources/setup-intents.mjs.map +1 -1
  337. package/resources/shared.d.mts +695 -388
  338. package/resources/shared.d.mts.map +1 -1
  339. package/resources/shared.d.ts +695 -388
  340. package/resources/shared.d.ts.map +1 -1
  341. package/resources/shipments.d.mts +26 -17
  342. package/resources/shipments.d.mts.map +1 -1
  343. package/resources/shipments.d.ts +26 -17
  344. package/resources/shipments.d.ts.map +1 -1
  345. package/resources/shipments.js +5 -3
  346. package/resources/shipments.js.map +1 -1
  347. package/resources/shipments.mjs +5 -3
  348. package/resources/shipments.mjs.map +1 -1
  349. package/resources/support-channels.d.mts +27 -19
  350. package/resources/support-channels.d.mts.map +1 -1
  351. package/resources/support-channels.d.ts +27 -19
  352. package/resources/support-channels.d.ts.map +1 -1
  353. package/resources/support-channels.js +5 -4
  354. package/resources/support-channels.js.map +1 -1
  355. package/resources/support-channels.mjs +5 -4
  356. package/resources/support-channels.mjs.map +1 -1
  357. package/resources/topups.d.mts +11 -9
  358. package/resources/topups.d.mts.map +1 -1
  359. package/resources/topups.d.ts +11 -9
  360. package/resources/topups.d.ts.map +1 -1
  361. package/resources/topups.js +2 -1
  362. package/resources/topups.js.map +1 -1
  363. package/resources/topups.mjs +2 -1
  364. package/resources/topups.mjs.map +1 -1
  365. package/resources/transfers.d.mts +35 -29
  366. package/resources/transfers.d.mts.map +1 -1
  367. package/resources/transfers.d.ts +35 -29
  368. package/resources/transfers.d.ts.map +1 -1
  369. package/resources/transfers.js +5 -3
  370. package/resources/transfers.js.map +1 -1
  371. package/resources/transfers.mjs +5 -3
  372. package/resources/transfers.mjs.map +1 -1
  373. package/resources/users.d.mts +20 -16
  374. package/resources/users.d.mts.map +1 -1
  375. package/resources/users.d.ts +20 -16
  376. package/resources/users.d.ts.map +1 -1
  377. package/resources/users.js +4 -3
  378. package/resources/users.js.map +1 -1
  379. package/resources/users.mjs +4 -3
  380. package/resources/users.mjs.map +1 -1
  381. package/resources/verifications.d.mts +6 -4
  382. package/resources/verifications.d.mts.map +1 -1
  383. package/resources/verifications.d.ts +6 -4
  384. package/resources/verifications.d.ts.map +1 -1
  385. package/resources/verifications.js +1 -1
  386. package/resources/verifications.mjs +1 -1
  387. package/resources/webhooks.d.mts +136 -95
  388. package/resources/webhooks.d.mts.map +1 -1
  389. package/resources/webhooks.d.ts +136 -95
  390. package/resources/webhooks.d.ts.map +1 -1
  391. package/resources/webhooks.js +3 -2
  392. package/resources/webhooks.js.map +1 -1
  393. package/resources/webhooks.mjs +3 -2
  394. package/resources/webhooks.mjs.map +1 -1
  395. package/resources/withdrawals.d.mts +53 -44
  396. package/resources/withdrawals.d.mts.map +1 -1
  397. package/resources/withdrawals.d.ts +53 -44
  398. package/resources/withdrawals.d.ts.map +1 -1
  399. package/resources/withdrawals.js +3 -2
  400. package/resources/withdrawals.js.map +1 -1
  401. package/resources/withdrawals.mjs +3 -2
  402. package/resources/withdrawals.mjs.map +1 -1
  403. package/src/client.ts +13 -3
  404. package/src/resources/access-tokens.ts +19 -20
  405. package/src/resources/account-links.ts +15 -13
  406. package/src/resources/ai-chats.ts +39 -26
  407. package/src/resources/app-builds.ts +35 -33
  408. package/src/resources/apps.ts +84 -56
  409. package/src/resources/authorized-users.ts +32 -26
  410. package/src/resources/chat-channels.ts +27 -19
  411. package/src/resources/checkout-configurations.ts +56 -46
  412. package/src/resources/companies.ts +68 -46
  413. package/src/resources/company-token-transactions.ts +81 -58
  414. package/src/resources/course-chapters.ts +24 -19
  415. package/src/resources/course-lesson-interactions.ts +7 -6
  416. package/src/resources/course-lessons.ts +126 -84
  417. package/src/resources/course-students.ts +38 -29
  418. package/src/resources/courses.ts +132 -91
  419. package/src/resources/disputes.ts +156 -102
  420. package/src/resources/dm-channels.ts +29 -16
  421. package/src/resources/dm-members.ts +30 -21
  422. package/src/resources/entries.ts +29 -21
  423. package/src/resources/experiences.ts +53 -45
  424. package/src/resources/fee-markups.ts +32 -21
  425. package/src/resources/files.ts +21 -17
  426. package/src/resources/forum-posts.ts +63 -43
  427. package/src/resources/forums.ts +20 -12
  428. package/src/resources/index.ts +2 -1
  429. package/src/resources/invoices.ts +112 -80
  430. package/src/resources/leads.ts +64 -42
  431. package/src/resources/ledger-accounts.ts +10 -8
  432. package/src/resources/members.ts +18 -19
  433. package/src/resources/memberships.ts +69 -51
  434. package/src/resources/messages.ts +46 -32
  435. package/src/resources/notifications.ts +33 -25
  436. package/src/resources/payment-methods.ts +212 -114
  437. package/src/resources/payments.ts +77 -39
  438. package/src/resources/payout-methods.ts +44 -29
  439. package/src/resources/plans.ts +121 -90
  440. package/src/resources/products.ts +215 -68
  441. package/src/resources/promo-codes.ts +41 -31
  442. package/src/resources/reactions.ts +24 -18
  443. package/src/resources/refunds.ts +44 -29
  444. package/src/resources/reviews.ts +66 -50
  445. package/src/resources/setup-intents.ts +61 -43
  446. package/src/resources/shared.ts +2637 -387
  447. package/src/resources/shipments.ts +26 -17
  448. package/src/resources/support-channels.ts +27 -19
  449. package/src/resources/topups.ts +11 -9
  450. package/src/resources/transfers.ts +35 -29
  451. package/src/resources/users.ts +20 -16
  452. package/src/resources/verifications.ts +6 -4
  453. package/src/resources/webhooks.ts +136 -95
  454. package/src/resources/withdrawals.ts +53 -43
  455. package/src/version.ts +1 -1
  456. package/version.d.mts +1 -1
  457. package/version.d.ts +1 -1
  458. package/version.js +1 -1
  459. package/version.mjs +1 -1
@@ -3,6 +3,7 @@
3
3
  import * as Shared from './shared';
4
4
  import * as AppsAPI from './apps';
5
5
  import * as CheckoutConfigurationsAPI from './checkout-configurations';
6
+ import * as DisputesAPI from './disputes';
6
7
  import * as MembershipsAPI from './memberships';
7
8
  import * as PaymentsAPI from './payments';
8
9
  import { CursorPage } from '../core/pagination';
@@ -29,101 +30,114 @@ export interface App {
29
30
  id: string;
30
31
 
31
32
  /**
32
- * The API key for the app
33
+ * The API key used to authenticate requests on behalf of this app. Null if no API
34
+ * key has been generated. Requires the 'developer:manage_api_key' permission.
33
35
  */
34
36
  api_key: App.APIKey | null;
35
37
 
36
38
  /**
37
- * The type of end-user an app is built for
39
+ * The target audience classification for this app (e.g., 'b2b_app', 'b2c_app',
40
+ * 'company_app', 'component').
38
41
  */
39
42
  app_type: AppsAPI.AppType;
40
43
 
41
44
  /**
42
- * The base url of the app
45
+ * The production base URL where the app is hosted. Null if no base URL is
46
+ * configured.
43
47
  */
44
48
  base_url: string | null;
45
49
 
46
50
  /**
47
- * The company that owns the app
51
+ * The company that owns and publishes this app.
48
52
  */
49
53
  company: App.Company;
50
54
 
51
55
  /**
52
- * The creator of the app
56
+ * The user who created and owns the company that published this app.
53
57
  */
54
58
  creator: App.Creator;
55
59
 
56
60
  /**
57
- * The path part for a specific view of the app. This is the template part of the
58
- * url after the base domain. Eg: /experiences/[experienceId]
61
+ * The URL path template for a specific view of this app, appended to the base
62
+ * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
63
+ * not configured.
59
64
  */
60
65
  dashboard_path: string | null;
61
66
 
62
67
  /**
63
- * The description of the app
68
+ * A written description of what this app does, displayed on the app store listing
69
+ * page. Null if no description has been set.
64
70
  */
65
71
  description: string | null;
66
72
 
67
73
  /**
68
- * The path part for a specific view of the app. This is the template part of the
69
- * url after the base domain. Eg: /experiences/[experienceId]
74
+ * The URL path template for a specific view of this app, appended to the base
75
+ * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
76
+ * not configured.
70
77
  */
71
78
  discover_path: string | null;
72
79
 
73
80
  /**
74
- * The unique part of the proxied domain for this app. Used to generate the base
75
- * url used to display the app inside the whop platform. Refers to the id part in
76
- * the final url: https://{domain_id}.apps.whop.com
81
+ * The unique subdomain identifier for this app's proxied URL on the Whop platform.
82
+ * Forms the URL pattern https://{domain_id}.apps.whop.com.
77
83
  */
78
84
  domain_id: string;
79
85
 
80
86
  /**
81
- * The path part for a specific view of the app. This is the template part of the
82
- * url after the base domain. Eg: /experiences/[experienceId]
87
+ * The URL path template for a specific view of this app, appended to the base
88
+ * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
89
+ * not configured.
83
90
  */
84
91
  experience_path: string | null;
85
92
 
86
93
  /**
87
- * The icon for the app. This icon is shown on discovery, on the product page, on
88
- * checkout, and as a default icon for the experiences.
94
+ * The icon image for this app, displayed on the app store, product pages,
95
+ * checkout, and as the default icon for experiences using this app.
89
96
  */
90
97
  icon: App.Icon | null;
91
98
 
92
99
  /**
93
- * The name of the app
100
+ * The display name of this app shown on the app store and in experience
101
+ * navigation. Maximum 30 characters.
94
102
  */
95
103
  name: string;
96
104
 
97
105
  /**
98
- * The set of permissions that an app requests to be granted when a user installs
99
- * the app.
106
+ * The whitelisted OAuth callback URLs that users are redirected to after
107
+ * authorizing the app.
108
+ */
109
+ redirect_uris: Array<string>;
110
+
111
+ /**
112
+ * The list of permissions this app requests when installed, including both
113
+ * required and optional permissions with justifications.
100
114
  */
101
115
  requested_permissions: Array<App.RequestedPermission>;
102
116
 
103
117
  /**
104
- * A collection of stats for the app.
118
+ * Aggregate usage statistics for this app, including daily, weekly, and monthly
119
+ * active user counts.
105
120
  */
106
121
  stats: App.Stats | null;
107
122
 
108
123
  /**
109
- * If the status is live, the app is visible on Whop discovery. In order to be
110
- * live, you need to set the name, icon, and description. Being unlisted or hidden
111
- * means it's not visible on Whop but you can still install the app via direct
112
- * link. To remove the app from whop discovery, you should set the status to
113
- * unlisted.
124
+ * The current visibility status of this app on the Whop app store. 'live' means
125
+ * publicly discoverable, 'unlisted' means accessible only via direct link, and
126
+ * 'hidden' means not visible anywhere.
114
127
  */
115
128
  status: AppStatuses;
116
129
 
117
130
  /**
118
- * Whether this app has been verified by Whop. Verified apps are endorsed by whop
119
- * and are shown in the 'featured apps' section of the app store.
131
+ * Whether this app has been verified by Whop. Verified apps are endorsed by Whop
132
+ * and displayed in the featured apps section of the app store.
120
133
  */
121
134
  verified: boolean;
122
135
  }
123
136
 
124
137
  export namespace App {
125
138
  /**
126
- * The API key for the app
139
+ * The API key used to authenticate requests on behalf of this app. Null if no API
140
+ * key has been generated. Requires the 'developer:manage_api_key' permission.
127
141
  */
128
142
  export interface APIKey {
129
143
  /**
@@ -143,7 +157,7 @@ export namespace App {
143
157
  }
144
158
 
145
159
  /**
146
- * The company that owns the app
160
+ * The company that owns and publishes this app.
147
161
  */
148
162
  export interface Company {
149
163
  /**
@@ -152,13 +166,13 @@ export namespace App {
152
166
  id: string;
153
167
 
154
168
  /**
155
- * The title of the company.
169
+ * The display name of the company shown to customers.
156
170
  */
157
171
  title: string;
158
172
  }
159
173
 
160
174
  /**
161
- * The creator of the app
175
+ * The user who created and owns the company that published this app.
162
176
  */
163
177
  export interface Creator {
164
178
  /**
@@ -167,24 +181,24 @@ export namespace App {
167
181
  id: string;
168
182
 
169
183
  /**
170
- * The name of the user from their Whop account.
184
+ * The user's display name shown on their public profile.
171
185
  */
172
186
  name: string | null;
173
187
 
174
188
  /**
175
- * The username of the user from their Whop account.
189
+ * The user's unique username shown on their public profile.
176
190
  */
177
191
  username: string;
178
192
  }
179
193
 
180
194
  /**
181
- * The icon for the app. This icon is shown on discovery, on the product page, on
182
- * checkout, and as a default icon for the experiences.
195
+ * The icon image for this app, displayed on the app store, product pages,
196
+ * checkout, and as the default icon for experiences using this app.
183
197
  */
184
198
  export interface Icon {
185
199
  /**
186
- * This is the URL you use to render optimized attachments on the client. This
187
- * should be used for apps.
200
+ * A pre-optimized URL for rendering this attachment on the client. This should be
201
+ * used for displaying attachments in apps.
188
202
  */
189
203
  url: string | null;
190
204
  }
@@ -228,36 +242,39 @@ export namespace App {
228
242
  }
229
243
 
230
244
  /**
231
- * A collection of stats for the app.
245
+ * Aggregate usage statistics for this app, including daily, weekly, and monthly
246
+ * active user counts.
232
247
  */
233
248
  export interface Stats {
234
249
  /**
235
- * This is the number of users that have spent time in this app in the last 24
236
- * hours.
250
+ * The number of unique users who have spent time in this app in the last 24 hours.
251
+ * Returns 0 if no usage data is available.
237
252
  */
238
253
  dau: number;
239
254
 
240
255
  /**
241
- * This is the number of users that have spent time in this app in the last 28
242
- * days.
256
+ * The number of unique users who have spent time in this app in the last 28 days.
257
+ * Returns 0 if no usage data is available.
243
258
  */
244
259
  mau: number;
245
260
 
246
261
  /**
247
- * This how much time, in seconds, users have spent in this app in the last 24
248
- * hours.
262
+ * The total time, in seconds, that all users have spent in this app over the last
263
+ * 24 hours. Returns 0 if no usage data is available.
249
264
  */
250
265
  time_spent_last24_hours: number;
251
266
 
252
267
  /**
253
- * This is the number of users that have spent time in this app in the last 7 days.
268
+ * The number of unique users who have spent time in this app in the last 7 days.
269
+ * Returns 0 if no usage data is available.
254
270
  */
255
271
  wau: number;
256
272
  }
257
273
  }
258
274
 
259
275
  /**
260
- * An App Build object representing a build of an application
276
+ * A versioned build artifact for a Whop React Native App, submitted for review and
277
+ * deployment to a specific platform.
261
278
  */
262
279
  export interface AppBuild {
263
280
  /**
@@ -266,8 +283,8 @@ export interface AppBuild {
266
283
  id: string;
267
284
 
268
285
  /**
269
- * This is generated by the client and used to verify the integrity of the file
270
- * that is submitted. It is a SHA256 hash of the app build file.
286
+ * A SHA-256 hash of the uploaded build file, generated by the client and used to
287
+ * verify file integrity.
271
288
  */
272
289
  checksum: string;
273
290
 
@@ -277,34 +294,33 @@ export interface AppBuild {
277
294
  created_at: string;
278
295
 
279
296
  /**
280
- * The URL to download the app build .zip file.
297
+ * A URL to download the app build as a .zip archive.
281
298
  */
282
299
  file_url: string;
283
300
 
284
301
  /**
285
- * Whether this app build is currently being used in production.
302
+ * Whether this build is the currently active production build for its platform.
286
303
  */
287
304
  is_production: boolean;
288
305
 
289
306
  /**
290
- * The platform of the app build (ios, android, web)
307
+ * The target platform for this build.
291
308
  */
292
309
  platform: AppBuildPlatforms;
293
310
 
294
311
  /**
295
- * The review message for the app build, if any. This is populated when the build
296
- * is rejected and there is a reason specified by the reviewer.
312
+ * Feedback from the reviewer explaining why the build was rejected. Null if the
313
+ * build has not been reviewed or was approved.
297
314
  */
298
315
  review_message: string | null;
299
316
 
300
317
  /**
301
- * The status of the app build (draft, approved, rejected, pending, etc)
318
+ * The current review status of this build.
302
319
  */
303
320
  status: AppBuildStatuses;
304
321
 
305
322
  /**
306
- * The supported app view types for the app build. These are the views that the
307
- * developer has specified that this build supports.
323
+ * The list of view types this build supports, as declared by the developer.
308
324
  */
309
325
  supported_app_view_types: Array<AppViewType>;
310
326
  }
@@ -356,12 +372,19 @@ export type BusinessTypes =
356
372
  | 'events'
357
373
  | 'coaching_and_courses'
358
374
  | 'other'
375
+ | 'services'
376
+ | 'gig_economy'
377
+ | 'marketplace'
378
+ | 'telehealth'
379
+ | 'class_action_settlement'
380
+ | 'physical_product'
359
381
  | 'saas'
360
382
  | 'course'
361
383
  | 'community';
362
384
 
363
385
  /**
364
- * Represents a Chat feed
386
+ * A real-time chat feed attached to an experience, with configurable moderation
387
+ * and posting permissions.
365
388
  */
366
389
  export interface ChatChannel {
367
390
  /**
@@ -370,44 +393,45 @@ export interface ChatChannel {
370
393
  id: string;
371
394
 
372
395
  /**
373
- * Whether or not media is banned in this chat
396
+ * Whether media uploads such as images and videos are blocked in this chat.
374
397
  */
375
398
  ban_media: boolean;
376
399
 
377
400
  /**
378
- * Whether or not URLs are banned in this chat
401
+ * Whether URL links are blocked from being posted in this chat.
379
402
  */
380
403
  ban_urls: boolean;
381
404
 
382
405
  /**
383
- * List of banned words in this chat
406
+ * A list of words that are automatically filtered from messages in this chat.
384
407
  */
385
408
  banned_words: Array<string>;
386
409
 
387
410
  /**
388
- * The experience for this chat
411
+ * The experience this chat feed is attached to.
389
412
  */
390
413
  experience: ChatChannel.Experience;
391
414
 
392
415
  /**
393
- * The number of seconds a user needs to wait before posting again, if any
416
+ * The minimum number of seconds a user must wait between consecutive messages.
417
+ * Null if no cooldown is enforced.
394
418
  */
395
419
  user_posts_cooldown_seconds: number | null;
396
420
 
397
421
  /**
398
- * Who can post on this chat
422
+ * The permission level controlling which users can send messages in this chat.
399
423
  */
400
424
  who_can_post: WhoCanPost;
401
425
 
402
426
  /**
403
- * Who can react on this chat
427
+ * The permission level controlling which users can add reactions in this chat.
404
428
  */
405
429
  who_can_react: WhoCanReact;
406
430
  }
407
431
 
408
432
  export namespace ChatChannel {
409
433
  /**
410
- * The experience for this chat
434
+ * The experience this chat feed is attached to.
411
435
  */
412
436
  export interface Experience {
413
437
  /**
@@ -416,16 +440,17 @@ export namespace ChatChannel {
416
440
  id: string;
417
441
 
418
442
  /**
419
- * The written name of the description.
443
+ * The display name of this experience shown to users in the product navigation.
444
+ * Maximum 255 characters.
420
445
  */
421
446
  name: string;
422
447
  }
423
448
  }
424
449
 
425
450
  /**
426
- * A checkout session is a reusable configuration for a checkout, including the
427
- * plan, affiliate, and custom metadata. Payments and memberships created from a
428
- * checkout session inherit its metadata.
451
+ * A checkout configuration is a reusable configuration for a checkout, including
452
+ * the plan, affiliate, and custom metadata. Payments and memberships created from
453
+ * a checkout session inherit its metadata.
429
454
  */
430
455
  export interface CheckoutConfiguration {
431
456
  /**
@@ -521,12 +546,14 @@ export namespace CheckoutConfiguration {
521
546
  id: string;
522
547
 
523
548
  /**
524
- * The interval in days at which the plan charges (renewal plans).
549
+ * The number of days between each recurring charge. Null for one-time plans. For
550
+ * example, 30 for monthly or 365 for annual billing.
525
551
  */
526
552
  billing_period: number | null;
527
553
 
528
554
  /**
529
- * The respective currency identifier for the plan.
555
+ * The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
556
+ * amounts on the plan are denominated in this currency.
530
557
  */
531
558
  currency: Shared.Currency;
532
559
 
@@ -544,12 +571,14 @@ export namespace CheckoutConfiguration {
544
571
  initial_price: number;
545
572
 
546
573
  /**
547
- * Indicates if the plan is a one time payment or recurring.
574
+ * The billing model for this plan: 'renewal' for recurring subscriptions or
575
+ * 'one_time' for single payments.
548
576
  */
549
577
  plan_type: Shared.PlanType;
550
578
 
551
579
  /**
552
- * This is the release method the business uses to sell this plan.
580
+ * The method used to sell this plan: 'buy_now' for immediate purchase or
581
+ * 'waitlist' for waitlist-based access.
553
582
  */
554
583
  release_method: Shared.ReleaseMethod;
555
584
 
@@ -560,12 +589,15 @@ export namespace CheckoutConfiguration {
560
589
  renewal_price: number;
561
590
 
562
591
  /**
563
- * The number of free trial days added before a renewal plan.
592
+ * The number of free trial days before the first charge on a renewal plan. Null if
593
+ * no trial is configured or the current user has already used a trial for this
594
+ * plan.
564
595
  */
565
596
  trial_period_days: number | null;
566
597
 
567
598
  /**
568
- * Shows or hides the plan from public/business view.
599
+ * Controls whether the plan is visible to customers. When set to 'hidden', the
600
+ * plan is only accessible via direct link.
569
601
  */
570
602
  visibility: Shared.Visibility;
571
603
  }
@@ -597,7 +629,8 @@ export interface Company {
597
629
  created_at: string;
598
630
 
599
631
  /**
600
- * The creator pitch for the company.
632
+ * A promotional pitch written by the company creator, displayed to potential
633
+ * customers on the store page.
601
634
  */
602
635
  description: string | null;
603
636
 
@@ -612,43 +645,47 @@ export interface Company {
612
645
  logo: Company.Logo | null;
613
646
 
614
647
  /**
615
- * The number of members in the company.
648
+ * The total number of users who currently hold active memberships across all of
649
+ * this company's products.
616
650
  */
617
651
  member_count: number;
618
652
 
619
653
  /**
620
- * A key-value store of data for the account, created/updated by the platform that
621
- * made the account.
654
+ * A key-value JSON object of custom metadata for this company, managed by the
655
+ * platform that created the account.
622
656
  */
623
657
  metadata: { [key: string]: unknown } | null;
624
658
 
625
659
  /**
626
- * The user who owns this company
660
+ * The user who owns and has full administrative control over this company.
627
661
  */
628
662
  owner_user: Company.OwnerUser;
629
663
 
630
664
  /**
631
- * The number of reviews that have been published for the company.
665
+ * The total number of published customer reviews across all products for this
666
+ * company.
632
667
  */
633
668
  published_reviews_count: number;
634
669
 
635
670
  /**
636
- * The slug/route of the company on the Whop site.
671
+ * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
637
672
  */
638
673
  route: string;
639
674
 
640
675
  /**
641
- * Whether Whop sends transactional emails to customers on behalf of this company.
676
+ * Whether Whop sends transactional emails (receipts, updates) to customers on
677
+ * behalf of this company.
642
678
  */
643
679
  send_customer_emails: boolean;
644
680
 
645
681
  /**
646
- * The social media accounts of the company
682
+ * The list of social media accounts and external links associated with this
683
+ * company.
647
684
  */
648
685
  social_links: Array<Company.SocialLink>;
649
686
 
650
687
  /**
651
- * The title of the company.
688
+ * The display name of the company shown to customers.
652
689
  */
653
690
  title: string;
654
691
 
@@ -658,7 +695,7 @@ export interface Company {
658
695
  updated_at: string;
659
696
 
660
697
  /**
661
- * If the company is Whop Verified
698
+ * Whether this company has been verified by Whop's trust and safety team.
662
699
  */
663
700
  verified: boolean;
664
701
  }
@@ -669,14 +706,14 @@ export namespace Company {
669
706
  */
670
707
  export interface Logo {
671
708
  /**
672
- * This is the URL you use to render optimized attachments on the client. This
673
- * should be used for apps.
709
+ * A pre-optimized URL for rendering this attachment on the client. This should be
710
+ * used for displaying attachments in apps.
674
711
  */
675
712
  url: string | null;
676
713
  }
677
714
 
678
715
  /**
679
- * The user who owns this company
716
+ * The user who owns and has full administrative control over this company.
680
717
  */
681
718
  export interface OwnerUser {
682
719
  /**
@@ -685,12 +722,12 @@ export namespace Company {
685
722
  id: string;
686
723
 
687
724
  /**
688
- * The name of the user from their Whop account.
725
+ * The user's display name shown on their public profile.
689
726
  */
690
727
  name: string | null;
691
728
 
692
729
  /**
693
- * The username of the user from their Whop account.
730
+ * The user's unique username shown on their public profile.
694
731
  */
695
732
  username: string;
696
733
  }
@@ -705,7 +742,7 @@ export namespace Company {
705
742
  id: string;
706
743
 
707
744
  /**
708
- * The URL
745
+ * The URL of the social media profile or external link.
709
746
  */
710
747
  url: string;
711
748
 
@@ -726,7 +763,8 @@ export namespace Company {
726
763
  }
727
764
 
728
765
  /**
729
- * A lesson interaction tracking user progress in courses
766
+ * A record of a user's progress on a specific lesson, tracking whether they have
767
+ * completed it.
730
768
  */
731
769
  export interface CourseLessonInteraction {
732
770
  /**
@@ -735,12 +773,12 @@ export interface CourseLessonInteraction {
735
773
  id: string;
736
774
 
737
775
  /**
738
- * Whether the lesson has been completed by the user
776
+ * Whether the user has finished this lesson.
739
777
  */
740
778
  completed: boolean;
741
779
 
742
780
  /**
743
- * The course for this lesson interaction
781
+ * The course that contains the tracked lesson.
744
782
  */
745
783
  course: CourseLessonInteraction.Course;
746
784
 
@@ -750,19 +788,19 @@ export interface CourseLessonInteraction {
750
788
  created_at: string;
751
789
 
752
790
  /**
753
- * The lesson this interaction is for
791
+ * The lesson that this progress record belongs to.
754
792
  */
755
793
  lesson: CourseLessonInteraction.Lesson;
756
794
 
757
795
  /**
758
- * The user who interacted with the lesson
796
+ * The user whose progress is being tracked.
759
797
  */
760
798
  user: CourseLessonInteraction.User;
761
799
  }
762
800
 
763
801
  export namespace CourseLessonInteraction {
764
802
  /**
765
- * The course for this lesson interaction
803
+ * The course that contains the tracked lesson.
766
804
  */
767
805
  export interface Course {
768
806
  /**
@@ -771,19 +809,19 @@ export namespace CourseLessonInteraction {
771
809
  id: string;
772
810
 
773
811
  /**
774
- * The experience that the course belongs to
812
+ * The parent experience that this course belongs to.
775
813
  */
776
814
  experience: Course.Experience;
777
815
 
778
816
  /**
779
- * The title of the course
817
+ * The display name of the course shown to students. Null if no title has been set.
780
818
  */
781
819
  title: string | null;
782
820
  }
783
821
 
784
822
  export namespace Course {
785
823
  /**
786
- * The experience that the course belongs to
824
+ * The parent experience that this course belongs to.
787
825
  */
788
826
  export interface Experience {
789
827
  /**
@@ -794,7 +832,7 @@ export namespace CourseLessonInteraction {
794
832
  }
795
833
 
796
834
  /**
797
- * The lesson this interaction is for
835
+ * The lesson that this progress record belongs to.
798
836
  */
799
837
  export interface Lesson {
800
838
  /**
@@ -803,19 +841,19 @@ export namespace CourseLessonInteraction {
803
841
  id: string;
804
842
 
805
843
  /**
806
- * The chapter this lesson belongs to
844
+ * The parent chapter that contains this lesson.
807
845
  */
808
846
  chapter: Lesson.Chapter;
809
847
 
810
848
  /**
811
- * The title of the lesson
849
+ * The display name of the lesson shown to students. Maximum 120 characters.
812
850
  */
813
851
  title: string;
814
852
  }
815
853
 
816
854
  export namespace Lesson {
817
855
  /**
818
- * The chapter this lesson belongs to
856
+ * The parent chapter that contains this lesson.
819
857
  */
820
858
  export interface Chapter {
821
859
  /**
@@ -826,7 +864,7 @@ export namespace CourseLessonInteraction {
826
864
  }
827
865
 
828
866
  /**
829
- * The user who interacted with the lesson
867
+ * The user whose progress is being tracked.
830
868
  */
831
869
  export interface User {
832
870
  /**
@@ -835,19 +873,20 @@ export namespace CourseLessonInteraction {
835
873
  id: string;
836
874
 
837
875
  /**
838
- * The name of the user from their Whop account.
876
+ * The user's display name shown on their public profile.
839
877
  */
840
878
  name: string | null;
841
879
 
842
880
  /**
843
- * The username of the user from their Whop account.
881
+ * The user's unique username shown on their public profile.
844
882
  */
845
883
  username: string;
846
884
  }
847
885
  }
848
886
 
849
887
  /**
850
- * A lesson interaction tracking user progress in courses
888
+ * A record of a user's progress on a specific lesson, tracking whether they have
889
+ * completed it.
851
890
  */
852
891
  export interface CourseLessonInteractionListItem {
853
892
  /**
@@ -856,7 +895,7 @@ export interface CourseLessonInteractionListItem {
856
895
  id: string;
857
896
 
858
897
  /**
859
- * Whether the lesson has been completed by the user
898
+ * Whether the user has finished this lesson.
860
899
  */
861
900
  completed: boolean;
862
901
 
@@ -866,19 +905,19 @@ export interface CourseLessonInteractionListItem {
866
905
  created_at: string;
867
906
 
868
907
  /**
869
- * The lesson this interaction is for
908
+ * The lesson that this progress record belongs to.
870
909
  */
871
910
  lesson: CourseLessonInteractionListItem.Lesson;
872
911
 
873
912
  /**
874
- * The user who interacted with the lesson
913
+ * The user whose progress is being tracked.
875
914
  */
876
915
  user: CourseLessonInteractionListItem.User;
877
916
  }
878
917
 
879
918
  export namespace CourseLessonInteractionListItem {
880
919
  /**
881
- * The lesson this interaction is for
920
+ * The lesson that this progress record belongs to.
882
921
  */
883
922
  export interface Lesson {
884
923
  /**
@@ -887,19 +926,19 @@ export namespace CourseLessonInteractionListItem {
887
926
  id: string;
888
927
 
889
928
  /**
890
- * The chapter this lesson belongs to
929
+ * The parent chapter that contains this lesson.
891
930
  */
892
931
  chapter: Lesson.Chapter;
893
932
 
894
933
  /**
895
- * The title of the lesson
934
+ * The display name of the lesson shown to students. Maximum 120 characters.
896
935
  */
897
936
  title: string;
898
937
  }
899
938
 
900
939
  export namespace Lesson {
901
940
  /**
902
- * The chapter this lesson belongs to
941
+ * The parent chapter that contains this lesson.
903
942
  */
904
943
  export interface Chapter {
905
944
  /**
@@ -910,7 +949,7 @@ export namespace CourseLessonInteractionListItem {
910
949
  }
911
950
 
912
951
  /**
913
- * The user who interacted with the lesson
952
+ * The user whose progress is being tracked.
914
953
  */
915
954
  export interface User {
916
955
  /**
@@ -919,12 +958,12 @@ export namespace CourseLessonInteractionListItem {
919
958
  id: string;
920
959
 
921
960
  /**
922
- * The name of the user from their Whop account.
961
+ * The user's display name shown on their public profile.
923
962
  */
924
963
  name: string | null;
925
964
 
926
965
  /**
927
- * The username of the user from their Whop account.
966
+ * The user's unique username shown on their public profile.
928
967
  */
929
968
  username: string;
930
969
  }
@@ -1068,27 +1107,30 @@ export interface Entry {
1068
1107
  created_at: string | null;
1069
1108
 
1070
1109
  /**
1071
- * Responses collected from the user when submitting their entry.
1110
+ * The list of responses collected from the user when submitting their waitlist
1111
+ * entry.
1072
1112
  */
1073
1113
  custom_field_responses: Array<Entry.CustomFieldResponse> | null;
1074
1114
 
1075
1115
  /**
1076
- * The waitlist plan the entry if for.
1116
+ * The waitlisted plan that this entry is a signup for.
1077
1117
  */
1078
1118
  plan: Entry.Plan | null;
1079
1119
 
1080
1120
  /**
1081
- * The product tied to this entry, if there is one.
1121
+ * The product associated with this entry's waitlisted plan. Null if the plan is
1122
+ * not tied to a product.
1082
1123
  */
1083
1124
  product: Entry.Product | null;
1084
1125
 
1085
1126
  /**
1086
- * The status of the entry.
1127
+ * The current status of the waitlist entry (e.g., drafted, pending, approved,
1128
+ * denied).
1087
1129
  */
1088
1130
  status: EntryStatus;
1089
1131
 
1090
1132
  /**
1091
- * The user who created the entry.
1133
+ * The user who submitted this waitlist entry.
1092
1134
  */
1093
1135
  user: Entry.User;
1094
1136
  }
@@ -1115,7 +1157,7 @@ export namespace Entry {
1115
1157
  }
1116
1158
 
1117
1159
  /**
1118
- * The waitlist plan the entry if for.
1160
+ * The waitlisted plan that this entry is a signup for.
1119
1161
  */
1120
1162
  export interface Plan {
1121
1163
  /**
@@ -1125,7 +1167,8 @@ export namespace Entry {
1125
1167
  }
1126
1168
 
1127
1169
  /**
1128
- * The product tied to this entry, if there is one.
1170
+ * The product associated with this entry's waitlisted plan. Null if the plan is
1171
+ * not tied to a product.
1129
1172
  */
1130
1173
  export interface Product {
1131
1174
  /**
@@ -1134,13 +1177,14 @@ export namespace Entry {
1134
1177
  id: string;
1135
1178
 
1136
1179
  /**
1137
- * The title of the product. Use for Whop 4.0.
1180
+ * The display name of the product shown to customers on the product page and in
1181
+ * search results.
1138
1182
  */
1139
1183
  title: string;
1140
1184
  }
1141
1185
 
1142
1186
  /**
1143
- * The user who created the entry.
1187
+ * The user who submitted this waitlist entry.
1144
1188
  */
1145
1189
  export interface User {
1146
1190
  /**
@@ -1149,17 +1193,18 @@ export namespace Entry {
1149
1193
  id: string;
1150
1194
 
1151
1195
  /**
1152
- * The email of the user
1196
+ * The user's email address. Requires the member:email:read permission to access.
1197
+ * Null if not authorized.
1153
1198
  */
1154
1199
  email: string | null;
1155
1200
 
1156
1201
  /**
1157
- * The name of the user from their Whop account.
1202
+ * The user's display name shown on their public profile.
1158
1203
  */
1159
1204
  name: string | null;
1160
1205
 
1161
1206
  /**
1162
- * The username of the user from their Whop account.
1207
+ * The user's unique username shown on their public profile.
1163
1208
  */
1164
1209
  username: string;
1165
1210
  }
@@ -1172,7 +1217,7 @@ export type EntryStatus = 'drafted' | 'pending' | 'approved' | 'denied' | 'any';
1172
1217
 
1173
1218
  /**
1174
1219
  * An experience is a feature or content module within a product, such as a chat,
1175
- * course, or app.
1220
+ * course, or custom app.
1176
1221
  */
1177
1222
  export interface Experience {
1178
1223
  /**
@@ -1181,7 +1226,7 @@ export interface Experience {
1181
1226
  id: string;
1182
1227
 
1183
1228
  /**
1184
- * The experience interface for this experience.
1229
+ * The app that powers this experience, defining its interface and behavior.
1185
1230
  */
1186
1231
  app: Experience.App;
1187
1232
 
@@ -1196,36 +1241,40 @@ export interface Experience {
1196
1241
  created_at: string;
1197
1242
 
1198
1243
  /**
1199
- * The logo for the experience.
1244
+ * The custom logo image for this experience. Null if no custom logo has been
1245
+ * uploaded.
1200
1246
  */
1201
1247
  image: Experience.Image | null;
1202
1248
 
1203
1249
  /**
1204
- * Whether the experience is visible to the public
1250
+ * Whether this experience is publicly visible to all users, including those
1251
+ * without a membership.
1205
1252
  */
1206
1253
  is_public: boolean;
1207
1254
 
1208
1255
  /**
1209
- * The written name of the description.
1256
+ * The display name of this experience shown to users in the product navigation.
1257
+ * Maximum 255 characters.
1210
1258
  */
1211
1259
  name: string;
1212
1260
 
1213
1261
  /**
1214
- * The order of the experience in the section
1262
+ * The sort position of this experience within its section. Lower values appear
1263
+ * first. Null if no position has been set.
1215
1264
  */
1216
1265
  order: string | null;
1217
1266
 
1218
1267
  /**
1219
- * The products that this experience is attached to. This defines which set of
1220
- * customers have access and can view this experience. If empty, this experience is
1221
- * only visible to authorized users of the company
1268
+ * The list of products this experience is attached to, which determines which
1269
+ * customers have access. Empty if the experience is only visible to authorized
1270
+ * company team members.
1222
1271
  */
1223
1272
  products: Array<Experience.Product>;
1224
1273
  }
1225
1274
 
1226
1275
  export namespace Experience {
1227
1276
  /**
1228
- * The experience interface for this experience.
1277
+ * The app that powers this experience, defining its interface and behavior.
1229
1278
  */
1230
1279
  export interface App {
1231
1280
  /**
@@ -1234,26 +1283,27 @@ export namespace Experience {
1234
1283
  id: string;
1235
1284
 
1236
1285
  /**
1237
- * The icon for the app. This icon is shown on discovery, on the product page, on
1238
- * checkout, and as a default icon for the experiences.
1286
+ * The icon image for this app, displayed on the app store, product pages,
1287
+ * checkout, and as the default icon for experiences using this app.
1239
1288
  */
1240
1289
  icon: App.Icon | null;
1241
1290
 
1242
1291
  /**
1243
- * The name of the app
1292
+ * The display name of this app shown on the app store and in experience
1293
+ * navigation. Maximum 30 characters.
1244
1294
  */
1245
1295
  name: string;
1246
1296
  }
1247
1297
 
1248
1298
  export namespace App {
1249
1299
  /**
1250
- * The icon for the app. This icon is shown on discovery, on the product page, on
1251
- * checkout, and as a default icon for the experiences.
1300
+ * The icon image for this app, displayed on the app store, product pages,
1301
+ * checkout, and as the default icon for experiences using this app.
1252
1302
  */
1253
1303
  export interface Icon {
1254
1304
  /**
1255
- * This is the URL you use to render optimized attachments on the client. This
1256
- * should be used for apps.
1305
+ * A pre-optimized URL for rendering this attachment on the client. This should be
1306
+ * used for displaying attachments in apps.
1257
1307
  */
1258
1308
  url: string | null;
1259
1309
  }
@@ -1269,23 +1319,24 @@ export namespace Experience {
1269
1319
  id: string;
1270
1320
 
1271
1321
  /**
1272
- * The slug/route of the company on the Whop site.
1322
+ * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
1273
1323
  */
1274
1324
  route: string;
1275
1325
 
1276
1326
  /**
1277
- * The title of the company.
1327
+ * The display name of the company shown to customers.
1278
1328
  */
1279
1329
  title: string;
1280
1330
  }
1281
1331
 
1282
1332
  /**
1283
- * The logo for the experience.
1333
+ * The custom logo image for this experience. Null if no custom logo has been
1334
+ * uploaded.
1284
1335
  */
1285
1336
  export interface Image {
1286
1337
  /**
1287
- * This is the URL you use to render optimized attachments on the client. This
1288
- * should be used for apps.
1338
+ * A pre-optimized URL for rendering this attachment on the client. This should be
1339
+ * used for displaying attachments in apps.
1289
1340
  */
1290
1341
  url: string | null;
1291
1342
  }
@@ -1301,19 +1352,22 @@ export namespace Experience {
1301
1352
  id: string;
1302
1353
 
1303
1354
  /**
1304
- * The route of the product.
1355
+ * The URL slug used in the product's public link (e.g., 'my-product' in
1356
+ * whop.com/company/my-product).
1305
1357
  */
1306
1358
  route: string;
1307
1359
 
1308
1360
  /**
1309
- * The title of the product. Use for Whop 4.0.
1361
+ * The display name of the product shown to customers on the product page and in
1362
+ * search results.
1310
1363
  */
1311
1364
  title: string;
1312
1365
  }
1313
1366
  }
1314
1367
 
1315
1368
  /**
1316
- * Represents a forum feed
1369
+ * A discussion forum where members can create posts, comment, and react, belonging
1370
+ * to an experience.
1317
1371
  */
1318
1372
  export interface Forum {
1319
1373
  /**
@@ -1322,29 +1376,32 @@ export interface Forum {
1322
1376
  id: string;
1323
1377
 
1324
1378
  /**
1325
- * The email notification preference for this forum
1379
+ * The email notification setting that controls which posts trigger email alerts.
1380
+ * One of: all_admin_posts, only_weekly_summary, none.
1326
1381
  */
1327
1382
  email_notification_preference: EmailNotificationPreferences;
1328
1383
 
1329
1384
  /**
1330
- * The experience for this forum
1385
+ * The parent experience that this forum belongs to.
1331
1386
  */
1332
1387
  experience: Forum.Experience;
1333
1388
 
1334
1389
  /**
1335
- * Who can comment on this forum
1390
+ * The permission level controlling who can comment on posts. One of: everyone,
1391
+ * admins.
1336
1392
  */
1337
1393
  who_can_comment: WhoCanCommentTypes;
1338
1394
 
1339
1395
  /**
1340
- * Who can post on this forum
1396
+ * The permission level controlling who can create new posts. One of: everyone,
1397
+ * admins.
1341
1398
  */
1342
1399
  who_can_post: WhoCanPostTypes;
1343
1400
  }
1344
1401
 
1345
1402
  export namespace Forum {
1346
1403
  /**
1347
- * The experience for this forum
1404
+ * The parent experience that this forum belongs to.
1348
1405
  */
1349
1406
  export interface Experience {
1350
1407
  /**
@@ -1353,14 +1410,16 @@ export namespace Forum {
1353
1410
  id: string;
1354
1411
 
1355
1412
  /**
1356
- * The written name of the description.
1413
+ * The display name of this experience shown to users in the product navigation.
1414
+ * Maximum 255 characters.
1357
1415
  */
1358
1416
  name: string;
1359
1417
  }
1360
1418
  }
1361
1419
 
1362
1420
  /**
1363
- * Represents a post in forum
1421
+ * A post or comment in a forum feed, supporting rich text, attachments, polls, and
1422
+ * reactions.
1364
1423
  */
1365
1424
  export interface ForumPost {
1366
1425
  /**
@@ -1373,69 +1432,70 @@ export interface ForumPost {
1373
1432
  id: string;
1374
1433
 
1375
1434
  /**
1376
- * The amount of comments on this post
1435
+ * The total number of direct comments on this post.
1377
1436
  */
1378
1437
  comment_count: number;
1379
1438
 
1380
1439
  /**
1381
- * The content of the forum post in Markdown format
1440
+ * The body of the forum post in Markdown format. Null if the post is paywalled and
1441
+ * the current user does not have access.
1382
1442
  */
1383
1443
  content: string | null;
1384
1444
 
1385
1445
  /**
1386
- * The timestamp when the post was created
1446
+ * The time this post was created, as a Unix timestamp.
1387
1447
  */
1388
1448
  created_at: string;
1389
1449
 
1390
1450
  /**
1391
- * Whether the forum post has been edited
1451
+ * Whether this post has been edited after its initial creation.
1392
1452
  */
1393
1453
  is_edited: boolean;
1394
1454
 
1395
1455
  /**
1396
- * Whether this forum post is pinned
1456
+ * Whether this post is pinned to the top of the forum feed.
1397
1457
  */
1398
1458
  is_pinned: boolean;
1399
1459
 
1400
1460
  /**
1401
- * Whether the user that sent the post is an admin of the company
1461
+ * Whether the author of this post is an admin of the company that owns the forum.
1402
1462
  */
1403
1463
  is_poster_admin: boolean;
1404
1464
 
1405
1465
  /**
1406
- * The number of likes this post has received
1466
+ * The total number of like reactions this post has received.
1407
1467
  */
1408
1468
  like_count: number | null;
1409
1469
 
1410
1470
  /**
1411
- * The ID of the parent forum post, if applicable
1471
+ * The unique identifier of the parent post. Null if this is a top-level post.
1412
1472
  */
1413
1473
  parent_id: string | null;
1414
1474
 
1415
1475
  /**
1416
- * The title of the forum post
1476
+ * The headline of the forum post. Null if the post has no title.
1417
1477
  */
1418
1478
  title: string | null;
1419
1479
 
1420
1480
  /**
1421
- * The timestamp when the post was last updated
1481
+ * The time this post was last updated, as a Unix timestamp.
1422
1482
  */
1423
1483
  updated_at: string;
1424
1484
 
1425
1485
  /**
1426
- * The user who created this forum post
1486
+ * The user who authored this forum post.
1427
1487
  */
1428
1488
  user: ForumPost.User;
1429
1489
 
1430
1490
  /**
1431
- * The number of times this message has been viewed
1491
+ * The total number of times this post has been viewed by users.
1432
1492
  */
1433
1493
  view_count: number | null;
1434
1494
  }
1435
1495
 
1436
1496
  export namespace ForumPost {
1437
1497
  /**
1438
- * The user who created this forum post
1498
+ * The user who authored this forum post.
1439
1499
  */
1440
1500
  export interface User {
1441
1501
  /**
@@ -1444,12 +1504,12 @@ export namespace ForumPost {
1444
1504
  id: string;
1445
1505
 
1446
1506
  /**
1447
- * The name of the user from their Whop account.
1507
+ * The user's display name shown on their public profile.
1448
1508
  */
1449
1509
  name: string | null;
1450
1510
 
1451
1511
  /**
1452
- * The username of the user from their Whop account.
1512
+ * The user's unique username shown on their public profile.
1453
1513
  */
1454
1514
  username: string;
1455
1515
  }
@@ -1557,10 +1617,1883 @@ export type IndustryTypes =
1557
1617
  | 'convention'
1558
1618
  | 'concerts'
1559
1619
  | 'meetups'
1560
- | 'parties';
1620
+ | 'parties'
1621
+ | 'forex_trading'
1622
+ | 'stock_trading'
1623
+ | 'options_trading'
1624
+ | 'crypto_trading'
1625
+ | 'futures_trading'
1626
+ | 'day_trading'
1627
+ | 'swing_trading'
1628
+ | 'algorithmic_trading'
1629
+ | 'prop_firm_trading'
1630
+ | 'value_investing'
1631
+ | 'real_estate_investing'
1632
+ | 'alternative_investments'
1633
+ | 'penny_stock_trading'
1634
+ | 'dividend_investing'
1635
+ | 'index_fund_investing'
1636
+ | 'gold_precious_metals'
1637
+ | 'venture_capital_education'
1638
+ | 'private_equity_education'
1639
+ | 'technical_analysis'
1640
+ | 'forex_scalping'
1641
+ | 'ict_smc_trading'
1642
+ | 'personalized_investment_advice'
1643
+ | 'sports_betting_picks'
1644
+ | 'fantasy_sports'
1645
+ | 'horse_racing'
1646
+ | 'poker_coaching'
1647
+ | 'esports_betting'
1648
+ | 'sports_analytics'
1649
+ | 'nfl_betting'
1650
+ | 'nba_betting'
1651
+ | 'mlb_betting'
1652
+ | 'soccer_betting'
1653
+ | 'mma_ufc_betting'
1654
+ | 'bodybuilding_coaching'
1655
+ | 'strength_training'
1656
+ | 'weight_loss_coaching'
1657
+ | 'athletic_performance'
1658
+ | 'yoga_instruction'
1659
+ | 'martial_arts_instruction'
1660
+ | 'running_coaching'
1661
+ | 'calisthenics'
1662
+ | 'flexibility_mobility'
1663
+ | 'nutrition_coaching'
1664
+ | 'swimming_coaching'
1665
+ | 'cycling_coaching'
1666
+ | 'boxing_coaching'
1667
+ | 'mma_coaching'
1668
+ | 'jiu_jitsu_coaching'
1669
+ | 'wrestling_coaching'
1670
+ | 'gymnastics_coaching'
1671
+ | 'pilates_instruction'
1672
+ | 'sports_nutrition'
1673
+ | 'body_recomposition'
1674
+ | 'golf_coaching'
1675
+ | 'tennis_coaching'
1676
+ | 'basketball_training'
1677
+ | 'soccer_training'
1678
+ | 'mental_health_coaching'
1679
+ | 'life_coaching'
1680
+ | 'biohacking'
1681
+ | 'holistic_health'
1682
+ | 'addiction_recovery_coaching'
1683
+ | 'breathwork'
1684
+ | 'meditation_mindfulness'
1685
+ | 'gut_health_coaching'
1686
+ | 'longevity_coaching'
1687
+ | 'womens_health_coaching'
1688
+ | 'mens_health_coaching'
1689
+ | 'fertility_wellness'
1690
+ | 'stress_management'
1691
+ | 'grief_coaching'
1692
+ | 'trauma_recovery_coaching'
1693
+ | 'adhd_coaching'
1694
+ | 'biomarker_health_coaching'
1695
+ | 'fitness_newsletter'
1696
+ | 'mental_health_newsletter'
1697
+ | 'longevity_newsletter'
1698
+ | 'medical_newsletter'
1699
+ | 'biohacking_newsletter'
1700
+ | 'womens_health_newsletter'
1701
+ | 'mens_health_newsletter'
1702
+ | 'pharma_biotech_newsletter'
1703
+ | 'ecommerce_education'
1704
+ | 'amazon_fba_coaching'
1705
+ | 'dropshipping_coaching'
1706
+ | 'print_on_demand_coaching'
1707
+ | 'retail_arbitrage'
1708
+ | 'wholesale_coaching'
1709
+ | 'startup_coaching'
1710
+ | 'business_strategy'
1711
+ | 'agency_building'
1712
+ | 'smma_coaching'
1713
+ | 'consulting_business'
1714
+ | 'saas_entrepreneurship'
1715
+ | 'local_business_coaching'
1716
+ | 'cleaning_business_coaching'
1717
+ | 'trucking_business_coaching'
1718
+ | 'vending_machine_business'
1719
+ | 'atm_business_coaching'
1720
+ | 'car_wash_business'
1721
+ | 'airbnb_business_coaching'
1722
+ | 'private_label_coaching'
1723
+ | 'etsy_coaching'
1724
+ | 'merch_business_coaching'
1725
+ | 'licensing_business'
1726
+ | 'business_acquisition'
1727
+ | 'women_entrepreneurship'
1728
+ | 'affiliate_marketing_education'
1729
+ | 'coaching_business_coaching'
1730
+ | 'dark_pattern_subscriptions'
1731
+ | 'income_guarantee_scheme'
1732
+ | 'lifetime_access_offers'
1733
+ | 'mlm_pyramid_scheme'
1734
+ | 'negative_option_billing'
1735
+ | 'startup_newsletter'
1736
+ | 'ecommerce_newsletter'
1737
+ | 'marketing_newsletter'
1738
+ | 'sales_newsletter'
1739
+ | 'small_business_newsletter'
1740
+ | 'leadership_newsletter'
1741
+ | 'agency_newsletter'
1742
+ | 'saas_newsletter'
1743
+ | 'hr_people_newsletter'
1744
+ | 'legal_business_newsletter'
1745
+ | 'real_estate_business_newsletter'
1746
+ | 'solopreneur_newsletter'
1747
+ | 'high_ticket_sales'
1748
+ | 'b2b_sales_coaching'
1749
+ | 'door_to_door_sales'
1750
+ | 'sales_funnel_coaching'
1751
+ | 'appointment_setting_coaching'
1752
+ | 'insurance_sales_coaching'
1753
+ | 'car_sales_coaching'
1754
+ | 'retail_sales_coaching'
1755
+ | 'solar_sales_coaching'
1756
+ | 'facebook_ads'
1757
+ | 'google_ads'
1758
+ | 'tiktok_marketing'
1759
+ | 'youtube_marketing'
1760
+ | 'instagram_growth'
1761
+ | 'seo_coaching'
1762
+ | 'email_marketing_coaching'
1763
+ | 'copywriting_coaching'
1764
+ | 'affiliate_marketing'
1765
+ | 'local_seo'
1766
+ | 'ai_marketing'
1767
+ | 'webinar_marketing'
1768
+ | 'event_marketing'
1769
+ | 'saas_marketing_coaching'
1770
+ | 'video_editing_education'
1771
+ | 'photography_coaching'
1772
+ | 'music_production'
1773
+ | 'ui_ux_design_education'
1774
+ | 'clipping_education'
1775
+ | 'ugc_creation'
1776
+ | '3d_modeling_education'
1777
+ | 'dj_education'
1778
+ | 'youtube_automation'
1779
+ | 'blog_monetization'
1780
+ | 'wedding_photography_education'
1781
+ | 'calligraphy_lettering'
1782
+ | 'illustration_education'
1783
+ | 'fashion_design_education'
1784
+ | 'interior_design_education'
1785
+ | 'influencer_education'
1786
+ | 'ai_content_creator_education'
1787
+ | 'web_development_education'
1788
+ | 'ai_ml_education'
1789
+ | 'data_science_education'
1790
+ | 'cybersecurity_education'
1791
+ | 'cloud_computing_education'
1792
+ | 'blockchain_education'
1793
+ | 'no_code_education'
1794
+ | 'automation_education'
1795
+ | 'game_development_education'
1796
+ | 'prompt_engineering'
1797
+ | 'python_programming'
1798
+ | 'javascript_programming'
1799
+ | 'react_development'
1800
+ | 'database_engineering'
1801
+ | 'aws_certification'
1802
+ | 'data_engineering'
1803
+ | 'robotics_education'
1804
+ | 'vr_ar_development'
1805
+ | 'linux_sysadmin'
1806
+ | 'wordpress_development'
1807
+ | 'ai_agent_building'
1808
+ | 'real_estate_wholesaling'
1809
+ | 'house_flipping'
1810
+ | 'property_development'
1811
+ | 'rental_property'
1812
+ | 'airbnb_str'
1813
+ | 'commercial_real_estate'
1814
+ | 'land_investing'
1815
+ | 'section_8_housing'
1816
+ | 'mobile_home_investing'
1817
+ | 'multifamily_investing'
1818
+ | 'self_storage_investing'
1819
+ | 'property_management_education'
1820
+ | 'vacation_rental_management'
1821
+ | 'credit_repair_education'
1822
+ | 'budgeting_coaching'
1823
+ | 'tax_strategy_education'
1824
+ | 'wealth_building'
1825
+ | 'student_loan_strategy'
1826
+ | 'credit_card_optimization'
1827
+ | 'career_coaching'
1828
+ | 'executive_coaching'
1829
+ | 'management_coaching'
1830
+ | 'tech_career_coaching'
1831
+ | 'medical_career_coaching'
1832
+ | 'trade_skills_education'
1833
+ | 'va_training'
1834
+ | 'bookkeeping_education'
1835
+ | 'data_career_coaching'
1836
+ | 'cybersecurity_career'
1837
+ | 'consulting_career'
1838
+ | 'investment_banking_career'
1839
+ | 'law_career_coaching'
1840
+ | 'nursing_career_coaching'
1841
+ | 'teaching_career_coaching'
1842
+ | 'personal_branding_career'
1843
+ | 'mens_dating_coaching'
1844
+ | 'womens_dating_coaching'
1845
+ | 'relationship_coaching'
1846
+ | 'marriage_coaching'
1847
+ | 'communication_coaching'
1848
+ | 'masculinity_coaching'
1849
+ | 'femininity_coaching'
1850
+ | 'breakup_recovery'
1851
+ | 'manifestation_coaching'
1852
+ | 'astrology_coaching'
1853
+ | 'energy_healing'
1854
+ | 'spiritual_coaching'
1855
+ | 'faith_based_coaching'
1856
+ | 'psychic_development'
1857
+ | 'numerology_coaching'
1858
+ | 'chakra_healing'
1859
+ | 'shamanic_healing'
1860
+ | 'biblical_coaching'
1861
+ | 'islamic_coaching'
1862
+ | 'productivity_coaching'
1863
+ | 'public_speaking_coaching'
1864
+ | 'mindset_coaching'
1865
+ | 'stoicism_philosophy'
1866
+ | 'mens_self_improvement'
1867
+ | 'womens_self_improvement'
1868
+ | 'leadership_development'
1869
+ | 'anger_management'
1870
+ | 'neurolinguistic_programming'
1871
+ | 'kindle_publishing'
1872
+ | 'amazon_kdp'
1873
+ | 'self_publishing'
1874
+ | 'audiobook_publishing'
1875
+ | 'course_creation'
1876
+ | 'digital_product_creation'
1877
+ | 'ghostwriting_business'
1878
+ | 'template_creation'
1879
+ | 'ai_book_publishing'
1880
+ | 'language_learning'
1881
+ | 'tutoring'
1882
+ | 'college_admissions_coaching'
1883
+ | 'cpa_exam_prep'
1884
+ | 'bar_exam_prep'
1885
+ | 'real_estate_exam_prep'
1886
+ | 'medical_board_prep'
1887
+ | 'pmp_certification_prep'
1888
+ | 'aws_certification_prep'
1889
+ | 'comptia_certification'
1890
+ | 'ap_exam_prep'
1891
+ | 'graduate_school_prep'
1892
+ | 'scholarship_coaching'
1893
+ | 'homeschool_education'
1894
+ | 'stem_education'
1895
+ | 'financial_certification'
1896
+ | 'coding_bootcamp_prep'
1897
+ | 'cooking_culinary'
1898
+ | 'travel_coaching'
1899
+ | 'parenting_coaching'
1900
+ | 'pet_training'
1901
+ | 'gardening_education'
1902
+ | 'diy_crafts'
1903
+ | 'survival_prepping'
1904
+ | 'baking_pastry'
1905
+ | 'wine_sommelier'
1906
+ | 'beer_brewing'
1907
+ | 'mixology_bartending'
1908
+ | 'woodworking'
1909
+ | 'pottery_ceramics'
1910
+ | 'knitting_crocheting'
1911
+ | 'jewelry_making'
1912
+ | 'aquarium_fishkeeping'
1913
+ | 'bird_watching'
1914
+ | 'astronomy_education'
1915
+ | 'magic_illusion'
1916
+ | 'car_restoration'
1917
+ | 'motorcycle_riding'
1918
+ | 'sailing_boating'
1919
+ | 'scuba_diving'
1920
+ | 'rock_climbing'
1921
+ | 'skiing_snowboarding'
1922
+ | 'surfing_education'
1923
+ | 'homesteading'
1924
+ | 'tiny_house_living'
1925
+ | 'van_life'
1926
+ | 'fashion_styling'
1927
+ | 'floral_design'
1928
+ | 'travel_planning_service'
1929
+ | 'esports_coaching'
1930
+ | 'game_specific_coaching'
1931
+ | 'legal_education'
1932
+ | 'music_theory'
1933
+ | 'music_business'
1934
+ | 'acting_coaching'
1935
+ | 'dance_instruction'
1936
+ | 'voice_acting'
1937
+ | 'english_coaching'
1938
+ | 'spanish_coaching'
1939
+ | 'mandarin_coaching'
1940
+ | 'french_coaching'
1941
+ | 'german_coaching'
1942
+ | 'japanese_coaching'
1943
+ | 'korean_coaching'
1944
+ | 'arabic_coaching'
1945
+ | 'sign_language_education'
1946
+ | 'accent_reduction'
1947
+ | 'business_english'
1948
+ | 'smma'
1949
+ | 'performance_marketing_agency'
1950
+ | 'seo_agency'
1951
+ | 'content_marketing_agency'
1952
+ | 'email_marketing_agency'
1953
+ | 'influencer_marketing_agency'
1954
+ | 'pr_agency'
1955
+ | 'branding_agency'
1956
+ | 'video_marketing_agency'
1957
+ | 'amazon_marketing_agency'
1958
+ | 'podcast_production_agency'
1959
+ | 'tiktok_agency'
1960
+ | 'linkedin_agency'
1961
+ | 'local_marketing_agency'
1962
+ | 'dental_marketing_agency'
1963
+ | 'real_estate_marketing_agency'
1964
+ | 'restaurant_marketing_agency'
1965
+ | 'ecommerce_marketing_agency'
1966
+ | 'b2b_marketing_agency'
1967
+ | 'growth_marketing_agency'
1968
+ | 'affiliate_management_agency'
1969
+ | 'conversion_optimization_agency'
1970
+ | 'event_marketing_agency'
1971
+ | 'click_farm_service'
1972
+ | 'data_scraping_service'
1973
+ | 'lead_list_sales'
1974
+ | 'social_media_bot_farm'
1975
+ | 'lead_generation_agency'
1976
+ | 'cold_email_agency'
1977
+ | 'cold_calling_agency'
1978
+ | 'sales_outsourcing'
1979
+ | 'crm_implementation'
1980
+ | 'appointment_setting_agency'
1981
+ | 'sales_training_agency'
1982
+ | 'revenue_operations_agency'
1983
+ | 'inbound_teleservices'
1984
+ | 'outbound_telemarketing'
1985
+ | 'ai_chatbot_agency'
1986
+ | 'ai_automation_agency'
1987
+ | 'ai_consulting'
1988
+ | 'workflow_automation_agency'
1989
+ | 'data_analytics_agency'
1990
+ | 'ai_voice_agent_agency'
1991
+ | 'ai_content_agency'
1992
+ | 'machine_learning_agency'
1993
+ | 'computer_vision_agency'
1994
+ | 'web_design_agency'
1995
+ | 'graphic_design_agency'
1996
+ | 'ui_ux_agency'
1997
+ | 'motion_design_agency'
1998
+ | 'product_design_agency'
1999
+ | 'logo_design_agency'
2000
+ | 'presentation_design_agency'
2001
+ | '3d_visualization_agency'
2002
+ | 'fashion_design_agency'
2003
+ | 'web_development_agency'
2004
+ | 'mobile_app_agency'
2005
+ | 'saas_development_agency'
2006
+ | 'ecommerce_development'
2007
+ | 'blockchain_development_agency'
2008
+ | 'game_development_agency'
2009
+ | 'devops_agency'
2010
+ | 'ai_development_agency'
2011
+ | 'wordpress_agency'
2012
+ | 'shopify_agency'
2013
+ | 'api_integration_agency'
2014
+ | 'cybersecurity_agency'
2015
+ | 'data_engineering_agency'
2016
+ | 'vr_ar_development_agency'
2017
+ | 'hacking_tools_malware'
2018
+ | 'stalkerware_monitoring'
2019
+ | 'tech_recruiting_agency'
2020
+ | 'executive_recruiting'
2021
+ | 'staffing_agency'
2022
+ | 'remote_staffing'
2023
+ | 'healthcare_recruiting'
2024
+ | 'va_placement_agency'
2025
+ | 'sales_recruiting'
2026
+ | 'creative_recruiting'
2027
+ | 'finance_recruiting'
2028
+ | 'legal_recruiting'
2029
+ | 'construction_staffing'
2030
+ | 'hospitality_staffing'
2031
+ | 'customer_support_outsourcing'
2032
+ | 'live_chat_agency'
2033
+ | 'technical_support_agency'
2034
+ | 'call_center_agency'
2035
+ | 'multilingual_support_agency'
2036
+ | 'community_management_agency'
2037
+ | 'video_clipping_agency'
2038
+ | 'ugc_agency'
2039
+ | 'content_writing_agency'
2040
+ | 'translation_agency'
2041
+ | 'social_media_management'
2042
+ | 'ghostwriting_agency'
2043
+ | 'podcast_editing_agency'
2044
+ | 'thumbnail_design_agency'
2045
+ | 'scriptwriting_agency'
2046
+ | 'seo_content_agency'
2047
+ | 'technical_writing_agency'
2048
+ | 'management_consulting'
2049
+ | 'financial_consulting'
2050
+ | 'hr_consulting'
2051
+ | 'operations_consulting'
2052
+ | 'it_consulting'
2053
+ | 'sustainability_consulting'
2054
+ | 'legal_consulting'
2055
+ | 'compliance_consulting'
2056
+ | 'supply_chain_consulting'
2057
+ | 'change_management_consulting'
2058
+ | 'digital_transformation_consulting'
2059
+ | 'healthcare_consulting'
2060
+ | 'real_estate_consulting'
2061
+ | 'franchise_consulting'
2062
+ | 'export_trade_consulting'
2063
+ | 'nonprofit_consulting'
2064
+ | 'education_consulting'
2065
+ | 'cannabis_consulting'
2066
+ | 'restaurant_consulting'
2067
+ | 'm_and_a_consulting'
2068
+ | 'pricing_strategy_consulting'
2069
+ | 'brand_strategy_consulting'
2070
+ | 'saas_marketing_consulting'
2071
+ | 'done_for_you_services'
2072
+ | 'prop_firm_passing_service'
2073
+ | 'trading_account_management'
2074
+ | 'done_for_you_trading'
2075
+ | 'accounting_bookkeeping'
2076
+ | 'tax_preparation'
2077
+ | 'legal_services'
2078
+ | 'notary_services'
2079
+ | 'insurance_brokerage'
2080
+ | 'financial_planning_service'
2081
+ | 'real_estate_services'
2082
+ | 'property_management'
2083
+ | 'mortgage_brokerage'
2084
+ | 'immigration_services'
2085
+ | 'patent_trademark_services'
2086
+ | 'business_formation_services'
2087
+ | 'shell_company_formation'
2088
+ | 'payroll_services'
2089
+ | 'audit_services'
2090
+ | 'forensic_accounting'
2091
+ | 'actuarial_services'
2092
+ | 'appraisal_services'
2093
+ | 'mediation_arbitration'
2094
+ | 'background_check_services'
2095
+ | 'bail_bond_services'
2096
+ | 'bnpl_service'
2097
+ | 'check_cashing_service'
2098
+ | 'cloud_mining_schemes'
2099
+ | 'consumer_lending'
2100
+ | 'credit_repair_service'
2101
+ | 'crowdfunding_platform'
2102
+ | 'crypto_exchange_brokerage'
2103
+ | 'debt_collection_agency'
2104
+ | 'debt_relief_settlement'
2105
+ | 'document_falsification'
2106
+ | 'escrow_service'
2107
+ | 'essay_mill_paper_mill'
2108
+ | 'fake_id_services'
2109
+ | 'fake_reference_services'
2110
+ | 'foreign_exchange_service'
2111
+ | 'government_service_facilitation'
2112
+ | 'immigration_services_unlicensed'
2113
+ | 'licensed_legal_services'
2114
+ | 'payment_facilitation'
2115
+ | 'personalized_tax_services'
2116
+ | 'prediction_market_exchange'
2117
+ | 'private_investigation'
2118
+ | 'repossession_services'
2119
+ | 'stablecoin_issuance'
2120
+ | 'standalone_tipping'
2121
+ | 'token_sales_ico'
2122
+ | 'tokenized_rwa'
2123
+ | 'unlicensed_legal_services'
2124
+ | 'yield_staking_products'
2125
+ | 'photography_service'
2126
+ | 'videography_service'
2127
+ | 'music_production_service'
2128
+ | 'voice_over_service'
2129
+ | 'event_photography'
2130
+ | 'drone_services'
2131
+ | 'commercial_photography'
2132
+ | 'portrait_photography_service'
2133
+ | 'real_estate_photography'
2134
+ | 'food_photography_service'
2135
+ | 'live_event_production'
2136
+ | 'podcast_production_service'
2137
+ | 'record_label'
2138
+ | 'book_publishing_house'
2139
+ | 'news_media_outlet'
2140
+ | 'radio_broadcasting'
2141
+ | 'tv_production_company'
2142
+ | 'film_studio'
2143
+ | 'magazine_publisher'
2144
+ | 'music_licensing_agency'
2145
+ | 'talent_management_agency'
2146
+ | 'advertising_network'
2147
+ | 'ad_tech_platform'
2148
+ | 'cleaning_service'
2149
+ | 'landscaping_service'
2150
+ | 'plumbing_service'
2151
+ | 'electrical_service'
2152
+ | 'hvac_service'
2153
+ | 'roofing_service'
2154
+ | 'painting_service'
2155
+ | 'moving_service'
2156
+ | 'handyman_service'
2157
+ | 'pest_control'
2158
+ | 'pool_service'
2159
+ | 'solar_installation'
2160
+ | 'home_renovation'
2161
+ | 'pressure_washing'
2162
+ | 'junk_removal'
2163
+ | 'garage_door_service'
2164
+ | 'fencing_service'
2165
+ | 'concrete_masonry'
2166
+ | 'tree_service'
2167
+ | 'window_cleaning'
2168
+ | 'gutter_service'
2169
+ | 'flooring_service'
2170
+ | 'cabinet_countertop'
2171
+ | 'home_inspection'
2172
+ | 'septic_service'
2173
+ | 'waterproofing_service'
2174
+ | 'insulation_service'
2175
+ | 'chimney_service'
2176
+ | 'locksmith_service'
2177
+ | 'glass_window_service'
2178
+ | 'epoxy_coating'
2179
+ | 'private_security_guard_service'
2180
+ | 'armored_car_transport'
2181
+ | 'executive_protection_bodyguard'
2182
+ | 'event_security_service'
2183
+ | 'alarm_system_installation'
2184
+ | 'cctv_installation'
2185
+ | 'private_investigation_agency'
2186
+ | 'background_check_provider'
2187
+ | 'locksmith_commercial'
2188
+ | 'bounty_hunter_bail_enforcement'
2189
+ | 'personal_styling'
2190
+ | 'personal_chef'
2191
+ | 'personal_assistant_service'
2192
+ | 'tutoring_service'
2193
+ | 'pet_services'
2194
+ | 'wedding_planning'
2195
+ | 'concierge_service'
2196
+ | 'personal_training_service'
2197
+ | 'nanny_service'
2198
+ | 'elder_care_service'
2199
+ | 'errand_service'
2200
+ | 'life_organization'
2201
+ | 'relocation_service'
2202
+ | 'adult_dating_services'
2203
+ | 'escort_services'
2204
+ | 'hotel_accommodation_bookings'
2205
+ | 'mail_order_spouse'
2206
+ | 'psychic_fortune_telling'
2207
+ | 'timeshare_sales'
2208
+ | 'freight_brokerage'
2209
+ | 'courier_service'
2210
+ | 'warehousing_service'
2211
+ | 'last_mile_delivery'
2212
+ | 'auto_transport'
2213
+ | 'international_shipping'
2214
+ | 'cold_chain_logistics'
2215
+ | 'commercial_airline_tickets'
2216
+ | 'cruise_line_bookings'
2217
+ | 'contract_manufacturing'
2218
+ | 'cnc_machining_service'
2219
+ | '3d_printing_service_commercial'
2220
+ | 'plastic_injection_molding'
2221
+ | 'metal_fabrication'
2222
+ | 'pcba_assembly'
2223
+ | 'chemical_manufacturing'
2224
+ | 'textile_manufacturing'
2225
+ | 'food_processing_facility'
2226
+ | 'packaging_manufacturing'
2227
+ | 'industrial_automation_integrator'
2228
+ | 'mining_and_extraction'
2229
+ | 'oil_and_gas_services'
2230
+ | 'renewable_energy_generation'
2231
+ | 'waste_management_recycling'
2232
+ | 'hazardous_waste_disposal'
2233
+ | 'aerospace_defense_contracting'
2234
+ | 'personal_training_studio'
2235
+ | 'nutrition_consulting'
2236
+ | 'mental_health_counseling'
2237
+ | 'physical_therapy_service'
2238
+ | 'occupational_therapy_service'
2239
+ | 'speech_therapy_service'
2240
+ | 'chiropractic_service'
2241
+ | 'acupuncture_service'
2242
+ | 'massage_therapy_service'
2243
+ | 'midwifery_doula'
2244
+ | 'lactation_consulting'
2245
+ | 'dietitian_service'
2246
+ | 'addiction_recovery_services'
2247
+ | 'dtc_lab_testing'
2248
+ | 'iv_therapy_infusion'
2249
+ | 'medspa_aesthetic_services'
2250
+ | 'prescription_delivery_services'
2251
+ | 'registered_dietitian_services'
2252
+ | 'unlicensed_therapy_counseling'
2253
+ | 'streetwear'
2254
+ | 'athleisure'
2255
+ | 'luxury_fashion'
2256
+ | 'kids_clothing'
2257
+ | 'custom_apparel'
2258
+ | 'workwear'
2259
+ | 'swimwear'
2260
+ | 'lingerie_intimates'
2261
+ | 'vintage_clothing'
2262
+ | 'plus_size_fashion'
2263
+ | 'maternity_clothing'
2264
+ | 'sleepwear_loungewear'
2265
+ | 'denim_brand'
2266
+ | 'outerwear_jackets'
2267
+ | 'socks_hosiery'
2268
+ | 'costumes_cosplay'
2269
+ | 'scrubs_medical_apparel'
2270
+ | 'dance_performance_wear'
2271
+ | 'hunting_camo_apparel'
2272
+ | 'protein_supplements'
2273
+ | 'vitamins_minerals'
2274
+ | 'pre_workout'
2275
+ | 'nootropics'
2276
+ | 'herbal_supplements'
2277
+ | 'weight_management_supplements'
2278
+ | 'gut_health'
2279
+ | 'cbd_products'
2280
+ | 'mushroom_supplements'
2281
+ | 'collagen_supplements'
2282
+ | 'testosterone_boosters'
2283
+ | 'sleep_supplements'
2284
+ | 'immune_support'
2285
+ | 'joint_bone_health'
2286
+ | 'greens_powder'
2287
+ | 'creatine_supplements'
2288
+ | 'electrolyte_hydration'
2289
+ | 'prenatal_supplements'
2290
+ | 'kids_supplements'
2291
+ | 'pet_supplements'
2292
+ | 'ayurvedic_supplements'
2293
+ | 'keto_supplements'
2294
+ | 'cannabis_thc_products'
2295
+ | 'cbd_hemp_products_compliant'
2296
+ | 'delta8_thc_products'
2297
+ | 'dietary_supplements'
2298
+ | 'drug_precursor_chemicals'
2299
+ | 'illegal_drugs'
2300
+ | 'kratom_kava_products'
2301
+ | 'medical_treatment_claims_product'
2302
+ | 'nutraceutical_products'
2303
+ | 'otc_medication_sales'
2304
+ | 'performance_enhancing_drugs'
2305
+ | 'research_chemicals_dangerous'
2306
+ | 'research_peptides'
2307
+ | 'sexual_enhancement_products'
2308
+ | 'tobacco_products'
2309
+ | 'unlicensed_rx_sales'
2310
+ | 'skincare'
2311
+ | 'haircare'
2312
+ | 'cosmetics_makeup'
2313
+ | 'mens_grooming'
2314
+ | 'fragrance'
2315
+ | 'oral_care'
2316
+ | 'sunscreen_spf'
2317
+ | 'hair_growth_products'
2318
+ | 'body_care'
2319
+ | 'deodorant'
2320
+ | 'lip_care'
2321
+ | 'acne_treatment'
2322
+ | 'men_skincare'
2323
+ | 'baby_skincare'
2324
+ | 'tattoo_aftercare'
2325
+ | 'intimate_care'
2326
+ | 'home_gym_equipment'
2327
+ | 'yoga_equipment'
2328
+ | 'combat_sports_gear'
2329
+ | 'outdoor_fitness_gear'
2330
+ | 'wearable_fitness'
2331
+ | 'recovery_equipment'
2332
+ | 'weightlifting_equipment'
2333
+ | 'cardio_equipment'
2334
+ | 'gymnastics_equipment'
2335
+ | 'swimming_gear'
2336
+ | 'jump_rope_equipment'
2337
+ | 'grip_strength_tools'
2338
+ | 'sauna_cold_plunge'
2339
+ | 'posture_correctors'
2340
+ | 'jewelry'
2341
+ | 'sunglasses_eyewear'
2342
+ | 'bags_wallets'
2343
+ | 'hats_headwear'
2344
+ | 'phone_accessories'
2345
+ | 'travel_accessories'
2346
+ | 'scarves_wraps'
2347
+ | 'belts'
2348
+ | 'hair_accessories'
2349
+ | 'tech_accessories'
2350
+ | 'keychains_charms'
2351
+ | 'custom_engraved_accessories'
2352
+ | 'cannabis_accessories_non_drug'
2353
+ | 'drug_paraphernalia'
2354
+ | 'high_value_goods_over_500'
2355
+ | 'precious_metals_stones'
2356
+ | 'replica_counterfeit_goods'
2357
+ | 'home_decor'
2358
+ | 'candles_scents'
2359
+ | 'kitchenware'
2360
+ | 'bedding_linens'
2361
+ | 'smart_home'
2362
+ | 'cleaning_products'
2363
+ | 'outdoor_furniture'
2364
+ | 'organization_storage'
2365
+ | 'wall_art_prints'
2366
+ | 'rugs_carpets'
2367
+ | 'lighting_fixtures'
2368
+ | 'planters_garden_decor'
2369
+ | 'bathroom_accessories'
2370
+ | 'luxury_home_goods'
2371
+ | 'seasonal_holiday_decor'
2372
+ | 'pet_home_products'
2373
+ | 'home_fragrance_diffusers'
2374
+ | 'hazardous_chemicals_b2c'
2375
+ | 'pre_orders_delayed_delivery'
2376
+ | 'audio_equipment'
2377
+ | 'camera_equipment'
2378
+ | 'gaming_hardware'
2379
+ | 'drones_robotics'
2380
+ | 'ev_accessories'
2381
+ | 'charging_power'
2382
+ | 'smart_wearables'
2383
+ | 'home_security_devices'
2384
+ | '3d_printers'
2385
+ | 'projectors_displays'
2386
+ | 'streaming_devices'
2387
+ | 'vr_headsets'
2388
+ | 'e_readers'
2389
+ | 'portable_tech'
2390
+ | 'hardware_wallets'
2391
+ | 'regulated_medical_devices'
2392
+ | 'signal_jamming_devices'
2393
+ | 'spy_cameras_hidden_recording'
2394
+ | 'specialty_coffee_tea'
2395
+ | 'health_food'
2396
+ | 'snacks_treats'
2397
+ | 'sauces_condiments'
2398
+ | 'alcohol_spirits'
2399
+ | 'meal_kits'
2400
+ | 'baked_goods'
2401
+ | 'beverages'
2402
+ | 'pet_food_treats'
2403
+ | 'protein_bars_snacks'
2404
+ | 'jerky_meat_snacks'
2405
+ | 'chocolate_confections'
2406
+ | 'honey_sweeteners'
2407
+ | 'olive_oil_vinegar'
2408
+ | 'hot_sauce'
2409
+ | 'dried_fruit_nuts'
2410
+ | 'baby_food'
2411
+ | 'plant_based_food'
2412
+ | 'gluten_free_food'
2413
+ | 'keto_food_products'
2414
+ | 'subscription_food_box'
2415
+ | 'kombucha_fermented'
2416
+ | 'alcohol_sales'
2417
+ | 'baby_products'
2418
+ | 'kids_toys'
2419
+ | 'kids_educational'
2420
+ | 'baby_clothing_accessories'
2421
+ | 'nursery_decor'
2422
+ | 'kids_outdoor_play'
2423
+ | 'kids_books'
2424
+ | 'baby_safety_products'
2425
+ | 'kids_arts_crafts'
2426
+ | 'camping_hiking'
2427
+ | 'fishing_gear'
2428
+ | 'hunting_gear'
2429
+ | 'cycling_gear'
2430
+ | 'water_sports_gear'
2431
+ | 'golf_equipment'
2432
+ | 'snow_sports_gear'
2433
+ | 'climbing_gear'
2434
+ | 'archery_equipment'
2435
+ | 'skateboarding_gear'
2436
+ | 'pickleball_equipment'
2437
+ | 'tennis_equipment'
2438
+ | 'equestrian_gear'
2439
+ | 'tactical_gear'
2440
+ | 'overlanding_gear'
2441
+ | 'explosives_fireworks'
2442
+ | 'firearms_sales'
2443
+ | 'self_defense_products'
2444
+ | 'weapon_components'
2445
+ | 'craft_kits'
2446
+ | 'sewing_textiles'
2447
+ | 'stationery'
2448
+ | 'scrapbooking_supplies'
2449
+ | 'beading_jewelry_supplies'
2450
+ | 'pottery_supplies'
2451
+ | 'printmaking_supplies'
2452
+ | 'car_accessories'
2453
+ | 'detailing_products'
2454
+ | 'motorcycle_gear'
2455
+ | 'truck_accessories'
2456
+ | 'off_road_parts'
2457
+ | 'car_audio_electronics'
2458
+ | 'performance_parts'
2459
+ | 'car_care_products'
2460
+ | 'ev_charging_accessories'
2461
+ | 'auto_repair_service'
2462
+ | 'auto_body_shop'
2463
+ | 'car_dealership'
2464
+ | 'car_wash'
2465
+ | 'tire_shop'
2466
+ | 'oil_change_shop'
2467
+ | 'auto_parts_store'
2468
+ | 'motorcycle_shop'
2469
+ | 'ev_charging_station'
2470
+ | 'transmission_shop'
2471
+ | 'muffler_exhaust_shop'
2472
+ | 'auto_glass_shop'
2473
+ | 'auto_upholstery_shop'
2474
+ | 'car_audio_shop'
2475
+ | 'smog_emissions_shop'
2476
+ | 'truck_repair_shop'
2477
+ | 'rv_repair_shop'
2478
+ | 'boat_repair_shop'
2479
+ | 'used_car_lot'
2480
+ | 'auto_auction'
2481
+ | 'dog_products'
2482
+ | 'cat_products'
2483
+ | 'aquarium_supplies'
2484
+ | 'bird_supplies'
2485
+ | 'reptile_supplies'
2486
+ | 'horse_supplies'
2487
+ | 'pet_apparel'
2488
+ | 'pet_tech'
2489
+ | 'pet_grooming_products'
2490
+ | 'hand_tools'
2491
+ | 'power_tools_and_accessories'
2492
+ | 'hardware_and_fasteners'
2493
+ | 'workshop_equipment_and_storage'
2494
+ | 'safety_and_work_gear'
2495
+ | 'painting_and_building_supplies'
2496
+ | 'office_supplies'
2497
+ | 'desk_accessories'
2498
+ | 'printing_supplies'
2499
+ | 'shipping_packaging'
2500
+ | 'reusable_products'
2501
+ | 'solar_powered_products'
2502
+ | 'handmade_goods_marketplace'
2503
+ | 'vintage_resale_marketplace'
2504
+ | 'electronics_marketplace'
2505
+ | 'auto_parts_marketplace'
2506
+ | 'luxury_goods_marketplace'
2507
+ | 'collectibles_marketplace'
2508
+ | 'nft_digital_marketplace'
2509
+ | 'wholesale_marketplace'
2510
+ | 'local_goods_marketplace'
2511
+ | 'sneaker_marketplace'
2512
+ | 'book_marketplace'
2513
+ | 'furniture_marketplace'
2514
+ | 'musical_instrument_marketplace'
2515
+ | 'art_marketplace'
2516
+ | 'ticket_marketplace'
2517
+ | 'industrial_equipment_marketplace'
2518
+ | 'craft_supply_marketplace'
2519
+ | 'baby_kids_marketplace'
2520
+ | 'outdoor_gear_marketplace'
2521
+ | 'pet_marketplace'
2522
+ | 'sustainable_goods_marketplace'
2523
+ | '3d_weapon_files'
2524
+ | 'cultural_artifacts_looted'
2525
+ | 'dropshipping_operations'
2526
+ | 'endangered_animal_products'
2527
+ | 'human_body_parts_tissue'
2528
+ | 'nft_marketplace'
2529
+ | 'penny_auction'
2530
+ | 'primary_event_ticketing'
2531
+ | 'freelancer_marketplace'
2532
+ | 'home_services_marketplace'
2533
+ | 'tutoring_marketplace'
2534
+ | 'legal_services_marketplace'
2535
+ | 'healthcare_marketplace'
2536
+ | 'wedding_services_marketplace'
2537
+ | 'creative_services_marketplace'
2538
+ | 'beauty_services_marketplace'
2539
+ | 'fitness_trainer_marketplace'
2540
+ | 'pet_services_marketplace'
2541
+ | 'childcare_marketplace'
2542
+ | 'elder_care_marketplace'
2543
+ | 'translation_marketplace'
2544
+ | 'coaching_marketplace'
2545
+ | 'therapy_marketplace'
2546
+ | 'photography_marketplace'
2547
+ | 'dj_entertainment_marketplace'
2548
+ | 'auto_services_marketplace'
2549
+ | 'freelance_marketplace_operator'
2550
+ | 'equipment_rental_marketplace'
2551
+ | 'vehicle_rental_marketplace'
2552
+ | 'space_rental_marketplace'
2553
+ | 'vacation_rental_marketplace'
2554
+ | 'clothing_rental_marketplace'
2555
+ | 'camera_gear_rental'
2556
+ | 'rv_camper_rental'
2557
+ | 'boat_rental_marketplace'
2558
+ | 'storage_rental_marketplace'
2559
+ | 'office_coworking_rental'
2560
+ | 'parking_rental_marketplace'
2561
+ | 'restaurant_marketplace'
2562
+ | 'grocery_marketplace'
2563
+ | 'catering_marketplace'
2564
+ | 'homemade_food_marketplace'
2565
+ | 'meal_prep_marketplace'
2566
+ | 'bakery_marketplace'
2567
+ | 'farm_produce_marketplace'
2568
+ | 'chef_booking_marketplace'
2569
+ | 'course_marketplace'
2570
+ | 'template_marketplace'
2571
+ | 'stock_media_marketplace'
2572
+ | 'music_beats_marketplace'
2573
+ | 'ebook_marketplace'
2574
+ | 'plugin_theme_marketplace'
2575
+ | '3d_model_marketplace'
2576
+ | 'prompt_marketplace'
2577
+ | 'code_snippet_marketplace'
2578
+ | 'game_account_selling'
2579
+ | 'game_cheats_hacks'
2580
+ | 'pirated_digital_content'
2581
+ | 'unauthorized_ingame_currency'
2582
+ | 'weapon_blueprint_distribution'
2583
+ | 'saas_marketplace'
2584
+ | 'agency_marketplace'
2585
+ | 'manufacturing_marketplace'
2586
+ | 'logistics_marketplace'
2587
+ | 'commercial_real_estate_marketplace'
2588
+ | 'business_for_sale_marketplace'
2589
+ | 'food_delivery'
2590
+ | 'grocery_delivery'
2591
+ | 'package_delivery'
2592
+ | 'moving_labor'
2593
+ | 'alcohol_delivery'
2594
+ | 'pharmacy_delivery'
2595
+ | 'flower_delivery_gig'
2596
+ | 'furniture_delivery_gig'
2597
+ | 'catering_delivery'
2598
+ | 'rideshare'
2599
+ | 'chauffeur_service'
2600
+ | 'bike_scooter_rental'
2601
+ | 'boat_charter_gig'
2602
+ | 'moving_truck_rental_gig'
2603
+ | 'assembly_installation'
2604
+ | 'waiting_line_service'
2605
+ | 'personal_shopping'
2606
+ | 'grocery_shopping_gig'
2607
+ | 'gift_wrapping_gig'
2608
+ | 'notary_gig'
2609
+ | 'laundry_gig'
2610
+ | 'car_wash_gig'
2611
+ | 'cleaning_gig'
2612
+ | 'lawn_care_gig'
2613
+ | 'handyman_gig'
2614
+ | 'pet_care_gig'
2615
+ | 'childcare_gig'
2616
+ | 'elder_care_gig'
2617
+ | 'painting_gig'
2618
+ | 'snow_removal_gig'
2619
+ | 'pool_cleaning_gig'
2620
+ | 'organizing_gig'
2621
+ | 'pressure_washing_gig'
2622
+ | 'junk_removal_gig'
2623
+ | 'freelance_design_gig'
2624
+ | 'freelance_writing_gig'
2625
+ | 'freelance_dev_gig'
2626
+ | 'music_performance_gig'
2627
+ | 'event_staffing_gig'
2628
+ | 'model_talent_gig'
2629
+ | 'photography_gig'
2630
+ | 'videography_gig'
2631
+ | 'voiceover_gig'
2632
+ | 'illustration_gig'
2633
+ | 'social_media_gig'
2634
+ | 'dj_gig'
2635
+ | 'face_painting_gig'
2636
+ | 'consulting_gig'
2637
+ | 'accounting_gig'
2638
+ | 'legal_gig'
2639
+ | 'healthcare_gig'
2640
+ | 'teaching_gig'
2641
+ | 'translation_gig'
2642
+ | 'data_entry_gig'
2643
+ | 'research_gig'
2644
+ | 'virtual_assistant_gig'
2645
+ | 'sales_gig'
2646
+ | 'recruiting_gig'
2647
+ | 'mystery_shopping'
2648
+ | 'focus_group_gig'
2649
+ | 'product_testing_gig'
2650
+ | 'drone_pilot_gig'
2651
+ | 'fitness_instruction_gig'
2652
+ | 'tour_guide_gig'
2653
+ | 'forex_signals_group'
2654
+ | 'stock_signals_group'
2655
+ | 'crypto_signals_group'
2656
+ | 'options_alerts_group'
2657
+ | 'futures_signals_group'
2658
+ | 'trading_education_group'
2659
+ | 'investing_community'
2660
+ | 'prediction_markets_group'
2661
+ | 'nft_alpha_group'
2662
+ | 'penny_stock_group'
2663
+ | 'dividend_investing_group'
2664
+ | 'real_estate_investing_group'
2665
+ | 'prop_firm_group'
2666
+ | 'sports_picks_group'
2667
+ | 'dfs_group'
2668
+ | 'horse_racing_group'
2669
+ | 'esports_picks_group'
2670
+ | 'nfl_picks_group'
2671
+ | 'nba_picks_group'
2672
+ | 'soccer_picks_group'
2673
+ | 'mlb_picks_group'
2674
+ | 'mma_picks_group'
2675
+ | 'prop_bets_group'
2676
+ | 'fantasy_sports_free_to_play'
2677
+ | 'licensed_gambling_operations'
2678
+ | 'unlicensed_gambling'
2679
+ | 'ecommerce_community'
2680
+ | 'agency_community'
2681
+ | 'saas_community'
2682
+ | 'saas_marketing_community'
2683
+ | 'real_estate_community'
2684
+ | 'sales_community'
2685
+ | 'affiliate_community'
2686
+ | 'reselling_community'
2687
+ | 'amazon_seller_community'
2688
+ | 'dropshipping_community'
2689
+ | 'freelancer_community'
2690
+ | 'startup_founder_community'
2691
+ | 'ceo_executive_community'
2692
+ | 'women_business_community'
2693
+ | 'marketing_community'
2694
+ | 'ai_business_community'
2695
+ | 'content_business_community'
2696
+ | 'local_business_community'
2697
+ | 'private_equity_community'
2698
+ | 'wholesaling_community'
2699
+ | 'coaching_business_community'
2700
+ | 'make_money_online_community'
2701
+ | 'fitness_accountability'
2702
+ | 'nutrition_community'
2703
+ | 'weight_loss_group'
2704
+ | 'bodybuilding_community'
2705
+ | 'running_community'
2706
+ | 'martial_arts_community'
2707
+ | 'mental_health_group'
2708
+ | 'biohacking_community'
2709
+ | 'addiction_support_group'
2710
+ | 'yoga_community'
2711
+ | 'crossfit_community'
2712
+ | 'longevity_community'
2713
+ | 'womens_fitness_community'
2714
+ | 'postpartum_fitness_group'
2715
+ | 'chronic_illness_support'
2716
+ | 'content_creator_community'
2717
+ | 'video_editing_community'
2718
+ | 'music_producer_community'
2719
+ | 'photography_community'
2720
+ | 'writing_community'
2721
+ | 'design_community'
2722
+ | 'youtube_creator_community'
2723
+ | 'tiktok_creator_community'
2724
+ | 'podcast_community'
2725
+ | 'filmmaker_community'
2726
+ | 'developer_community'
2727
+ | 'ai_community'
2728
+ | 'cybersecurity_community'
2729
+ | 'no_code_community'
2730
+ | 'indie_hacker_community'
2731
+ | 'devops_community'
2732
+ | 'data_science_community'
2733
+ | 'product_community'
2734
+ | 'open_source_community'
2735
+ | 'dating_community'
2736
+ | 'personal_development_community'
2737
+ | 'spirituality_community'
2738
+ | 'parenting_community'
2739
+ | 'travel_community'
2740
+ | 'networking_community'
2741
+ | 'faith_community'
2742
+ | 'mens_community'
2743
+ | 'womens_community'
2744
+ | 'expat_community'
2745
+ | 'adult_community_nsfw'
2746
+ | 'hate_violence_communities'
2747
+ | 'personal_fundraising'
2748
+ | 'political_fundraising'
2749
+ | 'political_organizations'
2750
+ | 'pornographic_content'
2751
+ | 'registered_501c3'
2752
+ | 'religious_organization'
2753
+ | 'unregistered_charities'
2754
+ | 'gaming_community'
2755
+ | 'car_enthusiast_community'
2756
+ | 'sneakerhead_community'
2757
+ | 'watch_collector_community'
2758
+ | 'wine_enthusiast_community'
2759
+ | 'cigar_community'
2760
+ | 'cooking_community'
2761
+ | 'gardening_community'
2762
+ | 'fishing_community'
2763
+ | 'hunting_community'
2764
+ | 'diy_maker_community'
2765
+ | 'golf_community'
2766
+ | 'sweepstakes_raffles'
2767
+ | 'forex_trading_bot'
2768
+ | 'stock_trading_platform'
2769
+ | 'crypto_trading_bot'
2770
+ | 'futures_trading_bot'
2771
+ | 'options_flow_tool'
2772
+ | 'portfolio_tracker'
2773
+ | 'financial_modeling_software'
2774
+ | 'accounting_software'
2775
+ | 'invoicing_software'
2776
+ | 'tax_software'
2777
+ | 'risk_management_software'
2778
+ | 'prop_trading_platform'
2779
+ | 'backtesting_software'
2780
+ | 'market_data_feed'
2781
+ | 'banking_software'
2782
+ | 'lending_platform'
2783
+ | 'insurance_software'
2784
+ | 'crypto_trading_tools_software'
2785
+ | 'non_custodial_wallet_tools'
2786
+ | 'ai_outreach_tool'
2787
+ | 'ai_chatbot_software'
2788
+ | 'ai_writing_tool'
2789
+ | 'ai_image_generator'
2790
+ | 'ai_video_tool'
2791
+ | 'ai_voice_tool'
2792
+ | 'ai_data_analysis'
2793
+ | 'ai_code_assistant'
2794
+ | 'ai_meeting_assistant'
2795
+ | 'workflow_automation_software'
2796
+ | 'ai_sales_tool'
2797
+ | 'ai_customer_support'
2798
+ | 'ai_recruiting_tool'
2799
+ | 'ai_translation_tool'
2800
+ | 'ai_music_tool'
2801
+ | 'ai_presentation_tool'
2802
+ | 'ai_research_tool'
2803
+ | 'ai_seo_tool'
2804
+ | 'ai_social_media_tool'
2805
+ | 'ai_phone_agent'
2806
+ | 'ai_legal_tool'
2807
+ | 'ai_healthcare_tool'
2808
+ | 'llm_api_platform'
2809
+ | 'ai_agent_platform'
2810
+ | 'generative_ai_platform'
2811
+ | 'celebrity_impersonation'
2812
+ | 'deepfake_service'
2813
+ | 'crm_software'
2814
+ | 'email_marketing_software'
2815
+ | 'sms_marketing_software'
2816
+ | 'seo_tool'
2817
+ | 'landing_page_builder'
2818
+ | 'ad_management_tool'
2819
+ | 'affiliate_tracking'
2820
+ | 'review_management'
2821
+ | 'analytics_dashboard'
2822
+ | 'lead_gen_software'
2823
+ | 'link_in_bio_tool'
2824
+ | 'influencer_platform'
2825
+ | 'webinar_platform'
2826
+ | 'ab_testing_tool'
2827
+ | 'chatbot_marketing'
2828
+ | 'video_sales_tool'
2829
+ | 'proposal_software'
2830
+ | 'competitive_intelligence'
2831
+ | 'social_listening_tool'
2832
+ | 'whatsapp_marketing_tool'
2833
+ | 'ecommerce_platform'
2834
+ | 'product_research_tool'
2835
+ | 'price_tracker'
2836
+ | 'shipping_software'
2837
+ | 'print_on_demand_software'
2838
+ | 'marketplace_seller_tool'
2839
+ | 'product_review_software'
2840
+ | 'returns_management'
2841
+ | 'product_feed_management'
2842
+ | 'checkout_optimization'
2843
+ | 'wholesale_ordering'
2844
+ | 'project_management_software'
2845
+ | 'team_communication'
2846
+ | 'video_conferencing'
2847
+ | 'document_collaboration'
2848
+ | 'time_tracking_software'
2849
+ | 'scheduling_software'
2850
+ | 'hr_software'
2851
+ | 'knowledge_base_software'
2852
+ | 'form_survey_builder'
2853
+ | 'note_taking_app'
2854
+ | 'task_management'
2855
+ | 'contract_management'
2856
+ | 'expense_management'
2857
+ | 'okr_goal_tracking'
2858
+ | 'employee_engagement'
2859
+ | 'onboarding_software'
2860
+ | 'applicant_tracking'
2861
+ | 'asset_management'
2862
+ | 'facility_management'
2863
+ | 'visitor_management'
2864
+ | 'api_management'
2865
+ | 'hosting_platform'
2866
+ | 'database_tool'
2867
+ | 'devops_tool'
2868
+ | 'monitoring_tool'
2869
+ | 'testing_tool'
2870
+ | 'code_editor'
2871
+ | 'no_code_builder'
2872
+ | 'cdn_platform'
2873
+ | 'error_tracking'
2874
+ | 'documentation_tool'
2875
+ | 'webhook_tool'
2876
+ | 'community_platform'
2877
+ | 'event_management_software'
2878
+ | 'webinar_software'
2879
+ | 'school_management'
2880
+ | 'newsletter_platform'
2881
+ | 'podcast_hosting'
2882
+ | 'forum_software'
2883
+ | 'virtual_classroom'
2884
+ | 'telehealth_platform'
2885
+ | 'ehr_software'
2886
+ | 'practice_management'
2887
+ | 'mental_health_app'
2888
+ | 'fitness_app'
2889
+ | 'nutrition_tracking_app'
2890
+ | 'wellness_app'
2891
+ | 'patient_engagement'
2892
+ | 'medical_billing_software'
2893
+ | 'pharmacy_management'
2894
+ | 'lab_management'
2895
+ | 'clinical_trial_software'
2896
+ | 'dental_software'
2897
+ | 'veterinary_software'
2898
+ | 'health_data_platform'
2899
+ | 'real_estate_crm'
2900
+ | 'property_management_software'
2901
+ | 'deal_analysis_tool'
2902
+ | 'mls_search_tool'
2903
+ | 'virtual_tour_software'
2904
+ | 'real_estate_marketing_software'
2905
+ | 'construction_management'
2906
+ | 'home_valuation_tool'
2907
+ | 'restaurant_pos'
2908
+ | 'salon_software'
2909
+ | 'gym_management_software'
2910
+ | 'auto_shop_software'
2911
+ | 'legal_practice_software'
2912
+ | 'church_management'
2913
+ | 'nonprofit_software'
2914
+ | 'logistics_software'
2915
+ | 'agriculture_software'
2916
+ | 'field_service_software'
2917
+ | 'marina_management'
2918
+ | 'hotel_pms'
2919
+ | 'childcare_management'
2920
+ | 'cleaning_business_software'
2921
+ | 'roofing_software'
2922
+ | 'landscaping_software'
2923
+ | 'pest_control_software'
2924
+ | 'tattoo_studio_software'
2925
+ | 'cannabis_software'
2926
+ | 'vpn_software'
2927
+ | 'password_manager'
2928
+ | 'cybersecurity_software'
2929
+ | 'identity_verification'
2930
+ | 'backup_recovery'
2931
+ | 'endpoint_protection'
2932
+ | 'email_security'
2933
+ | 'access_management'
2934
+ | 'compliance_software'
2935
+ | 'data_privacy_tool'
2936
+ | 'vpn_services'
2937
+ | 'game_mod_tool'
2938
+ | 'streaming_tool'
2939
+ | 'game_server_hosting'
2940
+ | 'music_software'
2941
+ | 'video_editing_software'
2942
+ | 'photo_editing_software'
2943
+ | 'animation_software'
2944
+ | 'audio_editing_software'
2945
+ | 'screen_recording_software'
2946
+ | 'fantasy_sports_paid_entry'
2947
+ | 'iptv_pirated_streaming'
2948
+ | 'loot_boxes_gacha'
2949
+ | 'skill_contests_free_entry'
2950
+ | 'skill_contests_paid_entry'
2951
+ | 'business_phone_system'
2952
+ | 'customer_messaging'
2953
+ | 'digital_key_reselling'
2954
+ | 'streaming_account_reselling'
2955
+ | 'primary_care_telehealth'
2956
+ | 'urgent_care_telehealth'
2957
+ | 'pediatric_telehealth'
2958
+ | 'geriatric_telehealth'
2959
+ | 'family_medicine_telehealth'
2960
+ | 'internal_medicine_telehealth'
2961
+ | 'preventive_care_telehealth'
2962
+ | 'licensed_online_pharmacy'
2963
+ | 'telemedicine_practitioner_services'
2964
+ | 'dermatology_telehealth'
2965
+ | 'acne_telehealth'
2966
+ | 'psoriasis_eczema_telehealth'
2967
+ | 'skin_cancer_screening_tele'
2968
+ | 'cosmetic_dermatology_tele'
2969
+ | 'therapy_telehealth'
2970
+ | 'psychiatry_telehealth'
2971
+ | 'addiction_telehealth'
2972
+ | 'couples_therapy_telehealth'
2973
+ | 'child_psychology_telehealth'
2974
+ | 'eating_disorder_telehealth'
2975
+ | 'ptsd_trauma_telehealth'
2976
+ | 'adhd_telehealth'
2977
+ | 'anxiety_depression_telehealth'
2978
+ | 'ocd_telehealth'
2979
+ | 'grief_counseling_telehealth'
2980
+ | 'anger_management_telehealth'
2981
+ | 'family_therapy_telehealth'
2982
+ | 'group_therapy_telehealth'
2983
+ | 'licensed_psychedelic_therapy'
2984
+ | 'womens_health_telehealth'
2985
+ | 'mens_health_telehealth'
2986
+ | 'sexual_health_telehealth'
2987
+ | 'fertility_telehealth'
2988
+ | 'hormone_therapy_telehealth'
2989
+ | 'menopause_telehealth'
2990
+ | 'prenatal_telehealth'
2991
+ | 'postpartum_telehealth'
2992
+ | 'erectile_dysfunction_tele'
2993
+ | 'hair_loss_telehealth'
2994
+ | 'birth_control_telehealth'
2995
+ | 'sti_testing_telehealth'
2996
+ | 'dental_telehealth'
2997
+ | 'orthodontics_telehealth'
2998
+ | 'optometry_telehealth'
2999
+ | 'oral_surgery_consultation'
3000
+ | 'vision_therapy_telehealth'
3001
+ | 'cardiology_telehealth'
3002
+ | 'endocrinology_telehealth'
3003
+ | 'neurology_telehealth'
3004
+ | 'orthopedic_telehealth'
3005
+ | 'allergy_telehealth'
3006
+ | 'ent_telehealth'
3007
+ | 'rheumatology_telehealth'
3008
+ | 'gastroenterology_telehealth'
3009
+ | 'infectious_disease_telehealth'
3010
+ | 'pulmonology_telehealth'
3011
+ | 'nephrology_telehealth'
3012
+ | 'oncology_telehealth'
3013
+ | 'hematology_telehealth'
3014
+ | 'urology_telehealth'
3015
+ | 'weight_management_telehealth'
3016
+ | 'glp1_weight_loss_tele'
3017
+ | 'diabetes_management_tele'
3018
+ | 'metabolic_health_tele'
3019
+ | 'bariatric_telehealth'
3020
+ | 'physical_therapy_telehealth'
3021
+ | 'occupational_therapy_tele'
3022
+ | 'speech_therapy_telehealth'
3023
+ | 'pain_management_telehealth'
3024
+ | 'cardiac_rehab_telehealth'
3025
+ | 'pelvic_floor_telehealth'
3026
+ | 'vestibular_telehealth'
3027
+ | 'sleep_medicine_telehealth'
3028
+ | 'chronic_disease_management'
3029
+ | 'chronic_pain_telehealth'
3030
+ | 'migraine_telehealth'
3031
+ | 'asthma_copd_telehealth'
3032
+ | 'nutrition_telehealth'
3033
+ | 'naturopathic_telehealth'
3034
+ | 'functional_medicine_telehealth'
3035
+ | 'acupuncture_telehealth'
3036
+ | 'health_coaching_telehealth'
3037
+ | 'integrative_medicine_tele'
3038
+ | 'ayurvedic_telehealth'
3039
+ | 'genetic_counseling_telehealth'
3040
+ | 'pharmacogenomics_tele'
3041
+ | 'rare_disease_telehealth'
3042
+ | 'second_opinion_telehealth'
3043
+ | 'vet_telehealth'
3044
+ | 'pet_behavior_telehealth'
3045
+ | 'exotic_pet_telehealth'
3046
+ | 'equine_telehealth'
3047
+ | 'veterinary_services'
3048
+ | 'class_action_settlement'
3049
+ | 'mastermind_event'
3050
+ | 'webinar_event'
3051
+ | 'bootcamp_event'
3052
+ | 'convention_expo'
3053
+ | 'conference_summit'
3054
+ | 'workshop_seminar'
3055
+ | 'hackathon'
3056
+ | 'pitch_competition'
3057
+ | 'training_certification_event'
3058
+ | 'product_launch_event'
3059
+ | 'investor_demo_day'
3060
+ | 'industry_awards_event'
3061
+ | 'panel_discussion_event'
3062
+ | 'virtual_summit'
3063
+ | 'corporate_training_event'
3064
+ | 'meetup_event'
3065
+ | 'dinner_event'
3066
+ | 'alumni_event'
3067
+ | 'community_gathering'
3068
+ | 'singles_event'
3069
+ | 'professional_happy_hour'
3070
+ | 'women_networking_event'
3071
+ | 'founders_dinner'
3072
+ | 'industry_mixer'
3073
+ | 'concert_event'
3074
+ | 'party_event'
3075
+ | 'comedy_show'
3076
+ | 'theater_performance'
3077
+ | 'film_screening'
3078
+ | 'art_exhibition'
3079
+ | 'food_festival'
3080
+ | 'music_festival'
3081
+ | 'cultural_festival'
3082
+ | 'fashion_show'
3083
+ | 'drag_show'
3084
+ | 'magic_show'
3085
+ | 'dance_performance'
3086
+ | 'poetry_spoken_word'
3087
+ | 'trivia_night'
3088
+ | 'wine_tasting_event'
3089
+ | 'beer_festival'
3090
+ | 'car_show'
3091
+ | 'fitness_challenge_event'
3092
+ | 'marathon_race'
3093
+ | 'tournament_event'
3094
+ | 'fight_event'
3095
+ | 'yoga_retreat_event'
3096
+ | 'outdoor_adventure_event'
3097
+ | 'esports_tournament'
3098
+ | 'obstacle_course_race'
3099
+ | 'cycling_event'
3100
+ | 'swim_meet'
3101
+ | 'golf_tournament'
3102
+ | 'pickleball_tournament'
3103
+ | 'crossfit_competition'
3104
+ | 'martial_arts_tournament'
3105
+ | 'surfing_competition'
3106
+ | 'wellness_retreat'
3107
+ | 'spiritual_retreat'
3108
+ | 'couples_retreat'
3109
+ | 'plant_medicine_retreat'
3110
+ | 'luxury_experience_event'
3111
+ | 'detox_retreat'
3112
+ | 'silent_retreat'
3113
+ | 'creative_retreat'
3114
+ | 'leadership_retreat'
3115
+ | 'mens_retreat'
3116
+ | 'womens_retreat'
3117
+ | 'digital_detox_retreat'
3118
+ | 'fundraiser_event'
3119
+ | 'awareness_event'
3120
+ | 'volunteer_event'
3121
+ | 'charity_auction'
3122
+ | 'benefit_concert'
3123
+ | 'charity_run_walk'
3124
+ | 'environmental_cleanup'
3125
+ | 'family_festival'
3126
+ | 'kids_event'
3127
+ | 'holiday_event'
3128
+ | 'farmers_market_event'
3129
+ | 'block_party'
3130
+ | 'graduation_ceremony'
3131
+ | 'memorial_event'
3132
+ | 'stock_market_newsletter'
3133
+ | 'crypto_newsletter'
3134
+ | 'personal_finance_newsletter'
3135
+ | 'real_estate_newsletter'
3136
+ | 'fintech_newsletter'
3137
+ | 'venture_capital_newsletter'
3138
+ | 'options_trading_newsletter'
3139
+ | 'forex_newsletter'
3140
+ | 'macro_economics_newsletter'
3141
+ | 'alternative_investing_newsletter'
3142
+ | 'tax_strategy_newsletter'
3143
+ | 'ai_newsletter'
3144
+ | 'tech_industry_newsletter'
3145
+ | 'cybersecurity_newsletter'
3146
+ | 'developer_newsletter'
3147
+ | 'product_newsletter'
3148
+ | 'devops_newsletter'
3149
+ | 'open_source_newsletter'
3150
+ | 'robotics_newsletter'
3151
+ | 'climate_tech_newsletter'
3152
+ | 'travel_newsletter'
3153
+ | 'fashion_newsletter'
3154
+ | 'parenting_newsletter'
3155
+ | 'sports_newsletter'
3156
+ | 'gaming_newsletter'
3157
+ | 'music_entertainment_newsletter'
3158
+ | 'book_reading_newsletter'
3159
+ | 'dating_relationships_newsletter'
3160
+ | 'home_design_newsletter'
3161
+ | 'pet_newsletter'
3162
+ | 'wine_spirits_newsletter'
3163
+ | 'automotive_newsletter'
3164
+ | 'political_newsletter'
3165
+ | 'geopolitics_newsletter'
3166
+ | 'media_journalism_newsletter'
3167
+ | 'defense_security_newsletter'
3168
+ | 'legal_policy_newsletter'
3169
+ | 'design_newsletter'
3170
+ | 'education_newsletter'
3171
+ | 'science_newsletter'
3172
+ | 'philosophy_newsletter'
3173
+ | 'sustainability_newsletter'
3174
+ | 'architecture_newsletter'
3175
+ | 'history_newsletter'
3176
+ | 'psychology_newsletter'
3177
+ | 'career_newsletter'
3178
+ | 'spirituality_newsletter'
3179
+ | 'self_improvement_newsletter'
3180
+ | 'productivity_newsletter'
3181
+ | 'faith_newsletter'
3182
+ | 'gym_facility'
3183
+ | 'crossfit_box'
3184
+ | 'yoga_studio'
3185
+ | 'pilates_studio'
3186
+ | 'martial_arts_gym'
3187
+ | 'boxing_gym'
3188
+ | 'climbing_gym'
3189
+ | 'dance_studio'
3190
+ | 'swimming_pool'
3191
+ | 'sports_facility'
3192
+ | 'golf_course'
3193
+ | 'bowling_alley'
3194
+ | 'skating_rink'
3195
+ | 'trampoline_park'
3196
+ | 'tennis_club'
3197
+ | 'pickleball_facility'
3198
+ | 'gymnastics_center'
3199
+ | 'spin_studio'
3200
+ | 'barre_studio'
3201
+ | 'personal_training_studio_bm'
3202
+ | 'recovery_studio'
3203
+ | 'indoor_soccer'
3204
+ | 'batting_cage'
3205
+ | 'shooting_range'
3206
+ | 'archery_range'
3207
+ | 'equestrian_center'
3208
+ | 'fine_dining'
3209
+ | 'fast_casual_restaurant'
3210
+ | 'fast_food'
3211
+ | 'food_truck'
3212
+ | 'bar_lounge'
3213
+ | 'brewery_taproom'
3214
+ | 'winery_tasting'
3215
+ | 'coffee_shop_cafe'
3216
+ | 'bakery'
3217
+ | 'juice_smoothie_bar'
3218
+ | 'pizza_shop'
3219
+ | 'sushi_restaurant'
3220
+ | 'ethnic_restaurant'
3221
+ | 'catering_kitchen'
3222
+ | 'ghost_kitchen'
3223
+ | 'ice_cream_shop'
3224
+ | 'donut_shop'
3225
+ | 'deli_sandwich_shop'
3226
+ | 'steakhouse'
3227
+ | 'seafood_restaurant'
3228
+ | 'bbq_restaurant'
3229
+ | 'mexican_restaurant'
3230
+ | 'italian_restaurant'
3231
+ | 'chinese_restaurant'
3232
+ | 'indian_restaurant'
3233
+ | 'thai_restaurant'
3234
+ | 'korean_restaurant'
3235
+ | 'mediterranean_restaurant'
3236
+ | 'vegan_vegetarian_restaurant'
3237
+ | 'brunch_restaurant'
3238
+ | 'ramen_noodle_shop'
3239
+ | 'poke_bowl_shop'
3240
+ | 'bubble_tea_shop'
3241
+ | 'wine_bar'
3242
+ | 'cocktail_bar'
3243
+ | 'sports_bar'
3244
+ | 'hookah_lounge'
3245
+ | 'distillery'
3246
+ | 'butcher_shop'
3247
+ | 'cheese_shop'
3248
+ | 'farmers_market_stall'
3249
+ | 'food_hall_vendor'
3250
+ | 'commercial_farming'
3251
+ | 'livestock_ranching'
3252
+ | 'hydroponic_vertical_farming'
3253
+ | 'forestry_logging'
3254
+ | 'aquaculture_fisheries'
3255
+ | 'vineyard_winery_production'
3256
+ | 'cannabis_cultivation'
3257
+ | 'hemp_farming'
3258
+ | 'grain_production'
3259
+ | 'agricultural_cooperative'
3260
+ | 'fertilizer_pesticide_sales'
3261
+ | 'farm_equipment_sales'
3262
+ | 'boutique_store'
3263
+ | 'clothing_store'
3264
+ | 'shoe_store'
3265
+ | 'jewelry_store'
3266
+ | 'electronics_store'
3267
+ | 'bookstore'
3268
+ | 'pet_store'
3269
+ | 'toy_store'
3270
+ | 'sporting_goods_store'
3271
+ | 'thrift_store'
3272
+ | 'smoke_shop'
3273
+ | 'cannabis_dispensary'
3274
+ | 'convenience_store'
3275
+ | 'grocery_store'
3276
+ | 'liquor_store'
3277
+ | 'florist'
3278
+ | 'gift_shop'
3279
+ | 'furniture_store'
3280
+ | 'home_improvement_store'
3281
+ | 'art_gallery_retail'
3282
+ | 'music_instrument_store'
3283
+ | 'outdoor_recreation_store'
3284
+ | 'phone_repair_store'
3285
+ | 'watch_store'
3286
+ | 'bridal_shop'
3287
+ | 'maternity_store'
3288
+ | 'kids_store'
3289
+ | 'sneaker_store'
3290
+ | 'vintage_store'
3291
+ | 'comic_book_store'
3292
+ | 'record_store'
3293
+ | 'craft_supply_store'
3294
+ | 'fabric_store'
3295
+ | 'health_food_store'
3296
+ | 'vitamin_supplement_store'
3297
+ | 'optical_store'
3298
+ | 'mattress_store'
3299
+ | 'appliance_store'
3300
+ | 'kitchen_bath_store'
3301
+ | 'tile_flooring_store'
3302
+ | 'paint_store'
3303
+ | 'garden_center'
3304
+ | 'gun_store'
3305
+ | 'pawn_shop'
3306
+ | 'dollar_store'
3307
+ | 'hair_salon'
3308
+ | 'nail_salon'
3309
+ | 'day_spa'
3310
+ | 'med_spa'
3311
+ | 'massage_studio'
3312
+ | 'tattoo_parlor'
3313
+ | 'tanning_salon'
3314
+ | 'beauty_supply_store'
3315
+ | 'lash_brow_studio'
3316
+ | 'waxing_studio'
3317
+ | 'sauna_bathhouse'
3318
+ | 'cryotherapy_studio'
3319
+ | 'float_sensory_studio'
3320
+ | 'iv_therapy_lounge'
3321
+ | 'teeth_whitening_studio'
3322
+ | 'microblading_studio'
3323
+ | 'spray_tan_studio'
3324
+ | 'blowout_bar'
3325
+ | 'mens_barbershop'
3326
+ | 'kids_salon'
3327
+ | 'medical_office'
3328
+ | 'dental_office'
3329
+ | 'chiropractic_office'
3330
+ | 'physical_therapy_clinic'
3331
+ | 'optometry_office'
3332
+ | 'dermatology_clinic'
3333
+ | 'urgent_care_clinic'
3334
+ | 'pharmacy'
3335
+ | 'veterinary_clinic'
3336
+ | 'mental_health_clinic'
3337
+ | 'fertility_clinic'
3338
+ | 'acupuncture_clinic'
3339
+ | 'hearing_aid_center'
3340
+ | 'orthopedic_clinic'
3341
+ | 'pediatric_clinic'
3342
+ | 'cosmetic_surgery_center'
3343
+ | 'allergy_clinic'
3344
+ | 'pain_management_clinic'
3345
+ | 'dialysis_center'
3346
+ | 'imaging_center'
3347
+ | 'lab_testing_center'
3348
+ | 'sleep_clinic'
3349
+ | 'weight_loss_clinic'
3350
+ | 'hormone_therapy_clinic'
3351
+ | 'addiction_treatment_center'
3352
+ | 'rehabilitation_center'
3353
+ | 'occupational_therapy_clinic'
3354
+ | 'speech_therapy_clinic'
3355
+ | 'wound_care_center'
3356
+ | 'funeral_home_mortuary'
3357
+ | 'crematory_service'
3358
+ | 'cemetery_memorial_park'
3359
+ | 'casket_urn_retailer'
3360
+ | 'pet_cremation_service'
3361
+ | 'biohazard_cleanup'
3362
+ | 'estate_liquidation'
3363
+ | 'hotel'
3364
+ | 'motel'
3365
+ | 'boutique_hotel'
3366
+ | 'bed_and_breakfast'
3367
+ | 'hostel'
3368
+ | 'resort'
3369
+ | 'campground_rv'
3370
+ | 'vacation_rental_property'
3371
+ | 'extended_stay'
3372
+ | 'glamping_site'
3373
+ | 'cabin_rental'
3374
+ | 'eco_lodge'
3375
+ | 'retreat_center'
3376
+ | 'tutoring_center'
3377
+ | 'daycare_center'
3378
+ | 'preschool'
3379
+ | 'learning_center'
3380
+ | 'music_school'
3381
+ | 'art_school'
3382
+ | 'driving_school'
3383
+ | 'language_school'
3384
+ | 'trade_school'
3385
+ | 'coding_bootcamp_location'
3386
+ | 'montessori_school'
3387
+ | 'after_school_program'
3388
+ | 'swim_school'
3389
+ | 'cooking_school'
3390
+ | 'test_prep_center'
3391
+ | 'special_needs_center'
3392
+ | 'adult_education_center'
3393
+ | 'flight_school'
3394
+ | 'cosmetology_school'
3395
+ | 'movie_theater'
3396
+ | 'escape_room'
3397
+ | 'arcade'
3398
+ | 'mini_golf'
3399
+ | 'laser_tag'
3400
+ | 'go_kart'
3401
+ | 'amusement_park'
3402
+ | 'museum'
3403
+ | 'zoo_aquarium'
3404
+ | 'theater_venue'
3405
+ | 'nightclub'
3406
+ | 'karaoke_bar'
3407
+ | 'comedy_club'
3408
+ | 'live_music_venue'
3409
+ | 'axe_throwing'
3410
+ | 'virtual_reality_arcade'
3411
+ | 'board_game_cafe'
3412
+ | 'cat_cafe'
3413
+ | 'haunted_house'
3414
+ | 'water_park'
3415
+ | 'indoor_playground'
3416
+ | 'trampoline_park_entertainment'
3417
+ | 'concert_venue'
3418
+ | 'drive_in_theater'
3419
+ | 'billiards_hall'
3420
+ | 'dart_bar'
3421
+ | 'batting_cage_entertainment'
3422
+ | 'indoor_skydiving'
3423
+ | 'law_office'
3424
+ | 'real_estate_office'
3425
+ | 'insurance_office'
3426
+ | 'accounting_office'
3427
+ | 'bank_credit_union'
3428
+ | 'printing_shop'
3429
+ | 'shipping_center'
3430
+ | 'dry_cleaner'
3431
+ | 'laundromat'
3432
+ | 'storage_facility'
3433
+ | 'coworking_space'
3434
+ | 'check_cashing'
3435
+ | 'title_company'
3436
+ | 'travel_agency_storefront'
3437
+ | 'staffing_office'
3438
+ | 'financial_advisor_office'
3439
+ | 'immigration_office'
3440
+ | 'bail_bonds_office'
3441
+ | 'pet_grooming'
3442
+ | 'dog_daycare'
3443
+ | 'pet_boarding'
3444
+ | 'dog_training_facility'
3445
+ | 'pet_spa'
3446
+ | 'aquatic_pet_store'
3447
+ | 'pet_bakery'
3448
+ | 'pet_photography_studio'
3449
+ | 'plumbing_showroom'
3450
+ | 'hvac_showroom'
3451
+ | 'solar_showroom'
3452
+ | 'kitchen_design_showroom'
3453
+ | 'bath_design_showroom'
3454
+ | 'window_door_showroom'
3455
+ | 'pool_spa_showroom'
3456
+ | 'fireplace_showroom'
3457
+ | 'countertop_showroom'
3458
+ | 'nonprofit_organization'
3459
+ | 'charity_foundation'
3460
+ | 'political_campaign'
3461
+ | 'community_organization'
3462
+ | 'environmental_nonprofit'
3463
+ | 'education_nonprofit'
3464
+ | 'health_nonprofit'
3465
+ | 'animal_welfare_nonprofit'
3466
+ | 'arts_culture_nonprofit'
3467
+ | 'social_justice_nonprofit'
3468
+ | 'veterans_nonprofit'
3469
+ | 'youth_nonprofit'
3470
+ | 'disaster_relief_nonprofit'
3471
+ | 'food_bank'
3472
+ | 'housing_nonprofit'
3473
+ | 'government_agency'
3474
+ | 'public_utility'
3475
+ | 'public_library'
3476
+ | 'public_school'
3477
+ | 'municipal_service'
3478
+ | 'military_installation'
3479
+ | 'embassy_consulate'
3480
+ | 'niche_service'
3481
+ | 'niche_product'
3482
+ | 'hybrid_business'
3483
+ | 'other_general'
3484
+ | 'holding_company'
3485
+ | 'family_office'
3486
+ | 'cooperative'
3487
+ | 'social_enterprise'
3488
+ | 'incubator_accelerator'
3489
+ | 'coworking_community'
3490
+ | 'media_company'
3491
+ | 'research_lab';
1561
3492
 
1562
3493
  /**
1563
- * A statement that defines an amount due by a customer.
3494
+ * An invoice represents an itemized bill sent by a company to a customer for a
3495
+ * specific product and plan, tracking the amount owed, due date, and payment
3496
+ * status.
1564
3497
  */
1565
3498
  export interface Invoice {
1566
3499
  /**
@@ -1574,45 +3507,48 @@ export interface Invoice {
1574
3507
  created_at: string;
1575
3508
 
1576
3509
  /**
1577
- * The plan that the invoice was created for.
3510
+ * The plan that this invoice charges for.
1578
3511
  */
1579
3512
  current_plan: Invoice.CurrentPlan;
1580
3513
 
1581
3514
  /**
1582
- * The date the invoice is due.
3515
+ * The deadline by which payment is expected. Null if the invoice is collected
3516
+ * automatically.
1583
3517
  */
1584
3518
  due_date: string | null;
1585
3519
 
1586
3520
  /**
1587
- * The email address that the invoice was created for.
3521
+ * The email address of the customer this invoice is addressed to. Null if no email
3522
+ * is on file.
1588
3523
  */
1589
3524
  email_address: string | null;
1590
3525
 
1591
3526
  /**
1592
- * A signed token that allows fetching the invoice data publically without being
1593
- * authenticated.
3527
+ * A signed token that allows fetching invoice data publicly without
3528
+ * authentication.
1594
3529
  */
1595
3530
  fetch_invoice_token: string;
1596
3531
 
1597
3532
  /**
1598
- * The number of the invoice.
3533
+ * The sequential invoice number for display purposes.
1599
3534
  */
1600
3535
  number: string;
1601
3536
 
1602
3537
  /**
1603
- * The status of the invoice.
3538
+ * The current payment status of the invoice, such as draft, open, paid, or void.
1604
3539
  */
1605
3540
  status: InvoiceStatus;
1606
3541
 
1607
3542
  /**
1608
- * The user that the invoice was created for.
3543
+ * The user this invoice is addressed to. Null if the user account has been
3544
+ * removed.
1609
3545
  */
1610
3546
  user: Invoice.User | null;
1611
3547
  }
1612
3548
 
1613
3549
  export namespace Invoice {
1614
3550
  /**
1615
- * The plan that the invoice was created for.
3551
+ * The plan that this invoice charges for.
1616
3552
  */
1617
3553
  export interface CurrentPlan {
1618
3554
  /**
@@ -1621,7 +3557,8 @@ export namespace Invoice {
1621
3557
  id: string;
1622
3558
 
1623
3559
  /**
1624
- * The respective currency identifier for the plan.
3560
+ * The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
3561
+ * amounts on the plan are denominated in this currency.
1625
3562
  */
1626
3563
  currency: Shared.Currency;
1627
3564
 
@@ -1632,7 +3569,8 @@ export namespace Invoice {
1632
3569
  }
1633
3570
 
1634
3571
  /**
1635
- * The user that the invoice was created for.
3572
+ * The user this invoice is addressed to. Null if the user account has been
3573
+ * removed.
1636
3574
  */
1637
3575
  export interface User {
1638
3576
  /**
@@ -1641,19 +3579,21 @@ export namespace Invoice {
1641
3579
  id: string;
1642
3580
 
1643
3581
  /**
1644
- * The name of the user from their Whop account.
3582
+ * The user's display name shown on their public profile.
1645
3583
  */
1646
3584
  name: string | null;
1647
3585
 
1648
3586
  /**
1649
- * The username of the user from their Whop account.
3587
+ * The user's unique username shown on their public profile.
1650
3588
  */
1651
3589
  username: string;
1652
3590
  }
1653
3591
  }
1654
3592
 
1655
3593
  /**
1656
- * A statement that defines an amount due by a customer.
3594
+ * An invoice represents an itemized bill sent by a company to a customer for a
3595
+ * specific product and plan, tracking the amount owed, due date, and payment
3596
+ * status.
1657
3597
  */
1658
3598
  export interface InvoiceListItem {
1659
3599
  /**
@@ -1667,45 +3607,48 @@ export interface InvoiceListItem {
1667
3607
  created_at: string;
1668
3608
 
1669
3609
  /**
1670
- * The plan that the invoice was created for.
3610
+ * The plan that this invoice charges for.
1671
3611
  */
1672
3612
  current_plan: InvoiceListItem.CurrentPlan;
1673
3613
 
1674
3614
  /**
1675
- * The date the invoice is due.
3615
+ * The deadline by which payment is expected. Null if the invoice is collected
3616
+ * automatically.
1676
3617
  */
1677
3618
  due_date: string | null;
1678
3619
 
1679
3620
  /**
1680
- * The email address that the invoice was created for.
3621
+ * The email address of the customer this invoice is addressed to. Null if no email
3622
+ * is on file.
1681
3623
  */
1682
3624
  email_address: string | null;
1683
3625
 
1684
3626
  /**
1685
- * A signed token that allows fetching the invoice data publically without being
1686
- * authenticated.
3627
+ * A signed token that allows fetching invoice data publicly without
3628
+ * authentication.
1687
3629
  */
1688
3630
  fetch_invoice_token: string;
1689
3631
 
1690
3632
  /**
1691
- * The number of the invoice.
3633
+ * The sequential invoice number for display purposes.
1692
3634
  */
1693
3635
  number: string;
1694
3636
 
1695
3637
  /**
1696
- * The status of the invoice.
3638
+ * The current payment status of the invoice, such as draft, open, paid, or void.
1697
3639
  */
1698
3640
  status: InvoiceStatus;
1699
3641
 
1700
3642
  /**
1701
- * The user that the invoice was created for.
3643
+ * The user this invoice is addressed to. Null if the user account has been
3644
+ * removed.
1702
3645
  */
1703
3646
  user: InvoiceListItem.User | null;
1704
3647
  }
1705
3648
 
1706
3649
  export namespace InvoiceListItem {
1707
3650
  /**
1708
- * The plan that the invoice was created for.
3651
+ * The plan that this invoice charges for.
1709
3652
  */
1710
3653
  export interface CurrentPlan {
1711
3654
  /**
@@ -1714,7 +3657,8 @@ export namespace InvoiceListItem {
1714
3657
  id: string;
1715
3658
 
1716
3659
  /**
1717
- * The respective currency identifier for the plan.
3660
+ * The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
3661
+ * amounts on the plan are denominated in this currency.
1718
3662
  */
1719
3663
  currency: Shared.Currency;
1720
3664
 
@@ -1725,7 +3669,8 @@ export namespace InvoiceListItem {
1725
3669
  }
1726
3670
 
1727
3671
  /**
1728
- * The user that the invoice was created for.
3672
+ * The user this invoice is addressed to. Null if the user account has been
3673
+ * removed.
1729
3674
  */
1730
3675
  export interface User {
1731
3676
  /**
@@ -1734,12 +3679,12 @@ export namespace InvoiceListItem {
1734
3679
  id: string;
1735
3680
 
1736
3681
  /**
1737
- * The name of the user from their Whop account.
3682
+ * The user's display name shown on their public profile.
1738
3683
  */
1739
3684
  name: string | null;
1740
3685
 
1741
3686
  /**
1742
- * The username of the user from their Whop account.
3687
+ * The user's unique username shown on their public profile.
1743
3688
  */
1744
3689
  username: string;
1745
3690
  }
@@ -1748,7 +3693,7 @@ export namespace InvoiceListItem {
1748
3693
  /**
1749
3694
  * The different statuses an invoice can be in
1750
3695
  */
1751
- export type InvoiceStatus = 'open' | 'paid' | 'past_due' | 'void';
3696
+ export type InvoiceStatus = 'draft' | 'open' | 'paid' | 'past_due' | 'void';
1752
3697
 
1753
3698
  /**
1754
3699
  * The different most recent actions a member can have.
@@ -1785,8 +3730,8 @@ export interface Membership {
1785
3730
  id: string;
1786
3731
 
1787
3732
  /**
1788
- * Whether this Membership is set to cancel at the end of the current billing
1789
- * cycle. Only applies for memberships that have a renewal plan.
3733
+ * Whether this membership is set to cancel at the end of the current billing
3734
+ * cycle. Only applies to memberships with a recurring plan.
1790
3735
  */
1791
3736
  cancel_at_period_end: boolean;
1792
3737
 
@@ -1797,17 +3742,19 @@ export interface Membership {
1797
3742
  cancel_option: MembershipsAPI.CancelOptions | null;
1798
3743
 
1799
3744
  /**
1800
- * The epoch timestamp of when the customer initiated a cancellation.
3745
+ * The time the customer initiated cancellation of this membership. As a Unix
3746
+ * timestamp. Null if the membership has not been canceled.
1801
3747
  */
1802
3748
  canceled_at: string | null;
1803
3749
 
1804
3750
  /**
1805
- * The reason that the member canceled the membership (filled out by the member).
3751
+ * Free-text explanation provided by the customer when canceling. Null if the
3752
+ * customer did not provide a reason.
1806
3753
  */
1807
3754
  cancellation_reason: string | null;
1808
3755
 
1809
3756
  /**
1810
- * The Company this Membership belongs to.
3757
+ * The company this membership belongs to.
1811
3758
  */
1812
3759
  company: Membership.Company;
1813
3760
 
@@ -1822,28 +3769,32 @@ export interface Membership {
1822
3769
  currency: Currency | null;
1823
3770
 
1824
3771
  /**
1825
- * The responses to custom checkout questions for this membership.
3772
+ * The customer's responses to custom checkout questions configured on the product
3773
+ * at the time of purchase.
1826
3774
  */
1827
3775
  custom_field_responses: Array<Membership.CustomFieldResponse>;
1828
3776
 
1829
3777
  /**
1830
- * When the member joined the company.
3778
+ * The time the user first joined the company associated with this membership. As a
3779
+ * Unix timestamp. Null if the member record does not exist.
1831
3780
  */
1832
3781
  joined_at: string | null;
1833
3782
 
1834
3783
  /**
1835
- * The license key for this Membership. This is only present if the membership
1836
- * grants access to an instance of the Whop Software app.
3784
+ * The software license key associated with this membership. Only present if the
3785
+ * product includes a Whop Software Licensing experience. Null otherwise.
1837
3786
  */
1838
3787
  license_key: string | null;
1839
3788
 
1840
3789
  /**
1841
- * The URL for the customer to manage their membership.
3790
+ * The URL where the customer can view and manage this membership, including
3791
+ * cancellation and plan changes. Null if no member record exists.
1842
3792
  */
1843
3793
  manage_url: string | null;
1844
3794
 
1845
3795
  /**
1846
- * The Member that this Membership belongs to.
3796
+ * The member record linking the user to the company for this membership. Null if
3797
+ * the member record has not been created yet.
1847
3798
  */
1848
3799
  member: Membership.Member | null;
1849
3800
 
@@ -1854,39 +3805,42 @@ export interface Membership {
1854
3805
  metadata: { [key: string]: unknown };
1855
3806
 
1856
3807
  /**
1857
- * Whether the membership's payments are currently paused.
3808
+ * Whether recurring payment collection for this membership is temporarily paused
3809
+ * by the company.
1858
3810
  */
1859
3811
  payment_collection_paused: boolean;
1860
3812
 
1861
3813
  /**
1862
- * The Plan this Membership is for.
3814
+ * The plan the customer purchased to create this membership.
1863
3815
  */
1864
3816
  plan: Membership.Plan;
1865
3817
 
1866
3818
  /**
1867
- * The Product this Membership grants access to.
3819
+ * The product this membership grants access to.
1868
3820
  */
1869
3821
  product: Membership.Product;
1870
3822
 
1871
3823
  /**
1872
- * The Promo Code that is currently applied to this Membership.
3824
+ * The promotional code currently applied to this membership's billing. Null if no
3825
+ * promo code is active.
1873
3826
  */
1874
3827
  promo_code: Membership.PromoCode | null;
1875
3828
 
1876
3829
  /**
1877
- * The timestamp in seconds at which the current billing cycle for this
1878
- * subscription ends. Only applies for memberships that have a renewal plan.
3830
+ * The end of the current billing period for this recurring membership. As a Unix
3831
+ * timestamp. Null if the membership is not recurring.
1879
3832
  */
1880
3833
  renewal_period_end: string | null;
1881
3834
 
1882
3835
  /**
1883
- * The timestamp in seconds at which the current billing cycle for this
1884
- * subscription start. Only applies for memberships that have a renewal plan.
3836
+ * The start of the current billing period for this recurring membership. As a Unix
3837
+ * timestamp. Null if the membership is not recurring.
1885
3838
  */
1886
3839
  renewal_period_start: string | null;
1887
3840
 
1888
3841
  /**
1889
- * The status of the membership.
3842
+ * The current lifecycle status of the membership (e.g., active, trialing,
3843
+ * past_due, canceled, expired, completed).
1890
3844
  */
1891
3845
  status: MembershipStatus;
1892
3846
 
@@ -1896,14 +3850,14 @@ export interface Membership {
1896
3850
  updated_at: string;
1897
3851
 
1898
3852
  /**
1899
- * The user this membership belongs to
3853
+ * The user who owns this membership. Null if the user account has been deleted.
1900
3854
  */
1901
3855
  user: Membership.User | null;
1902
3856
  }
1903
3857
 
1904
3858
  export namespace Membership {
1905
3859
  /**
1906
- * The Company this Membership belongs to.
3860
+ * The company this membership belongs to.
1907
3861
  */
1908
3862
  export interface Company {
1909
3863
  /**
@@ -1912,7 +3866,7 @@ export namespace Membership {
1912
3866
  id: string;
1913
3867
 
1914
3868
  /**
1915
- * The title of the company.
3869
+ * The display name of the company shown to customers.
1916
3870
  */
1917
3871
  title: string;
1918
3872
  }
@@ -1938,7 +3892,8 @@ export namespace Membership {
1938
3892
  }
1939
3893
 
1940
3894
  /**
1941
- * The Member that this Membership belongs to.
3895
+ * The member record linking the user to the company for this membership. Null if
3896
+ * the member record has not been created yet.
1942
3897
  */
1943
3898
  export interface Member {
1944
3899
  /**
@@ -1948,7 +3903,7 @@ export namespace Membership {
1948
3903
  }
1949
3904
 
1950
3905
  /**
1951
- * The Plan this Membership is for.
3906
+ * The plan the customer purchased to create this membership.
1952
3907
  */
1953
3908
  export interface Plan {
1954
3909
  /**
@@ -1958,7 +3913,7 @@ export namespace Membership {
1958
3913
  }
1959
3914
 
1960
3915
  /**
1961
- * The Product this Membership grants access to.
3916
+ * The product this membership grants access to.
1962
3917
  */
1963
3918
  export interface Product {
1964
3919
  /**
@@ -1967,13 +3922,15 @@ export namespace Membership {
1967
3922
  id: string;
1968
3923
 
1969
3924
  /**
1970
- * The title of the product. Use for Whop 4.0.
3925
+ * The display name of the product shown to customers on the product page and in
3926
+ * search results.
1971
3927
  */
1972
3928
  title: string;
1973
3929
  }
1974
3930
 
1975
3931
  /**
1976
- * The Promo Code that is currently applied to this Membership.
3932
+ * The promotional code currently applied to this membership's billing. Null if no
3933
+ * promo code is active.
1977
3934
  */
1978
3935
  export interface PromoCode {
1979
3936
  /**
@@ -1983,7 +3940,7 @@ export namespace Membership {
1983
3940
  }
1984
3941
 
1985
3942
  /**
1986
- * The user this membership belongs to
3943
+ * The user who owns this membership. Null if the user account has been deleted.
1987
3944
  */
1988
3945
  export interface User {
1989
3946
  /**
@@ -1992,17 +3949,18 @@ export namespace Membership {
1992
3949
  id: string;
1993
3950
 
1994
3951
  /**
1995
- * The email of the user
3952
+ * The user's email address. Requires the member:email:read permission to access.
3953
+ * Null if not authorized.
1996
3954
  */
1997
3955
  email: string | null;
1998
3956
 
1999
3957
  /**
2000
- * The name of the user from their Whop account.
3958
+ * The user's display name shown on their public profile.
2001
3959
  */
2002
3960
  name: string | null;
2003
3961
 
2004
3962
  /**
2005
- * The username of the user from their Whop account.
3963
+ * The user's unique username shown on their public profile.
2006
3964
  */
2007
3965
  username: string;
2008
3966
  }
@@ -2023,7 +3981,7 @@ export type MembershipStatus =
2023
3981
  | 'canceling';
2024
3982
 
2025
3983
  /**
2026
- * Represents a message in a DM channel
3984
+ * A message sent within an experience chat, direct message, or group chat.
2027
3985
  */
2028
3986
  export interface Message {
2029
3987
  /**
@@ -2036,69 +3994,74 @@ export interface Message {
2036
3994
  id: string;
2037
3995
 
2038
3996
  /**
2039
- * The content of the message in Markdown format
3997
+ * The message content formatted as Markdown. Null if the message has no text
3998
+ * content.
2040
3999
  */
2041
4000
  content: string | null;
2042
4001
 
2043
4002
  /**
2044
- * The timestamp when the post was created
4003
+ * The timestamp when this message was originally created.
2045
4004
  */
2046
4005
  created_at: string;
2047
4006
 
2048
4007
  /**
2049
- * Whether the message has been edited
4008
+ * Whether the message content has been edited after it was originally sent.
2050
4009
  */
2051
4010
  is_edited: boolean;
2052
4011
 
2053
4012
  /**
2054
- * Whether this message is pinned
4013
+ * Whether this message is pinned to the top of the channel for easy access.
2055
4014
  */
2056
4015
  is_pinned: boolean;
2057
4016
 
2058
4017
  /**
2059
- * The type of post
4018
+ * The classification of this message: regular, system, or automated.
2060
4019
  */
2061
4020
  message_type: DmsPostTypes;
2062
4021
 
2063
4022
  /**
2064
- * The poll for this message
4023
+ * A poll attached to this message. Null if the message does not contain a poll.
2065
4024
  */
2066
4025
  poll: Message.Poll | null;
2067
4026
 
2068
4027
  /**
2069
- * The reaction counts for this message
4028
+ * Aggregated reaction counts on this message, filtered to a specific reaction
4029
+ * type.
2070
4030
  */
2071
4031
  poll_votes: Array<Message.PollVote>;
2072
4032
 
2073
4033
  /**
2074
- * The reaction counts for this message
4034
+ * Aggregated reaction counts on this message, filtered to a specific reaction
4035
+ * type.
2075
4036
  */
2076
4037
  reaction_counts: Array<Message.ReactionCount>;
2077
4038
 
2078
4039
  /**
2079
- * The ID of the message this is replying to, if applicable
4040
+ * The unique identifier of the message this post is replying to. Null if this is
4041
+ * not a reply.
2080
4042
  */
2081
4043
  replying_to_message_id: string | null;
2082
4044
 
2083
4045
  /**
2084
- * The timestamp when the post was last updated
4046
+ * The timestamp when this message was last modified.
2085
4047
  */
2086
4048
  updated_at: string;
2087
4049
 
2088
4050
  /**
2089
- * The user who sent this message
4051
+ * The user who authored this message.
2090
4052
  */
2091
4053
  user: Message.User;
2092
4054
 
2093
4055
  /**
2094
- * The number of times this message has been viewed
4056
+ * The number of unique views this message has received. Null if view tracking is
4057
+ * not enabled for this channel.
2095
4058
  */
2096
4059
  view_count: number | null;
2097
4060
  }
2098
4061
 
2099
4062
  export namespace Message {
2100
4063
  /**
2101
- * The poll for this message
4064
+ * A poll attached to this message. Null if the message does not contain a poll.
2102
4065
  */
2103
4066
  export interface Poll {
2104
4067
  /**
@@ -2155,7 +4118,7 @@ export namespace Message {
2155
4118
  }
2156
4119
 
2157
4120
  /**
2158
- * The user who sent this message
4121
+ * The user who authored this message.
2159
4122
  */
2160
4123
  export interface User {
2161
4124
  /**
@@ -2164,12 +4127,12 @@ export namespace Message {
2164
4127
  id: string;
2165
4128
 
2166
4129
  /**
2167
- * The name of the user from their Whop account.
4130
+ * The user's display name shown on their public profile.
2168
4131
  */
2169
4132
  name: string | null;
2170
4133
 
2171
4134
  /**
2172
- * The username of the user from their Whop account.
4135
+ * The user's unique username shown on their public profile.
2173
4136
  */
2174
4137
  username: string;
2175
4138
  }
@@ -2201,8 +4164,8 @@ export interface PageInfo {
2201
4164
  }
2202
4165
 
2203
4166
  /**
2204
- * A payment represents a completed or attempted charge for a membership. Payments
2205
- * track the amount, status, currency, and payment method used.
4167
+ * A payment represents a completed or attempted charge. Payments track the amount,
4168
+ * status, currency, and payment method used.
2206
4169
  */
2207
4170
  export interface Payment {
2208
4171
  /**
@@ -2241,7 +4204,8 @@ export interface Payment {
2241
4204
  card_brand: PaymentsAPI.CardBrands | null;
2242
4205
 
2243
4206
  /**
2244
- * The last 4 digits of the card used to make the payment.
4207
+ * The last four digits of the card used to make this payment. Null if the payment
4208
+ * was not made with a card.
2245
4209
  */
2246
4210
  card_last4: string | null;
2247
4211
 
@@ -2265,11 +4229,29 @@ export interface Payment {
2265
4229
  */
2266
4230
  dispute_alerted_at: string | null;
2267
4231
 
4232
+ /**
4233
+ * The disputes attached to this payment. Null if the actor in context does not
4234
+ * have the payment:dispute:read permission.
4235
+ */
4236
+ disputes: Array<Payment.Dispute> | null;
4237
+
2268
4238
  /**
2269
4239
  * If the payment failed, the reason for the failure.
2270
4240
  */
2271
4241
  failure_message: string | null;
2272
4242
 
4243
+ /**
4244
+ * The number of financing installments for the payment. Present if the payment is
4245
+ * a financing payment (e.g. Splitit, Klarna, etc.).
4246
+ */
4247
+ financing_installments_count: number | null;
4248
+
4249
+ /**
4250
+ * The financing transactions attached to this payment. Present if the payment is a
4251
+ * financing payment (e.g. Splitit, Klarna, etc.).
4252
+ */
4253
+ financing_transactions: Array<Payment.FinancingTransaction>;
4254
+
2273
4255
  /**
2274
4256
  * The time of the last payment attempt.
2275
4257
  */
@@ -2297,12 +4279,14 @@ export interface Payment {
2297
4279
  next_payment_attempt: string | null;
2298
4280
 
2299
4281
  /**
2300
- * The datetime the payment was paid
4282
+ * The time at which this payment was successfully collected. Null if the payment
4283
+ * has not yet succeeded. As a Unix timestamp.
2301
4284
  */
2302
4285
  paid_at: string | null;
2303
4286
 
2304
4287
  /**
2305
- * The payment method used for the payment, if available.
4288
+ * The tokenized payment method reference used for this payment. Null if no token
4289
+ * was used.
2306
4290
  */
2307
4291
  payment_method: Payment.PaymentMethod | null;
2308
4292
 
@@ -2347,6 +4331,13 @@ export interface Payment {
2347
4331
  */
2348
4332
  refunded_at: string | null;
2349
4333
 
4334
+ /**
4335
+ * The resolution center cases opened by the customer on this payment. Null if the
4336
+ * actor in context does not have the payment:resolution_center_case:read
4337
+ * permission.
4338
+ */
4339
+ resolutions: Array<Payment.Resolution> | null;
4340
+
2350
4341
  /**
2351
4342
  * True when the payment status is `open` and its membership is in one of the
2352
4343
  * retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
@@ -2487,6 +4478,107 @@ export namespace Payment {
2487
4478
  title: string;
2488
4479
  }
2489
4480
 
4481
+ /**
4482
+ * A dispute is a chargeback or payment challenge filed against a company,
4483
+ * including evidence and response status.
4484
+ */
4485
+ export interface Dispute {
4486
+ /**
4487
+ * The unique identifier for the dispute.
4488
+ */
4489
+ id: string;
4490
+
4491
+ /**
4492
+ * The disputed amount in the specified currency, formatted as a decimal.
4493
+ */
4494
+ amount: number;
4495
+
4496
+ /**
4497
+ * The three-letter ISO currency code for the disputed amount.
4498
+ */
4499
+ currency: Shared.Currency;
4500
+
4501
+ /**
4502
+ * Whether the dispute evidence can still be edited and submitted. Returns true
4503
+ * only when the dispute status requires a response.
4504
+ */
4505
+ editable: boolean | null;
4506
+
4507
+ /**
4508
+ * The deadline by which dispute evidence must be submitted. Null if no response
4509
+ * deadline is set.
4510
+ */
4511
+ needs_response_by: string | null;
4512
+
4513
+ /**
4514
+ * Additional freeform notes submitted by the company as part of the dispute
4515
+ * evidence.
4516
+ */
4517
+ notes: string | null;
4518
+
4519
+ /**
4520
+ * A human-readable reason for the dispute.
4521
+ */
4522
+ reason: string | null;
4523
+
4524
+ /**
4525
+ * The current status of the dispute lifecycle, such as needs_response,
4526
+ * under_review, won, or lost.
4527
+ */
4528
+ status: DisputesAPI.DisputeStatuses;
4529
+ }
4530
+
4531
+ /**
4532
+ * A payment transaction.
4533
+ */
4534
+ export interface FinancingTransaction {
4535
+ /**
4536
+ * The unique identifier for the payment transaction.
4537
+ */
4538
+ id: string;
4539
+
4540
+ /**
4541
+ * The amount of the payment transaction.
4542
+ */
4543
+ amount: number;
4544
+
4545
+ /**
4546
+ * The date and time the payment transaction was created.
4547
+ */
4548
+ created_at: string;
4549
+
4550
+ /**
4551
+ * The status of the payment transaction.
4552
+ */
4553
+ status:
4554
+ | 'succeeded'
4555
+ | 'declined'
4556
+ | 'error'
4557
+ | 'pending'
4558
+ | 'created'
4559
+ | 'expired'
4560
+ | 'won'
4561
+ | 'rejected'
4562
+ | 'lost'
4563
+ | 'prevented';
4564
+
4565
+ /**
4566
+ * The type of the payment transaction.
4567
+ */
4568
+ transaction_type:
4569
+ | 'purchase'
4570
+ | 'authorize'
4571
+ | 'capture'
4572
+ | 'refund'
4573
+ | 'cancel'
4574
+ | 'verify'
4575
+ | 'chargeback'
4576
+ | 'three_d_secure'
4577
+ | 'fraud_screening'
4578
+ | 'authorization'
4579
+ | 'installment';
4580
+ }
4581
+
2490
4582
  /**
2491
4583
  * The member attached to this payment.
2492
4584
  */
@@ -2518,7 +4610,8 @@ export namespace Payment {
2518
4610
  }
2519
4611
 
2520
4612
  /**
2521
- * The payment method used for the payment, if available.
4613
+ * The tokenized payment method reference used for this payment. Null if no token
4614
+ * was used.
2522
4615
  */
2523
4616
  export interface PaymentMethod {
2524
4617
  /**
@@ -2553,17 +4646,18 @@ export namespace Payment {
2553
4646
  brand: PaymentsAPI.CardBrands | null;
2554
4647
 
2555
4648
  /**
2556
- * Card expiration month, like 03 for March.
4649
+ * The two-digit expiration month of the card (1-12). Null if not available.
2557
4650
  */
2558
4651
  exp_month: number | null;
2559
4652
 
2560
4653
  /**
2561
- * Card expiration year, like 27 for 2027.
4654
+ * The two-digit expiration year of the card (e.g., 27 for 2027). Null if not
4655
+ * available.
2562
4656
  */
2563
4657
  exp_year: number | null;
2564
4658
 
2565
4659
  /**
2566
- * Last four digits of the card.
4660
+ * The last four digits of the card number. Null if not available.
2567
4661
  */
2568
4662
  last4: string | null;
2569
4663
  }
@@ -2589,12 +4683,14 @@ export namespace Payment {
2589
4683
  id: string;
2590
4684
 
2591
4685
  /**
2592
- * The route of the product.
4686
+ * The URL slug used in the product's public link (e.g., 'my-product' in
4687
+ * whop.com/company/my-product).
2593
4688
  */
2594
4689
  route: string;
2595
4690
 
2596
4691
  /**
2597
- * The title of the product. Use for Whop 4.0.
4692
+ * The display name of the product shown to customers on the product page and in
4693
+ * search results.
2598
4694
  */
2599
4695
  title: string;
2600
4696
  }
@@ -2636,6 +4732,75 @@ export namespace Payment {
2636
4732
  promo_type: Shared.PromoType;
2637
4733
  }
2638
4734
 
4735
+ /**
4736
+ * A resolution is a dispute or support case between a buyer and seller, tracking
4737
+ * the issue, status, and outcome.
4738
+ */
4739
+ export interface Resolution {
4740
+ /**
4741
+ * The unique identifier for the resolution.
4742
+ */
4743
+ id: string;
4744
+
4745
+ /**
4746
+ * Whether the customer has filed an appeal after the initial resolution decision.
4747
+ */
4748
+ customer_appealed: boolean;
4749
+
4750
+ /**
4751
+ * The list of actions currently available to the customer.
4752
+ */
4753
+ customer_response_actions: Array<'respond' | 'appeal' | 'withdraw'>;
4754
+
4755
+ /**
4756
+ * The deadline by which the next response is required. Null if no deadline is
4757
+ * currently active. As a Unix timestamp.
4758
+ */
4759
+ due_date: string | null;
4760
+
4761
+ /**
4762
+ * The category of the dispute.
4763
+ */
4764
+ issue:
4765
+ | 'forgot_to_cancel'
4766
+ | 'item_not_received'
4767
+ | 'significantly_not_as_described'
4768
+ | 'unauthorized_transaction'
4769
+ | 'product_unacceptable';
4770
+
4771
+ /**
4772
+ * Whether the merchant has filed an appeal after the initial resolution decision.
4773
+ */
4774
+ merchant_appealed: boolean;
4775
+
4776
+ /**
4777
+ * The list of actions currently available to the merchant.
4778
+ */
4779
+ merchant_response_actions: Array<'accept' | 'deny' | 'request_more_info' | 'appeal' | 'respond'>;
4780
+
4781
+ /**
4782
+ * The list of actions currently available to the Whop platform for moderating this
4783
+ * resolution.
4784
+ */
4785
+ platform_response_actions: Array<
4786
+ 'request_buyer_info' | 'request_merchant_info' | 'merchant_wins' | 'platform_refund' | 'merchant_refund'
4787
+ >;
4788
+
4789
+ /**
4790
+ * The current status of the resolution case, indicating which party needs to
4791
+ * respond or if the case is closed.
4792
+ */
4793
+ status:
4794
+ | 'merchant_response_needed'
4795
+ | 'customer_response_needed'
4796
+ | 'merchant_info_needed'
4797
+ | 'customer_info_needed'
4798
+ | 'under_platform_review'
4799
+ | 'customer_won'
4800
+ | 'merchant_won'
4801
+ | 'customer_withdrew';
4802
+ }
4803
+
2639
4804
  /**
2640
4805
  * The user that made this payment.
2641
4806
  */
@@ -2646,26 +4811,27 @@ export namespace Payment {
2646
4811
  id: string;
2647
4812
 
2648
4813
  /**
2649
- * The email of the user
4814
+ * The user's email address. Requires the member:email:read permission to access.
4815
+ * Null if not authorized.
2650
4816
  */
2651
4817
  email: string | null;
2652
4818
 
2653
4819
  /**
2654
- * The name of the user from their Whop account.
4820
+ * The user's display name shown on their public profile.
2655
4821
  */
2656
4822
  name: string | null;
2657
4823
 
2658
4824
  /**
2659
- * The username of the user from their Whop account.
4825
+ * The user's unique username shown on their public profile.
2660
4826
  */
2661
4827
  username: string;
2662
4828
  }
2663
4829
  }
2664
4830
 
2665
4831
  /**
2666
- * A plan defines pricing and billing terms for a product. Each product can have
2667
- * multiple plans representing different pricing options, such as one-time
2668
- * payments, recurring subscriptions, or free trials.
4832
+ * A plan defines pricing and billing terms for a checkout. Plans can optionally
4833
+ * belong to a product, where they represent different pricing options such as
4834
+ * one-time payments, recurring subscriptions, or free trials.
2669
4835
  */
2670
4836
  export interface Plan {
2671
4837
  /**
@@ -2674,17 +4840,20 @@ export interface Plan {
2674
4840
  id: string;
2675
4841
 
2676
4842
  /**
2677
- * The interval in days at which the plan charges (renewal plans).
4843
+ * The number of days between each recurring charge. Null for one-time plans. For
4844
+ * example, 30 for monthly or 365 for annual billing.
2678
4845
  */
2679
4846
  billing_period: number | null;
2680
4847
 
2681
4848
  /**
2682
- * Whether or not the plan collects tax.
4849
+ * Whether tax is collected on purchases of this plan, based on the company's tax
4850
+ * configuration.
2683
4851
  */
2684
4852
  collect_tax: boolean;
2685
4853
 
2686
4854
  /**
2687
- * The company for the plan.
4855
+ * The company that sells this plan. Null for standalone invoice plans not linked
4856
+ * to a company.
2688
4857
  */
2689
4858
  company: Plan.Company | null;
2690
4859
 
@@ -2694,17 +4863,20 @@ export interface Plan {
2694
4863
  created_at: string;
2695
4864
 
2696
4865
  /**
2697
- * The respective currency identifier for the plan.
4866
+ * The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
4867
+ * amounts on the plan are denominated in this currency.
2698
4868
  */
2699
4869
  currency: Currency;
2700
4870
 
2701
4871
  /**
2702
- * The custom fields for the plan.
4872
+ * Custom input fields displayed on the checkout form that collect additional
4873
+ * information from the buyer.
2703
4874
  */
2704
4875
  custom_fields: Array<Plan.CustomField>;
2705
4876
 
2706
4877
  /**
2707
- * The description of the plan.
4878
+ * A text description of the plan visible to customers. Maximum 500 characters.
4879
+ * Null if no description is set.
2708
4880
  */
2709
4881
  description: string | null;
2710
4882
 
@@ -2722,42 +4894,50 @@ export interface Plan {
2722
4894
  initial_price: number;
2723
4895
 
2724
4896
  /**
2725
- * A personal description or notes section for the business.
4897
+ * Private notes visible only to the company owner and team members. Not shown to
4898
+ * customers. Null if no notes have been added.
2726
4899
  */
2727
4900
  internal_notes: string | null;
2728
4901
 
2729
4902
  /**
2730
- * The invoice associated with this plan.
4903
+ * The invoice this plan was generated for. Null if the plan was not created for a
4904
+ * specific invoice.
2731
4905
  */
2732
4906
  invoice: Plan.Invoice | null;
2733
4907
 
2734
4908
  /**
2735
- * The number of members for the plan.
4909
+ * The number of users who currently hold an active membership through this plan.
4910
+ * Only visible to authorized team members.
2736
4911
  */
2737
4912
  member_count: number | null;
2738
4913
 
2739
4914
  /**
2740
- * The explicit payment method configuration for the plan, if any.
4915
+ * The explicit payment method configuration specifying which payment methods are
4916
+ * enabled or disabled for this plan. Null if the plan uses default settings.
2741
4917
  */
2742
4918
  payment_method_configuration: Plan.PaymentMethodConfiguration | null;
2743
4919
 
2744
4920
  /**
2745
- * Indicates if the plan is a one time payment or recurring.
4921
+ * The billing model for this plan: 'renewal' for recurring subscriptions or
4922
+ * 'one_time' for single payments.
2746
4923
  */
2747
4924
  plan_type: PlanType;
2748
4925
 
2749
4926
  /**
2750
- * The product that this plan belongs to.
4927
+ * The product that this plan belongs to. Null for standalone one-off purchases not
4928
+ * linked to a product.
2751
4929
  */
2752
4930
  product: Plan.Product | null;
2753
4931
 
2754
4932
  /**
2755
- * The direct link to purchase the product.
4933
+ * The full URL where customers can purchase this plan directly, bypassing the
4934
+ * product page.
2756
4935
  */
2757
4936
  purchase_url: string;
2758
4937
 
2759
4938
  /**
2760
- * This is the release method the business uses to sell this plan.
4939
+ * The method used to sell this plan: 'buy_now' for immediate purchase or
4940
+ * 'waitlist' for waitlist-based access.
2761
4941
  */
2762
4942
  release_method: ReleaseMethod;
2763
4943
 
@@ -2768,27 +4948,33 @@ export interface Plan {
2768
4948
  renewal_price: number;
2769
4949
 
2770
4950
  /**
2771
- * The number of payments required before pausing the subscription.
4951
+ * The total number of installment payments required before the subscription
4952
+ * pauses. Null if split pay is not configured. Must be greater than 1.
2772
4953
  */
2773
4954
  split_pay_required_payments: number | null;
2774
4955
 
2775
4956
  /**
2776
- * The number of units available for purchase. Only displayed to authorized actors
4957
+ * The number of units available for purchase. Only visible to authorized team
4958
+ * members. Null if the requester lacks permission.
2777
4959
  */
2778
4960
  stock: number | null;
2779
4961
 
2780
4962
  /**
2781
- * The tax type for the plan.
4963
+ * How tax is handled for this plan: 'inclusive' (tax included in price),
4964
+ * 'exclusive' (tax added at checkout), or 'unspecified' (tax not configured).
2782
4965
  */
2783
4966
  tax_type: TaxType;
2784
4967
 
2785
4968
  /**
2786
- * The title of the plan. This will be visible on the product page to customers.
4969
+ * The display name of the plan shown to customers on the product page and at
4970
+ * checkout. Maximum 30 characters. Null if no title has been set.
2787
4971
  */
2788
4972
  title: string | null;
2789
4973
 
2790
4974
  /**
2791
- * The number of free trial days added before a renewal plan.
4975
+ * The number of free trial days before the first charge on a renewal plan. Null if
4976
+ * no trial is configured or the current user has already used a trial for this
4977
+ * plan.
2792
4978
  */
2793
4979
  trial_period_days: number | null;
2794
4980
 
@@ -2804,14 +4990,16 @@ export interface Plan {
2804
4990
  updated_at: string;
2805
4991
 
2806
4992
  /**
2807
- * Shows or hides the plan from public/business view.
4993
+ * Controls whether the plan is visible to customers. When set to 'hidden', the
4994
+ * plan is only accessible via direct link.
2808
4995
  */
2809
4996
  visibility: Visibility;
2810
4997
  }
2811
4998
 
2812
4999
  export namespace Plan {
2813
5000
  /**
2814
- * The company for the plan.
5001
+ * The company that sells this plan. Null for standalone invoice plans not linked
5002
+ * to a company.
2815
5003
  */
2816
5004
  export interface Company {
2817
5005
  /**
@@ -2820,7 +5008,7 @@ export namespace Plan {
2820
5008
  id: string;
2821
5009
 
2822
5010
  /**
2823
- * The title of the company.
5011
+ * The display name of the company shown to customers.
2824
5012
  */
2825
5013
  title: string;
2826
5014
  }
@@ -2861,7 +5049,8 @@ export namespace Plan {
2861
5049
  }
2862
5050
 
2863
5051
  /**
2864
- * The invoice associated with this plan.
5052
+ * The invoice this plan was generated for. Null if the plan was not created for a
5053
+ * specific invoice.
2865
5054
  */
2866
5055
  export interface Invoice {
2867
5056
  /**
@@ -2871,7 +5060,8 @@ export namespace Plan {
2871
5060
  }
2872
5061
 
2873
5062
  /**
2874
- * The explicit payment method configuration for the plan, if any.
5063
+ * The explicit payment method configuration specifying which payment methods are
5064
+ * enabled or disabled for this plan. Null if the plan uses default settings.
2875
5065
  */
2876
5066
  export interface PaymentMethodConfiguration {
2877
5067
  /**
@@ -2897,7 +5087,8 @@ export namespace Plan {
2897
5087
  }
2898
5088
 
2899
5089
  /**
2900
- * The product that this plan belongs to.
5090
+ * The product that this plan belongs to. Null for standalone one-off purchases not
5091
+ * linked to a product.
2901
5092
  */
2902
5093
  export interface Product {
2903
5094
  /**
@@ -2906,7 +5097,8 @@ export namespace Plan {
2906
5097
  id: string;
2907
5098
 
2908
5099
  /**
2909
- * The title of the product. Use for Whop 4.0.
5100
+ * The display name of the product shown to customers on the product page and in
5101
+ * search results.
2910
5102
  */
2911
5103
  title: string;
2912
5104
  }
@@ -2933,7 +5125,7 @@ export interface Product {
2933
5125
  business_type: BusinessTypes | null;
2934
5126
 
2935
5127
  /**
2936
- * A short type of the company that this product belongs to.
5128
+ * The company this product belongs to.
2937
5129
  */
2938
5130
  company: Product.Company;
2939
5131
 
@@ -2943,45 +5135,56 @@ export interface Product {
2943
5135
  created_at: string;
2944
5136
 
2945
5137
  /**
2946
- * The custom call to action for the product.
5138
+ * The call-to-action button label displayed on the product's purchase page (e.g.,
5139
+ * 'join', 'buy', 'subscribe').
2947
5140
  */
2948
5141
  custom_cta: CustomCta;
2949
5142
 
2950
5143
  /**
2951
- * The custom call to action URL for the product, if any.
5144
+ * An optional URL that the call-to-action button links to instead of the default
5145
+ * checkout flow. Null if no custom URL is set.
2952
5146
  */
2953
5147
  custom_cta_url: string | null;
2954
5148
 
2955
5149
  /**
2956
- * The custom statement descriptor for the product.
5150
+ * A custom text label that appears on the customer's bank or credit card statement
5151
+ * for purchases of this product. Maximum 22 characters, including the required
5152
+ * prefix WHOP\*.
2957
5153
  */
2958
5154
  custom_statement_descriptor: string | null;
2959
5155
 
2960
5156
  /**
2961
- * A short description of what the company offers or does.
5157
+ * A brief summary of what the product offers, displayed on product pages and
5158
+ * search results.
2962
5159
  */
2963
5160
  description: string | null;
2964
5161
 
2965
5162
  /**
2966
- * A unique identifier used to create or update products. When provided on product
2967
- * creation endpoints, we’ll look up an existing product by this identifier if it
2968
- * exists, we’ll update it; if not, we’ll create a new one.
5163
+ * A unique identifier used to create or update products via the API. When provided
5164
+ * on product creation endpoints, an existing product with this identifier will be
5165
+ * updated instead of creating a new one.
2969
5166
  */
2970
5167
  external_identifier: string | null;
2971
5168
 
2972
5169
  /**
2973
- * The percentage of a transaction a user is eligible to earn from the whop
2974
- * marketplace global affiliate program.
5170
+ * The gallery images for this product, ordered by position.
5171
+ */
5172
+ gallery_images: Array<Product.GalleryImage>;
5173
+
5174
+ /**
5175
+ * The commission rate (as a percentage) that affiliates earn on sales through the
5176
+ * Whop marketplace global affiliate program. Null if the program is not active.
2975
5177
  */
2976
5178
  global_affiliate_percentage: number | null;
2977
5179
 
2978
5180
  /**
2979
- * The status of the global affiliate program for this product.
5181
+ * The enrollment status of this product in the Whop marketplace global affiliate
5182
+ * program.
2980
5183
  */
2981
5184
  global_affiliate_status: GlobalAffiliateStatus;
2982
5185
 
2983
5186
  /**
2984
- * The headline of the product.
5187
+ * A short marketing headline displayed prominently on the product's product page.
2985
5188
  */
2986
5189
  headline: string | null;
2987
5190
 
@@ -2991,43 +5194,48 @@ export interface Product {
2991
5194
  industry_type: IndustryTypes | null;
2992
5195
 
2993
5196
  /**
2994
- * The percentage of a transaction a user is eligible to earn from the whop
2995
- * marketplace member affiliate program.
5197
+ * The commission rate (as a percentage) that existing members earn when referring
5198
+ * new customers through the member affiliate program. Null if the program is not
5199
+ * active.
2996
5200
  */
2997
5201
  member_affiliate_percentage: number | null;
2998
5202
 
2999
5203
  /**
3000
- * The status of the member affiliate program for this product.
5204
+ * The enrollment status of this product in the member affiliate program.
3001
5205
  */
3002
5206
  member_affiliate_status: GlobalAffiliateStatus;
3003
5207
 
3004
5208
  /**
3005
- * The number of active users for this product.
5209
+ * The number of users who currently hold an active membership to this product.
5210
+ * Returns 0 if the company has disabled public member counts.
3006
5211
  */
3007
5212
  member_count: number;
3008
5213
 
3009
5214
  /**
3010
- * The user that owns the product (company owner).
5215
+ * The user who owns the company that sells this product.
3011
5216
  */
3012
5217
  owner_user: Product.OwnerUser;
3013
5218
 
3014
5219
  /**
3015
- * The product tax code for the product, if any.
5220
+ * The tax classification code applied to purchases of this product for sales tax
5221
+ * calculation. Null if no tax code is assigned.
3016
5222
  */
3017
5223
  product_tax_code: Product.ProductTaxCode | null;
3018
5224
 
3019
5225
  /**
3020
- * The number of reviews that have been published for the product.
5226
+ * The total number of published customer reviews for this product's company.
3021
5227
  */
3022
5228
  published_reviews_count: number;
3023
5229
 
3024
5230
  /**
3025
- * The route of the product.
5231
+ * The URL slug used in the product's public link (e.g., 'my-product' in
5232
+ * whop.com/company/my-product).
3026
5233
  */
3027
5234
  route: string;
3028
5235
 
3029
5236
  /**
3030
- * The title of the product. Use for Whop 4.0.
5237
+ * The display name of the product shown to customers on the product page and in
5238
+ * search results.
3031
5239
  */
3032
5240
  title: string;
3033
5241
 
@@ -3037,19 +5245,20 @@ export interface Product {
3037
5245
  updated_at: string;
3038
5246
 
3039
5247
  /**
3040
- * Whether this product is Whop verified.
5248
+ * Whether this company has been verified by Whop's trust and safety team.
3041
5249
  */
3042
5250
  verified: boolean;
3043
5251
 
3044
5252
  /**
3045
- * This product will/will not be displayed publicly.
5253
+ * Controls whether the product is visible to customers. When set to 'hidden', the
5254
+ * product is only accessible via direct link.
3046
5255
  */
3047
5256
  visibility: Visibility;
3048
5257
  }
3049
5258
 
3050
5259
  export namespace Product {
3051
5260
  /**
3052
- * A short type of the company that this product belongs to.
5261
+ * The company this product belongs to.
3053
5262
  */
3054
5263
  export interface Company {
3055
5264
  /**
@@ -3058,18 +5267,38 @@ export namespace Product {
3058
5267
  id: string;
3059
5268
 
3060
5269
  /**
3061
- * The slug/route of the company on the Whop site.
5270
+ * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
3062
5271
  */
3063
5272
  route: string;
3064
5273
 
3065
5274
  /**
3066
- * The title of the company.
5275
+ * The display name of the company shown to customers.
3067
5276
  */
3068
5277
  title: string;
3069
5278
  }
3070
5279
 
3071
5280
  /**
3072
- * The user that owns the product (company owner).
5281
+ * Represents an image attachment
5282
+ */
5283
+ export interface GalleryImage {
5284
+ /**
5285
+ * Represents a unique identifier that is Base64 obfuscated. It is often used to
5286
+ * refetch an object or as key for a cache. The ID type appears in a JSON response
5287
+ * as a String; however, it is not intended to be human-readable. When expected as
5288
+ * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
5289
+ * input value will be accepted as an ID.
5290
+ */
5291
+ id: string;
5292
+
5293
+ /**
5294
+ * A pre-optimized URL for rendering this attachment on the client. This should be
5295
+ * used for displaying attachments in apps.
5296
+ */
5297
+ url: string | null;
5298
+ }
5299
+
5300
+ /**
5301
+ * The user who owns the company that sells this product.
3073
5302
  */
3074
5303
  export interface OwnerUser {
3075
5304
  /**
@@ -3078,18 +5307,19 @@ export namespace Product {
3078
5307
  id: string;
3079
5308
 
3080
5309
  /**
3081
- * The name of the user from their Whop account.
5310
+ * The user's display name shown on their public profile.
3082
5311
  */
3083
5312
  name: string | null;
3084
5313
 
3085
5314
  /**
3086
- * The username of the user from their Whop account.
5315
+ * The user's unique username shown on their public profile.
3087
5316
  */
3088
5317
  username: string;
3089
5318
  }
3090
5319
 
3091
5320
  /**
3092
- * The product tax code for the product, if any.
5321
+ * The tax classification code applied to purchases of this product for sales tax
5322
+ * calculation. Null if no tax code is assigned.
3093
5323
  */
3094
5324
  export interface ProductTaxCode {
3095
5325
  /**
@@ -3098,12 +5328,13 @@ export namespace Product {
3098
5328
  id: string;
3099
5329
 
3100
5330
  /**
3101
- * The name of the product tax code.
5331
+ * The human-readable name of this tax classification (e.g., 'Digital - SaaS').
3102
5332
  */
3103
5333
  name: string;
3104
5334
 
3105
5335
  /**
3106
- * The type of product this tax code applies to.
5336
+ * The broad product category this tax code covers (e.g., physical goods, digital
5337
+ * services).
3107
5338
  */
3108
5339
  product_type: 'physical' | 'digital' | 'services';
3109
5340
  }
@@ -3130,14 +5361,14 @@ export interface ProductListItem {
3130
5361
  created_at: string;
3131
5362
 
3132
5363
  /**
3133
- * A unique identifier used to create or update products. When provided on product
3134
- * creation endpoints, we’ll look up an existing product by this identifier if it
3135
- * exists, we’ll update it; if not, we’ll create a new one.
5364
+ * A unique identifier used to create or update products via the API. When provided
5365
+ * on product creation endpoints, an existing product with this identifier will be
5366
+ * updated instead of creating a new one.
3136
5367
  */
3137
5368
  external_identifier: string | null;
3138
5369
 
3139
5370
  /**
3140
- * The headline of the product.
5371
+ * A short marketing headline displayed prominently on the product's product page.
3141
5372
  */
3142
5373
  headline: string | null;
3143
5374
 
@@ -3147,22 +5378,25 @@ export interface ProductListItem {
3147
5378
  industry_type: IndustryTypes | null;
3148
5379
 
3149
5380
  /**
3150
- * The number of active users for this product.
5381
+ * The number of users who currently hold an active membership to this product.
5382
+ * Returns 0 if the company has disabled public member counts.
3151
5383
  */
3152
5384
  member_count: number;
3153
5385
 
3154
5386
  /**
3155
- * The number of reviews that have been published for the product.
5387
+ * The total number of published customer reviews for this product's company.
3156
5388
  */
3157
5389
  published_reviews_count: number;
3158
5390
 
3159
5391
  /**
3160
- * The route of the product.
5392
+ * The URL slug used in the product's public link (e.g., 'my-product' in
5393
+ * whop.com/company/my-product).
3161
5394
  */
3162
5395
  route: string;
3163
5396
 
3164
5397
  /**
3165
- * The title of the product. Use for Whop 4.0.
5398
+ * The display name of the product shown to customers on the product page and in
5399
+ * search results.
3166
5400
  */
3167
5401
  title: string;
3168
5402
 
@@ -3172,12 +5406,13 @@ export interface ProductListItem {
3172
5406
  updated_at: string;
3173
5407
 
3174
5408
  /**
3175
- * Whether this product is Whop verified.
5409
+ * Whether this company has been verified by Whop's trust and safety team.
3176
5410
  */
3177
5411
  verified: boolean;
3178
5412
 
3179
5413
  /**
3180
- * This product will/will not be displayed publicly.
5414
+ * Controls whether the product is visible to customers. When set to 'hidden', the
5415
+ * product is only accessible via direct link.
3181
5416
  */
3182
5417
  visibility: Visibility;
3183
5418
  }
@@ -3188,7 +5423,7 @@ export interface ProductListItem {
3188
5423
  export type PromoType = 'percentage' | 'flat_amount';
3189
5424
 
3190
5425
  /**
3191
- * Represents a reaction to a feed post
5426
+ * A single reaction left by a user on a feed post, such as a like or emoji.
3192
5427
  */
3193
5428
  export interface Reaction {
3194
5429
  /**
@@ -3197,24 +5432,25 @@ export interface Reaction {
3197
5432
  id: string;
3198
5433
 
3199
5434
  /**
3200
- * The emoji that was used in shortcode format (:heart:)
5435
+ * The emoji used for this reaction in shortcode format. Null if the reaction type
5436
+ * is not emoji.
3201
5437
  */
3202
5438
  emoji: string | null;
3203
5439
 
3204
5440
  /**
3205
- * The ID of the post this reaction belongs to
5441
+ * The unique identifier of the post this reaction was left on.
3206
5442
  */
3207
5443
  resource_id: string;
3208
5444
 
3209
5445
  /**
3210
- * The user who reacted to the post
5446
+ * The user who left this reaction on the post.
3211
5447
  */
3212
5448
  user: Reaction.User;
3213
5449
  }
3214
5450
 
3215
5451
  export namespace Reaction {
3216
5452
  /**
3217
- * The user who reacted to the post
5453
+ * The user who left this reaction on the post.
3218
5454
  */
3219
5455
  export interface User {
3220
5456
  /**
@@ -3223,12 +5459,12 @@ export namespace Reaction {
3223
5459
  id: string;
3224
5460
 
3225
5461
  /**
3226
- * The name of the user from their Whop account.
5462
+ * The user's display name shown on their public profile.
3227
5463
  */
3228
5464
  name: string | null;
3229
5465
 
3230
5466
  /**
3231
- * The username of the user from their Whop account.
5467
+ * The user's unique username shown on their public profile.
3232
5468
  */
3233
5469
  username: string;
3234
5470
  }
@@ -3245,7 +5481,8 @@ export type ReceiptStatus = 'draft' | 'open' | 'paid' | 'pending' | 'uncollectib
3245
5481
  export type ReleaseMethod = 'buy_now' | 'waitlist';
3246
5482
 
3247
5483
  /**
3248
- * A shipment
5484
+ * A physical shipment associated with a payment, including carrier details and
5485
+ * tracking information.
3249
5486
  */
3250
5487
  export interface Shipment {
3251
5488
  /**
@@ -3254,7 +5491,7 @@ export interface Shipment {
3254
5491
  id: string;
3255
5492
 
3256
5493
  /**
3257
- * The carrier of the shipment
5494
+ * The shipping carrier responsible for delivering this shipment.
3258
5495
  */
3259
5496
  carrier: ShipmentCarrier;
3260
5497
 
@@ -3264,22 +5501,25 @@ export interface Shipment {
3264
5501
  created_at: string;
3265
5502
 
3266
5503
  /**
3267
- * The delivery estimate of the shipment
5504
+ * The estimated delivery date for this shipment. Null if the carrier has not
5505
+ * provided an estimate.
3268
5506
  */
3269
5507
  delivery_estimate: string | null;
3270
5508
 
3271
5509
  /**
3272
- * The payment of the shipment
5510
+ * The payment associated with this shipment. Null if the payment has been deleted
5511
+ * or is inaccessible.
3273
5512
  */
3274
5513
  payment: Shipment.Payment | null;
3275
5514
 
3276
5515
  /**
3277
- * The service of the shipment
5516
+ * The shipping service level used for this shipment. Null if the carrier does not
5517
+ * specify a service tier.
3278
5518
  */
3279
5519
  service: string | null;
3280
5520
 
3281
5521
  /**
3282
- * The status of the shipment
5522
+ * The current delivery status of this shipment.
3283
5523
  */
3284
5524
  status: ShipmentStatus;
3285
5525
 
@@ -3289,7 +5529,7 @@ export interface Shipment {
3289
5529
  substatus: ShipmentSubstatus | null;
3290
5530
 
3291
5531
  /**
3292
- * The tracking code of the shipment
5532
+ * The carrier-assigned tracking number used to look up shipment progress.
3293
5533
  */
3294
5534
  tracking_code: string;
3295
5535
 
@@ -3301,7 +5541,8 @@ export interface Shipment {
3301
5541
 
3302
5542
  export namespace Shipment {
3303
5543
  /**
3304
- * The payment of the shipment
5544
+ * The payment associated with this shipment. Null if the payment has been deleted
5545
+ * or is inaccessible.
3305
5546
  */
3306
5547
  export interface Payment {
3307
5548
  /**
@@ -3441,7 +5682,8 @@ export type ShipmentSubstatus =
3441
5682
  | 'weather_delay';
3442
5683
 
3443
5684
  /**
3444
- * Represents a DM channel
5685
+ * A messaging channel that can be a one-on-one DM, group chat, company support
5686
+ * conversation, or platform-level direct message.
3445
5687
  */
3446
5688
  export interface SupportChannel {
3447
5689
  /**
@@ -3450,34 +5692,40 @@ export interface SupportChannel {
3450
5692
  id: string;
3451
5693
 
3452
5694
  /**
3453
- * The bot ID if this is a support chat
5695
+ * The unique identifier of the company associated with this channel. Null if this
5696
+ * is not a support or company-scoped conversation.
3454
5697
  */
3455
5698
  company_id: string | null;
3456
5699
 
3457
5700
  /**
3458
- * The custom name of the DM channel, if any
5701
+ * A custom display name assigned to this channel by the user. Null if no custom
5702
+ * name has been set.
3459
5703
  */
3460
5704
  custom_name: string | null;
3461
5705
 
3462
5706
  /**
3463
- * The customer user if this is a support chat
5707
+ * The customer who initiated this support conversation. Null if this is not a
5708
+ * support chat.
3464
5709
  */
3465
5710
  customer_user: SupportChannel.CustomerUser | null;
3466
5711
 
3467
5712
  /**
3468
- * When the last message was sent
5713
+ * The timestamp when the most recent message was sent in this channel. Null if no
5714
+ * messages have been sent.
3469
5715
  */
3470
5716
  last_message_at: string | null;
3471
5717
 
3472
5718
  /**
3473
- * When the support ticket was resolved (null if unresolved)
5719
+ * The timestamp when the linked support ticket was marked as resolved. Null if
5720
+ * unresolved or not a support chat.
3474
5721
  */
3475
5722
  resolved_at: string | null;
3476
5723
  }
3477
5724
 
3478
5725
  export namespace SupportChannel {
3479
5726
  /**
3480
- * The customer user if this is a support chat
5727
+ * The customer who initiated this support conversation. Null if this is not a
5728
+ * support chat.
3481
5729
  */
3482
5730
  export interface CustomerUser {
3483
5731
  /**
@@ -3486,12 +5734,12 @@ export namespace SupportChannel {
3486
5734
  id: string;
3487
5735
 
3488
5736
  /**
3489
- * The name of the user from their Whop account.
5737
+ * The user's display name shown on their public profile.
3490
5738
  */
3491
5739
  name: string | null;
3492
5740
 
3493
5741
  /**
3494
- * The username of the user from their Whop account.
5742
+ * The user's unique username shown on their public profile.
3495
5743
  */
3496
5744
  username: string;
3497
5745
  }
@@ -3504,7 +5752,7 @@ export namespace SupportChannel {
3504
5752
  export type TaxType = 'inclusive' | 'exclusive' | 'unspecified';
3505
5753
 
3506
5754
  /**
3507
- * Credit Transaction Transfer
5755
+ * A transfer of credit between two ledger accounts.
3508
5756
  */
3509
5757
  export interface Transfer {
3510
5758
  /**
@@ -3513,8 +5761,8 @@ export interface Transfer {
3513
5761
  id: string;
3514
5762
 
3515
5763
  /**
3516
- * The amount of the transfer. Provided as a number in the specified currency. Eg:
3517
- * 10.43 for $10.43 USD.
5764
+ * The transfer amount in the currency specified by the currency field. For
5765
+ * example, 10.43 represents $10.43 USD.
3518
5766
  */
3519
5767
  amount: number;
3520
5768
 
@@ -3524,43 +5772,45 @@ export interface Transfer {
3524
5772
  created_at: string;
3525
5773
 
3526
5774
  /**
3527
- * The currency of the credit transaction transfer
5775
+ * The currency in which this transfer amount is denominated.
3528
5776
  */
3529
5777
  currency: Currency;
3530
5778
 
3531
5779
  /**
3532
- * The recipient of the credit transaction transfer
5780
+ * The entity receiving the transferred funds.
3533
5781
  */
3534
5782
  destination: Transfer.User | null | Transfer.Company | null;
3535
5783
 
3536
5784
  /**
3537
- * The ID of the destination ledger account
5785
+ * The unique identifier of the ledger account receiving the funds.
3538
5786
  */
3539
5787
  destination_ledger_account_id: string;
3540
5788
 
3541
5789
  /**
3542
- * The decimal fee of the credit transaction transfer
5790
+ * The flat fee amount deducted from this transfer, in the transfer's currency.
5791
+ * Null if no flat fee was applied.
3543
5792
  */
3544
5793
  fee_amount: number | null;
3545
5794
 
3546
5795
  /**
3547
- * Custom key-value pairs attached to the transfer. Max 50 keys, 500 chars per key,
3548
- * 5000 chars per value.
5796
+ * Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
5797
+ * characters per key, 5000 characters per value.
3549
5798
  */
3550
5799
  metadata: { [key: string]: unknown } | null;
3551
5800
 
3552
5801
  /**
3553
- * The notes of the credit transaction transfer
5802
+ * A free-text note attached to this transfer by the sender. Null if no note was
5803
+ * provided.
3554
5804
  */
3555
5805
  notes: string | null;
3556
5806
 
3557
5807
  /**
3558
- * The sender of the credit transaction transfer
5808
+ * The entity that sent the transferred funds.
3559
5809
  */
3560
5810
  origin: Transfer.User | null | Transfer.Company | null;
3561
5811
 
3562
5812
  /**
3563
- * The ID of the origin ledger account
5813
+ * The unique identifier of the ledger account that sent the funds.
3564
5814
  */
3565
5815
  origin_ledger_account_id: string;
3566
5816
  }
@@ -3577,7 +5827,7 @@ export namespace Transfer {
3577
5827
  id: string;
3578
5828
 
3579
5829
  /**
3580
- * The name of the user from their Whop account.
5830
+ * The user's display name shown on their public profile.
3581
5831
  */
3582
5832
  name: string | null;
3583
5833
 
@@ -3587,7 +5837,7 @@ export namespace Transfer {
3587
5837
  typename: 'User';
3588
5838
 
3589
5839
  /**
3590
- * The username of the user from their Whop account.
5840
+ * The user's unique username shown on their public profile.
3591
5841
  */
3592
5842
  username: string;
3593
5843
  }
@@ -3603,12 +5853,12 @@ export namespace Transfer {
3603
5853
  id: string;
3604
5854
 
3605
5855
  /**
3606
- * The slug/route of the company on the Whop site.
5856
+ * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
3607
5857
  */
3608
5858
  route: string;
3609
5859
 
3610
5860
  /**
3611
- * The title of the company.
5861
+ * The display name of the company shown to customers.
3612
5862
  */
3613
5863
  title: string;
3614
5864
 
@@ -3629,7 +5879,7 @@ export namespace Transfer {
3629
5879
  id: string;
3630
5880
 
3631
5881
  /**
3632
- * The name of the user from their Whop account.
5882
+ * The user's display name shown on their public profile.
3633
5883
  */
3634
5884
  name: string | null;
3635
5885
 
@@ -3639,7 +5889,7 @@ export namespace Transfer {
3639
5889
  typename: 'User';
3640
5890
 
3641
5891
  /**
3642
- * The username of the user from their Whop account.
5892
+ * The user's unique username shown on their public profile.
3643
5893
  */
3644
5894
  username: string;
3645
5895
  }
@@ -3655,12 +5905,12 @@ export namespace Transfer {
3655
5905
  id: string;
3656
5906
 
3657
5907
  /**
3658
- * The slug/route of the company on the Whop site.
5908
+ * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
3659
5909
  */
3660
5910
  route: string;
3661
5911
 
3662
5912
  /**
3663
- * The title of the company.
5913
+ * The display name of the company shown to customers.
3664
5914
  */
3665
5915
  title: string;
3666
5916