Skip to main content
PATCH
/
api
/
v1
/
public
/
coupons
/
{uid}
/
use
Usar cupom
curl --request PATCH \
  --url https://api.indiqai.com/api/v1/public/coupons/{uid}/use \
  --header 'X-API-Key: <x-api-key>'
{
  "uid": "A1B2C3D4",
  "status": "usado",
  "valor": 200,
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Usar Cupom

Marca um cupom ainda não utilizado como usado.

​
Comportamento atual

  • a rota não recebe body
  • o response model atual retorna o cupom atualizado com status: "usado"
  • campos opcionais não recarregados neste fluxo podem vir ausentes ou null
  • se o cupom já estiver marcado como usado, o backend devolve o mesmo estado usado
  • 404 fica reservado para cupom inexistente ou fora do escopo da empresa

​
Exemplo de resposta

{
  "uid": "A1B2C3D4",
  "status": "usado",
  "valor": 200,
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

​
Status comuns

  • 200 cupom marcado como usado ou replay de um cupom já usado
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 404 cupom inexistente, fora da empresa ou sem estado aproveitável
  • 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