Gerenciamento

Obter saldo da organização

Retorna os totais atuais de saldo da organização para o token de gerenciamento.

GEThttps://api.tokenlab.sh/v1/management/balance

Visão Geral

Este endpoint retorna os totais atuais de saldo da organização associada ao token de gerenciamento. Ele usa a mesma referência atual de saldo da organização usada por faturamento e liquidação.

Notas

  • Os campos monetários aceitam apenas USD.

  • Os campos monetários são retornados em USD. Use balance, total_recharge e total_used para exibição; use balance_decimal, total_recharge_decimal e total_used_decimal para reconciliação exata.

Exemplo

Requisição

cURL
curl -X GET "https://api.tokenlab.sh/v1/management/balance" \
  -H "Authorization: Bearer mt-your-management-token"

Solicitação / Resposta

Esta página fornece o esquema OpenAPI e exemplos de requisições para copiar. Envie solicitações de gerenciamento pelo terminal ou cliente usando um Management Token; o envio direto não está disponível nesta página.

Exemplo de resposta

Resposta

200 OK
{
  "object": "organization_balance",
  "organization_id": "org_123",
  "balance": 42.5,
  "balance_decimal": "42.50",
  "total_recharge": 100,
  "total_recharge_decimal": "100",
  "total_used": 57.5,
  "total_used_decimal": "57.50"
}

Campos importantes

objectstring
Sempre organization_balance.
organization_idstring
Organização associada ao token de gerenciamento atual.
balancenumber
Saldo atual da organização em USD como JSON number para exibição.
balance_decimalstring
Saldo atual exato da organização em USD como string decimal para reconciliação.
total_rechargenumber
Total de recargas bem-sucedidas da organização em USD como JSON number para exibição.
total_recharge_decimalstring
Total exato de recargas bem-sucedidas da organização em USD como string decimal para reconciliação.
total_usednumber
Gasto acumulado de uso da organização em USD como JSON number para exibição.
total_used_decimalstring
Gasto acumulado exato de uso da organização em USD como string decimal para reconciliação.

Autorização

ManagementTokenAuth
AuthorizationBearer <token>

Autenticação por token de gerenciamento. Crie ou gerencie Tokens de Gerenciamento em Dashboard > API > Management Tokens.

Local: header

Resposta

application/json

application/json

application/json

application/json