# Get credits

Get credits is a read in the HeadHoncho API. This month's credits: the plan's grant, what rolled over, what was bought, what was used and what is left.

Page: https://headhoncho.app/docs/api/get_credits | Part of the HeadHoncho API docs: https://headhoncho.app/docs/api | Machine-readable: https://headhoncho.app/docs/api/openapi.json | Everything in one file: https://headhoncho.app/docs/api/llms-full.txt

## The request

Reference for **Get credits**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/credits`

Any key can call it. An answered call costs 1 credit; a refusal costs nothing. See [credits](https://headhoncho.app/docs/api/errors#credits).

Send your key as `Authorization: Bearer hh_live_...`. See [API keys](https://headhoncho.app/docs/api/keys).

## Parameters

This call takes no parameters.

## Try it with your key

Paste your key and change the values. The box builds the call as a cURL line and a fetch line, ready to copy. It never sends anything itself.

Paste your key on the web page and it fills a cURL line and a fetch line with your key and the example values. The page never sends the key anywhere. The same lines with a placeholder key are under Examples below.

## What comes back

available (grant, rolled_over, carried and topped_up, less used), granted, used, month (YYYY-MM, in the workspace's time zone), renews_on, plan, plan_status and per_call, the credits one API call costs. The same figures the app's credits box shows. Card details and buying credits stay in the app.

It never changes a record. It only reads the companies the key reaches.

## Every field in the answer

Types are read from the example answer. Money is a plain number in the company's currency. A time carries its offset from UTC (`Z` is UTC). Ids are opaque text. A field with no line of its own here has its name spelled out; the common fields mean the same on every page.

| Field | Type | Meaning |
| --- | --- | --- |
| `available` | number | True when this is connected and can be read. |
| `granted` | number | The granted. |
| `used` | number | The used. |
| `month` | text | The first day of the month. |
| `plan` | text | The plan. |
| `plan_status` | text | The plan status. |
| `renews_on` | date (YYYY-MM-DD) | The date it was renews. |
| `grant` | number | The grant. |
| `rolled_over` | number | The rolled over. |
| `carried` | number | The carried. |
| `topped_up` | number | The topped up. |
| `per_call` | number | Credits one answered call costs. |

## Errors that apply

| Code | Status | What it means |
| --- | --- | --- |
| [`missing_key`](https://headhoncho.app/docs/api/errors#missing_key) | 401 | Send your key as Authorization: Bearer hh_live_... |
| [`unknown_key`](https://headhoncho.app/docs/api/errors#unknown_key) | 401 | That key is not one we issued, or it was revoked. |
| [`no_credits`](https://headhoncho.app/docs/api/errors#no_credits) | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |

## Related

- [Whoami](https://headhoncho.app/docs/api/whoami): Who this key or app acts as, which companies it reaches, what it may do, and the words to use in commands: statuses, job types and technicians.
- [List companies](https://headhoncho.app/docs/api/list_companies): The companies this credential reaches, each with its name, time zone, country and service area. The same ids every other call takes as company_id.
- [Get company](https://headhoncho.app/docs/api/get_company): One company this credential reaches: its name, time zone, country and service area.
- [Get usage](https://headhoncho.app/docs/api/get_usage): What the plan has used, what API calls cost and what this credential called, by day or by endpoint, with the credits left.
- [List plans](https://headhoncho.app/docs/api/list_plans): The plans on offer, with price and what each includes, and which one this workspace is on.
- The same records in the app: [Multiple companies](https://headhoncho.app/docs/companies).
- How the API fits together: [the model](https://headhoncho.app/docs/api/model), [API keys](https://headhoncho.app/docs/api/keys), [errors](https://headhoncho.app/docs/api/errors) and [the MCP server](https://headhoncho.app/docs/api/mcp).

## Examples

### Answer

```json
{
  "available": 612.0,
  "granted": 1500.0,
  "used": 888.0,
  "month": "2026-10",
  "plan": "core",
  "plan_status": "active",
  "renews_on": "2026-11-01",
  "grant": 1500.0,
  "rolled_over": 0.0,
  "carried": 0.0,
  "topped_up": 0.0,
  "per_call": 1.0
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/credits" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/credits",
    headers={"Authorization": "Bearer hh_live_..."},
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/credits", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: get_credits
Arguments: none
Access: any key
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, get credits."
```