Skip to main content
GET
TypeScript

Autorisationer

Authorization
string
header
påkrævet

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:basic:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Member ID (mber_ tag).

Svar

the stamped number outranks the consented account read

access_level
enum<string>
påkrævet

What the member can reach on the account: customer for paying members, admin for team members, no_access once every grant has lapsed.

Tilgængelige muligheder:
no_access,
admin,
customer
Eksempel:

"customer"

account_id
string
påkrævet

The account this member belongs to, prefixed biz_.

Eksempel:

"biz_xxxxxxxxxxxxxx"

created_at
string
påkrævet

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

Eksempel:

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

display_name
string
påkrævet

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.

Eksempel:

"Dana Whitfield"

earnings_usd
object | null
påkrævet

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
påkrævet

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.

Eksempel:

"marcus@shinetime.example"

id
string
påkrævet

Member ID, prefixed mber_.

Eksempel:

"mber_xxxxxxxxxxxxxx"

joined_at
string
påkrævet

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

Eksempel:

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

last_accessed_at
string | null
påkrævet

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

Eksempel:

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

last_activity
Message · object | null
påkrævet

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
påkrævet

When the member and the account last interacted, as an ISO 8601 timestamp. For example, a message in the member's support chat.

Eksempel:

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

metadata
object | null
påkrævet

Your own key-value data stored on this member. null when none is set.

Eksempel:

null

most_recent_action
enum<string> | null
påkrævet

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.

Tilgængelige muligheder:
canceling,
churned,
finished_split_pay,
paused,
paid_subscriber,
paid_once,
expiring,
joined,
left,
trialing,
pending_entry,
renewing,
past_due,
null
Eksempel:

"paid_subscriber"

most_recent_action_at
string | null
påkrævet

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

Eksempel:

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

name
string | null
påkrævet

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.

Eksempel:

"Northwind Legal LLP"

phone_number
string | null
påkrævet

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.

Eksempel:

"+xxxxxxxxxxx"

status
enum<string>
påkrævet

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

Tilgængelige muligheder:
joined,
left
Eksempel:

"joined"

token_balance
number
påkrævet

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

Eksempel:

70.25

unsubscribe_status
enum<string> | null
påkrævet

unsubscribed once the member opts out of the account's marketing communications, null while they're subscribed. Only the member can change it.

Tilgængelige muligheder:
unsubscribed,
null
Eksempel:

"unsubscribed"

usd_total_spent
object
påkrævet

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

user
object | null
påkrævet

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