# List plans

List plans is a read in the HeadHoncho API. The plans on offer, with price and what each includes, and which one this workspace is on.

Page: https://headhoncho.app/docs/api/list_plans | 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 **List plans**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/plans`

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

plans, in the order the app prints them: code, name, monthly_price_cents (null when you must talk to us), self_serve, is_recommended, entitlements (unit_code, unit_name, included, unlimited, custom), the extra credit pack if the plan has one, history_months, scheduled_reports and api_access. every_plan: what is unlimited on all of them. current: the plan in force. pack: the credit pack this workspace may buy, or null.

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 |
| --- | --- | --- |
| `plans` | list of objects | The plans. |
| `plans[].code` | text | The code. |
| `plans[].name` | text | The name, as the app shows it. |
| `plans[].monthly_price_cents` | whole number | The monthly price cents. |
| `plans[].self_serve` | true or false | The self serve. |
| `plans[].is_recommended` | true or false | True when it is recommended. |
| `plans[].entitlements` | list of objects | The entitlements. |
| `plans[].entitlements[].unit_code` | text | The unit code. |
| `plans[].entitlements[].unit_name` | text | The unit name. |
| `plans[].entitlements[].included` | whole number | The included. |
| `plans[].entitlements[].unlimited` | true or false | The unlimited. |
| `plans[].entitlements[].custom` | true or false | The custom. |
| `plans[].pack` | value or null | The pack. |
| `plans[].history_months` | whole number | The history months. |
| `plans[].scheduled_reports` | true or false | The scheduled reports. |
| `plans[].api_access` | true or false | The api access. |
| `every_plan` | list of objects | The every plan. |
| `every_plan[].unit_code` | text | The unit code. |
| `every_plan[].unit_name` | text | The unit name. |
| `current` | object | The current. |
| `current.code` | text | The code. |
| `current.name` | text | The name, as the app shows it. |
| `current.status` | text | The job status. |
| `pack` | value or null | The pack. |

## 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.
- [Get credits](https://headhoncho.app/docs/api/get_credits): This month's credits: the plan's grant, what rolled over, what was bought, what was used and what is left.
- 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
{
  "plans": [
    {
      "code": "free",
      "name": "Free",
      "monthly_price_cents": 0,
      "self_serve": true,
      "is_recommended": false,
      "entitlements": [
        {
          "unit_code": "companies",
          "unit_name": "Companies",
          "included": 1,
          "unlimited": false,
          "custom": false
        }
      ],
      "pack": null,
      "history_months": 3,
      "scheduled_reports": false,
      "api_access": true
    },
    {
      "code": "core",
      "name": "Core",
      "monthly_price_cents": 14900,
      "self_serve": true,
      "is_recommended": true,
      "entitlements": [
        {
          "unit_code": "companies",
          "unit_name": "Companies",
          "included": 5,
          "unlimited": false,
          "custom": false
        }
      ],
      "pack": null,
      "history_months": 12,
      "scheduled_reports": true,
      "api_access": true
    }
  ],
  "every_plan": [
    {
      "unit_code": "campaigns",
      "unit_name": "Campaigns"
    }
  ],
  "current": {
    "code": "core",
    "name": "Core",
    "status": "active"
  },
  "pack": null
}
```

### cURL

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

### Python

```python
import requests

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

### JavaScript

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

### Your AI

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