Replaces the Legacy Members resource.
Existing Legacy integrations keep working; see API
versions for the stability contract.
Endpoints
Attributes
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, customerThe 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.The user’s gross income across Whop, in USD, refreshed periodically.
null when the user hides their earnings or the buyer is another business.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.When the member last opened the account’s content, as an ISO 8601 timestamp.
null if they never have.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
Properties
Who sent the message: the member, or someone on the account’s team.
null when the sender’s account no longer exists.Properties
Properties
When the member and the account last interacted, as an ISO 8601 timestamp. For
example, a message in the member’s support chat.
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_dueWhen
most_recent_action took effect, as an ISO 8601 timestamp. null when
most_recent_action is null.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.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.joined while the member is part of the account, left after they leave.Available options: joined, leftThe member’s current token balance for this account, computed from token
transactions.
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: unsubscribedHow much the member has spent on the account’s products, in USD.
Properties
Properties
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.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The user behind this member.
null when the buyer is another business rather than a person.Properties
Properties
The user’s city, derived from their IP address.
null when unknown or the
user turned off location sharing.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.The user’s state or region code, like
CA, derived from their IP address.
null when unknown or the user turned off location sharing.Member

