# Coupons

## Objet coupon

L’objet `coupon` représente un coupon de réduction applicable à une commande. Il possède les propriétés suivantes :

## Propriétés

| Propriété | Type | Description |
| --- | --- | --- |
| `reference_name` | string | Nom de référence interne, non affiché aux clients. |
| `code` | string | Code que les clients utilisent pour appliquer le coupon. Il doit être unique et facile à mémoriser. |
| `note` | string | Note affichée aux clients lorsqu’ils appliquent le coupon, qui peut expliquer la réduction. |
| `coupon_type` | string | Type de coupon. Valeurs acceptées : `"direct_discount"` et `"gift"`. |
| `discount_type` | string | Type de réduction. Valeurs acceptées : `"flat"` et `"percent"`. |
| `discount_value` | number | Valeur de la réduction, montant fixe ou pourcentage selon `discount_type`. |
| `min_amount` | number | Montant minimum de commande requis pour utiliser le coupon. |
| `max_amount` | number | Montant maximum de commande auquel le coupon peut s’appliquer. |
| `max_discount` | number | Réduction maximale pouvant être appliquée. |
| `max_uses` | number | Nombre maximal d’utilisations du coupon. |
| `max_uses_user` | number | Nombre maximal d’utilisations par un même utilisateur. |
| `new_user` | boolean | Indique si le coupon est réservé aux nouveaux utilisateurs. |
| `start_at` | string | Date et heure à partir desquelles le coupon est disponible. |
| `end_at` | string | Date et heure d’expiration du coupon. |
| `active` | boolean | Indique si le coupon est actuellement actif. |

## Exemple

Voici un exemple d’objet `coupon` :

```json
{
    "coupon": {
        "reference_name": "Holiday Campaign",
        "code": "HOLIDAY",
        "note": "Great! You have received $10 disount.",
        "coupon_type": "direct_discount",
        "discount_type": "flat",
        "discount_value": 10,
        "min_amount": 100,
        "max_amount": 0,
        "max_discount": 10,
        "max_uses": 1000,
        "max_uses_user": 1,
        "new_user": true,
        "start_at": "2022-12-12 00:00:00",
        "end_at": "2022-12-31 00:00:00",
        "active": true
    }
}
```