# Credits available to this project

GET

/projects/{projectId}/billing/balance

```js
const url = 'https://zkao.io/api/v1/projects/example/billing/balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

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

* Production`zkao.io/api/v1/projects/{projectId}/billing/balance`
* Staging`staging.zkao.io/api/v1/projects/{projectId}/billing/balance`

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

* **[bearerAuth](https://docs.zkao.io/api/#bearerauth)**

## Parameters

### Path Parameters

* **projectId**

  required

  string

## Responses

### 200

OK

application/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

```json
{
  "organization": {
    "id": "example",
    "slug": "example",
    "name": "example"
  },
  "balanceCredits": 1,
  "availableCredits": 1,
  "reservedCredits": 1
}
```

### 401

Missing, malformed, expired, or revoked token

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 403

The token lacks the required scope

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 404

Resource not in this token’s project or repo allowlist

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```
