POST /teams/{teamId}/billing/redeem-coupon
Resgata cupom pela primeira vez (não aplica ainda)
- Access: Team admin
- Service:
https://api-billing.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
Responde POST /teams/{teamId}/billing/coupons/ redeem — o time resgata um cupom pela primeira vez. Em transação com FOR UPDATE no coupon: valida validade/estoque/uniqueness por team; INSERT em coupon_redemptions; UPDATE incrementando used_count.
A unicidade do par (cupom, time) tem DUAS guardas, e é de propósito (O-014): o FOR UPDATE + EXISTS serializam quem entra por aqui, e idx_coupon_redemptions_team_unique (migration 007) recusa no banco quem escrever por qualquer outro caminho. A violação do índice volta 409, igual ao caminho do lock — ver isRedemptionConflict.
A aplicação do desconto na próxima invoice fica pro path de invoicing (ApplyCouponToInvoice).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
code | string | yes |
{
"code": "string"
}Responses
200
ok
| Name | Type | Required | Description |
|---|---|---|---|
ok | boolean | no |
400
input inválido
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
recurso não encontrado
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
409
já resgatado
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
410
inativo/expirado/exhausted
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
erro interno
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X POST 'https://api-billing.axuz.net/teams/TEAM_ID/billing/redeem-coupon' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"string"}'Node.js
const res = await fetch("https://api-billing.axuz.net/teams/TEAM_ID/billing/redeem-coupon", {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"code": "string"
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"POST",
"https://api-billing.axuz.net/teams/TEAM_ID/billing/redeem-coupon",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"code": "string",
},
timeout=30,
)
res.raise_for_status()
print(res.json())