Validar Cupom
Descrição
Valida um código de cupom cadastrado no sistema para o usuário autenticado. Use este endpoint na página de resumo do pedido para exibir o valor com desconto antes de redirecionar ao checkout. Retorna se o cupom é válido, a mensagem e o percentual de desconto.
Verbo
POST
URL Base
https://api.soargi.com
Endpoint
/payment/validate-coupon
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
| Content-Type | application/json |
Corpo da Requisição
{
"code": "SOAR10"
}
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| code | string | Sim | Código do cupom cadastrado no sistema (ex.: SOAR10). |
Sucesso - Cupom válido (200)
{
"valid": true,
"message": "Cupom valido.",
"discount": 10,
"stripe_promotion_code_id": "promo_xxx..."
}
Resposta - Cupom inválido (200)
{
"valid": false,
"message": "Codigo invalido ou expirado.",
"discount": 0
}
Erro - 401 (Token inválido)
{
"status": 401,
"error": "Invalid or expired token."
}
Códigos de Resposta
- 200 - Validação retornada (valid true ou false conforme o cupom)
- 401 - Token inválido ou expirado
Observações
- É necessário estar autenticado. Cupons restritos a usuários (list_users) validam o user_id do JWT.
- Use este endpoint na página de resumo do pedido: ao preencher o código, chame validate-coupon e exiba o total com desconto (discount em %).
- Ao clicar em "Comprar licença", envie o mesmo código em promo_code no POST /payment/checkout para aplicar o desconto na sessão do Stripe.