---
title: "Usage and plan limits of an organization"
method: GET
path: "/usage"
tags: ["Identity"]
---

# Usage and plan limits of an organization

`GET /usage`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/usage`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Query parameters

- `orgId` string: Organization id (required when you belong to several)

## Response `200`

Usage

- object
  - `period` object, required
    - `start` string, required: ISO-8601 timestamp
    - `end` string, required: ISO-8601 timestamp
  - `projects` object, required
    - `used` integer, required
    - `limit` integer, nullable, required
  - `deployments` integer, required
  - `databases` object, required
    - `used` integer, required
    - `limit` integer, nullable, required
  - `resources` object, required: sum of allocated limits over every project and database (0 when nothing is allocated), and the total caps they count against
    - `cpus` number, required
    - `memoryMb` integer, required
    - `totalCpus` number, nullable: the organization's total vCPU cap (set by the platform operator); null = none
    - `totalMemoryMb` integer, nullable: the organization's total memory cap in MB; null = none

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `503`: Hosting engine unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)