Member

A member represents a user’s relationship with a company on Whop, including their access level, status, and spending history.

This resource has a successor in the Whop API, the versioned API that new integrations should build on. This page stays fully supported.

Example

{
	"access_level": "no_access",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"route": "<string>",
		"title": "<string>"
	},
	"company_token_balance": 6.9,
	"created_at": "2023-12-01T05:00:00.401Z",
	"id": "<string>",
	"joined_at": "2023-12-01T05:00:00.401Z",
	"most_recent_action": "canceling",
	"most_recent_action_at": "2023-12-01T05:00:00.401Z",
	"phone": "<string>",
	"status": "drafted",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"usd_total_spent": 6.9,
	"user": {
		"email": "<string>",
		"id": "<string>",
		"name": "<string>",
		"username": "<string>"
	}
}

access_level · AccessLevel · required

The member’s content access level. admin means their team role grants administrative content access, customer means they hold a valid product membership, and no_access means they cannot access company content.

Available options: no_access, admin, customer

company · object · required

The company for the member.

Show child attributes

id · string · required

The unique identifier for the company.

Example: biz_xxxxxxxxxxxxxx

route · string · required

The slug/route of the company on the Whop site.

title · string · required

The written name of the company.

company_token_balance · number · required

The member’s token balance for this company. Computed live from the ledger, not from a cache.

Example: 6.9

created_at · string<date-time> · required

The datetime the company member was created.

Example: 2023-12-01T05:00:00.401Z

id · string · required

The unique identifier for the company member.

joined_at · string<date-time> · required

When the member joined the company

Example: 2023-12-01T05:00:00.401Z

most_recent_action · MemberMostRecentActions | null · required

The most recent action the member has taken.

Available options: canceling, churned, finished_split_pay, paused, paid_subscriber, paid_once, expiring, joined, drafted, left, trialing, pending_entry, renewing, past_due

most_recent_action_at · string<date-time> | null · required

The time for the most recent action, if applicable.

Example: 2023-12-01T05:00:00.401Z

phone · string | null · required

The phone number for the member, if available.

status · MemberStatuses · required

The status of the member

Available options: drafted, joined, left

updated_at · string<date-time> · required

The datetime the company member was last updated.

Example: 2023-12-01T05:00:00.401Z

usd_total_spent · number · required

How much money this customer has spent on the company’s products and plans

Example: 6.9

user · object | null · required

The user for this member, if any.

Show child attributes

email · string | null · required

The digital mailing address of the user.

id · string · required

The unique identifier for the company member user.

name · string | null · required

The user’s full name.

username · string · required

The whop username.