Skip to main content
A Member is one buyer’s relationship with an account: one record per customer, however many memberships they hold. 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.
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.
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 member’s phone number, or null. Their account number when they have shared one with this seller; otherwise the most recent number collected (or verified) at checkout.
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.
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 — "10.00" is ten dollars. A string so no float rounds it in transit.
string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount CARRIES — 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
Display name.
object
required
Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

string
required
Avatar image URL. Always present — a generated placeholder when the user set no picture.
string
required
Public username.
Member