BEbey-dev
Usage

Retrieve Usage

Changed on

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

Request

  • Base URL
    https://api.bey.dev
  • URL
    https://api.bey.dev/v1/usage
  • Auth
    API key in header x-api-key

Response

Successful Response

period_startstring required

Start of the billing period in ISO 8601 format.

period_endstring required

End of the billing period in ISO 8601 format, exclusive.

included_secondsinteger required

Usage your plan includes in the billing period.

used_secondsinteger required

Usage billed in the billing period, including overage.

remaining_secondsinteger required

Usage your plan includes that is not used yet.

overage_secondsinteger required

Usage billed past what your plan includes. It only grows when usage-based billing is enabled.

Example response

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

Changes