> For the complete documentation index, see [llms.txt](https://docs.kinesis.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kinesis.network/mcp/tools/billing.md). # Billing Inspect the organization’s balance and costs with its admin permissions. Inspect the organization’s balance and costs with its admin permissions. These are action names. In default compact mode, call the indicated group tool with `{"action":"","params":{...}}`; the arguments below go inside `params`. In `?mode=all`, call the action name directly with those arguments. `browse_github` and `read_docs` are direct tools in both modes. Expand each schema for nested fields, enum values and validation constraints. Successful results are JSON in both text content and `structuredContent`; failures use `isError` and `structuredContent.error`. Billing is per organization and requires an admin role. Pass its slug as `org`. MCP does not add credits or configure auto-reload; on a balance refusal, explain the entitlement and leave billing to an organization admin. MCP money errors omit payment links. REST retains checkout sessions, saved-card top-ups and auto-reload updates. The [OpenAI profile](/mcp/openai-profile.md) calls individual actions, omits `get_byod_token`, and restricts credential inputs and environment outputs. The input schemas below describe the standard catalog; profile-specific schemas are included where they differ. ## `get_balance` Current balance and billing status of the caller's organization **Group:** `billing` · **Behavior:** Read **Compact tool:** `billing` · **Action:** `get_balance` **MCP annotations:** `readOnlyHint: true` · `destructiveHint: false` · `idempotentHint: true` · `openWorldHint: false` ### Permissions and REST equivalents | Operation | REST | Required scopes | | ----------------- | ---------------------- | --------------- | | `billing.balance` | `GET /billing/balance` | `billing:read` | ### Arguments | Argument | Type | Required | Description | | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------ | | `org` | `string` | No | Slug of the organization to act in (see orgs.list); needed when the caller reaches more than one |
Complete input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "org": { "description": "Slug of the organization to act in (see orgs.list); needed when the caller reaches more than one", "type": "string", "minLength": 3, "maxLength": 39 } }, "additionalProperties": false } ```
### Result * `balanceCents` (`number`): Paid balance * `promoBalanceCents` (`number`): Promotional credit, spent first * `currency` (`string`): See the complete response schema below. * `overLimitCents` (`number`): How far below zero the balance may go * `status` (`string or null`): See the complete response schema below. * `mode` (`string`): Billing mode of the organization * `frozen` (`boolean`): The organization is frozen: writes are refused until it is unfrozen * `autoReload` (`object`): See the complete response schema below.
Response schema: billing.balance ```json { "type": "object", "properties": { "balanceCents": { "type": "number", "description": "Paid balance" }, "promoBalanceCents": { "type": "number", "description": "Promotional credit, spent first" }, "currency": { "type": "string" }, "overLimitCents": { "type": "number", "description": "How far below zero the balance may go" }, "status": { "type": [ "string", "null" ] }, "mode": { "type": "string", "description": "Billing mode of the organization" }, "frozen": { "type": "boolean", "description": "The organization is frozen: writes are refused until it is unfrozen" }, "autoReload": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The saved card is charged automatically when the balance drops below the threshold" }, "thresholdCents": { "description": "Balance that triggers a reload", "type": [ "number", "null" ] }, "targetCents": { "description": "Balance after a reload", "type": [ "number", "null" ] } }, "required": [ "enabled", "thresholdCents", "targetCents" ], "additionalProperties": false } }, "required": [ "balanceCents", "promoBalanceCents", "currency", "overLimitCents", "status", "mode", "frozen", "autoReload" ], "additionalProperties": false } ```
Operation-specific errors: `400 org_required`, `403 key_project_restricted`. ## `get_costs` Cost breakdown for a date range of up to 366 days. Default: the current calendar month, UTC **Group:** `billing` · **Behavior:** Read **Compact tool:** `billing` · **Action:** `get_costs` **MCP annotations:** `readOnlyHint: true` · `destructiveHint: false` · `idempotentHint: true` · `openWorldHint: false` ### Permissions and REST equivalents | Operation | REST | Required scopes | | --------------- | -------------------- | --------------- | | `billing.costs` | `GET /billing/costs` | `billing:read` | ### Arguments | Argument | Type | Required | Description | | ----------- | -------- | -------- | ------------------------------------------------------------------------------------------------ | | `start` | `string` | No | First day, YYYY-MM-DD | | `end` | `string` | No | Last day, YYYY-MM-DD | | `projectId` | `string` | No | Limit to one project | | `appId` | `string` | No | Limit to one app | | `org` | `string` | No | Slug of the organization to act in (see orgs.list); needed when the caller reaches more than one |
Complete input schema ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "start": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "First day, YYYY-MM-DD" }, "end": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Last day, YYYY-MM-DD" }, "projectId": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$", "description": "Limit to one project" }, "appId": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$", "description": "Limit to one app" }, "org": { "description": "Slug of the organization to act in (see orgs.list); needed when the caller reaches more than one", "type": "string", "minLength": 3, "maxLength": 39 } }, "additionalProperties": false } ```
### Result * `start` (`string`): ISO 8601 timestamp (UTC) * `end` (`string`): ISO 8601 timestamp (UTC) * `currency` (`string`): See the complete response schema below. * `totalCost` (`number`): Total for the range, in the billing currency * `byProject` (`array`): See the complete response schema below. * `byApp` (`array`): See the complete response schema below. * `byResource` (`array`): Cost per billed resource (CPU, GPU, RAM, storage, bandwidth, ...) * `daily` (`array`): See the complete response schema below.
Response schema: billing.costs ```json { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp (UTC)" }, "end": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp (UTC)" }, "currency": { "type": "string" }, "totalCost": { "type": "number", "description": "Total for the range, in the billing currency" }, "byProject": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "cost": { "type": "number" } }, "required": [ "projectId", "projectName", "cost" ], "additionalProperties": false } }, "byApp": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": "string" }, "appName": { "type": "string" }, "projectId": { "type": "string" }, "cost": { "type": "number" } }, "required": [ "appId", "appName", "projectId", "cost" ], "additionalProperties": false } }, "byResource": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "cost": { "type": "number" }, "usage": { "type": "number" }, "unit": { "type": "string" } }, "required": [ "type", "cost", "usage", "unit" ], "additionalProperties": false }, "description": "Cost per billed resource (CPU, GPU, RAM, storage, bandwidth, ...)" }, "daily": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD" }, "cost": { "type": "number" } }, "required": [ "date", "cost" ], "additionalProperties": false } } }, "required": [ "start", "end", "currency", "totalCost", "byProject", "byApp", "byResource", "daily" ], "additionalProperties": false } ```
Operation-specific errors: `400 org_required`. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.kinesis.network/mcp/tools/billing.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.