---
title: "Plan Usage API Reference | Linkbreakers"
description: "How much of each limit of your plan the workspace has used (tracked visits, API calls, platform credits, team members, custom domains, webhooks), read…"
canonical: "https://linkbreakers.com/help/api/plan-usage"
---

# Plan Usage

How much of each limit of your plan the workspace has used (tracked visits, API calls, platform credits, team members, custom domains, webhooks), read from the counters that enforce them.

2 entries on this page

## The allowance object

WorkspaceAllowance.

One limit the workspace's plan sets, with what the workspace has used of it.

`cheapestActionCost` integer (int32)

Platform credits only: the credits the cheapest action that spends them needs before it runs

`cycleEndAt` string (date-time)

The last second of the current cycle; the allowance refills one second later. Absent for totals that never refill and when nothing has been counted yet.

`cycleStartAt` string (date-time)

Start of the current cycle. Absent when nothing has been counted yet.

`key` enum

What the limit is on

Allowed values

* `PLAN_LIMIT_KEY_CUSTOM_DOMAINS` Custom domains connected to the workspace
* `PLAN_LIMIT_KEY_TEAM_MEMBERS` Members of the workspace
* `PLAN_LIMIT_KEY_PLATFORM_CREDITS` Platform credits, spent by creating links and by AI features
* `PLAN_LIMIT_KEY_TRACKED_VISITS` Tracked visits (scans and clicks)
* `PLAN_LIMIT_KEY_PUBLIC_API_CALLS` Public API calls
* `PLAN_LIMIT_KEY_WEBHOOKS` Webhooks configured in the workspace
* `PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE` Assistant messages per minute
* `PLAN_LIMIT_KEY_LINKS_INCLUDED` Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.
* `PLAN_LIMIT_KEY_MEDIA_STORAGE_MB` Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.

`kind` enum

How the limit behaves

Allowed values

* `PLAN_LIMIT_KIND_TOTAL` A standing total that does not refill, such as connected domains
* `PLAN_LIMIT_KIND_MONTHLY` An allowance that refills every month
* `PLAN_LIMIT_KIND_PER_MINUTE` A rate that refills every minute
* `PLAN_LIMIT_KIND_UNLIMITED` No ceiling
* `PLAN_LIMIT_KIND_METERED` No ceiling; every unit is billed

`limit` integer (int32)

The ceiling. Absent when kind is PLAN\_LIMIT\_KIND\_UNLIMITED or PLAN\_LIMIT\_KIND\_METERED.

`limitBytes` integer (int64)

Media storage only: the most media the workspace may hold, in bytes. Absent for other limits and when there is no ceiling.

`lockedCount` integer (int32)

Tracked visits only: visits recorded past the limit in the current cycle that the workspace's plan still locks. Absent for other limits.

`lockedTotalCount` integer (int32)

Tracked visits only: every visit the workspace's plan still locks, across all cycles. Upgrading to a plan with a higher limit reveals them. Absent for other limits.

`noticeDismissed` boolean

Whether the calling member dismissed the over-limit notice for this limit in the current cycle

`reached` boolean

Whether the limit is used up for the current cycle. Platform credits count as reached once neither the monthly credits nor the purchased top-up credits hold cheapestActionCost, so nothing that spends credits can run. Never reached on a plan billed per unit used.

`recordedCount` integer (int32)

Tracked visits only: every visit recorded in the current cycle, used plus lockedCount. Absent for other limits.

`remaining` integer (int32)

Units left in the current cycle. For platform credits, the monthly credits left plus the purchased top-up credits left. Absent when there is no ceiling.

`resetsOn` object

The day the allowance refills, which is the first day of the next cycle in the workspace's timezone. Absent for totals that never refill and when nothing has been counted yet.

3 child attributes

`day` integer (int32)

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

`month` integer (int32)

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

`year` integer (int32)

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

`used` integer (int32)

Units used in the current cycle. For a total such as custom domains, what the workspace holds.

`usedBytes` integer (int64)

Media storage only: the bytes the workspace's media holds, exact. used is the same figure in megabytes, rounded up. Absent for other limits.

Example allowance

