---
title: "The entitlement meter table for the current period"
method: GET
path: "/api/v1/organizations/{organization_id}/billing/usage"
tags: ["organizations"]
---

# The entitlement meter table for the current period

`GET /api/v1/organizations/{organization_id}/billing/usage`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/organizations/{organization_id}/billing/usage`
- Auth: HTTP bearer

## Path parameters

- `organization_id` string, required

## Response `200`

Meters

- BillingUsage
  - `period_started_at` string, required
  - `state` string, required
  - `seats` integer, required
  - `meters` BillingEntitlementMeter[], required
    - `meter_key` string, required
    - `dimension_value` string, nullable
    - `unit` string, required
    - `included` number, required
    - `used` number, required
    - `projected_overage_cents` integer, required: Forecast overage for the current allowance window.
    - `raw_used` number, required: Full billing-period usage before allowance resets.
    - `remaining` number, required
    - `spend_cents` integer, required: What this period's overage costs so far at the unit price. The standard CI runner classes split their shared pool's overage by each class's own minutes.
    - `hard_cap` number, nullable
    - `cap` number, nullable: The quantity past which new usage is refused; null means unlimited.
    - `pay_as_you_go` boolean, required
    - `unit_price_nanodollars` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)