HAhacktron
REST API - Credits

The organization's pentest credit balance

Changed on
get/credits

Request

  • Base URL
    https://api.hacktron.ai/v1
  • URL
    https://api.hacktron.ai/v1/credits
  • Auth
    API key in header X-Api-Key

Response

organization_idstring required

Organization UUID

balancenumber required

Current pentest credit balance available for use

total_purchasednumber required

Total pentest credits purchased across all time

total_usednumber required

Total pentest credits deducted for completed/running pentests

total_refundednumber required

Total pentest credits refunded from cancelled pentests

total_grantednumber required

Total pentest credits granted at no charge

used_this_periodnumber nullable required

Credits deducted since the start of the current billing period, null when the organization has no billing period

is_unlimitedboolean required

Whether this organization has internal unlimited pentest entitlement

Example response

{
  "organization_id": "f336d0bc-b841-465b-8045-024475c079dd",
  "balance": 12000,
  "total_purchased": 16000,
  "total_used": 8000,
  "total_refunded": 4000,
  "total_granted": 2000,
  "used_this_period": 1240
}

Changes