Skip to content
zkaozkaozkao docs
These docs describe staging.zkao.io and the @zksecurity/zkao-cli@next release. For production, see docs.zkao.io.

Credits available to this project

GET
/projects/{projectId}/billing/balance
curl --request GET \
  --url https://zkao.io/api/v1/projects/example/billing/balance \
  --header 'Authorization: Bearer <token>'

Requires scope: read. The organization’s shared prepaid balance, available to this project and to the organization’s other projects. All amounts are in credits.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
organization
required

The organization whose shared balance this is.

object
id
required
string
slug
required

URL segment of the organization (/orgs/<slug>), unique across zkao.

string
name
required
string
balanceCredits
required

The organization’s total prepaid credit balance, shared by all of its projects.

integer
availableCredits
required

Balance minus credits reserved by the organization’s in-flight scans.

integer
reservedCredits
required

Credits held by the organization’s queued/running scans.

integer
Examplegenerated
{
  "organization": {
    "id": "example",
    "slug": "example",
    "name": "example"
  },
  "balanceCredits": 1,
  "availableCredits": 1,
  "reservedCredits": 1
}

401

Section titled “401”

Missing, malformed, expired, or revoked token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
Example
{
  "error": {
    "code": "unauthorized"
  }
}

403

Section titled “403”

The token lacks the required scope

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
Example
{
  "error": {
    "code": "unauthorized"
  }
}

404

Section titled “404”

Resource not in this token’s project or repo allowlist

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
Example
{
  "error": {
    "code": "unauthorized"
  }
}