Retrieve Usage
curl --request GET \
--url https://api.bey.dev/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"period_start": "2026-10-01T00:00:00+00:00",
"period_end": "2027-01-01T00:00:00+00:00",
"included_seconds": 540000,
"used_seconds": 432000,
"remaining_seconds": 108000,
"overage_seconds": 0
}Usage
Retrieve Usage
Retrieve your organization’s usage in the current billing period.
All figures are seconds as your plan counts them, and cover every workspace of your organization, so only an API key of the default workspace can read them. Usage can take a few minutes to appear.
GET
/
v1
/
usage
Retrieve Usage
curl --request GET \
--url https://api.bey.dev/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.bey.dev/v1/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.bey.dev/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"period_start": "2026-10-01T00:00:00+00:00",
"period_end": "2027-01-01T00:00:00+00:00",
"included_seconds": 540000,
"used_seconds": 432000,
"remaining_seconds": 108000,
"overage_seconds": 0
}Response
Successful Response
Usage of the current billing period.
Was this page helpful?