Skip to main content
Registra el estado de facturación (active, trialing, past_due, etc.), el periodo actual, las cancelaciones pendientes, los metadatos personalizados y la clave de licencia de software cuando el producto incluye licencias. Usa la API de membresías para listar las membresías de una cuenta o las tuyas, recuperar una por ID o clave de licencia, invitar a un destinatario a unirse mediante una variante gratuita y gestionar el ciclo de vida: cancelar de inmediato o al final del periodo, revertir una cancelación programada, pausar y reanudar el cobro de pagos, ampliar o reactivar el acceso, aplicar un código promocional o un afiliado, cambiar la frecuencia de renovación, resincronizar el acceso, generar un enlace de transferencia y actualizar los metadatos.
Reemplaza el recurso heredado Memberships. Las integraciones heredadas existentes siguen funcionando; consulta Versiones de la API para conocer el compromiso de estabilidad.

Endpoints

Atributos

string
requerido
ID de la membresía, con el prefijo mem_.
object
requerido
La cuenta (vendedor) a la que pertenece esta membresía.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string | null
requerido
URL de la imagen del logotipo de la cuenta. null cuando la cuenta no ha establecido uno.
string
requerido
Identificador de ruta pública de la cuenta, utilizado en la ruta de la tienda whop.com/\{route}.
string
requerido
Nombre visible de la cuenta.
object | null
requerido
La comisión de afiliado de la membresía. null sin un afiliado, sin affiliate:basic:read en la cuenta, y siempre en los webhooks.

Propiedades

string
requerido
ID del afiliado, con el prefijo aff_.
string
requerido
Si la comisión se paga solo en el primer pago de la membresía o en todos sus pagos.Opciones disponibles: first_payment, all_payments
object | null
requerido
La comisión de tarifa fija en la moneda de la membresía, o null si es un porcentaje.

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.
number | null
requerido
La comisión porcentual en puntos porcentuales, así que 20 significa 20 %, o null si es una tarifa fija.
string
requerido
Cómo se estableció la tasa de comisión: custom para una tasa establecida para este afiliado, member para la tasa de afiliado de miembros del plan o producto, global para la tasa de afiliado global del producto, o marketplace para una referencia del marketplace de Whop.Opciones disponibles: custom, member, marketplace, global
string
requerido
Si la comisión es un porcentaje o una tarifa fija.Opciones disponibles: flat_fee, percentage
boolean
requerido
Si esta membresía paga comisiones de afiliado. false significa que el afiliado se mantiene en la membresía pero ya no se le paga.
string
requerido
ID del usuario del afiliado, con el prefijo user_.
integer | null
requerido
Número de días entre cobros recurrentes. null para membresías que no se renuevan o membresías con varios calendarios de renovación.
boolean
requerido
Si la membresía está configurada para cancelarse cuando termine el periodo de facturación actual. Solo tiene sentido para variantes recurrentes.
string | null
requerido
La categoría que eligió el miembro como motivo de la cancelación. null cuando no se eligió ninguna categoría.Opciones disponibles: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testing
string | null
requerido
Cuándo se solicitó la cancelación, o cuándo se canceló la membresía si no hay ninguna hora de solicitud registrada, como marca de tiempo ISO 8601. null cuando no hay ninguna registrada.
string | null
requerido
Explicación en texto libre proporcionada al cancelar. null cuando no se proporcionó ningún motivo.
string | null
requerido
Cómo se cobran las renovaciones. charge_automatically cobra el método de pago guardado en cada periodo; send_invoice envía al comprador una factura por correo electrónico en cada periodo. null cuando no está establecido.Opciones disponibles: charge_automatically, send_invoice
string
requerido
Cuándo se creó la membresía, como marca de tiempo ISO 8601.
string | null
requerido
Cuándo se renueva el periodo de facturación actual, o cuándo vence una membresía que no se renueva, como marca de tiempo ISO 8601. null para compras únicas sin vencimiento.
string | null
requerido
Cuándo comenzó el periodo de facturación actual, como marca de tiempo ISO 8601. null cuando no hay ningún periodo de facturación registrado.
string | null
requerido
Cuándo termina el acceso de una membresía con un vencimiento fijo, como marca de tiempo ISO 8601. null cuando la membresía no tiene vencimiento, como una membresía que se renueva.
object[] | null
requerido
Las cuentas del miembro en plataformas externas, como Discord y Telegram. Vacío cuando el miembro no tiene ninguna vinculada. null en los webhooks.

Propiedades

