API docs

Current billing-period consumption

GET
/usage

This billing period’s metered consumption — /v1/screen calls and monitored record-months, priced — matching exactly what is metered for billing over the same period, so you can reconcile before the invoice arrives.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Your API key, sent as Authorization: Bearer <key>.

Response Body

Current-period usage, priced.

application/json
  1. response
period*string
Match^\d{4}-(0[1-9]|1[0-2])$
screenCalls*integer
Range0 <= value <= 9007199254740991
recordMonths*integer
Range0 <= value <= 9007199254740991
price*
curl -X GET "https://example.com/usage" \  -H "Authorization: Bearer $EXCLIA_API_KEY"
{  "period": "string",  "screenCalls": 0,  "recordMonths": 0,  "price": {    "screenCallCents": 0,    "recordMonthCents": 0,    "subtotalCents": 0,    "platformMinimumCents": 0,    "totalCents": 0,    "minimumApplied": true  }}