---
title: "Retrieve usage"
method: GET
path: "/api/space/usage"
tags: ["Space Billing"]
---

# Retrieve usage

`GET /api/space/usage`

Returns company-wide usage for a month: the total, usage by kind, and usage per project.
`month` defaults to the current month, so calling with no parameters returns usage so
far this month.

Usage is computed on request from the usage reporting pipeline, so the response is
`502` when that pipeline is unavailable.

#### Permissions

Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

## Query parameters

- `month` string

## Response `200`

The request has succeeded.

- SpaceUsage — Company-wide usage for a month, in total, by kind, and per project. Usage is computed on request from the usage reporting pipeline.
  - `type` 'usage', required — The object type. Always `usage`.
  - `month` string, required — The calendar month the usage covers, as `YYYY-MM`.
  - `total_in_microdollars` integer, required — The total usage in microdollars.
  - `total_in_dollars` number, double, required — The total usage in US dollars.
  - `usage_by_kind` SpaceAmountByKind[], required — Company-wide usage broken down by kind.
    - `kind` string, required — A stable code for the kind of usage or adjustment.
    - `description` string, required — A description of the kind.
    - `amount_in_microdollars` integer, required — The amount in microdollars.
    - `amount_in_dollars` number, double, required — The same amount in US dollars.
  - `projects` SpaceProjectUsage[], required — Usage per project, each with its own breakdown by kind.
    - `id` string, uuid, required — Universal Unique Identifier.
    - `name` string, nullable, required — The name of the project. Can be `null`.
    - `amount_in_microdollars` integer, required — The project's total in microdollars.
    - `amount_in_dollars` number, double, required — The same total in US dollars.
    - `usage_by_kind` SpaceAmountByKind[], required — The project's usage broken down by kind.
      - `kind` string, required — A stable code for the kind of usage or adjustment.
      - `description` string, required — A description of the kind.
      - `amount_in_microdollars` integer, required — The amount in microdollars.
      - `amount_in_dollars` number, double, required — The same amount in US dollars.

## Other responses

- `401` — The credential is missing, unknown, or revoked; its holder is not a member of the space in the subdomain; the member is not an owner or admin; or billing for this space is not managed in the space itself, which is the case for a space purchased through a cloud marketplace and for a suspended or deactivated space. A space deactivated for nonpayment keeps the billing endpoints so that its outstanding balance can be settled. The body is the plain text `Unauthorized`. An unverified space instead receives the JSON body `{"message": "Please validate a phone number to access your account."}` on every endpoint under `/api/space`.
- `422` — `month` is not formatted `YYYY-MM` (`invalid_month`), is before the month the space was created (`month_precedes_space_creation`), or is after the current month (`month_is_in_the_future`).
- `500` — An internal server error occurred.
- `502` — An upstream billing or usage reporting service was unavailable. The body is empty; retry later.

## Changes

> 161 revisions in range; 3 could not be searched.

- **2026-09-15** `45bac4fd93ab` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/signalwire/apis/signalwire-rest-api/changes/api/space/usage/get.md)

---

[API](https://skmtc.dev/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.dev/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signalwire/apis/signalwire-rest-api/revisions/20ee0f568ece?raw)