Skip to main content
GET
/
coupons
/
get
Buscar um cupom
curl --request GET \
  --url https://api.abacatepay.com/v2/coupons/get \
  --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": {}
  },
  "error": null,
  "success": true
}
Retorna os dados de um cupom pelo seu code.

Requer a permissão COUPON:READ.
Use redeemsCount para acompanhar quantas vezes o cupom já foi utilizado e status para verificar se ainda está ativo.

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

​
id
string

Identificador único do cupom

Example:

"MY_COUPON"

Response

Cupom encontrado com sucesso.

​
data
object

Os dados do seu cupom.

​
error
string | null
Example:

null

​
success
boolean

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

Example:

true