Skip to main content
GET
Buscar cupom

Consultar Cupom

Retorna o estado atual de um cupom da empresa autenticada.

Comportamento atual

  • a resposta retorna uid, status, product_name, valor, expires_at e created_at
  • o backend serializa o status atual como ativo ou usado
  • quando o cupom está vinculado a produto, product_name é enriquecido nesta rota

Exemplo de resposta

Status comuns

  • 200 cupom encontrado
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 404 cupom inexistente ou fora da empresa autenticada
  • 422 header ou path inválidos
  • 429 limite global da API pública excedido

Headers

X-API-Key
string
required

Chave de API

Path Parameters

uid
string
required

Response

Successful Response

Dados de um cupom.

status
string
required
uid
string
required
created_at
string<date-time> | null
expires_at
string<date-time> | null
product_name
string | null
valor
number | null