Skip to main content
It tracks whether they have joined or left, their access level, and when they last opened the account’s content. Use the Members API to list and search an account’s members, retrieve a single member, and read a member’s activity log. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead.
Replaces the Legacy Members resource. Existing Legacy integrations keep working; see API versions for the stability contract.

Endpoints

Attributes

string
required
Member ID, prefixed mber_.
string
required
What the member can reach on the account: customer for paying members, admin for team members, no_access once every grant has lapsed.Available options: no_access, admin, customer
string
required
The account this member belongs to, prefixed biz_.
string
required
When the member record was created, as an ISO 8601 timestamp.
string
required
The name to show for this member: the user’s name, or their username when they have not set one. The buying business’s name when user is null.
object | null
required
The user’s gross income across Whop, in USD, refreshed periodically. null when the user hides their earnings or the buyer is another business.

Properties

string
required
Gross income in USD over the last 24 hours.
string
required
Gross income in USD over the last 30 days.
string
required
Gross income in USD over the last 7 days.
string
required
All-time gross income in USD.
string | null
required
The user’s email address. null without member:email:read on the account, when the buyer is another business, or when the user has no assigned email.
string
required
When the member first joined the account, as an ISO 8601 timestamp.
string | null
required
When the member last opened the account’s content, as an ISO 8601 timestamp. null if they never have.
message | null
required
What happened at last_activity_at. object says which kind of activity it is. null without support_chat:read on the account, or when last_activity_at is null.

Properties

string
required
The message ID.
object | null
required
Who sent the message: the member, or someone on the account’s team. null when the sender’s account no longer exists.

Properties

string
required
User ID, prefixed user_.
string | null
required
Display name.
object
required
Avatar wrapper. Its url is always present, and is a generated placeholder when the user set no picture.

Properties

string
required
Avatar image URL. Always present. It is a generated placeholder when the user set no picture.
string
required
Public username.
string
required
The support chat the message was sent in.
string
required
When the message was sent, as an ISO 8601 timestamp.
string
required
Always message.
string | null
required
The message text without formatting. null when the message has no text, such as an attachment on its own.
string | null
required
When the member and the account last interacted, as an ISO 8601 timestamp. For example, a message in the member’s support chat.
object | null
required
Your own key-value data stored on this member. null when none is set.
string | null
required
The member’s latest lifecycle state on the account, derived from their memberships, such as paid_subscriber, canceling, or churned. null until it is first computed.Available options: canceling, churned, finished_split_pay, paused, paid_subscriber, paid_once, expiring, joined, left, trialing, pending_entry, renewing, past_due
string | null
required
When most_recent_action took effect, as an ISO 8601 timestamp. null when most_recent_action is null.
string | null
required
The name the account gave this customer with PATCH /members/:id. Invoices show it as the customer name on every invoice for this member, in place of the user’s own name. null when the account has not set one.
string | null
required
The member’s phone number: the most recent number collected (or verified) at checkout, otherwise their account number when they have shared one with this seller. null without member:phone:read on the account, or when there is neither.
string
required
joined while the member is part of the account, left after they leave.Available options: joined, left
number
required
The member’s current token balance for this account, computed from token transactions.
string | null
required
unsubscribed once the member opts out of the account’s marketing communications, null while they’re subscribed. Only the member can change it.Available options: unsubscribed
object
required
How much the member has spent on the account’s products, in USD.

Properties

string
required
The amount in major units, as an exact decimal string. For example, "10.00" is ten dollars. It is a string so that no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount carries. This is the precision the charge itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
object | null
required
The user behind this member. null when the buyer is another business rather than a person.

Properties

string
required
User ID, prefixed user_.
string | null
required
The user’s city, derived from their IP address. null when unknown or the user turned off location sharing.
string | null
required
The user’s country as an ISO 3166-1 alpha-2 code, like US, derived from their IP address. null when unknown or the user turned off location sharing.
string | null
required
Display name.
object
required
Avatar wrapper. Its url is always present, and is a generated placeholder when the user set no picture.

Properties

string
required
Avatar image URL. Always present. It is a generated placeholder when the user set no picture.
string | null
required
The user’s state or region code, like CA, derived from their IP address. null when unknown or the user turned off location sharing.
string
required
Public username.
Member