Get API credit balance

GET

/api/v1/management/credits/balance

curl --request GET \
  --url https://api.koneth.com/api/v1/management/credits/balance \
  --header 'Authorization: <Authorization>' \
  --header 'X-Request-Id: onboarding-client-1042'

• Production
• Local development

Returns the organization’s API credit wallet and low-balance state. Requires credits:read.

Authorizations

• managementKey

Parameters

Header Parameters

X-Request-Id

string

Optional correlation ID used for API request billing and logs.

Example

onboarding-client-1042

Responses

200

Credit wallet returned.

Media typeapplication/json

object

wallet

required

object

id

required

string format: uuid

organizationId

required

string format: uuid

availableCredits

required

integer

reservedCredits

required

integer

lifetimePurchased

required

integer

lifetimeConsumed

required

integer

lowBalanceThreshold

required

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

lowBalance

required

boolean

Example

{
  "wallet": {
    "id": "0f6f2d88-9357-4ce6-9b9e-76db2f98bb2e",
    "organizationId": "b7378db4-5a7a-4e69-a8df-04f2e6d94243",
    "availableCredits": 24890,
    "reservedCredits": 0,
    "lifetimePurchased": 30000,
    "lifetimeConsumed": 5110,
    "lowBalanceThreshold": 10000,
    "createdAt": "2026-08-01T09:00:00.000Z",
    "updatedAt": "2026-08-25T01:30:00.000Z",
    "lowBalance": false
  }
}

401

Management API authentication is missing or invalid.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Management API authentication required"
}

402

The organization cannot cover the active API request price.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Insufficient API credits"
}

403

The key lacks the required scope or server access.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Missing API scope: accounts:read"
}

404

The requested resource was not found.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example^generated

{
  "error": "example",
  "issues": [
    {}
  ]
}

500

Unexpected server error.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Internal server error"
}