v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar cupons

Retorna todos os cupons que você criou com suporte a paginação.

Você pode usar essa rota para visualizar todos os seus cupons, incluindo seus status (ativos, inativos ou expirados), descontos aplicados e quantas vezes foram utilizados.

Alternativa: Você também pode visualizar e gerenciar seus cupons pelo Dashboard da AbacatePay.

get/coupons/list

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

Quantidade de itens por página (1-100).

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:DEYVIN_20

Filtrar por identificador único do cupom

status'ACTIVE' | 'INACTIVE' | 'EXPIRED'

Filtrar por status do cupom

Response

Lista de cupons retornada com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "DEYVIN_20",
      "notes": "Cupom de desconto pro meu público",
      "maxRedeems": -1,
      "discountKind": "PERCENTAGE",
      "discount": 123,
      "devMode": true,
      "status": "ACTIVE",
      "createdAt": "2025-05-25T23:43:25.250Z",
      "updatedAt": "2025-05-25T23:43:25.250Z"
    }
  ],
  "success": true
}