Skip to main content
Registra si se ha unido o se ha ido, su nivel de acceso y cuándo abrió por última vez el contenido de la cuenta. Usa la API de miembros para listar y buscar los miembros de una cuenta, recuperar un solo miembro y leer el registro de actividad de un miembro. Las filas de miembros se crean y mantienen mediante el ciclo de vida de las membresías; para conceder o revocar el acceso, trabaja con las membresías.
Reemplaza el recurso heredado Members. Las integraciones heredadas existentes siguen funcionando; consulta Versiones de la API para conocer el compromiso de estabilidad.

Endpoints

Atributos

string
requerido
ID del miembro, con el prefijo mber_.
string
requerido
A qué puede acceder el miembro en la cuenta: customer para miembros que pagan, admin para miembros del equipo, no_access una vez que han caducado todas las concesiones.Opciones disponibles: no_access, admin, customer
string
requerido
La cuenta a la que pertenece este miembro, con el prefijo biz_.
string
requerido
Cuándo se creó el registro del miembro, como marca de tiempo ISO 8601.
string
requerido
El nombre que se mostrará para este miembro: el nombre del usuario, o su nombre de usuario cuando no ha establecido uno. El nombre de la empresa compradora cuando user es null.
object | null
requerido
Los ingresos brutos del usuario en Whop, en USD, actualizados periódicamente. null cuando el usuario oculta sus ganancias o el comprador es otra empresa.

Propiedades

string
requerido
Ingresos brutos en USD en las últimas 24 horas.
string
requerido
Ingresos brutos en USD en los últimos 30 días.
string
requerido
Ingresos brutos en USD en los últimos 7 días.
string
requerido
Ingresos brutos históricos en USD.
string | null
requerido
La dirección de correo electrónico del usuario. null sin member:email:read en la cuenta, cuando el comprador es otra empresa o cuando el usuario no tiene ningún correo asignado.
string
requerido
Cuándo se unió el miembro por primera vez a la cuenta, como marca de tiempo ISO 8601.
string | null
requerido
Cuándo abrió el miembro por última vez el contenido de la cuenta, como marca de tiempo ISO 8601. null si nunca lo ha hecho.
message | null
requerido
Qué ocurrió en last_activity_at. object indica de qué tipo de actividad se trata. null sin support_chat:read en la cuenta, o cuando last_activity_at es null.

Propiedades

string
requerido
El ID del mensaje.
object | null
requerido
Quién envió el mensaje: el miembro o alguien del equipo de la cuenta. null cuando la cuenta del remitente ya no existe.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.
string
requerido
Nombre de usuario público.
string
requerido
El chat de soporte en el que se envió el mensaje.
string
requerido
Cuándo se envió el mensaje, como marca de tiempo ISO 8601.
string
requerido
Siempre message.
string | null
requerido
El texto del mensaje sin formato. null cuando el mensaje no tiene texto, como un adjunto por sí solo.
string | null
requerido
Cuándo interactuaron por última vez el miembro y la cuenta, como marca de tiempo ISO 8601. Por ejemplo, un mensaje en el chat de soporte del miembro.
object | null
requerido
Tus propios datos clave-valor almacenados en este miembro. null cuando no se ha establecido ninguno.
string | null
requerido
El estado más reciente del ciclo de vida del miembro en la cuenta, derivado de sus membresías, como paid_subscriber, canceling o churned. null hasta que se calcula por primera vez.Opciones disponibles: canceling, churned, finished_split_pay, paused, paid_subscriber, paid_once, expiring, joined, left, trialing, pending_entry, renewing, past_due
string | null
requerido
Cuándo entró en vigor most_recent_action, como marca de tiempo ISO 8601. null cuando most_recent_action es null.
string | null
requerido
El nombre que la cuenta le dio a este cliente con PATCH /members/:id. Las facturas lo muestran como nombre del cliente en todas las facturas de este miembro, en lugar del nombre propio del usuario. null cuando la cuenta no ha establecido uno.
string | null
requerido
El número de teléfono del miembro: el número más reciente recopilado (o verificado) en el checkout o, en su defecto, el número de su cuenta cuando lo ha compartido con este vendedor. null sin member:phone:read en la cuenta, o cuando no hay ninguno.
string
requerido
joined mientras el miembro forma parte de la cuenta, left después de que se vaya.Opciones disponibles: joined, left
number
requerido
El saldo de tokens actual del miembro para esta cuenta, calculado a partir de las transacciones de tokens.
string | null
requerido
unsubscribed una vez que el miembro se da de baja de las comunicaciones de marketing de la cuenta, null mientras esté suscrito. Solo el miembro puede cambiarlo.Opciones disponibles: unsubscribed
object
requerido
Cuánto ha gastado el miembro en los productos de la cuenta, en USD.

Propiedades

string
requerido
El importe en unidades principales, como una cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de punto flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cobro.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa este valor para dar formato al número en tu propia configuración regional.
object | null
requerido
El usuario detrás de este miembro. null cuando el comprador es otra empresa en lugar de una persona.

Propiedades

string
requerido
ID del usuario, con el prefijo user_.
string | null
requerido
La ciudad del usuario, derivada de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string | null
requerido
El país del usuario como código ISO 3166-1 alfa-2, como US, derivado de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no ha establecido ninguna imagen.
string | null
requerido
El código de estado o región del usuario, como CA, derivado de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string
requerido
Nombre de usuario público.
Member