---
title: "Get a month of usage"
url: https://docs.corefinity.com/api/reference/billing/get-billing-usage
type: endpoint
last_updated: 2026-11-13
feature: billing
related:
  - https://docs.corefinity.com/guides/billing/billing-overview.md
  - https://docs.corefinity.com/mcp/tools/corestack_billing_usage_get.md
---
# Get a month of usage

Answers what the account accrued in one calendar month (UTC): the month's total, each day's total (a day on
which nothing accrued is left out) and each contract line with its hours and its own days. `credits_applied`
lists the credits applied to invoices whose period starts in the month, as negative amounts.

```http
GET /api/corestack/billing/usage
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 a minute
- Try it in the console: on

## Query parameters

- `account` (integer): The billing account to read, by its `id` (see `GET /corestack/billing/account`). Left out, the request acts on your company's default billing account. An account that does not exist and one that is not your company's answer the same 404.
- `account_id` (integer): The same as `account`, under the name the MCP tools use. Send one of the two: when they name different accounts the request is refused `422 invalid` on `account_id`.
- `month` (string): The month, as `YYYY-MM`. Left out, the current month (UTC).

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/billing/usage \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/billing/usage');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/billing/usage', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/billing/usage",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The month's usage.

```json
{
  "credits_applied": [],
  "currency": "GBP",
  "days": [
    {
      "amount": {
        "amount": "19.35",
        "currency": "GBP"
      },
      "day": "2027-01-01"
    },
    {
      "amount": {
        "amount": "19.35",
        "currency": "GBP"
      },
      "day": "2027-01-02"
    },
    {
      "amount": {
        "amount": "19.35",
        "currency": "GBP"
      },
      "day": "2027-01-03"
    }
  ],
  "lines": [
    {
      "amount": {
        "amount": "337.10",
        "currency": "GBP"
      },
      "contract_line": {
        "id": 9001,
        "kind": "package",
        "label": "CC8 · Northwind UK 1"
      },
      "days": [
        {
          "amount": {
            "amount": "19.35",
            "currency": "GBP"
          },
          "day": "2027-01-01",
          "hours": 24
        },
        {
          "amount": {
            "amount": "19.35",
            "currency": "GBP"
          },
          "day": "2027-01-02",
          "hours": 24
        },
        {
          "amount": {
            "amount": "19.35",
            "currency": "GBP"
          },
          "day": "2027-01-03",
          "hours": 24
        }
      ],
      "hours": 418
    }
  ],
  "month": "2027-01",
  "total": {
    "amount": "337.10",
    "currency": "GBP"
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up (`two_factor_required`), or you may not read your company's billing (`billing_forbidden`): billing is for the company's owner, its billing contacts and its primary user.

```json
{
  "code": "billing_forbidden",
  "message": "Billing is available to your company's owner and billing contacts.",
  "reason": "billing_forbidden"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 422 `month` is not a month (`invalid`), or `account` and `account_id` name different billing accounts.

```json
{
  "code": "invalid",
  "errors": {
    "account_id": [
      "Send account or account_id, not both: they name different billing accounts."
    ]
  },
  "field": "account_id",
  "message": "Send account or account_id, not both: they name different billing accounts.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `billing_forbidden` | Billing is for the organisation's owner and billing contacts. Ask one of them to do this. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Billing](https://docs.corefinity.com/guides/billing/billing-overview.md)
- MCP tool: [`corestack_billing_usage_get`](https://docs.corefinity.com/mcp/tools/corestack_billing_usage_get.md)
