# Cupones

## Objeto cupón

El objeto `coupon` representa un cupón de descuento que se puede aplicar a un pedido. Tiene las siguientes propiedades:

## Propiedades

| Propiedad | Tipo | Descripción |
| --- | --- | --- |
| `reference_name` | string | Nombre de referencia interno que no se muestra a los clientes. |
| `code` | string | Código que los clientes usan para canjear el cupón. Debe ser único y fácil de recordar. |
| `note` | string | Nota que se muestra al aplicar el cupón y que puede explicar el descuento. |
| `coupon_type` | string | Tipo de cupón. Valores válidos: `"direct_discount"` y `"gift"`. |
| `discount_type` | string | Tipo de descuento. Valores válidos: `"flat"` y `"percent"`. |
| `discount_value` | number | Valor del descuento; puede ser un importe fijo o un porcentaje según `discount_type`. |
| `min_amount` | number | Importe mínimo del pedido requerido para usar el cupón. |
| `max_amount` | number | Importe máximo del pedido al que se puede aplicar el cupón. |
| `max_discount` | number | Descuento máximo que se puede aplicar. |
| `max_uses` | number | Número máximo de veces que se puede usar el cupón. |
| `max_uses_user` | number | Número máximo de usos por usuario. |
| `new_user` | boolean | Indica si el cupón solo está disponible para usuarios nuevos. |
| `start_at` | string | Fecha y hora a partir de las que está disponible el cupón. |
| `end_at` | string | Fecha y hora en que caduca el cupón. |
| `active` | boolean | Indica si el cupón está activo actualmente. |

## Ejemplo

Este es un ejemplo de objeto `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
    }
}
```
