Docs
API 1.39
Status
Credits

Read credit balance and pools

GET /v1/credits: Read credit balance and pools

GET /v1/credits
Operation idgetCredits
Key scoperead: every key
SectionCredits

#Example request

curl -X GET "https://api.kaab.ist/v1/credits" \
  -H "Authorization: Bearer $KAAB_API_KEY"

#Responses

#200

Credits

Credits

{
  "balance": 1200,
  "reserved": 40,
  "available": 1160,
  "pools": [
    {
      "type": "allowance",
      "amount": 1000,
      "expires_at": "2026-10-01T00:00:00Z"
    },
    {
      "type": "purchased",
      "amount": 200,
      "expires_at": null
    }
  ],
  "auto_recharge": {
    "threshold": 200,
    "amount": 1000
  }
}

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
403The key's scope does not cover this operation
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?