Get the balance

GET

/account/balance

const url = 'https://api.clearance.rest/account/balance';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.clearance.rest/account/balance \
  --header 'X-API-Key: <X-API-Key>'

Team balance plus the project’s spend today and this month (UTC) and its spend limits.

Authorizations

ApiKeyAuth

Responses

200

Default Response

application/json

object

success

required

boolean

balance

required

Available team balance (amounts held for in-flight operations are already deducted).

number

held

required

Amount currently held for in-flight operations.

number

currency

required

string

Allowed values: USD

project

required

Spend in USD today and this month (UTC) with the configured limits.

object

spent_today

required

Amount in USD.

number

spent_this_month

required

Amount in USD.

number

daily_limit

required

Any of:

number
null

Amount in USD.

number

monthly_limit

required

Any of:

number
null

Amount in USD.

number

mcp_token

required

Any of:

object
null

Spend in USD today and this month (UTC) with the configured limits.

object

spent_today

required

Amount in USD.

number

spent_this_month

required

Amount in USD.

number

daily_limit

required

Any of:

number
null

Amount in USD.

number

monthly_limit

required

Any of:

number
null

Amount in USD.

number

Example

{
  "success": true,
  "currency": "USD"
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}