Usage & Limits

If your plan is metered, the Usage page shows where you stand against your limits for the current period.

Where limits come from

Limits are defined per plan and travel with the license as entitlements:

type PlanLimits = {
  activations?: number | null          // max sites/devices (null = unlimited)
  apiRequestsPerMonth?: number | null   // monthly usage cap (null = unlimited)
  teamSeats?: number | null             // seats on team plans
}

A null limit means unlimited.

How usage is counted

Each chargeable operation in your plugin reports usage (see Metered Usage). The portal keeps a counter per metric, per billing period:

Reading usage in the portal

The Usage page shows each metric as a progress bar with used / limit and the reset date. The Dashboard shows a condensed version.

Period resets

Developers can read the reset time programmatically:

const summary = await client.usageSummary({ licenseKey })
console.log('Resets on:', summary.data.resetAt) // ISO datetime

Exceeding a limit

When a metric hits its cap, further metered calls are denied (allowed: false) unless credits cover the overage. See Billing & Credits.

For developers