> ## Documentation Index
> Fetch the complete documentation index at: https://fortal-pay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência

> Visão geral das operações disponíveis para cupons.

## Criar cupom

<Card title="Campos obrigatórios" type="info" horizontal>
  Os campos `code` (único), `value`, `type`(`PERCENTAGE` ou `FIXED_AMOUNT`).
</Card>

<Note>
  O campo `type` aceita apenas os seguintes valores:

  * `PERCENTAGE` — Desconto percentual.
  * `FIXED_AMOUNT` — Desconto em valor fixo (informado em centavos).
</Note>

<Note>
  Os campos `starts_at` e `expires_at` são opcionais e permitem definir o período de validade do cupom. Caso não sejam informados, o cupom ficará disponível imediatamente e sem data de expiração.
  Eles aceitam `yyyy-MM-dd` ou `yyyy-MM-dd'T'HH:mm:ss`. Uma data sem horário usa o início do dia em `starts_at` e o fim do dia em `expires_at`.
</Note>

Payload esperado

```json theme={null}
POST /coupons
{
  "code": "string",						// obrigatório
  "type": "PERCENTAGE",					// obrigatório
  "value": 1,							// obrigatorio
  "max_uses": 10,						// opcional
  "starts_at": "2026-08-02",          // opcional
  "expires_at": "2026-09-02"          // opcional
}
```

Resposta

```json theme={null}
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "type": "FIXED_AMOUNT",
    "value": 25.00,
    "max_uses": 10,
    "used_count": 0,
    "starts_at": "2026-08-02T21:23:10.506Z",
    "expires_at": "2026-08-02T21:23:10.506Z",
    "status": "ACTIVE",
    "created_at": "2026-08-02T21:23:10.506Z",
    "updated_at": "2026-08-02T21:23:10.506Z"
  }
}
```

<CardGroup cols={3} />