Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Organisation 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.

get/organisations/{id}/credit_balance

Path parameters

idstring required
Example:org_1GB56M1ST1S0GVNA

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

Example response

{
  "total": {
    "active_credits_total": {
      "credits": 125.632,
      "credit_kgs": 125632
    },
    "retired_credits_total": {
      "credits": 125.632,
      "credit_kgs": 125632
    }
  },
  "supplier_balances": [
    {
      "supplier_id": "spl_1CC712KFS1S0YKPS",
      "total": {
        "active_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        },
        "retired_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        }
      }
    }
  ],
  "project_balances": [
    {
      "project_id": "prj_1CTWZQGKE1S0VAXA",
      "total": {
        "active_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        },
        "retired_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        }
      }
    }
  ],
  "order_balances": [
    {
      "order_id": "ord_1FAN3S3WV1S0B842",
      "total": {
        "active_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        },
        "retired_credits_total": {
          "credits": 125.632,
          "credit_kgs": 125632
        }
      }
    }
  ]
}