ABabacatepay

Criar um cupom

Changed on

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

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/coupons/create
  • Auth
    HTTP bearer

Request body

codestring required

Identificador único do cupom

notesstring

Descrição sbre o cupom

maxRedeemsnumber required

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

discountinteger required

Valor do desconto. Em PERCENTAGE, é em centésimos de ponto percentual: 100 = 1%, 1000 = 10% (máximo 10000 = 100%). Em FIXED, é em centavos (mínimo 100 = R$ 1,00).

startsAtstring date-time

Início da validade do cupom. Se omitido, o cupom vale imediatamente. Precisa ser posterior a hoje.

expiresAtstring date-time

Fim da validade do cupom. Se omitido, o cupom não expira. Precisa ser posterior a hoje e a startsAt.

Example request

{
  "code": "DEYVIN_20",
  "notes": "Cupom de desconto pro meu público",
  "maxRedeems": 10,
  "discount": 1000,
  "startsAt": "2026-09-01T00:00:00.000Z",
  "expiresAt": "2026-12-31T23:59:59.000Z"
}

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": 1000,
    "devMode": true,
    "status": "ACTIVE",
    "createdAt": "2025-05-25T23:43:25.250Z",
    "updatedAt": "2025-05-25T23:43:25.250Z"
  },
  "success": true
}

Changes

  • fac08134cda8Revision changes
    • breaking

      the request property type changed from number to integer

    • warning

      the request property's min was set to 0.00

  • ea8a72b04f2aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property with a default value became required