---
title: "Get usage summary"
method: GET
path: "/v2/usage/summary"
tags: ["Usage"]
---

# Get usage summary

`GET /v2/usage/summary`

## Request

- Base URL: `https://api.checklyhq.com`
- URL: `https://api.checklyhq.com/v2/usage/summary`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v2/usage/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

Get consumption across usage terms, with a calculation breakdown for each pricing rule.

## Query parameters

- `from` string, date: Inclusive UTC date. Defaults to the earliest selected usage start, or to.
- `to` string, date: Inclusive UTC date. Defaults to today.
- `usageTermsIds` string[]
- `accountIds` string[]
- `pricingRuleKeys` string[]

## Headers

- `x-checkly-account` string, uuid: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

## Response `200`

Successful

- UsageV2SummaryResponse
  - `period` object, required
    - `from` string, date, required
    - `to` string, date, required
  - `usageTermsIds` string[], required
  - `totals` object, required
    - `creditsUsed` number, nullable, required: Credits rounded to four decimals before aggregation: once per organization-day for uptime monitors, and per resource-day and applied rate for other usage. Rules absent from configured pricing contribute zero. Null means unavailable or incompatible pricing, or uncovered dates.
  - `breakdown` UsageV2Breakdown[], required
    - `usageTermsId` string, uuid, required
    - `pricingRuleKey` 'apiChecks' | 'multistepChecks' | 'browserChecks' | 'playwrightCheckSuites' | 'uptimeMonitors' | 'aiInvocations' | 'statusPages' | 'statusPageAdditionalServices' | 'statusPageAdditionalSubscribers' | 'additionalSms' | 'additionalPhoneAlerts', required
    - `accountId` string
    - `period` object, required
      - `from` string, date, required
      - `to` string, date, required
    - `pricingRule` union, required
      - object
        - `method` 'per_unit', required
        - `quantity` number, required
        - `unit` string, required
        - `credits` number, required
        - `rates` object[]
          - `when` string, required
          - `credits` number, required
        - `included` object
          - `quantity` number, required
          - `period` string
      - object
        - `method` 'per_period', required
        - `period` 'day', required
        - `price` object, required
          - `annualCredits` number, required
      - object
        - `method` 'capacity_blocks_per_period', required
        - `period` 'day', required
        - `unit` string, required
        - `included` object, required
          - `quantity` number, required
        - `block` object, required
          - `quantity` number, required
          - `annualCredits` number, required
    - `calculations` UsageV2Calculation[], required
      - union
        - object
          - `rateCondition` string, nullable, required
          - `measuredQuantity` number, required
          - `includedQuantity` number, nullable, required
          - `billableQuantity` number, nullable, required
          - `creditsUsed` number, nullable, required: Credits rounded to four decimals before aggregation: once per organization-day for uptime monitors, and per resource-day and applied rate for other usage. Rules absent from configured pricing contribute zero. Null means unavailable or incompatible pricing, or uncovered dates.
        - object
          - `billableResourceDays` number, required
          - `appliedDailyCredits` number, required
          - `proration` object, required
            - `daysPerYear` 365, required
          - `creditsUsed` number, nullable, required: Credits rounded to four decimals before aggregation: once per organization-day for uptime monitors, and per resource-day and applied rate for other usage. Rules absent from configured pricing contribute zero. Null means unavailable or incompatible pricing, or uncovered dates.
        - object
          - `scope` 'statusPage', required
          - `measuredQuantity` number, required
          - `includedQuantity` number, required
          - `billableBlockDays` number, required
          - `appliedDailyCreditsPerBlock` number, required
          - `proration` object, required
            - `daysPerYear` 365, required
          - `creditsUsed` number, nullable, required: Credits rounded to four decimals before aggregation: once per organization-day for uptime monitors, and per resource-day and applied rate for other usage. Rules absent from configured pricing contribute zero. Null means unavailable or incompatible pricing, or uncovered dates.
    - `creditsUsed` number, nullable, required: Credits rounded to four decimals before aggregation: once per organization-day for uptime monitors, and per resource-day and applied rate for other usage. Rules absent from configured pricing contribute zero. Null means unavailable or incompatible pricing, or uncovered dates.
  - `coverage` object, required: Dates outside organization usage terms. Credits for gaps are unknown; deliberately filtered terms are excluded.
    - `gaps` object[], required
      - `from` string, date, required
      - `to` string, date, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `502`: Response

## Changes

- **2026-10-31** `bc90d1bfa738`: 7 info
  - added the optional property `errorCode` to the response with the `400` status
  - added the optional property `errorCode` to the response with the `401` status
  - added the optional property `errorCode` to the response with the `403` status
  - added the optional property `errorCode` to the response with the `404` status
  - …3 more
- **2026-10-17** `4698655f7ecd`: 2 info
  - added `subschema #1, subschema #2, subschema #3` to the `breakdown/items/calculations/items/` response property `anyOf` list for the response status `200`
  - removed `subschema #1, subschema #2, subschema #3` from the `breakdown/items/calculations/items/` response property `anyOf` list for the response status `200`
- **2026-10-07** `aba5d34c749b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/checklyhq/apis/checkly-public-api/changes/v2/usage/summary/get.md)

---

[API](https://skmtc.dev/checklyhq/apis/checkly-public-api.md) - [All operations](https://skmtc.dev/checklyhq/apis/checkly-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/checklyhq/apis/checkly-public-api/revisions/bc90d1bfa738?raw)