Criar um novo cupom

curl --request POST \
  --url https://api.abacatepay.com/v1/coupon/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "code": "DEYVIN_20",
    "discountKind": "PERCENTAGE",
    "discount": 123,
    "notes": "Cupom de desconto pro meu público",
    "maxRedeems": 10,
    "metadata": {}
  },
  "error": "<unknown>"
}
'

{
  "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": "<unknown>"
}

POST

coupon

create

Criar um novo cupom

curl --request POST \
  --url https://api.abacatepay.com/v1/coupon/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "code": "DEYVIN_20",
    "discountKind": "PERCENTAGE",
    "discount": 123,
    "notes": "Cupom de desconto pro meu público",
    "maxRedeems": 10,
    "metadata": {}
  },
  "error": "<unknown>"
}
'

{
  "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": "<unknown>"
}

Authorizations

Authorization

string

header

required

Cabeçalho de autenticação Bearer no formato Bearer <abacatepay-api-key> onde <abacatepay-api-key> é a sua chave de API.

Body

application/json

data

object

Os dados do seu cupom.

Show child attributes

data.code

string

required

Identificador único do cupom

Example:

"DEYVIN_20"

data.discountKind

enum<string>

required

Tipo de desconto aplicado, porcentagem ou fixo

Available options:

PERCENTAGE,

FIXED

data.discount

number

required

Valor de desconto a ser aplicado

data.notes

string

Descrição sbre o cupom

Example:

"Cupom de desconto pro meu público"

data.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

data.metadata

object

Objeto chave valor para metadados do cupom

error

null

Response

Cliente criado com sucesso.

data

object

Os dados do seu cupom.

Show child attributes

data.id

string

required

Identificador único do cupom

Example:

"DEYVIN_20"

data.discountKind

enum<string>

required

Tipo de desconto aplicado, porcentagem ou fixo

Available options:

PERCENTAGE,

FIXED

Example:

"PERCENTAGE"

data.discount

number

required

Valor de desconto a ser aplicado

Example:

123

data.status

enum<string>

required

Status atual do cupom.

Available options:

ACTIVE,

INACTIVE,

EXPIRED

Example:

"ACTIVE"

data.createdAt

string<date-time>

required

Data de criação do cupom.

Example:

"2025-05-25T23:43:25.250Z"

data.updatedAt

string<date-time>

required

Data de atualização do cupom.

Example:

"2025-05-25T23:43:25.250Z"

data.notes

string

Descrição sobre o cupom

Example:

"Cupom de desconto pro meu público"

data.maxRedeems

integer

default:10

Quantidade de vezes em que o cupom pode ser resgatado. -1 significa ilimitado.

Example:

-1

data.redeemsCount

integer

Quantidade de vezes que o cupom já foi resgatado.

Example:

0

data.devMode

boolean

Indica se o cupom foi criado em ambiente de testes.

Example:

true

data.metadata

object

Objeto chave valor para metadados do cupom

error

null

Referência Listar cupons

⌘I

Introdução

Cliente

Cobrança

Pix QRCode

Cupom

Saque

Loja

Trust MRR

Criar um novo cupom

Authorizations

Body

Response