Skip to main content
POST
Create Member

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

member:manage

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-12"

Body

application/json
email
string<email>
required

The email address of the person to add. If no Whop user has it, one is created.

Example:

"jane@example.com"

account_id
string

The account to add the member to (biz_ tag). Defaults to the account the credential acts as.

Example:

"biz_xxxxxxxxxxxxxx"

name
string

The name of the person to add. Ignored when a user on Whop already exists for this email address.

Example:

"Jane Doe"

Response

member created for an email with no Whop user

access_level
enum<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
Example:

"customer"

account_id
string
required

The account this member belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

created_at
string
required

When the member record was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

display_name
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.

Example:

"Dana Whitfield"

earnings_usd
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.

email
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.

Example:

"marcus@shinetime.example"

id
string
required

Member ID, prefixed mber_.

Example:

"mber_xxxxxxxxxxxxxx"

joined_at
string
required

When the member first joined the account, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

last_accessed_at
string | null
required

When the member last opened the account's content, as an ISO 8601 timestamp. null if they never have.

Example:

"2026-01-01T12:00:00.000Z"

last_activity
Message · object | 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.

last_activity_at
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.

Example:

"2026-01-01T12:00:00.000Z"

most_recent_action
enum<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,
null
Example:

"paid_subscriber"

most_recent_action_at
string | null
required

When most_recent_action took effect, as an ISO 8601 timestamp. null when most_recent_action is null.

Example:

"2026-01-01T12:00:00.000Z"

name
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.

Example:

"Northwind Legal LLP"

phone_number
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.

Example:

"+xxxxxxxxxxx"

status
enum<string>
required

joined while the member is part of the account, left after they leave.

Available options:
joined,
left
Example:

"joined"

token_balance
number
required

The member's current token balance for this account, computed from token transactions.

Example:

70.25

unsubscribe_status
enum<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,
null
Example:

"unsubscribed"

usd_total_spent
object
required

How much the member has spent on the account's products, in USD.

user
object | null
required

The user behind this member. null when the buyer is another business rather than a person.