1. Docs
  2. API Reference
  3. Get the Account's current plan usage

Get the Account's current plan usage

GET/api/v1/billing/usage

Returns the Account's current usage for every implemented plan dimension (dashboard_seats, mau, m2m_tokens, sso_connections), each entry reporting limit, used, and percent (used/limit capped at 1.0). Dimensions whose producer features have not shipped yet are omitted, so the dashboard renders only what is present. Powers the Billing page usage panel and the per-page soft-cap banners.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission billing.viewAccount

Read the subscription, the plan, usage and invoices. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Responses

application/json

  • dataUsageSummaryResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

UsageSummaryResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/billing/usage" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "account_id": "string",
    "current_plan": "free",
    "dimensions": {
      "dashboard_seats": {
        "limit": 0,
        "used": 0,
        "percent": 0
      },
      "organizations": {
        "limit": 0,
        "used": 0,
        "percent": 0
      },
      "mau": {
        "limit": 0,
        "used": 0,
        "percent": 0
      },
      "m2m_tokens": {
        "limit": 0,
        "used": 0,
        "percent": 0
      },
      "sso_connections": {
        "limit": 0,
        "used": 0,
        "percent": 0
      }
    },
    "features": {
      "sso": false,
      "scim": false,
      "audit_destinations": false
    }
  }
}
 Related endpoints
GETGet the Account's current subscription
GETGet the Account's plan-feature entitlements
GETList the purchasable plan prices
GETList the Account's invoices
GETSummarize the Account's invoices
GETPreview the Account's next invoice
 Was this page helpful?

Tell us how we can improve this guide.

Canopy