Tool

Get credit balance

Shows the current plan, connected account and creator limits, available credits, held credits and credits used this period.

POSTtools.readFree

POST/openapi/v1/tools/get_balance

Call it

curl -X POST https://api.cuekoo.com/openapi/v1/tools/get_balance \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

The MCP tool is named cuekoo_get_balance. Arguments and results are identical to the REST call.

Arguments

Send a JSON object with these fields. Scope: tools.read.

This Tool takes no arguments. Send an empty object: {}.

Response

Name	Type	Required
`available`	`integer`	Required
`held`	`integer`	Required
`plan`	`object`	Required
`plan.channels_limit`	`integer \| null`	Required
`plan.channels_used`	`integer`	Required
`plan.creators_limit`	`integer \| null`	Required
`plan.creators_used`	`integer`	Required
`plan.name`	`string`	Required
`plan.period_end`	`string \| null`	Optional
`plan.period_start`	`string \| null`	Optional
`used_this_period`	`integer`	Required

A call returns the Tool's output object at HTTP 200. Failures use the error envelope.

Credits

This Tool is free. It does not reserve or spend credits.