string
requerido
El ID de usuario del miembro en la plataforma, como un ID de usuario de Discord. Con el prefijo de la plataforma (discord_\<external_id>), es el valor external_account por el que filtra List Memberships.
string
requerido
La plataforma en la que está la cuenta del miembro.Opciones disponibles: discord, telegram
string | null
requerido
El nombre de usuario del miembro en la plataforma. null cuando Whop no lo conoce, como en el caso de una membresía importada solo con un ID de Discord.
object | null
requerido
El motivo de cancelación propio de la cuenta que eligió el miembro, tal como lo vio. null cuando el miembro eligió una categoría predeterminada o no indicó ningún motivo.

Propiedades

string
requerido
La etiqueta de la opción cuando el miembro la eligió. Cambiar el nombre de la opción más tarde no la modifica.
object
requerido
El precio inicial actual de la variante, en la moneda de la variante. Es un precio de lista, no necesariamente lo que pagó el comprador. amount es "0.00" cuando el primer cobro es gratuito.

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.
string | null
requerido
La clave de licencia de software de esta membresía. Solo está presente cuando el producto incluye una experiencia de licencias de software.
string | null
requerido
URL donde el comprador puede iniciar sesión para gestionar la facturación. null sin un registro de miembro o salvo que el llamador sea el comprador o tenga member:manage en la cuenta.
object | null
requerido
La fila de miembro del llamador en la cuenta. Solo está presente cuando la membresía pertenece al llamador; null en las lecturas del lado del vendedor.

Propiedades

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 | 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.
number | null
requerido
La posición de orden del miembro en la propia lista de cuentas del comprador. null hasta que la organice.
string | null
requerido
El registro de miembro del comprador en la cuenta, con el prefijo mber_. null cuando la membresía no tiene registro de miembro, como una membresía no reclamada.
object
requerido
Pares clave-valor personalizados almacenados en la membresía, utilizados habitualmente para las licencias de software.
string | null
requerido
El evento más reciente del ciclo de vida de la membresía, como renewing_on o canceled_on. Combínalo con most_recent_action_at. null cuando no hay ninguno registrado.Opciones disponibles: canceled_on, finished_split_pay_at, canceling_on, ending_on, renewing_on, past_due, next_payment_attempt, paused_at, trial_ends_at, unresolved_at, trial_canceling_on
string | null
requerido
Cuándo ocurrió o está programado que ocurra most_recent_action, como marca de tiempo ISO 8601. Una hora futura para eventos próximos como renewing_on. null cuando no hay ninguna acción registrada.
string | null
requerido
El número de teléfono del comprador registrado para esta membresía, o null. El número recopilado (o verificado) en el checkout cuando la recopilación de teléfonos del vendedor está activada; en su defecto, el número de la cuenta del comprador cuando lo ha compartido con este vendedor.
object
requerido
El producto al que esta membresía concede acceso.

Propiedades

string
requerido
ID del producto, con el prefijo prod_.
string | null
requerido
URL de la imagen del logotipo del producto. null cuando el producto no tiene logotipo.
string
requerido
Nombre visible del producto.
string
requerido
El producto al que esta membresía concede acceso, con el prefijo prod_.
string | null
requerido
El código promocional que descuenta esta membresía, con el prefijo promo_. null cuando no se ha aplicado ninguno. Se establece en el checkout o mediante Apply Promo Code to Membership.
object | null
requerido
El precio de renovación de la variante, en la moneda de la variante, después de cualquier código promocional que siga aplicándose. A una membresía facturada en la moneda local del comprador se le cobra este precio convertido al tipo de cambio de cada fecha de facturación. null para membresías que no se renuevan.

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.
integer | null
requerido
Cuotas pagadas contabilizadas hasta ahora en una membresía de pago fraccionado. null cuando la membresía no usa pago fraccionado, o antes de que se contabilice su primera cuota.
integer | null
requerido
Pagos a plazos requeridos antes de que la membresía deje de facturarse. null cuando la membresía no usa pago fraccionado.
string
requerido
Estado de facturación de la membresía. Las membresías active/trialing conceden acceso; past_due es el periodo de gracia tras un pago fallido; las compras únicas completed mantienen el acceso; las canceled/expired no.Opciones disponibles: trialing, active, past_due, completed, canceled, expired, unresolved
string
requerido
Cuándo se modificó la membresía por última vez, como marca de tiempo ISO 8601. Refleja el cambio más reciente en la propia membresía, para que puedas conciliar con los reintentos, repeticiones y rellenos de webhooks.
string | null
requerido
El comprador, con el prefijo user_. null cuando el comprador es otra empresa o la membresía no está reclamada.
string
requerido
La variante que compró el comprador, con el prefijo plan_.
Membership