---
title: "Organisation Credit Balance"
method: GET
path: "/organisations/{id}/credit_balance"
---

# Organisation Credit Balance

`GET /organisations/{id}/credit_balance`

Information about active and retired credits owned by the given organisation.

Includes total balances as well as balances split by orders, projects and suppliers.

## Path parameters

- `id` string, required

## Headers

- `x-client-secret` string, required — A secret token identifying the client connecting to the API

## Response `200`

Successful Response

- OrganisationCreditBalance
  - `total` CreditBalance, required
    - `active_credits_total` CreditQuantity, required
      - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
      - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
    - `retired_credits_total` CreditQuantity, required
      - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
      - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
  - `supplier_balances` SupplierCreditBalance[], required
    - `supplier_id` string, required
    - `total` CreditBalance, required
      - `active_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
      - `retired_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
  - `project_balances` ProjectCreditBalance[], required
    - `project_id` string, required
    - `total` CreditBalance, required
      - `active_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
      - `retired_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
  - `order_balances` OrderCreditBalance[], required
    - `order_id` string, required
    - `total` CreditBalance, required
      - `active_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.
      - `retired_credits_total` CreditQuantity, required
        - `credits` number, required — A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
        - `credit_kgs` integer, required — A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/isometric/apis/isometric-registry-api.md) · [All operations](https://skmtc.net/isometric/apis/isometric-registry-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/isometric/isometric-registry-api/revisions/2e31eeb1cb99/schema)