Skip to main content
POST
Criar cupom
Permissão: coupon.write (chave secreta; chave publicável não é aceita).

Endpoint

Em produção use https://api.upag.io/v1 com sk_live_....

Parâmetros

string
required
percentage ou fixed.
string
required
Nome interno (mínimo 3 caracteres).
string
required
Código do cupom (mínimo 3 caracteres). Único por conta; guardado em maiúsculas.
string
required
all ou specific.
string[]
UUIDs de produtos. Obrigatório (não vazio) quando appliesTo é specific.
integer
Obrigatório quando type é percentage. Inteiro de 1 a 100.
integer
Obrigatório quando type é fixed. Valor em centavos (≥ 1).
string
Obrigatório quando type é fixed: brl ou usd.
string
Descrição (mínimo 3 caracteres). Padrão null.
boolean
default:"true"
Se o cupom pode ser usado.
integer
Máximo de usos (≥ 1). Padrão null (ilimitado).
string (ISO 8601)
Data de expiração. Padrão null (não expira).

Resposta

201 Created
Response
  • 400 (COUPON_ALREADY_EXISTS) — já existe um cupom com esse code na conta.
  • 422 — validação (por exemplo, percentOff fora de 1–100 ou specific sem produtos).
Campos: Referência de cupons.