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

# API de Promo Codes

> Un Promo Code es un descuento que un comprador introduce en el checkout, ya sea un porcentaje o un importe fijo.

Pertenece a una cuenta, puede limitarse a un producto y controla quién puede canjearlo, cuántas veces, hasta cuándo y durante cuántos períodos de facturación dura el descuento.

Usa la API de Promo Codes para crear códigos para una cuenta, listarlos y obtenerlos, desactivar un código para pausar los canjes o volver a activarlo, y archivar los códigos que ya no ofreces.

## Endpoints

| Endpoint | Solicitud |
| - | - |
| [Listar Promo Codes](https://docs.whop.com/es/api-reference/promo-codes/list-promo-codes.md) | GET `/promo_codes` |
| [Obtener Promo Code](https://docs.whop.com/es/api-reference/promo-codes/retrieve-promo-code.md) | GET `/promo_codes/{id}` |
| [Crear Promo Code](https://docs.whop.com/es/api-reference/promo-codes/create-promo-code.md) | POST `/promo_codes` |
| [Activar Promo Code](https://docs.whop.com/es/api-reference/promo-codes/activate-promo-code.md) | POST `/promo_codes/{id}/activate` |
| [Desactivar Promo Code](https://docs.whop.com/es/api-reference/promo-codes/deactivate-promo-code.md) | POST `/promo_codes/{id}/deactivate` |
| [Eliminar Promo Code](https://docs.whop.com/es/api-reference/promo-codes/delete-promo-code.md) | DELETE `/promo_codes/{id}` |

## Atributos

**id** `string` *required*

ID del código promocional, con el prefijo `promo_`.

**account** `object` *required*

Cuenta propietaria del código promocional.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID de la cuenta, con el prefijo `biz_`.
>
> **title** `string` *required*
>
> Nombre visible de la cuenta.

**affiliate** `object | null` *required*

Afiliado al que se le acreditan los referidos que usan el código promocional, o `null` cuando no hay ningún afiliado asociado.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID del afiliado, con el prefijo `aff_`.
>
> **user** `object` *required*
>
> Usuario que es el afiliado.
>
> > [accordion] Propiedades
> >
> > **id** `string` *required*
> >
> > ID de usuario del afiliado, con el prefijo `user_`.
> >
> > **name** `string | null` *required*
> >
> > Nombre visible del afiliado.
> >
> > **profile\_pic** `string` *required*
> >
> > URL del avatar del afiliado, incluida la alternativa generada cuando no se ha definido ningún avatar.
> >
> > **username** `string | null` *required*
> >
> > Nombre de usuario público del afiliado.

**amount\_off** `number` *required*

Importe del descuento. Los descuentos porcentuales se representan como una fracción decimal.

**churned\_users\_only** `boolean` *required*

Si el código promocional está restringido a clientes que se dieron de baja.

**code** `string | null` *required*

Código que se introduce en el checkout.

**created\_at** `string` *required*

Cuándo se creó el código promocional, como marca de tiempo ISO 8601.

**currency** `string` *required*

Divisa usada para un descuento de importe fijo.

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`

**duration** `string` *required*

Cuánto tiempo se aplica el descuento.

Opciones disponibles: `forever`, `once`, `repeating`

**existing\_memberships\_only** `boolean` *required*

Si el código promocional se aplica solo a membresías existentes.

**expires\_at** `string | null` *required*

Cuándo vence el código promocional, como marca de tiempo ISO 8601.

**metadata** `object` *required*

Metadatos clave-valor personalizados almacenados en el código promocional.

**new\_users\_only** `boolean` *required*

Si el código promocional está restringido a clientes nuevos.

**one\_per\_customer** `boolean` *required*

Si cada cliente puede canjear el código promocional solo una vez.

**product** `object | null` *required*

Producto al que está restringido el código promocional, o `null` cuando no está limitado a un producto.

> [accordion] Propiedades
>
> **id** `string` *required*
>
> ID del producto, con el prefijo `prod_`.
>
> **title** `string` *required*
>
> Nombre visible del producto.

**promo\_duration\_months** `integer | null` *required*

Intervalos de facturación a los que se aplica el descuento.

**promo\_type** `string` *required*

Si el descuento es porcentual o de importe fijo.

Opciones disponibles: `percentage`, `flat_amount`

**status** `string` *required*

Estado del ciclo de vida del código promocional.

Opciones disponibles: `active`, `inactive`, `archived`

**stock** `integer` *required*

Usos máximos cuando el stock es limitado.

**unlimited\_stock** `boolean` *required*

Si el código promocional no tiene límite de canjes.

**updated\_at** `string` *required*

Cuándo se actualizó el código promocional, como marca de tiempo ISO 8601.

**uses** `integer` *required*

Membresías que usaron el código promocional.

```json PromoCode theme={null}
{
	"id": "promo_xxxxxxxxxxxxxx",
	"code": "SUMMER25",
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "Shine Time Auto Detailing"
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxxx",
		"title": "Ceramic Coating Package"
	},
	"affiliate": {
		"id": "aff_xxxxxxxxxxxxxx",
		"user": {
			"id": "user_xxxxxxxxxxxxxx",
			"username": "danawhitfield",
			"name": "Dana Whitfield",
			"profile_pic": "https://ui-avatars.com/api/?name=Dana+Whitfield"
		}
	},
	"status": "active",
	"promo_type": "percentage",
	"amount_off": 0.25,
	"currency": "usd",
	"duration": "repeating",
	"promo_duration_months": 3,
	"new_users_only": true,
	"churned_users_only": false,
	"existing_memberships_only": false,
	"one_per_customer": true,
	"unlimited_stock": false,
	"stock": 200,
	"uses": 37,
	"expires_at": "2026-12-31T23:59:59.000Z",
	"metadata": {},
	"created_at": "2026-09-01T12:00:00.000Z",
	"updated_at": "2026-09-01T12:00:00.000Z"
}
```
