Referência da API

Listar usos do cupom

Retorna lista paginada de quem usou o cupom: qual cliente, qual fatura (com a Offer de origem), quanto foi descontado (em centavos), IP e user-agent do checkout. Útil pra auditoria, relatórios de campanha e suporte.

GET/v2/coupons/:id/redemptions

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

idstring (path, UUID)obrigatório

UUID do cupom.

Exemplo: cpn_a8f3d2e1-...

pagenumber (query, 0-indexed)opcional

Página, começando em 0. Padrão: 0.

Exemplo: 0

limitnumber (query)opcional

Quantidade por página. Padrão: 20. Máximo: 100.

Exemplo: 20

Respostas

200

Lista paginada das redemptions, ordenadas por createdAt DESC (mais recentes primeiro). Cada item inclui customer e invoice (com a Offer de origem embutida).

JSON

{
  "result": [
    {
      "id": "red_xyz123",
      "amountDiscounted": 1500,
      "ipAddress": "201.23.45.67",
      "userAgent": "Mozilla/5.0 ...",
      "createdAt": "2026-05-26T15:00:00.000Z",
      "customer": {
        "id": "c8a5f4d2-...",
        "name": "João Silva",
        "email": "joao@exemplo.com",
        "document": "12345678901"
      },
      "invoice": {
        "id": "inv_111",
        "status": "PAID",
        "description": "Plano Premium - João Silva",
        "amount": 8500,
        "amountPaid": 7000,
        "paidAt": "2026-05-26T15:05:23.000Z",
        "offer": {
          "id": "off_plano_premium",
          "name": "Plano Premium",
          "slug": "plano-premium"
        }
      }
    }
  ],
  "totalCount": 47
}

404

Cupom não encontrado.

JSON

{ "status": 404, "error": "Cupom nao encontrado" }

Exemplos

cURL

curl -X GET "https://api.pagnovo.com/v2/coupons/cpn_a8f3d2e1-.../redemptions?limit=50" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"