couponEnabled).
Estrutura
Atributos
type
type
percentage (usa percentOff, inteiro de 1 a 100) ou fixed (usa amountOff em centavos e currency). O campo do outro tipo vem null.code
code
Código digitado pelo comprador (mínimo 3 caracteres). É normalizado para maiúsculas, sem espaços nas pontas, e é único por conta. Não pode ser alterado depois de criado.
amountOff / currency
amountOff / currency
Só em
fixed. amountOff em centavos (inteiro ≥ 1); currency é brl ou usd. Um cupom fixo só desconta quando a moeda bate com a da cobrança.uses / maxUses
uses / maxUses
uses é quantas vezes o cupom foi usado. maxUses (inteiro ≥ 1, ou null para ilimitado) é o teto de usos.appliesTo / appliesToProducts
appliesTo / appliesToProducts
all ou specific. Em specific, appliesToProducts é a lista de UUIDs de produtos elegíveis (obrigatória e não vazia). Em all vem null.active / expiresAt
active / expiresAt
Cupom inativo ou expirado é recusado na aplicação.
expiresAt é uma data ISO 8601 ou null.Endpoints
Todos exigem chave secreta (sk_).
Erros ao aplicar um cupom
Ao aplicar o cupom em um checkout, a API pode responder400 com COUPON_NOT_ENABLED, COUPON_NOT_ACTIVE, COUPON_EXPIRED ou COUPON_MAX_USES_REACHED.