---
title: "Get Resource Usage"
method: GET
path: "/api/v1/resource-claims/{subscriptionId}/usage"
tags: ["Resource Claims"]
---

# Get Resource Usage

`GET /api/v1/resource-claims/{subscriptionId}/usage`

Get resource usage information for a subscription. Exactly one of resourceSlug or resourceId must be provided.

## Path parameters

- `subscriptionId` string, required

## Query parameters

- `resourceSlug` string
- `resourceId` string

## Response `200`

Successful response

- ResourceUsage — The usage data for a resource.
  - `usage` ResourceUsageData, required
    - `resourceSlug` string, required
    - `resourceId` string, required
    - `capacity` integer, required
    - `claimed` integer, required
    - `available` integer, required
  - `claims` ResourceClaimClientSelectSchema[], required
    - `id` string, required
    - `createdAt` integer, required — Epoch milliseconds.
    - `updatedAt` integer, required — Epoch milliseconds.
    - `livemode` boolean, required
    - `organizationId` string, required
    - `subscriptionItemFeatureId` string, required
    - `resourceId` string, required
    - `subscriptionId` string, required
    - `pricingModelId` string, required
    - `externalId` string, nullable, required
    - `claimedAt` integer, required — Epoch milliseconds.
    - `releasedAt` integer, nullable — Epoch milliseconds.
    - `releaseReason` string, nullable, required
    - `metadata` Metadata — JSON object

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

## Changes

- **2026-01-15** `dd9d7ebc5860` — 1 breaking, 6 info
  - the `usage` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - added the new optional `query` request parameter `resourceId`
  - added the required property `usage/available` to the response with the `200` status
  - added the required property `usage/capacity` to the response with the `200` status
  - …3 more
- **2026-01-14** `7fcbd2dbf3c1` — 1 info
  - added the required property `claims` to the response with the `200` status
- **2026-01-11** `599bbd902d65` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/flowglad/apis/flowglad-api/changes/api/v1/resource-claims/:subscriptionId/usage/get.md)

---

[API](https://skmtc.dev/flowglad/apis/flowglad-api.md) · [All operations](https://skmtc.dev/flowglad/apis/flowglad-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/flowglad/flowglad-api/revisions/06c4dd78e137/schema)
