Skip to main content

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.

Cupons oferecem desconto percentual ou valor fixo aos clientes, com limite de uso e contagem de resgates.

​
Criar cupom

Use /coupons/create.

Campos obrigatórios

Obrigatórios: code (único), discount, discountKind (PERCENTAGE ou FIXED). Opcionais: maxRedeems, notes, metadata.
Exemplo: 
POST /coupons/create
{
  "code": "MY_COUPON",                    // obrigatório - identificador único do cupom
  "discountKind": "PERCENTAGE",           // obrigatório - tipo de desconto (PERCENTAGE ou FIXED)
  "discount": 10,                         // obrigatório - valor do desconto
  "maxRedeems": -1,                       // -1 = ilimitado; qualquer número positivo limita os usos
  "notes": "Cupom de desconto especial",  
  "metadata": {                           
    "campaign": "black-friday"
  }
}
Resposta: 
{
  "data": {
    "id": "MY_COUPON",
    "discountKind": "PERCENTAGE",
    "discount": 10,
    "maxRedeems": -1,
    "redeemsCount": 0,
    "status": "ACTIVE",
    "devMode": true,
    "notes": "Cupom de desconto especial",
    "createdAt": "2025-01-23T14:06:16.880Z",
    "updatedAt": "2025-01-23T14:06:16.880Z"
  },
  "success": true,
  "error": null
}