Monthly spend and purchase summary for this project

GET

/projects/{projectId}/billing/summary

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

• Production
• Staging

Requires scope: read. Per-month net scan spend and net purchases attributed to this project, in credits, newest first. Purchases land in the organization’s shared balance.

Authorizations

• bearerAuth

Parameters

Path Parameters

projectId

required

string

Query Parameters

months

integer

>= 1 <= 24

Responses

200

OK

Media typeapplication/json

object

organization

required

The organization whose shared balance the purchases were made into.

object

id

required

string

slug

required

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

string

name

required

string

months

required

Array<object>

object

month

required

YYYY-MM (UTC).

string

spentCredits

required

Net scan spend (deductions less refunds), in credits.

integer

purchasedCredits

required

Net purchases (purchases less clawbacks), in credits.

integer

Example^generated

{
  "organization": {
    "id": "example",
    "slug": "example",
    "name": "example"
  },
  "months": [
    {
      "month": "example",
      "spentCredits": 1,
      "purchasedCredits": 1
    }
  ]
}

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

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

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"
  }
}