Skip to main content
The Account endpoints let you retrieve information about your KnoxCall tenant, including subscription details and current resource usage against plan limits.

Get Account Info

GET /v1/account
Returns your tenant’s account details, including subscription plan and billing period.

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "slug": "acme-corp",
    "name": "Acme Corporation",
    "region": "us-east",
    "subscription_plan": "pro",
    "subscription_status": "active",
    "trial_start_at": "2026-01-01T00:00:00.000Z",
    "trial_end_at": "2026-01-14T23:59:59.000Z",
    "subscription_current_period_start": "2026-03-01T00:00:00.000Z",
    "subscription_current_period_end": "2026-03-31T23:59:59.000Z",
    "subscription_cancel_at": null,
    "created_at": "2026-01-01T00:00:00.000Z"
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
curl https://api.knoxcall.com/v1/account \
  -H "Authorization: Bearer tk_live_abc123..."

Errors

StatusTypeDescription
404not_foundAccount not found

Get Current Usage

GET /v1/account/usage
Returns your current resource usage and plan limits for the current billing period. Use this to monitor how close you are to hitting plan limits before creating new resources.

Response

{
  "data": {
    "billing_period": {
      "year": 2026,
      "month": 3,
      "start": "2026-03-01T00:00:00.000Z",
      "end": "2026-03-31T23:59:59.000Z"
    },
    "api_calls": {
      "used": 12847,
      "limit": 100000,
      "percentage": 12.85
    },
    "resources": {
      "routes": { "used": 8, "limit": 50 },
      "secrets": { "used": 12, "limit": 100 },
      "clients": { "used": 5, "limit": 25 },
      "environments": { "used": 3, "limit": null }
    },
    "plan": "pro",
    "status": "active"
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
A limit of null means the resource is unlimited on your current plan.
curl https://api.knoxcall.com/v1/account/usage \
  -H "Authorization: Bearer tk_live_abc123..."