API reference

Usage

Your plan and how much of this month's access link allowance you have used.

Retrieve usage

GET /usage

This month's access link usage (UTC calendar months). Every new request and access page session counts once, clients and prospects separately. A limit of null means no limit applies.

Scope usage:read

Returns

200 Usage for the current month.

Fields (object)
  • plan string | null
  • billingPeriod string | null
  • trial boolean
  • apiAccess boolean
  • countingMode string

    One of access_links.

  • period object
    Show fields of period
    • start datetime
    • end datetime
    • timezone string
  • clients object
    Show fields of clients
    • used integer
    • limit integer | null
    • remaining integer | null
  • prospects object
    Show fields of prospects
    • used integer
    • limit integer | null
    • remaining integer | null
  • overage object

    With overage billing, client links beyond included are billed instead of refused.

    Show fields of overage
    • enabled boolean
    • included integer | null
    • billableUnits integer
  • 401 The API key is missing, invalid or revoked.
  • 403 The key lacks the scope (CAPABILITY_REQUIRED), the plan has no API access (PLAN_NOT_ENTITLED), or, when creating a request, the monthly limit is reached (PLAN_LIMIT_REACHED).
  • 429 Rate limited (RATE_LIMITED); wait for Retry-After seconds.
Request 
curl "https://api.agencyaccess.co/api/v2/usage" \
  -H "Authorization: Bearer $AGENCYACCESS_API_KEY"
Response 200 
{
  "data": {
    "plan": "Agency",
    "billingPeriod": "Monthly",
    "trial": false,
    "apiAccess": true,
    "countingMode": "access_links",
    "period": {
      "start": "2026-10-01T00:00:00.000Z",
      "end": "2026-11-01T00:00:00.000Z",
      "timezone": "UTC"
    },
    "clients": {
      "used": 37,
      "limit": 50,
      "remaining": 13
    },
    "prospects": {
      "used": 4,
      "limit": null,
      "remaining": null
    },
    "overage": {
      "enabled": false,
      "included": null,
      "billableUnits": 0
    }
  },
  "meta": {
    "requestId": "req_1f0b6c2e9a7d4f58b3c1e6a9d2f4b7c0"
  }
}