skip to content
superbot.gg

Get the credit balance

Part of Usage & spend, 8 operations. The overview covers keys, scopes and errors.

GET /v1/credits

The credit balance, the period meter and the plan.

A caller key holding billing:read (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id getCredits in Usage & spend.

Response 200

The balance.

application/json: Credits.

  • credits object required

    The pot view: beta, plan and permanent credits with a total.

  • balance_credits number required
  • balance_tokens number required
  • total_usage_tokens number required
  • period_usage_tokens number required
  • capacity_tokens number required
  • keys_count integer required
  • paid_usd_week number required
  • list_usd_week number required
  • saved_usd_week number required
  • plan string required
  • renews_at string

Errors

StatusCodeWhat to change
401unauthorized

Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.

403insufficient_scope

The key lacks the scope in required_scopes; mint a key that holds it.

view .mdopenapi
Request

curl

curl -sS -X GET "https://superbot.gg/v1/credits" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

const res = await fetch(`https://superbot.gg/v1/credits`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://superbot.gg/v1/credits",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())
Response

200 The balance.

{
  "credits": {},
  "balance_credits": 0,
  "balance_tokens": 0,
  "total_usage_tokens": 0,
  "period_usage_tokens": 0,
  "capacity_tokens": 0,
  "keys_count": 0,
  "paid_usd_week": 0,
  "list_usd_week": 0,
  "saved_usd_week": 0,
  "plan": "your-plan",
  "renews_at": "your-renews-at"
}

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}