Quota

Check your subscription usage and remaining credits

GET/v1/quota

Get current quota usage

Returns your current subscription tier, credit balance, scan usage counts, and billing period details. Use this endpoint to check remaining credits before initiating scans or to display usage information in your dashboard.

Example Request

bash

curl -X GET "https://apviso.com/api/v1/v1/quota" \
  -H "X-API-Key: apvk_your_key_here"

Response

Returns the full quota breakdown for the current billing period, including credit totals, scan and retest counts, scheduled scan limits, and pay-as-you-go balance if enabled.

json

{
  "tier": "professional",
  "billingPeriod": {
    "start": "2026-04-01T00:00:00Z",
    "end": "2026-04-30T23:59:59Z"
  },
  "credits": {
    "total": 500,
    "used": 127,
    "remaining": 373
  },
  "scans": {
    "total": 50,
    "used": 12,
    "remaining": 38
  },
  "retests": {
    "total": 25,
    "used": 3,
    "remaining": 22
  },
  "scheduledScans": {
    "total": 10,
    "active": 2
  },
  "payg": {
    "enabled": true,
    "balance": 84.5
  }
}

Back to API Reference