---
title: "Get the usage of a client project"
method: GET
path: "/clients/{id}/usage"
tags: ["Agencies"]
---

# Get the usage of a client project

`GET /clients/{id}/usage`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/clients/{id}/usage`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `clients:read`)

Costs and usage per calendar month (UTC), oldest first: cost_eur with cost_by_source and cost_by_payer (client: the project's own credit, agency: paid by your agency), top_ups_eur and the app meters, plus the current payer and budget_eur. For invoicing your client with your own markup, or your own client portal.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `months` integer

## Response `200`

Usage per month.

- object
  - `object` 'client_usage', required
  - `project_id` string, uuid, required
  - `currency` 'EUR', required
  - `payer` 'client' | 'agency'
  - `budget_eur` number, nullable
  - `months` object[], required
    - `month` string, required
    - `cost_eur` number, required
    - `cost_by_source` object, required
    - `cost_by_payer` object, required
      - `client` number, required
      - `agency` number, required
    - `cost_by_payer_source` object, required
      - `client` object, required
      - `agency` object, required
    - `top_ups_eur` number, required
    - `app_requests` number, required
    - `app_errors` number, required
    - `app_cpu_ms` number, required

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `422`: Unprocessable Content: validation_failed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)