Skip to main content
GET
The organization's pentest credit balance
Returns the pentest credits available to the organization, with totals purchased, used, refunded and granted. is_unlimited is true for organizations without a credit limit.
Scope required: read

Authorizations

X-Api-Key
string
header
required

Response

200 - application/json
organization_id
string
required

Organization UUID

Example:

"f336d0bc-b841-465b-8045-024475c079dd"

balance
number
required

Current pentest credit balance available for use

Example:

12000

total_purchased
number
required

Total pentest credits purchased across all time

Example:

16000

total_used
number
required

Total pentest credits deducted for completed/running pentests

Example:

8000

total_refunded
number
required

Total pentest credits refunded from cancelled pentests

Example:

4000

total_granted
number
required

Total pentest credits granted at no charge

Example:

2000

used_this_period
number | null
required

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

Example:

1240

is_unlimited
boolean
required

Whether this organization has internal unlimited pentest entitlement

Example:

false