Skip to main content
POST
/
coupons
/
create
Criar um cupom
curl --request POST \
  --url https://api.abacatepay.com/v2/coupons/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "DEYVIN_20",
  "discountKind": "PERCENTAGE",
  "discount": 123,
  "notes": "Cupom de desconto pro meu público",
  "maxRedeems": 10,
  "metadata": {}
}
'
{
  "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
}

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.

Cria um cupom de desconto que seus clientes aplicam no checkout.

Obrigatórios

code (único na sua loja), discountKind (PERCENTAGE ou FIXED) e discount (valor do desconto).
PERCENTAGE desconta uma porcentagem do total. FIXED desconta um valor fixo em centavos. Exemplo — 10% de desconto ilimitado: 
{
  "code": "BEMVINDO10",
  "discountKind": "PERCENTAGE",
  "discount": 10,
  "maxRedeems": -1,
  "notes": "Cupom de boas-vindas"
}
Exemplo — R$ 20,00 fixo, válido 50 vezes: 
{
  "code": "PROMO20",
  "discountKind": "FIXED",
  "discount": 2000,
  "maxRedeems": 50
}
-1 significa usos ilimitados. Qualquer valor positivo limita o número total de resgates.

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.

Body

application/json

Os dados do seu cupom.

​
code
string
required

Identificador único do cupom

Example:

"DEYVIN_20"

​
discountKind
enum<string>
required

Tipo de desconto aplicado, porcentagem ou fixo

Available options:
PERCENTAGE,
FIXED
​
discount
number
required

Valor de desconto a ser aplicado

​
notes
string

Descrição sbre o cupom

Example:

"Cupom de desconto pro meu público"

​
maxRedeems
number
default:-1

Quantidade de vezes em que o cupom pode ser resgatado. -1 Significa que esse cupom pode ser resgatado sem limites

Example:

10

​
metadata
object

Objeto chave valor para metadados do cupom

Response

Cupom criado 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