> ## 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 Promo Codes

> Un Promo Code est une réduction qu'un acheteur saisit au paiement, sous forme de pourcentage ou de montant fixe.

Il appartient à un compte, peut être limité à un seul produit et définit qui peut l'utiliser, combien de fois, jusqu'à quand, et pendant combien de périodes de facturation la réduction s'applique.

Utilisez l'API Promo Codes pour créer des codes pour un compte, les lister et les récupérer, désactiver un code pour suspendre son utilisation ou le réactiver, et archiver les codes que vous ne proposez plus.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les codes promo](https://docs.whop.com/fr/api-reference/promo-codes/list-promo-codes.md) | GET `/promo_codes` |
| [Récupérer un code promo](https://docs.whop.com/fr/api-reference/promo-codes/retrieve-promo-code.md) | GET `/promo_codes/{id}` |
| [Créer un code promo](https://docs.whop.com/fr/api-reference/promo-codes/create-promo-code.md) | POST `/promo_codes` |
| [Activer un code promo](https://docs.whop.com/fr/api-reference/promo-codes/activate-promo-code.md) | POST `/promo_codes/{id}/activate` |
| [Désactiver un code promo](https://docs.whop.com/fr/api-reference/promo-codes/deactivate-promo-code.md) | POST `/promo_codes/{id}/deactivate` |
| [Supprimer un code promo](https://docs.whop.com/fr/api-reference/promo-codes/delete-promo-code.md) | DELETE `/promo_codes/{id}` |

## Attributs

**id** `string` *required*

ID du code promo, préfixé par `promo_`.

**account** `object` *required*

Compte propriétaire du code promo.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID du compte, préfixé par `biz_`.
>
> **title** `string` *required*
>
> Nom d'affichage du compte.

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

Affilié crédité des parrainages qui utilisent le code promo, ou `null` si aucun affilié n'est associé.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de l'affilié, préfixé par `aff_`.
>
> **user** `object` *required*
>
> Utilisateur qui est l'affilié.
>
> > [accordion] Propriétés
> >
> > **id** `string` *required*
> >
> > ID utilisateur de l'affilié, préfixé par `user_`.
> >
> > **name** `string | null` *required*
> >
> > Nom d'affichage de l'affilié.
> >
> > **profile\_pic** `string` *required*
> >
> > URL de l'avatar de l'affilié, y compris l'avatar de remplacement généré lorsqu'aucun avatar n'est défini.
> >
> > **username** `string | null` *required*
> >
> > Nom d'utilisateur public de l'affilié.

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

Montant de la réduction. Les réductions en pourcentage sont représentées sous forme de fraction décimale.

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

Indique si le code promo est réservé aux clients perdus.

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

Code saisi lors du paiement.

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

Date de création du code promo, sous forme d'horodatage ISO 8601.

**currency** `string` *required*

Devise utilisée pour une réduction à montant fixe.

Options 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*

Durée d'application de la réduction.

Options disponibles : `forever`, `once`, `repeating`

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

Indique si le code promo s'applique uniquement aux abonnements existants.

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

Date d'expiration du code promo, sous forme d'horodatage ISO 8601.

**metadata** `object` *required*

Métadonnées clé-valeur personnalisées stockées sur le code promo.

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

Indique si le code promo est réservé aux nouveaux clients.

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

Indique si chaque client ne peut utiliser le code promo qu'une seule fois.

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

Produit auquel le code promo est limité, ou `null` s'il n'est pas limité à un produit.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID du produit, préfixé par `prod_`.
>
> **title** `string` *required*
>
> Nom d'affichage du produit.

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

Nombre d'intervalles de facturation auxquels la réduction s'applique.

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

Indique si la réduction est un pourcentage ou un montant fixe.

Options disponibles : `percentage`, `flat_amount`

**status** `string` *required*

Statut du cycle de vie du code promo.

Options disponibles : `active`, `inactive`, `archived`

**stock** `integer` *required*

Nombre maximal d'utilisations lorsque le stock est limité.

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

Indique si le code promo n'a aucune limite d'utilisation.

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

Date de mise à jour du code promo, sous forme d'horodatage ISO 8601.

**uses** `integer` *required*

Nombre d'abonnements ayant utilisé le code promo.

```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"
}
```


## Related topics

- [Code promo](https://docs.whop.com/fr/api-reference/legacy/promo-codes/promo-code.md)
- [Delete Promo Code](https://docs.whop.com/fr/api-reference/promo-codes/delete-promo-code.md)
- [Delete promo code](https://docs.whop.com/fr/api-reference/legacy/promo-codes/delete-promo-code.md)
