LYNX UPBANK · Tecnologia de pagamentos Pix & Crypto

Cupons de desconto

POST/v1/coupons

Gerencia os cupons de desconto aplicáveis nos seus checkouts. GET /v1/coupons lista (escopo STORE:READ). No POST: sem id cria; com id edita; com { id, delete: true } exclui.

Permissão necessária: STORE:MANAGE

Parâmetros

Parâmetro	Tipo	Descrição
`id`	string	ID do cupom (cpn_…). Presente = edita; com delete: true = exclui.
`code`obrig.	string	Código do cupom: 3 a 24 caracteres A-Z, 0-9, hífen ou _ (ex.: BEMVINDO10).
`type`obrig.	string	"percent" (desconto %) ou "fixed" (valor fixo em centavos).
`percent`	number	Percentual de desconto (0 a 100), obrigatório se type for percent.
`fixedCents`	integer	Desconto fixo em centavos, obrigatório se type for fixed.
`applyScope`	string	"subtotal" (padrão, produto + order bump) ou "base" (só o produto).
`appliesTo`	string	"all" (padrão, todos os checkouts) ou "selected" (use checkoutIds).
`checkoutIds`	array	IDs dos checkouts onde o cupom vale (com appliesTo: selected).
`maxUses`	integer	Limite de usos (0 = ilimitado).
`minAmountCents`	integer	Pedido mínimo em centavos para o cupom valer.
`expiresAt`	string	Validade (ISO, ex.: "2026-12-31"). O dia inteiro é incluído.
`status`	string	"active" (padrão) ou "paused".

Requisição

bash

curl -X POST https://lynxpix.cc/api/v1/coupons \
  -H "Authorization: Bearer lynx_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"code":"BEMVINDO10","type":"percent","percent":10,"maxUses":100,"expiresAt":"2026-12-31"}'

Resposta

json

{
  "data": {
    "id": "cpn_1a2b3c",
    "code": "BEMVINDO10",
    "type": "percent",
    "percent": 10,
    "uses": 0,
    "status": "active"
  },
  "error": null
}