Axuz Developers

POST /v1/teams/{teamId}/billing/invoices/{invoiceId}/charge

Cobra fatura open em payment_method salvo

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

Sucesso imediato → 200. Pending (SCA / async) → 202 (webhook confirma). Falha → 502 com o motivo.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
invoiceIdpathstringsim

Corpo da requisição

application/json

NomeTipoObrigatórioDescrição
payment_method_idstringnão

UUID de payment_methods; vazio = default do time

{
  "payment_method_id": "string"
}

Respostas

200

pago

NomeTipoObrigatórioDescrição
okbooleannão
statusstringnão
provider_idstringnão

202

pending (aguarda webhook)

NomeTipoObrigatórioDescrição
okbooleannão
statusstringnão
provider_idstringnão
requires_webhookbooleannão

400

input inválido

NomeTipoObrigatórioDescrição
errorstringsim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

404

recurso não encontrado

NomeTipoObrigatórioDescrição
errorstringsim

409

fatura já paga / não cobrável

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

502

falha do gateway

NomeTipoObrigatórioDescrição
errorstringsim

503

gateway não configurado

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/charge' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"payment_method_id":"string"}'

Node.js

const res = await fetch("https://api-billing.axuz.net/v1/teams/TEAM_ID/billing/invoices/INVOICE_ID/charge", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "payment_method_id": "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/charge",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "payment_method_id": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())