Get usage term v2

Get usage term

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v2/usage/terms/{id}",
  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 <token>"
  ],
]);

$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}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "accounts": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "contractStartDate": "2023-12-25",
  "contractEndDate": "2023-12-25",
  "usageStartDate": "2023-12-25",
  "creditBudget": 1,
  "standardCreditsPerUnit": 1,
  "premiumCreditsPerUnit": 1,
  "packageModel": "limits",
  "pricingRules": {
    "apiChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "multistepChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "browserChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "playwrightCheckSuites": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "uptimeMonitors": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "aiInvocations": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPages": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPageAdditionalServices": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPageAdditionalSubscribers": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "additionalSms": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "additionalPhoneAlerts": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    }
  }
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

GET

usage

terms

{id}

Get usage term

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v2/usage/terms/{id}",
  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 <token>"
  ],
]);

$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}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "accounts": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "contractStartDate": "2023-12-25",
  "contractEndDate": "2023-12-25",
  "usageStartDate": "2023-12-25",
  "creditBudget": 1,
  "standardCreditsPerUnit": 1,
  "premiumCreditsPerUnit": 1,
  "packageModel": "limits",
  "pricingRules": {
    "apiChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "multistepChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "browserChecks": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "playwrightCheckSuites": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "uptimeMonitors": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "aiInvocations": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPages": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPageAdditionalServices": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "statusPageAdditionalSubscribers": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "additionalSms": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    },
    "additionalPhoneAlerts": {
      "method": "per_unit",
      "quantity": 1,
      "unit": "<string>",
      "credits": 1,
      "rates": [
        {
          "when": "<string>",
          "credits": 1
        }
      ],
      "included": {
        "quantity": 1,
        "period": "<string>"
      }
    }
  }
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

Authorizations

Authorization

string

header

required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. 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

Path Parameters

string<uuid>

required

Response

Successful

string<uuid>

required

name

string

required

accounts

object[]

required

Show child attributes

contractStartDate

string<date>

required

contractEndDate

string<date>

required

usageStartDate

string<date>

required

creditBudget

number | null

required

Required range: x > 0

standardCreditsPerUnit

number | null

required

Required range: x >= 0

premiumCreditsPerUnit

number | null

required

Required range: x >= 0

packageModel

enum<string> | null

required

Available options:

limits,

credits,

null

pricingRules

object | null

required

Show child attributes

Getting Started

API Reference

Authorizations

Headers

Path Parameters

Response