Usage

Get usage projections

Changed on

Project whole-term credit consumption from completed UTC days using v2 pricing rules.

get/v2/usage/terms/{id}/projections

Request

Path parameters

idstring uuid required

Query parameters

asOfstring date

Inclusive completed UTC date. Defaults to yesterday UTC; today and future dates are rejected.

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

usageTermsIdstring uuid required
asOfstring date required

Requested completed UTC date, including when it falls outside the term.

weeksSinceStartinteger required
weeksRemaininginteger required
creditsUsednumber 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.

remainingCreditsnumber nullable required

Term budget minus credits used. Negative when over budget.

budgetedDailyCreditsnumber nullable required

Term budget divided by inclusive days from usage start through contract end, rounded to four decimals. Null when the budget is unavailable.

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status