```json
{
  "cheapestActionCost": 0,
  "cycleEndAt": "2026-01-15T09:30:00Z",
  "cycleStartAt": "2026-01-15T09:30:00Z",
  "key": "PLAN_LIMIT_KEY_CUSTOM_DOMAINS",
  "kind": "PLAN_LIMIT_KIND_TOTAL",
  "limit": 0,
  "limitBytes": 0,
  "lockedCount": 0,
  "lockedTotalCount": 0,
  "noticeDismissed": false,
  "reached": false,
  "recordedCount": 0,
  "remaining": 0,
  "resetsOn": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "used": 0,
  "usedBytes": 0
}
```

### Response

200

`allowances` array of object

One entry per limit the plan sets

Fields: [The allowance object](#plan-usage-object).

`limits` array of object

Every limit this workspace is allowed, as enforced for its subscription, including the ones not counted per cycle such as webhooks and the Assistant rate. A trial or sponsored workspace can be allowed less than the plan it reports, and these are what it gets.

3 child attributes

`key` enum

What the limit is on.

Allowed values

* `PLAN_LIMIT_KEY_CUSTOM_DOMAINS` Custom domains connected to the workspace
* `PLAN_LIMIT_KEY_TEAM_MEMBERS` Members of the workspace
* `PLAN_LIMIT_KEY_PLATFORM_CREDITS` Platform credits, spent by creating links and by AI features
* `PLAN_LIMIT_KEY_TRACKED_VISITS` Tracked visits (scans and clicks)
* `PLAN_LIMIT_KEY_PUBLIC_API_CALLS` Public API calls
* `PLAN_LIMIT_KEY_WEBHOOKS` Webhooks configured in the workspace
* `PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE` Assistant messages per minute
* `PLAN_LIMIT_KEY_LINKS_INCLUDED` Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.
* `PLAN_LIMIT_KEY_MEDIA_STORAGE_MB` Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.

`kind` enum

How the limit behaves.

Allowed values

* `PLAN_LIMIT_KIND_TOTAL` A standing total that does not refill, such as connected domains
* `PLAN_LIMIT_KIND_MONTHLY` An allowance that refills every month
* `PLAN_LIMIT_KIND_PER_MINUTE` A rate that refills every minute
* `PLAN_LIMIT_KIND_UNLIMITED` No ceiling
* `PLAN_LIMIT_KIND_METERED` No ceiling; every unit is billed

`value` integer (int32)

The ceiling. Absent when kind is PLAN\_LIMIT\_KIND\_UNLIMITED or PLAN\_LIMIT\_KIND\_METERED.

`plan` enum

The plan the limits come from. A trial or sponsored workspace reports the plan it is allowed what of.

Allowed values

* `PRICING_PLAN_ID_FREE` Free plan, no payment
* `PRICING_PLAN_ID_LIGHT` Light plan
* `PRICING_PLAN_ID_PRO` Pro plan. Trials and sponsored workspaces are allowed what Pro allows unless a limit says otherwise.
* `PRICING_PLAN_ID_ENTERPRISE` Enterprise plan, billed on usage and priced on request through sales

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/plan-usage" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "allowances": [
    {
      "cheapestActionCost": 0,
      "cycleEndAt": "2026-01-15T09:30:00Z",
      "cycleStartAt": "2026-01-15T09:30:00Z",
      "key": "PLAN_LIMIT_KEY_CUSTOM_DOMAINS",
      "kind": "PLAN_LIMIT_KIND_TOTAL",
      "limit": 0,
      "limitBytes": 0,
      "lockedCount": 0,
      "lockedTotalCount": 0,
      "noticeDismissed": false,
      "reached": false,
      "recordedCount": 0,
      "remaining": 0,
      "resetsOn": {
        "day": 0,
        "month": 0,
        "year": 0
      },
      "used": 0,
      "usedBytes": 0
    }
  ],
  "limits": [
    {
      "key": "PLAN_LIMIT_KEY_CUSTOM_DOMAINS",
      "kind": "PLAN_LIMIT_KIND_TOTAL",
      "value": 0
    }
  ],
  "plan": "PRICING_PLAN_ID_FREE"
}
```

---

Source: https://linkbreakers.com/help/api/plan-usage
