Credits

List credits

GET /api/v2/credits

Returns all credits for your account. Use the optional status query parameter to filter by credit status.

Query parameters

Response 200 OK

[
  {
    "id": "cred_001",
    "sourceType": "subscription",
    "status": "available",
    "createdAt": "2026-01-01T00:00:00Z",
    "usedAt": null,
    "expiresAt": "2027-01-01T00:00:00Z"
  },
  {
    "id": "cred_002",
    "sourceType": "one_time",
    "status": "used",
    "createdAt": "2026-01-15T10:30:00Z",
    "usedAt": "2026-02-01T14:00:00Z",
    "expiresAt": "2027-01-15T10:30:00Z"
  }
]

Get credit balance

GET /api/v2/credits/balance

Returns aggregated credit counts for your account. This is the fastest way to check how many credits you have available.

Response 200 OK

{
  "available": 8,
  "used": 4,
  "expired": 0,
  "expiringSoon": 2,
  "total": 12
}

Consume a credit

POST /api/v2/credits/{id}/use

Consume a specific credit to start a pentest against a target. The target's domain must be verified.

Request body

Response 200 OK

{
  "scanId": "scan_abc123"
}

Error responses

Each pentest consumes one credit. Credits are consumed using FIFO order (oldest first) when no specific credit ID is provided. All credits expire 1 year from the date of purchase.