v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Criar um cupom

Permite que você crie um novo cupom que pode ser usado por seus clientes para aplicar descontos.

Alternativa: Você também pode criar e gerenciar seus cupons pelo Dashboard da AbacatePay.

post/coupons/create

Request body

codestring required

Identificador único do cupom

notesstring

Descrição sbre o cupom

maxRedeemsnumber

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

discountKind'PERCENTAGE' | 'FIXED' required

Tipo de desconto aplicado, porcentagem ou fixo

discountnumber required

Valor de desconto a ser aplicado

metadataobject

Objeto chave valor para metadados do cupom

Example request

{
  "code": "DEYVIN_20",
  "notes": "Cupom de desconto pro meu público",
  "maxRedeems": 10
}

Response

Cupom criado com sucesso.

errorstring nullable

successboolean

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

Example response

{
  "data": {
    "id": "DEYVIN_20",
    "notes": "Cupom de desconto pro meu público",
    "maxRedeems": -1,
    "discountKind": "PERCENTAGE",
    "discount": 123,
    "devMode": true,
    "status": "ACTIVE",
    "createdAt": "2025-05-25T23:43:25.250Z",
    "updatedAt": "2025-05-25T23:43:25.250Z"
  },
  "success": true
}