API reference
Get usage
GET /v1/usage — current monthly quota usage for the authenticated API key.
GET /v1/usage returns the monthly quota usage for the API key on the
request. Useful for surfacing usage in your own admin UI or for triggering
upgrade prompts before you hit the cap.
Endpoint
GET https://api.shieldsignup.com/v1/usageAuthentication
Bearer token in the Authorization header. See
Authentication.
Request example
curl https://api.shieldsignup.com/v1/usage \
-H "Authorization: Bearer ${SHIELDSIGNUP_API_KEY}"Response
HTTP/1.1 200 OK
Content-Type: application/json| Field | Type | Description |
|---|---|---|
plan | string | Plan associated with this API key. One of "free", "starter", "pro", "business". |
period_start | string | RFC 3339 timestamp at the start of the current UTC month. |
period_end | string | RFC 3339 timestamp at the end of the current UTC month. |
assessments_used | integer | Live assessments deducted from quota so far this period. Sandbox (sk_test_…) calls do not count. |
assessments_limit | integer | Monthly cap for this plan. See Rate limits for plan-by-plan numbers. |
overage_rate_per_1k | number | Cost in USD per additional 1,000 assessments above the cap. |
reset_at | string | RFC 3339 timestamp at which the quota resets (start of the next UTC month). |
{
"plan": "starter",
"period_start": "2026-05-01T00:00:00Z",
"period_end": "2026-05-31T23:59:59Z",
"assessments_used": 4312,
"assessments_limit": 10000,
"overage_rate_per_1k": 0.5,
"reset_at": "2026-06-01T00:00:00Z"
}Errors
| HTTP | error.code | Cause |
|---|---|---|
401 | unauthorized | Missing or invalid API key. |
401 | token_revoked | Key was revoked from the dashboard. |
This endpoint also returns the standard rate-limit response headers documented in Rate limits.