Usage

Usage is your workspace’s limits and what it has used of them. Read it to see how close you are to a limit.

Scopes: usage:read to read.

Handle errors and limits Limits

Endpoints

Get limits and usageGET /v1/usage

The usage object

Attributes

limits object

Each limit has a limit, where null means unlimited. The two rate limits are never null: they are always enforced.

Show 6 child attributesHide child attributes

limits.api_requests_per_minute object

Requests a minute.

Show 2 child attributesHide child attributes

limits.api_requests_per_minute.limit integer · nullable

Requests your workspace can make a minute.

limits.api_requests_per_minute.used integer

Requests made this minute, this one included.

limits.api_messages_per_second object

Messages sent a second.

Show 1 child attributesHide child attributes

limits.api_messages_per_second.limit integer · nullable

Messages your workspace can send a second.

limits.contacts object

Contacts in your workspace.

Show 2 child attributesHide child attributes

limits.contacts.limit integer · nullable

Contacts your workspace can have.

limits.contacts.used integer

Contacts you have. Counted at most once a minute, so it can be up to 60 seconds old.

limits.broadcast_messages_per_month object

Broadcast messages in a month.

Show 3 child attributesHide child attributes

limits.broadcast_messages_per_month.limit integer · nullable

Broadcast messages your workspace can send in the month.

limits.broadcast_messages_per_month.used integer

Broadcast messages sent or set aside so far in the month.

limits.broadcast_messages_per_month.period string

The month a monthly limit counts, as YYYY-MM in UTC.

limits.webhook_endpoints object

Webhook endpoints in your workspace.

Show 2 child attributesHide child attributes

limits.webhook_endpoints.limit integer · nullable

Webhook endpoints your workspace can have.

limits.webhook_endpoints.used integer

Webhook endpoints you have.

limits.api_keys object

Active API keys in your workspace.

Show 2 child attributesHide child attributes

limits.api_keys.limit integer · nullable

Active API keys your workspace can have.

limits.api_keys.used integer

Active API keys you have.

features array of strings

The API and webhook features on your plan, such as api.messages or webhooks.contacts. More may be added.

The usage object

{
  "limits": {
    "api_requests_per_minute": {
      "limit": 600,
      "used": 12
    },
    "api_messages_per_second": {
      "limit": 20
    },
    "contacts": {
      "limit": 10000,
      "used": 812
    },
    "broadcast_messages_per_month": {
      "limit": 50000,
      "used": 1200,
      "period": "2026-10"
    },
    "webhook_endpoints": {
      "limit": 3,
      "used": 1
    },
    "api_keys": {
      "limit": 5,
      "used": 2
    }
  },
  "features": [
    "api.contacts",
    "api.messages",
    "webhooks.messages"
  ]
}