Axuz Developers

POST /v1/teams/{teamId}/billing/invoices/{invoiceId}/apply-coupon

Aplica cupom em fatura open/draft (Fase 99)

  • Acesso: Admin da equipe
  • Serviço: https://api-billing.axuz.net

Autenticação aceita

  • 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`.

Exposes ApplyCouponToInvoice via POST /teams/:teamId/billing/invoices/:invoiceId/apply-coupon. Body: {"code": "SUMMER20"}. Maps ApplyCouponError codes to HTTP status: not_found → 404, expired/exhausted → 410, wrong_scope → 400, already_applied → 409, invoice_not_open → 409, invoice_not_found → 404.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
invoiceIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
codestringsim
{
  "code": "string"
}

Respostas

200

cupom aplicado

NomeTipoObrigatórioDescrição
invoice_idstring<uuid>não
coupon_idstring<uuid>não
subtotal_centsintegernão
discount_centsintegernão
total_centsintegernão

400

input inválido

NomeTipoObrigatórioDescrição
errorstringsim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

fatura não é do time

NomeTipoObrigatórioDescrição
errorstringsim

404

recurso não encontrado

NomeTipoObrigatórioDescrição
errorstringsim

409

already_applied / invoice_not_open

NomeTipoObrigatórioDescrição
errorstringsim

410

expired / exhausted

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

erro interno

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api-billing.axuz.net/v1/teams/TEAM_ID/billing/invoices/INVOICE_ID/apply-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/v1/teams/TEAM_ID/billing/invoices/INVOICE_ID/apply-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/v1/teams/TEAM_ID/billing/invoices/INVOICE_ID/apply-coupon",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "code": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())