Skip to content

Get current billing-period usage counters by product.

GET
/billing/usage
curl --request GET \
--url https://api.siteqwality.com/billing/usage \
--header 'Authorization: Bearer <token>'

Usage counters

Media type application/json
object
period
required

The Uptime product’s period, kept for backwards compatibility. Read ProductUsage::period for the period a given product is metered in.

string
products
required
Array<object>
object
product
required
string
current_usage
required

Usage in the product’s CUSTOMER-FACING unit (see unit), not the raw tracking unit. Synthetic is metered in seconds for sub-minute accuracy but reported in minutes so it matches the packs and the pricing page.

integer format: int64
quota_limit
required
integer format: int64
hard_stopped
required
boolean
unit
required

The unit current_usage / quota_limit are expressed in.

string
period
required

The usage period THIS product is metered in. Products are anchored per subscription, so an account can be metering RUM on its billing anniversary while an unpurchased product runs on the calendar month; the top-level period cannot describe that.

string
Example generated
{
"period": "example",
"products": [
{
"product": "example",
"current_usage": 1,
"quota_limit": 1,
"hard_stopped": true,
"unit": "example",
"period": "example"
}
]
}

Missing or invalid authentication

Internal server error