checkly account - Checkly Docs

Available since CLI v7.7.0.

The checkly account command lets you view account-level information directly from the terminal. Use it to check which features are available on your plan, inspect metered limits, and discover available check locations.

Prerequisites

Before using checkly account, ensure you have:

Checkly CLI installed
Valid Checkly account authentication (run npx checkly login if needed)

For additional setup information, see CLI overview.

Usage

Terminal

npx checkly account <subcommand> [arguments] [options]

Subcommands

Subcommand	Description
`plan`	Show your account plan, entitlements, and feature limits.

`checkly account plan`

Show your account plan, entitlements, and feature limits. The default view displays a summary of metered entitlements with their limits. Use --output=json for the full response including locations, feature flags, and upgrade URLs. Usage:

Terminal

npx checkly account plan [key] [options]

Arguments:

Argument	Description
`key`	Entitlement key to look up (e.g. `BROWSER_CHECKS`). Shows a detail view for that entitlement.

Options:

Option	Required	Description
`--type, -t`	-	Filter entitlements by type: `metered` or `flag`.
`--search, -s`	-	Search entitlements by name or description.
`--disabled`	-	Show only entitlements not included in your plan.
`--output, -o`	-	Output format: `table`, `json`, or `md`. Default: `table`.

Plan Options

key

string

Pass an entitlement key as a positional argument to see a detail view for that specific entitlement, including its type, status, limit, and upgrade URL if applicable.Usage:

Terminal

npx checkly account plan BROWSER_CHECKS
npx checkly account plan PRIVATE_LOCATIONS

--type, -t

string

Filter entitlements by type. Use metered to see entitlements with numeric limits, or flag to see boolean feature flags.Usage:

Terminal

npx checkly account plan --type=metered
npx checkly account plan -t flag

--search, -s

string

Search entitlements by name or description using a case-insensitive match.Usage:

Terminal

npx checkly account plan --search="browser"
npx checkly account plan -s "alert"

--disabled

boolean

Show only entitlements that are not included in your current plan. Each disabled entitlement includes the required plan and an upgrade URL.Usage:

Terminal

npx checkly account plan --disabled
npx checkly account plan --disabled --type=flag

--output, -o

string

default:"table"

Set the output format. Use json for the full response including locations, all entitlements, and upgrade URLs. Use md for markdown.Usage:

Terminal

npx checkly account plan --output=json
npx checkly account plan -o md

Plan Examples

Terminal

# Show account plan summary (metered limits + flag count)
npx checkly account plan

# Get the full response as JSON (recommended for agents)
npx checkly account plan --output=json

# Show only metered entitlements
npx checkly account plan --type=metered

# Show only feature flags
npx checkly account plan --type=flag

# Search for specific entitlements
npx checkly account plan --search="browser"

# Show features not included in your plan
npx checkly account plan --disabled

# Look up a specific entitlement
npx checkly account plan BROWSER_CHECKS

JSON Response

The --output=json format returns a structured response useful for programmatic access and AI agents.

{
  "plan": "hobby",
  "planDisplayName": "Hobby",
  "checkoutUrl": "https://app.checklyhq.com/accounts/.../billing/checkout",
  "contactSalesUrl": "https://www.checklyhq.com/contact-sales/",
  "locations": {
    "all": [
      { "id": "us-east-1", "name": "N. Virginia", "available": true },
      { "id": "eu-west-1", "name": "Ireland", "available": false }
    ],
    "maxPerCheck": 3
  },
  "entitlements": [
    {
      "key": "BROWSER_CHECKS",
      "type": "metered",
      "enabled": true,
      "quantity": 10
    },
    {
      "key": "PRIVATE_LOCATIONS",
      "type": "metered",
      "enabled": false,
      "requiredPlan": "TEAM",
      "requiredPlanDisplayName": "Team",
      "upgradeUrl": "https://app.checklyhq.com/accounts/.../billing/checkout"
    }
  ]
}

Key fields:

locations.all — filter to entries where available is true to get valid locations for your checks. Respect maxPerCheck as the upper bound per check.
entitlements — metered entitlements include a quantity limit. Disabled entitlements include requiredPlan and upgradeUrl.

checkly members - List and manage account members
checkly skills manage - Account management context for AI agents
checkly whoami - Display current account information
checkly switch - Switch between Checkly accounts

​Usage

​Subcommands

​checkly account plan

​Plan Options

​Plan Examples

​JSON Response

​Related Commands

Usage

Subcommands

`checkly account plan`

Plan Options

Plan Examples

JSON Response

Related Commands