usage

Read this month's usage and remaining quota

Returns the monthly usage summary for the calling tenant: the plan quota, the requests counted so far and the requests still available. Defaults to the current month (UTC); pass month=YYYY-MM for another. Figures come from the billing aggregates and can lag real time by up to about an hour, so use this for reporting, not for deciding whether the next call will succeed. For an hour-by-hour view use getUsageHourly.

get/v1/usage

Request

  • Base URL: https://api.skanqrcode.com
  • URL: https://api.skanqrcode.com/v1/usage
  • Auth: HTTP bearer

Query parameters

monthstring

Calendar month (UTC) as YYYY-MM. Defaults to the current month.

Example:2026-09

Response

Monthly usage summary.

tenantIdstring required
monthstring required

The calendar month (UTC) this response covers.

monthlyQuotainteger required

Requests included in the plan for a month.

totalRequestsinteger required

Requests counted against the monthly quota so far, combined across every API key, client IP and access surface.

availableRequestsinteger required

max(monthlyQuota - totalRequests, 0). On plans that bill overage, reaching zero means the next request is billed as overage rather than blocked.

Changes

No recorded changes to this operation across all 1 revision of this API.