Skip to main content
GET
/
coupons
/
list
Listar cupons
curl --request GET \
  --url https://api.abacatepay.com/v2/coupons/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "DEYVIN_20",
      "discountKind": "PERCENTAGE",
      "discount": 123,
      "status": "ACTIVE",
      "createdAt": "2025-05-25T23:43:25.250Z",
      "updatedAt": "2025-05-25T23:43:25.250Z",
      "notes": "Cupom de desconto pro meu público",
      "maxRedeems": -1,
      "redeemsCount": 0,
      "devMode": true,
      "metadata": {}
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

Retorna todos os cupons da sua loja, incluindo ativos e inativos.

Requer a permissão COUPON:READ.
Use limit, after e before para paginar. Cada item segue o mesmo formato da resposta do Criar Cupom, incluindo status, redeemsCount e maxRedeems.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
after
string

Cursor para buscar itens após este ponto

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

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

Required range: 1 <= x <= 100
Example:

100

​
id
string

Filtrar por identificador único do cupom

Example:

"DEYVIN_20"

​
status
enum<string>

Filtrar por status do cupom

Available options:
ACTIVE,
INACTIVE,
EXPIRED

Response

Lista de cupons retornada com sucesso.

​
data
object[]

Lista de cupons.

​
success
boolean

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

Example:

true

​
error
string | null
Example:

null

​
pagination
object

Informações de paginação baseada em cursor.