Obter Status de Faturamento

Retornar o plano atual, a situação de faturamento, a franquia de créditos e a cota de armazenamento. credits e storage informam as franquias agrupadas do pagador e são null a menos que quem faz a chamada possa gerenciar o faturamento desse pagador; são sempre null para uma API key de workspace. O histórico de faturamento fica em GET /api/v2/billing/logs.

GET/api/v2/billing/status
X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de query

workspaceId?string

Workspace whose payer should be resolved. A workspace API key is pinned to its own workspace: any other id answers 404 Workspace not found, which is also what an id that does not exist answers.

Tamanho1 <= length <= 128

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v2/billing/status" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "workspaceId": null,
    "period": {
      "start": "2026-07-01T00:00:00.000Z",
      "end": "2026-08-01T00:00:00.000Z"
    },
    "plan": "pro",
    "status": "active",
    "credits": {
      "used": 512,
      "limit": 20000,
      "remaining": 19488
    },
    "storage": {
      "usedBytes": 5242880,
      "limitBytes": 1073741824,
      "percentUsed": 0.48828125
    }
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}