Membership
Documentation Index
Fetch the complete documentation index at: https://docs.whop.com/llms.txt
Use this file to discover all available pages before exploring further.
A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule.
Whether this membership is set to cancel at the end of the current billing cycle. Only applies to memberships with a recurring plan.
The category selected for why the member canceled (e.g. too_expensive, switching, missing_features).
too_expensive, switching, missing_features, technical_issues, bad_experience, other, testing The time the customer initiated cancellation of this membership. As a Unix timestamp. Null if the membership has not been canceled.
"2023-12-01T05:00:00.401Z"
Free-text explanation provided by the customer when canceling. Null if the customer did not provide a reason.
"I found a better alternative."
The ID of the checkout session/configuration that produced this membership, if any. Use this to map memberships back to the checkout configuration that created them.
The company this membership belongs to.
The datetime the membership was created.
"2023-12-01T05:00:00.401Z"
The three-letter ISO currency code for this membership's billing. Null if the membership is free.
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau The customer's responses to custom checkout questions configured on the product at the time of purchase.
The unique identifier for the membership.
"mem_xxxxxxxxxxxxxx"
The time the user first joined the company associated with this membership. As a Unix timestamp. Null if the member record does not exist.
"2023-12-01T05:00:00.401Z"
The software license key associated with this membership. Only present if the product includes a Whop Software Licensing experience. Null otherwise.
"A1B2C3-D4E5F6-G7H8I9"
The URL where the customer can view and manage this membership, including cancellation and plan changes. Null if no member record exists.
"https://whop.com/billing/manage/mem_abc123"
The member record linking the user to the company for this membership. Null if the member record has not been created yet.
Custom key-value pairs for the membership (commonly used for software licensing, e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
Whether recurring payment collection for this membership is temporarily paused by the company.
The plan the customer purchased to create this membership.
The product this membership grants access to.
The promotional code currently applied to this membership's billing. Null if no promo code is active.
The end of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.
"2023-12-01T05:00:00.401Z"
The start of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.
"2023-12-01T05:00:00.401Z"
The current lifecycle status of the membership (e.g., active, trialing, past_due, canceled, expired, completed).
trialing, active, past_due, completed, canceled, expired, unresolved, drafted, canceling The datetime the membership was last updated.
"2023-12-01T05:00:00.401Z"
The user who owns this membership. Null if the user account has been deleted.