Current organization usage and limits for the active billing period

Return the org-wide usage for the current calendar month and configured limits.

Usage is aggregated across all members of the organization (limits are org-level) for the current calendar-month period and resets on the first of each month. Simulation usage is a single figure; compute usage is broken down by job type with the total in compute.usage. All values are in hours; a None limit means that usage type is unconstrained.

Current organization usage and limits for the active billing period

cURL

curl --request GET \
  --url https://api.ionworks.com/organizations/current/usage

import requests

url = "https://api.ionworks.com/organizations/current/usage"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.ionworks.com/organizations/current/usage', 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.ionworks.com/organizations/current/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.ionworks.com/organizations/current/usage"

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

	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.ionworks.com/organizations/current/usage")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/organizations/current/usage")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "simulation": {
    "usage": 0,
    "limit": 123
  },
  "compute": {
    "usage": 0,
    "usage_by_type": {},
    "limit": 123
  }
}

Response

200 - application/json

Successful Response

Org usage and limits for the current calendar-month billing period.

Usage resets on the first of each month. All usage/limit values are in hours.

period_start · string<date-time> · required

period_end · string<date-time> · required

simulation · SimulationUsage · object · required

Current simulation usage and its configured limit, in hours.

Show child attributes

compute · ComputeUsage · object · required

Current compute usage and its configured limit, in hours.

usage is the total across all job types; usage_by_type breaks it down (informational — the limit applies to the total).

Show child attributes