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
}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.
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
}Authorizations
Your Beyond Presence API Key.
Response
Successful Response
Usage of the current billing period.
Start of the billing period in ISO 8601 format.
"2026-10-01T00:00:00+00:00"
End of the billing period in ISO 8601 format, exclusive.
"2027-01-01T00:00:00+00:00"
Usage your plan includes in the billing period.
540000
Usage billed in the billing period, including overage.
432000
Usage your plan includes that is not used yet.
108000
Usage billed past what your plan includes. It only grows when usage-based billing is enabled.
0
Was this page helpful?