Skip to main content
POST
Check product limits for plan
Required scopes:

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
plan
enum<string>
required

The plan to check limits against.

Available options:
starter,
team,
enterprise,
enterpriseplus

Response

200 - application/json

Resources that exceeded the limits of the specified plan.

resource
string

The resource name that exceeded the plan limit.

  • agents — the number of active agents, including bots, that exceeded the limit.
  • groups — the number of groups that exceeded the limit.
  • banned — the number of banned visitors that exceeded the limit.
  • queue — the number of chats waiting in the queue (with Messaging Mode disabled) that exceeded the limit.
  • queue_continuous — the number of chats waiting in the queue (with Messaging Mode enabled) that exceeded the limit.
  • groups_per_agent — the number of groups an agent can be assigned to that exceeded the limit.
  • access_rules — the number of Access Rules that exceeded the limit.
  • group_chooser_groups — the number of groups available in the pre-chat survey that exceeded the limit.
limit_balance
integer

The number by which the current usage exceeds the plan limit.

id
string

The ID of the specific resource instance that exceeded the limit (e.g. agent ID or group ID). Returned only when applicable.