> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Membresía

> Una membresía representa una relación activa entre un usuario y un producto. Registra el acceso del usuario, el estado de facturación y el calendario de renovación.

> [!NOTE]
>
> Este recurso tiene un sucesor en la [API de Whop](https://docs.whop.com/es/api-reference/legacy/memberships/membership.md), la API versionada sobre la que deben construirse las nuevas integraciones. Esta página sigue teniendo soporte completo.

```json Example theme={null}
{
	"cancel_at_period_end": true,
	"cancel_option": "too_expensive",
	"cancelation_status": "won_back",
	"canceled_at": "2023-12-01T05:00:00.401Z",
	"cancellation_reason": "I found a better alternative.",
	"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Pickaxe"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"custom_field_responses": [
		{
			"answer": "<string>",
			"id": "cfrp_xxxxxxxxxxxxx",
			"question": "<string>"
		}
	],
	"external_accounts": [
		{
			"external_id": "<string>",
			"platform": "<string>",
			"username": "<string>"
		}
	],
	"feedback_option": {
		"label": "<string>"
	},
	"formatted_renewal_price": "$25.00 / month",
	"id": "mem_xxxxxxxxxxxxxx",
	"initial_price_paid": "$25.00",
	"joined_at": "2023-12-01T05:00:00.401Z",
	"license_key": "A1B2C3-D4E5F6-G7H8I9",
	"manage_url": "https://whop.com/billing/manage/mem_abc123",
	"member": {
		"id": "mber_xxxxxxxxxxxxx"
	},
	"metadata": {},
	"payment_collection_paused": true,
	"plan": {
		"id": "plan_xxxxxxxxxxxxx",
		"metadata": {}
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"metadata": {},
		"title": "Pickaxe Analytics"
	},
	"promo_code": {
		"id": "promo_xxxxxxxxxxxx"
	},
	"renewal_period_end": "2023-12-01T05:00:00.401Z",
	"renewal_period_start": "2023-12-01T05:00:00.401Z",
	"status": "trialing",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"profile_pic": "<string>",
		"username": "johndoe42"
	}
}
```

**cancel\_at\_period\_end** `boolean` *required*

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.

**cancel\_option** `CancelOptions | null` *required*

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`

**cancelation\_status** `CancelationStatus | null` *required*

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`

**canceled\_at** `string\<date-time\> | null` *required*

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`

**cancellation\_reason** `string | null` *required*

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.`

**checkout\_configuration\_id** `string | null` *required*

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`

**company** `object` *required*

La empresa a la que pertenece esta membresía.

**atributos secundarios**

**id** `string` *required*

El identificador único de la empresa.

Ejemplo: `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

El nombre visible de la empresa que se muestra a los clientes.

Ejemplo: `Pickaxe`

**created\_at** `string\<date-time\>` *required*

La fecha y hora en que se creó la membresía.

Ejemplo: `2023-12-01T05:00:00.401Z`

**currency** `Currencies | null` *required*

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`

**custom\_field\_responses** `array\<object\>` *required*

Las respuestas del cliente a las preguntas personalizadas del checkout configuradas en el producto en el momento de la compra.

**atributos secundarios**

**answer** `string` *required*

La respuesta que dio un usuario a la pregunta o campo específico.

**id** `string` *required*

El identificador único de la respuesta del campo personalizado.

Ejemplo: `cfrp_xxxxxxxxxxxxx`

**question** `string` *required*

La pregunta formulada por el campo personalizado

**external\_accounts** `array\<object\> | null` *required*

Las cuentas del miembro en plataformas externas, como Discord y Telegram. Vacío cuando el miembro no tiene ninguna vinculada. Null en webhooks.

**atributos secundarios**

**external\_id** `string` *required*

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.

**platform** `string` *required*

La plataforma en la que está la cuenta del miembro: `discord` o `telegram`.

**username** `string | null` *required*

El nombre de usuario del miembro en la plataforma. Null cuando Whop no lo conoce, como en una membresía importada solo con un ID de Discord.

**feedback\_option** `object | null` *required*

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.

**atributos secundarios**

**label** `string` *required*

La etiqueta de la opción en el momento en que el miembro la eligió. Cambiar el nombre de la opción más adelante no la modifica.

**formatted\_renewal\_price** `string | null` *required*

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`

**id** `string` *required*

El identificador único de la membresía.

Ejemplo: `mem_xxxxxxxxxxxxxx`

**initial\_price\_paid** `string` *required*

El importe que pagó el cliente al comprar por primera vez esta membresía, formateado con el símbolo de moneda.

Ejemplo: `$25.00`

**joined\_at** `string\<date-time\> | null` *required*

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`

**license\_key** `string | null` *required*

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`

**manage\_url** `string | null` *required*

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`

**member** `object | null` *required*

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.

**atributos secundarios**

**id** `string` *required*

El identificador único del miembro.

Ejemplo: `mber_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

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.

**payment\_collection\_paused** `boolean` *required*

Indica si la empresa ha pausado temporalmente el cobro de pagos recurrentes de esta membresía.

**plan** `object` *required*

El plan que compró el cliente para crear esta membresía.

**atributos secundarios**

**id** `string` *required*

El identificador único del plan.

Ejemplo: `plan_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Pares clave-valor personalizados almacenados en el plan. Se incluyen en las cargas útiles de webhooks de eventos de pagos y membresías. Máximo 50 claves, 100 caracteres por clave y 500 caracteres por valor de cadena. Las claves reservadas `custom_cta` y `custom_cta_url`, cuando están definidas, sustituyen la llamada a la acción del checkout del producto para este plan.

**product** `object` *required*

El producto al que esta membresía otorga acceso.

**atributos secundarios**

**id** `string` *required*

El identificador único del producto.

Ejemplo: `prod_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Pares clave-valor personalizados almacenados en el producto e incluidos en las cargas útiles de webhooks de pagos y membresías. Máximo 50 claves, 100 caracteres por clave y 500 caracteres por valor de cadena.

**title** `string` *required*

El nombre visible del producto que se muestra a los clientes en la página del producto y en los resultados de búsqueda.

Ejemplo: `Pickaxe Analytics`

**promo\_code** `object | null` *required*

El código promocional aplicado actualmente a la facturación de esta membresía. Null si no hay ningún código promocional activo.

**atributos secundarios**

**id** `string` *required*

El identificador único del código promocional.

Ejemplo: `promo_xxxxxxxxxxxx`

**renewal\_period\_end** `string\<date-time\> | null` *required*

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`

**renewal\_period\_start** `string\<date-time\> | null` *required*

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`

**status** `MembershipStatus` *required*

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`

**updated\_at** `string\<date-time\>` *required*

La fecha y hora en que se actualizó por última vez la membresía.

Ejemplo: `2023-12-01T05:00:00.401Z`

**user** `object | null` *required*

El usuario propietario de esta membresía. Null si la cuenta de usuario se ha eliminado.

**atributos secundarios**

**email** `string | null` *required*

La dirección de correo electrónico del usuario. Requiere el permiso member:email:read para acceder. Null si no está autorizado.

Ejemplo: `john.doe@example.com`

**id** `string` *required*

El identificador único del usuario.

Ejemplo: `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

El nombre visible del usuario que se muestra en su perfil público.

Ejemplo: `John Doe`

**profile\_pic** `string` *required*

La URL de la foto de perfil del usuario. Usa profilePicture para obtener el objeto de adjunto completo.

**username** `string` *required*

El nombre de usuario único que se muestra en su perfil público.

Ejemplo: `johndoe42`


## Related topics

- [API de membresías](https://docs.whop.com/es/api-reference/memberships/membership.md)
- [Membresías](https://docs.whop.com/es/developer/guides/memberships.md)
- [Referencia del SDK de Checkout para iOS](https://docs.whop.com/es/developer/guides/ios/checkout-reference.md)
