Skip to main content
AccessLevel
required
The access level of the product member. If its admin, the member is an authorized user of the company. If its customer, the member has a valid membership to any product on the company. If its no_access, the member does not have access to the product.Available options: no_access, admin, customer
object
required
The company for the member.
number
required
The member’s token balance for this company. Computed live from the ledger, not from a cache.Example: 6.9
string<date-time>
required
The datetime the company member was created.Example: 2023-12-01T05:00:00.401Z
string
required
The unique identifier for the company member.
string<date-time>
required
When the member joined the companyExample: 2023-12-01T05:00:00.401Z
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
string<date-time> | null
required
The time for the most recent action, if applicable.Example: 2023-12-01T05:00:00.401Z
string | null
required
The phone number for the member, if available.
MemberStatuses
required
The status of the memberAvailable options: drafted, joined, left
string<date-time>
required
The datetime the company member was last updated.Example: 2023-12-01T05:00:00.401Z
number
required
How much money this customer has spent on the company’s products and plansExample: 6.9
object | null
required
The user for this member, if any.