# Read your usage

> Your spend in `[start, end)` — the whole account, every key and the app: one row per task, API key and credit type, with job counts and the credits charged.

`GET https://api.refabric.com/v1/account/usage`

**Authentication.** A key with `account:read`: the figures are your account's spend.

**Key features**

- Pages of 50 rows by default, 200 at most.
- A window of 90 days at most.

**Common use cases**

- Bill your own customers per key.
- See which task spends the most.

**See also**

- `GET /v1/account/metrics`
- `GET /v1/account/balance`

Authentication: `Authorization: Key $REFABRIC_API_KEY`, scope `account:read`.

## Query parameters

- `limit` (integer, _optional_, default: `50`, 1 to 200) — Items per page: default 50, at most 200.
- `cursor` (string | null, _optional_) — The previous page's `next_cursor`, copied back as it came, for the next page. Never build one.
- `start` (string | null, _optional_, format: date-time) — Inclusive, ISO-8601 (`2026-09-01T00:00:00Z`; no zone means UTC). Default: 30 days before `end`. The window is at most 90 days.
- `end` (string | null, _optional_, format: date-time) — Exclusive, ISO-8601 (no zone means UTC). Default: now.
- `api_key_id` (string | null, _optional_) — Only jobs started with this key of yours (`key_…`).
- `task` (string | null, _optional_) — Only jobs of this task (`image.generate`).

## Header parameters

- `Refabric-Version` (string, _optional_, format: date) — The contract version you wrote against (a date). Absent: the current version.
- `X-Request-ID` (string, _optional_, max length 128) — Your own id for this request; we answer it back under X-Client-Request-ID.

## Response 200

Done: the answer is in the body.

- `items` (array<object>, _required_) — This page's items, in the listing's order.
  - `task` (string, _required_) — The task's public name.
    Example: `image.generate`
  - `api_key_id` (string | null, _required_) — The key that started the jobs; `null` for work started in the Refabric app.
    Example: `key_8f3a`
  - `credit_type` (string | null, _required_) — Which kind of credit an amount is counted in. `null` when nothing was charged.
    Values: `refabric_credits` (Spent by tasks.); `model_credits` (Credits for model training.)
    Example: `refabric_credits`
  - `jobs` (integer, _required_) — Jobs submitted in the group.
    Example: `12`
  - `succeeded` (integer, _required_) — Jobs that finished with a result.
    Example: `10`
  - `failed` (integer, _required_) — Jobs that ended with an error or were cancelled.
    Example: `2`
  - `credits` (integer, _required_) — Credits charged for the group's jobs.
    Example: `110`
- `has_more` (boolean, _required_) — Whether another page follows this one.
  Example: `false`
- `as_of` (string, _required_) — The moment these figures were read (UTC, ISO-8601).
  Example: `2026-10-01T00:00:00Z`
- `start` (string, _required_) — The window's first instant, inclusive (UTC).
  Example: `2026-09-01T00:00:00Z`
- `end` (string, _required_) — The window's end, exclusive (UTC); without `end` sent, `as_of`.
  Example: `2026-10-01T00:00:00Z`
- `next_cursor` (string | null, _optional_) — Send it back as `cursor` for the next page. Absent on the last page. Opaque: never build or edit one.
  Example: `eyJsIjoiY2hhbmdlbG9nIn0`

```json
{
  "items": [],
  "next_cursor": "eyJsIjoiY2hhbmdlbG9nIn0",
  "has_more": false,
  "as_of": "2026-10-01T00:00:00Z",
  "start": "2026-09-01T00:00:00Z",
  "end": "2026-10-01T00:00:00Z"
}
```

## Response 400

The request cannot be read as it was sent (a header, the URL or the body's form).

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Response 401

No valid API key was sent.

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Response 403

Your key or your plan does not allow this.

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Response 422

A field is missing or has a value this operation cannot use.

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Response 429

Too many requests: wait for the number of seconds in the Retry-After header.

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Response 500

Something went wrong on our side; retry, and quote the request id if it keeps happening.

```json
{
  "error": {
    "code": "string",
    "type": "invalid_request",
    "message": "string",
    "field": "string",
    "retryable": true,
    "docs": "string",
    "request_id": "string",
    "ctx": {
      "required": 0,
      "balance": 0,
      "retry_after": 0
    },
    "input": null,
    "job_id": "string",
    "required": 0,
    "balance": 0
  }
}
```

## Request

```python
import os
import requests

url = "https://api.refabric.com/v1/account/usage"

headers = {"Authorization": f"Key {os.environ['REFABRIC_API_KEY']}"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.refabric.com/v1/account/usage';
const options = {method: 'GET', headers: {Authorization: `Key ${process.env.REFABRIC_API_KEY}`}};

try {
    const response = await fetch(url, options);
    const data = await response.json();
    console.log(data);
} catch (error) {
    console.error(error);
}
```

```bash
curl --request GET \
    --url https://api.refabric.com/v1/account/usage \
    --header "Authorization: Key $REFABRIC_API_KEY"
```