Financeiro
Ler a franquia de IA do mês em curso
Quanto da franquia de IA do mês em curso o cliente já usou, até hoje, e o excedente que seria cobrado se o mês fechasse agora — pela mesma regra da pré-fatura, sem gravar nada. É o anel de franquia do cabeçalho. Cliente sem agente em produção, ou sem cotação USD/BRL, responde 422. Fora do alcance responde 404, igual a um cliente que não existe.
Autorização
bearer billing:readAutorizaçãoBearer <token>
Credencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: billing:read
Parâmetros de caminho
tenant_id*integer
Id do cliente
Formato
int64Corpo da resposta
application/json
application/json
curl -X GET "https://example.com/billing/profiles/0/allowance-usage"{ "allowance_cents": 0, "as_of": "2019-08-24", "competence": "string", "consumed_cents": 0, "currency": "string", "draft_cents": 0, "excess_cents": 0, "production_cents": 0, "remaining_cents": 0, "tenant_id": 0, "used_cents": 0, "used_percent": "string"}