Skip to main content
GET
/
api
/
v1
/
billing
/
credits
Get available credits balance
curl --request GET \
  --url https://api.example.com/api/v1/billing/credits \
  --header 'Authorization: Bearer <token>'
{
  "availableCredits": 123,
  "organizationId": 123,
  "retrievedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Response

Returns the credits balance

Response model for credits balance

​
availableCredits
number<double>

Current available credits balance

​
organizationId
integer<int32>

Organization ID

​
retrievedAt
string<date-time>

Timestamp when the balance was retrieved