Skip to main content
Este recurso tiene un sucesor en la API de Whop, la API versionada sobre la que deben construirse las nuevas integraciones. Esta página sigue teniendo soporte completo.
boolean
requerido
Indica si esta membresía está configurada para cancelarse al final del ciclo de facturación actual. Solo se aplica a membresías con un plan recurrente.
CancelOptions | null
requerido
La categoría seleccionada como motivo por el que el miembro canceló (p. ej., too_expensive, switching, missing_features).Opciones disponibles: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testing
CancelationStatus | null
requerido
Indica si el cliente está cancelando, se fue o fue recuperado. Null si la membresía no tiene motivo de cancelación o su estado de cancelación es indeterminado.Opciones disponibles: won_back, left, canceling
string<date-time> | null
requerido
La fecha y hora en que el cliente inició la cancelación de esta membresía. Como marca de tiempo Unix. Null si la membresía no se ha cancelado.Ejemplo: 2023-12-01T05:00:00.401Z
string | null
requerido
Explicación en texto libre proporcionada por el cliente al cancelar. Null si el cliente no proporcionó ningún motivo.Ejemplo: I found a better alternative.
string | null
requerido
El ID de la sesión/configuración de checkout que generó esta membresía, si la hay. Úsalo para relacionar las membresías con la configuración de checkout que las creó.Ejemplo: ch_xxxxxxxxxxxxxxx
object
requerido
La empresa a la que pertenece esta membresía.
string<date-time>
requerido
La fecha y hora en que se creó la membresía.Ejemplo: 2023-12-01T05:00:00.401Z
Currencies | null
requerido
El código de moneda ISO de tres letras para la facturación de esta membresía. Null si la membresía es gratuita.Opciones disponibles: usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau, hnl
array<object>
requerido
Las respuestas del cliente a las preguntas personalizadas del checkout configuradas en el producto en el momento de la compra.
array<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 webhooks.
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.
string | null
requerido
El precio de renovación recurrente de esta membresía, formateado con el símbolo de moneda y el intervalo de facturación. Null si la membresía no es recurrente.Ejemplo: $25.00 / month
string
requerido
El identificador único de la membresía.Ejemplo: mem_xxxxxxxxxxxxxx
string
requerido
El importe que pagó el cliente al comprar por primera vez esta membresía, formateado con el símbolo de moneda.Ejemplo: $25.00
string<date-time> | null
requerido
La fecha y hora en que el usuario se unió por primera vez a la empresa asociada a esta membresía. Como marca de tiempo Unix. Null si el registro de miembro no existe.Ejemplo: 2023-12-01T05:00:00.401Z
string | null
requerido
La clave de licencia de software asociada a esta membresía. Solo está presente si el producto incluye una experiencia de Whop Software Licensing. Null en caso contrario.Ejemplo: A1B2C3-D4E5F6-G7H8I9
string | null
requerido
La URL donde el cliente puede ver y gestionar esta membresía, incluidas la cancelación y los cambios de plan. Null si no existe ningún registro de miembro.Ejemplo: https://whop.com/billing/manage/mem_abc123
object | null
requerido
El registro de miembro que vincula al usuario con la empresa para esta membresía. Null si el registro de miembro aún no se ha creado.
object | null
requerido
Pares clave-valor personalizados de la membresía (usados habitualmente para licencias de software, p. ej., HWID). Máximo 50 claves, 100 caracteres por clave y 500 caracteres por valor de cadena.
boolean
requerido
Indica si la empresa ha pausado temporalmente el cobro de pagos recurrentes de esta membresía.
object
requerido
El plan que compró el cliente para crear esta membresía.
object
requerido
El producto al que esta membresía otorga acceso.
object | null
requerido
El código promocional aplicado actualmente a la facturación de esta membresía. Null si no hay ningún código promocional activo.
string<date-time> | null
requerido
El final del periodo de facturación actual de esta membresía recurrente. Como marca de tiempo Unix. Null si la membresía no es recurrente.Ejemplo: 2023-12-01T05:00:00.401Z
string<date-time> | null
requerido
El inicio del periodo de facturación actual de esta membresía recurrente. Como marca de tiempo Unix. Null si la membresía no es recurrente.Ejemplo: 2023-12-01T05:00:00.401Z
MembershipStatus
requerido
El estado actual del ciclo de vida de la membresía (p. ej., active, trialing, past_due, canceled, expired, completed).Opciones disponibles: trialing, active, past_due, completed, canceled, expired, unresolved, drafted, canceling
string<date-time>
requerido
La fecha y hora en que se actualizó por última vez la membresía.Ejemplo: 2023-12-01T05:00:00.401Z
object | null
requerido
El usuario propietario de esta membresía. Null si la cuenta de usuario se ha eliminado.