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

Organisation Credit Balance

cURL

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

import requests

url = "https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance"

headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-secret': '<x-client-secret>', Authorization: 'Bearer <token>'}
};

fetch('https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/registry/v0/organisations/{id}/credit_balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret · string · required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id · string · required

Required string length: 20 - 37

Examples:

"org_1GB56M1ST1S0GVNA"

"org_1CP8EQDNQSBXTMR2"

Response

200

application/json

Successful Response

order_balances · OrderCreditBalance · object[] · required

Show child attributes

project_balances · ProjectCreditBalance · object[] · required

Show child attributes

supplier_balances · SupplierCreditBalance · object[] · required

Show child attributes

total · CreditBalance · object · required

Show child attributes