> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get credit balance

> Read how many credits an account has left in its monthly and purchased pools, with its monthly allocation and top-up price; returns the balance.

`veryfront__get_credit_balance`

Requires account.billing.read.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Read-only.

## Arguments

See the full schema below for the accepted shape and constraints.

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__get_credit_balance",
    "arguments": {}
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `credit_price_eur` | `number` | Yes | The credit price eur returned by the tool. Minimum: `0`. |
| `tier` | `number` | Yes | The tier returned by the tool. |
| `purchased` | `number` | Yes | The purchased returned by the tool. |
| `total` | `number` | Yes | The total returned by the tool. |
| `tier_limit` | `number` | Yes | The tier limit returned by the tool. |
| `account_id` | `string` | Yes | The account id returned by the tool. Format: `uuid`. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the get_credit_balance tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "credit_price_eur": {
      "type": "number",
      "minimum": 0,
      "description": "The credit price eur returned by the tool."
    },
    "tier": {
      "type": "number",
      "description": "The tier returned by the tool."
    },
    "purchased": {
      "type": "number",
      "description": "The purchased returned by the tool."
    },
    "total": {
      "type": "number",
      "description": "The total returned by the tool."
    },
    "tier_limit": {
      "type": "number",
      "description": "The tier limit returned by the tool."
    },
    "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "The account id returned by the tool."
    }
  },
  "required": [
    "credit_price_eur",
    "tier",
    "purchased",
    "total",
    "tier_limit",
    "account_id"
  ],
  "additionalProperties": false,
  "description": "Credit balance of the authenticated user by pool, with the effective tier top-up rate in EUR. Reading it grants an eligible missing monthly allocation first.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__get_credit_balance` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.