Saldo de Créditos

Name: SRTGen
Rating: 4.9 (10000 reviews)

Consulte seu saldo atual de créditos disponíveis para gerenciar o uso e evitar falhas nas tarefas.

GET/api/v1/balance

Implementação Rápida

curl -X GET https://api.srtgen.com/api/v1/balance \
  -H "x-api-key: <YOUR_API_KEY>"

GEThttps://api.srtgen.com/api/v1/balance

Este endpoint retorna o saldo total utilizável, que inclui as cotas mensais de sua assinatura e quaisquer créditos extras de recarga que você tenha adquirido.

Estrutura da Resposta

Parâmetro	Tipo	Obrigatório
Identidade e Contexto
`user`	Objeto	Informações básicas sobre o usuário autenticado.
`user.name`	Tipo	O nome de exibição do usuário.
`user.email`	Tipo	O endereço de e-mail registrado.
Detalhamento do Saldo de Créditos
`credits`	Objeto	Detalhamento detalhado do saldo de créditos.
`credits.totalBalance`	Number	Soma de todos os créditos utilizáveis (Cotas + Extra).
`credits.extraCredits`	Number	Créditos de recarga permanentes.
`credits.plans`	Array	Lista de planos de assinatura ativos.
`plans[].name`	Tipo	Nome de exibição do plano (ex: 'Plano Pro').
`plans[].status`	Tipo	Status da assinatura (ativo, past_due).
`plans[].balance`	Number	Créditos restantes neste ciclo específico.
Uso do Armazenamento em Nuvem
`storage`	Objeto	Estatísticas de uso do armazenamento em nuvem.
`storage.usage`	Number	Uso atual do armazenamento em bytes.
`storage.limit`	Number	Limite máximo de armazenamento em bytes com base no seu plano.
`storage.formattedUsage`	Tipo	Uso legível por humanos (ex: '200 MB').
`storage.formattedLimit`	Tipo	Limite legível por humanos (ex: '10 GB').

Exemplo de Resposta: 200 OK

{
  "success": true,
  "user": {
    "name": "Alex Rivera",
    "email": "[email protected]"
  },
  "credits": {
    "totalBalance": 1250,
    "totalMonthlyCredits": 1000,
    "extraCredits": 250,
    "plans": [
      {
        "id": "starter",
        "name": "Starter Plan",
        "status": "active",
        "balance": 1000,
        "total": 1000,
        "resetTime": "2026-04-29T17:48:46.000Z"
      }
    ]
  },
  "storage": {
    "usage": 209715200,
    "limit": 10737418240,
    "formattedUsage": "200 MB",
    "formattedLimit": "10 GB"
  },
  "updatedAt": "2026-03-29T17:48:46.000Z"
}

Erros

Status	Código do Erro	Descrição
401	unauthorized	Chave de API ausente ou inválida.
500	server_error	Ocorreu um erro interno inesperado.

Esta página foi útil?