---
title: "What this workspace's plan allows, and how much of it is used"
method: GET
path: "/workspaces/{id}/entitlements"
tags: ["billing"]
---

# What this workspace's plan allows, and how much of it is used

`GET /workspaces/{id}/entitlements`

## Request

- Base URL: `https://api.swingfactor.ai/v1`
- URL: `https://api.swingfactor.ai/v1/workspaces/{id}/entitlements`
- Auth: HTTP bearer

## Path parameters

- `id` string, uuid, required

## Response `200`

The plan, its status, its limits and the counts.

- Entitlements
  - `plan` 'observer' | 'investigator' | 'institute' | 'null', nullable, required
  - `status` 'active' | 'trialing' | 'past_due' | 'canceled', required
  - `cycle` 'monthly' | 'annual', required
  - `provider` 'stripe' | 'apple' | 'google' | 'null', nullable, required
  - `renewsAt` string, nullable, required
  - `cancelAtPeriodEnd` boolean, required
  - `everPaid` boolean
  - `features` string[], required
  - `limits` object, required
  - `quantity` integer
  - `usage` object
  - `resets` object
  - `balances` object
  - `trial` object
    - `eligible` boolean, required
    - `days` integer, nullable, required
    - `endsAt` string, nullable
    - `used` boolean

## Other responses

- `401`: No token, or not a valid one: `unauthorized`.

---

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