---
title: "Listar cupons"
method: GET
path: "/coupons/list"
---

# Listar cupons

`GET /coupons/list`

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](https://app.abacatepay.com/cupons).

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `startDate` string, date
- `endDate` string, date
- `id` string
- `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED'

## Response `200`

Lista de cupons retornada com sucesso.

- object
  - `data` CouponResponse[] — Lista de cupons.
    - `id` string, required — Identificador único do cupom
    - `notes` string — Descrição sobre o cupom
    - `maxRedeems` integer — Quantidade de vezes em que o cupom pode ser resgatado. -1 significa ilimitado.
    - `redeemsCount` integer — Quantidade de vezes que o cupom já foi resgatado.
    - `discountKind` 'PERCENTAGE' | 'FIXED', required — Tipo de desconto aplicado, porcentagem ou fixo
    - `discount` number, required — Valor de desconto a ser aplicado
    - `devMode` boolean — Indica se o cupom foi criado em ambiente de testes.
    - `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED', required — Status atual do cupom.
    - `createdAt` string, date-time, required — Data de criação do cupom.
    - `updatedAt` string, date-time, required — Data de atualização do cupom.
    - `metadata` object — Objeto chave valor para metadados do cupom
  - `success` boolean — Se a requisição obteve sucesso ou não.
  - `error` string, nullable
  - `pagination` PaginationCursor — Informações de paginação baseada em cursor.
    - `hasMore` boolean, required — Indica se existe mais itens para carregar.
    - `next` string, nullable, required — Cursor para próxima página (usar em after).
    - `before` string, nullable, required — Cursor para página anterior (usar em before).

## Other responses

- `401` — Não autorizado. Falha na autenticação.

---

[API](https://skmtc.net/abacatepay/apis/api-abacatepay.md) · [All operations](https://skmtc.net/abacatepay/apis/api-abacatepay/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/abacatepay/api-abacatepay/revisions/6b89a7fa70f5/schema)