# Get usage projections v2 - Checkly Docs

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

Source: https://www.checklyhq.com/docs/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules/

---

Get usage projections

```
curl --request GET \
--url https://api.checklyhq.com/v2/usage/terms/{id}/projections \
--header 'Authorization: Bearer '
```

```
import requests

url = "https://api.checklyhq.com/v2/usage/terms/{id}/projections"

headers = {"Authorization": "Bearer "}

response = requests.get(url, headers=headers)

print(response.text)
```

```
const options = {method: 'GET', headers: {Authorization: 'Bearer '}};

fetch('https://api.checklyhq.com/v2/usage/terms/{id}/projections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
```

```
"https://api.checklyhq.com/v2/usage/terms/{id}/projections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer "
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
```

```
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.checklyhq.com/v2/usage/terms/{id}/projections"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer ")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
```

```
HttpResponse response = Unirest.get("https://api.checklyhq.com/v2/usage/terms/{id}/projections")
.header("Authorization", "Bearer ")
.asString();
```

```
require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v2/usage/terms/{id}/projections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer '

response = http.request(request)
puts response.read_body
```

```
{
"usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"asOf": "2023-12-25",
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"weeksSinceStart": 1,
"weeksRemaining": 1,
"creditsUsed": 1,
"remainingCredits": 123,
"budgetedDailyCredits": 1,
"windows": {
"sinceStart": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last30Days": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last7Days": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last1Day": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
}
}
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

Usage

# Get usage projections v2

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

GET

/

v2

/

usage

/

terms

/

{id}

/

projections

Get usage projections

```
curl --request GET \
--url https://api.checklyhq.com/v2/usage/terms/{id}/projections \
--header 'Authorization: Bearer '
```

```
import requests

url = "https://api.checklyhq.com/v2/usage/terms/{id}/projections"

headers = {"Authorization": "Bearer "}

response = requests.get(url, headers=headers)

print(response.text)
```

```
const options = {method: 'GET', headers: {Authorization: 'Bearer '}};

fetch('https://api.checklyhq.com/v2/usage/terms/{id}/projections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
```

```
"https://api.checklyhq.com/v2/usage/terms/{id}/projections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer "
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
```

```
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.checklyhq.com/v2/usage/terms/{id}/projections"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer ")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
```

```
HttpResponse response = Unirest.get("https://api.checklyhq.com/v2/usage/terms/{id}/projections")
.header("Authorization", "Bearer ")
.asString();
```

```
require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v2/usage/terms/{id}/projections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer '

response = http.request(request)
puts response.read_body
```

```
{
"usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"asOf": "2023-12-25",
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"weeksSinceStart": 1,
"weeksRemaining": 1,
"creditsUsed": 1,
"remainingCredits": 123,
"budgetedDailyCredits": 1,
"windows": {
"sinceStart": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last30Days": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last7Days": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
},
"last1Day": {
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"observedDays": 1,
"creditsUsed": 1,
"averageDailyCredits": 1,
"projectedAnnualPercentOfBudget": 1,
"projectedCreditsAtContractEnd": 1,
"projectedRemainingCredits": 123,
"projectedPercentAtContractEnd": 1,
"projectedWeeksUntilExhausted": 1
}
}
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

```
{
"statusCode": 123,
"error": " ",
"message": " ",
"code": "ACCOUNT_NOT_IN_USAGE_TERMS",
"errorCode": "ERR_ACCOUNT_NOT_ACCESSIBLE"
}
```

#### Authorizations

Authorization

string

header

required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys).
Your API key is like a password:
keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL: `curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"`

#### Headers

x-checkly-account

string<uuid>

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

#### Path Parameters

id

string<uuid>

required

#### Query Parameters

asOf

string<date>

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

#### Response

Successful

Whole-term projections from v2-priced daily charges. Credit amounts use four decimals; percentages and exhaustion weeks use two. Reads are live, including historical asOf dates.

usageTermsId

string<uuid>

required

asOf

string<date>

required

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

period

object | null

required

Usage start through the earlier of asOf and term end. Null before usage starts.

Show child attributes

weeksSinceStart

integer

required

Required range: `x >= 0`

weeksRemaining

integer

required

Required range: `x >= 0`

creditsUsed

number | null

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.

Required range: `x >= 0`

remainingCredits

number | null

required

Term budget minus credits used. Negative when over budget.

budgetedDailyCredits

number | null

required

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

Required range: `x >= 0`

windows

object

required

Show child attributes

Was this page helpful?

[Suggest edits](https://github.com/checkly/docs/edit/main/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules.mdx)[Raise issue](https://github.com/checkly/docs/issues/new?title=Issue%20on%20docs&body=Path:%20/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules)

[Get usage term v2 Previous](https://www.checklyhq.com/docs/api-reference/usage/get-a-usage-term-with-its-budget-accounts-and-applied-pricing-rules)[Get usage terms v1 Next](https://www.checklyhq.com/docs/api-reference/usage/get-usage-terms)

[x](https://x.com/checklyhq)[github](https://github.com/checkly)[linkedin](https://linkedin.com/company/checkly)

[Powered by This documentation is built and hosted on Mintlify, a developer documentation platform](https://www.mintlify.com/?utm_campaign=poweredBy&utm_medium=referral&utm_source=checkly-422f444a)
