Skip to main content
Os cupons de desconto permitem que você ofereça reduções de preço aos seus clientes de forma controlada e estratégica. Você pode criar cupons com desconto percentual ou valor fixo, definir limites de uso e acompanhar quantas vezes foram utilizados.

​
Estrutura

Um cupom é representado em nossa API pela seguinte estrutura: 
{
  "id": "MY_COUPON",
  "discountKind": "PERCENTAGE",
  "discount": 10,
  "maxRedeems": -1,
  "redeemsCount": 0,
  "status": "ACTIVE",
  "devMode": true,
  "notes": "teste de cupom",
  "createdAt": "2025-01-23T14:06:16.880Z",
  "updatedAt": "2025-01-23T14:06:16.880Z"
}

​
Atributos:

{
  "id": "MY_COUPON",
}
id : string.
Código único do cupom que seus clientes irão utilizar para aplicar o desconto
{
  "notes": "Cupom de boas-vindas - 10% de desconto",
}
notes : string.
Descrição interna do cupom para sua organização e controle
{
  "maxRedeems": -1,
}
maxRedeems : number.
Limite de vezes que o cupom pode ser utilizado. Use -1 para cupons ilimitados ou um número específico para limitar o uso
{
  "redeemsCount": 0,
}
redeemsCount : number.
Contador de quantas vezes o cupom já foi utilizado pelos clientes
{
  "discountKind": "PERCENTAGE",
}
discountKind : string.
Tipo de desconto aplicado pelo cupom
TipoDescrição
PERCENTAGEDesconto percentual (ex: 10% de desconto)
FIXEDValor fixo (ex: R$ 5,00 de desconto)
{
  "discount": 10,
}
discount : number.
Valor do desconto. Para PERCENTAGE use números de 1-100 (ex: 10 = 10%). Para FIXED use o valor em centavos (ex: 500 = R$ 5,00)
{
  "status": "ACTIVE",
}
status : string.
Status atual do cupom
StatusDescrição
ACTIVEO cupom está ativo e pode ser utilizado pelos clientes
DELETEDO cupom foi removido e não pode mais ser usado
DISABLEDO cupom foi desabilitado ou atingiu o limite máximo de usos
{
  "devMode": true,
}
devMode : boolean.
Indica se o cupom foi criado em ambiente de desenvolvimento (true) ou produção (false)
{
  "metadata": {
    "campaign": "black-friday-2024",
    "category": "new-customers"
  },
}
metadata : object.
Objeto para armazenar informações adicionais sobre o cupom, como campanha, categoria ou outros dados relevantes para sua organização
{
  "createdAt": "2025-01-23T14:06:16.880Z",
}
createdAt : date-time.
Data e hora de criação do cupom
{
  "updatedAt": "2025-01-23T14:06:16.880Z",
}
updatedAt : date-time.
Data e hora da última atualização do cupom