---
title: "Allowances API Reference"
description: "What the workspace has used of each limit its plan sets, read from the same counters that enforce them."
canonical: "https://linkbreakers.com/help/api/allowances"
---

# Allowances

What the workspace has used of each limit its plan sets, read from the same counters that enforce them.

## Allowances

## [#](#allowances-object)The The workspace's allowances object

The workspace's allowances

allowances

array<object>

One entry per limit the plan sets

plan

string (enum)

PricingPlanId identifies a plan a workspace can subscribe to

##### Allowed values

`PRICING_PLAN_ID_UNSPECIFIED`

Not set

`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

Example object

```json
{
  "allowances": [
    {
      "cycleEndAt": "2026-10-10T18:21:07.612Z",
      "cycleStartAt": "2026-10-10T18:21:07.612Z",
      "key": "PLAN_LIMIT_KEY_UNSPECIFIED",
      "kind": "PLAN_LIMIT_KIND_UNSPECIFIED",
      "limit": 0,
      "noticeDismissed": false,
      "reached": false,
      "used": 0
    }
  ],
  "plan": "PRICING_PLAN_ID_UNSPECIFIED"
}
```

GET

`/v1/allowances`

Requires auth

## [#](#list-allowances)List allowances

Return every limit the workspace's plan sets with what has been used in the current cycle, when it resets and whether it has been reached. Requires the \`workspace:read\` scope.

### [#](#list-allowances-parameters)Parameters

This endpoint does not accept any parameters.

### [#](#list-allowances-response)Response

200

Everything worked as expected.

allowances

array<object>

One entry per limit the plan sets

plan

string (enum)

PricingPlanId identifies a plan a workspace can subscribe to

##### Allowed values

`PRICING_PLAN_ID_UNSPECIFIED`

Not set

`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

### [#](#list-allowances-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/allowances" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "allowances": [
    {
      "cycleEndAt": "2026-10-10T18:21:07.607Z",
      "cycleStartAt": "2026-10-10T18:21:07.607Z",
      "key": "PLAN_LIMIT_KEY_UNSPECIFIED",
      "kind": "PLAN_LIMIT_KIND_UNSPECIFIED",
      "limit": 0,
      "noticeDismissed": false,
      "reached": false,
      "used": 0
    }
  ],
  "plan": "PRICING_PLAN_ID_UNSPECIFIED"
}
```

Base URL: `https://api.linkbreakers.com`

POST

`/v1/allowances/dismiss`

Requires auth

## [#](#dismiss-an-allowance-notice)Dismiss an allowance notice

Hide the over-limit notice for one limit, for the calling member, until the limit's next cycle. Only a member can dismiss; an API token gets a permission error. Requires the \`workspace:write\` scope.

### [#](#dismiss-an-allowance-notice-parameters)Parameters

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#dismiss-an-allowance-notice-request)Request body

key

string (enum)

PlanLimitKey names one thing a plan puts a number on

##### Allowed values

`PLAN_LIMIT_KEY_UNSPECIFIED`

Not set

`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.

### [#](#dismiss-an-allowance-notice-response)Response

200

Everything worked as expected.

No structured schema available for this section.

### [#](#dismiss-an-allowance-notice-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X POST "https://api.linkbreakers.com/v1/allowances/dismiss" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"key":"PLAN_LIMIT_KEY_UNSPECIFIED"}'
```

Sample payload (application/json)

```json
{
  "key": "PLAN_LIMIT_KEY_UNSPECIFIED"
}
```

Typical response

```json
{}
```

Base URL: `https://api.linkbreakers.com`

---

Source: https://linkbreakers.com/help/api/allowances