Skip to main content
POST
Criar um novo cupom

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

Os dados do seu cupom.

code
string
required

Identificador único do cupom

Example:

"DEYVIN_20"

notes
string
required

Descrição sbre o cupom

Example:

"Cupom de desconto pro meu público"

discountKind
enum<string>
required

Tipo de desconto aplicado, porcentagem ou fixo

Available options:
PERCENTAGE,
FIXED
discount
number
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).

Example:

1000

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

Cliente criado com sucesso.

data
object

Os dados do seu cupom.

error
null
Example:

null