Get this month so far
The current billing month so far, not invoiced yet: trader-months per family (unbilledUnits), with an estimate at your agreed prices of the month-end invoice (minimums included) if the month ended now. Also what is unpaid on issued invoices (outstandingCents, overdueCents) and your credit balance. Billing months follow America/Chicago. Works without complete billing details.
Access: read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/billing/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.hyperprop.com/platform/v1/organization/billing/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.hyperprop.com/platform/v1/organization/billing/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.hyperprop.com/platform/v1/organization/billing/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"currency": "usd",
"billingMonth": "2026-11-01",
"asOf": "2026-11-02T13:00:00.000Z",
"unbilledUnits": {
"cme": 1300,
"crypto": 120,
"platform": 1
},
"invoicedUnits": {
"cme": 1300,
"crypto": 120,
"platform": 1
},
"hasAgreement": true,
"pricingStartsOn": null,
"estimate": {
"usageCents": 3120000,
"monthEndCents": 3420000,
"minimumApplies": true,
"minimums": [
{
"family": "cme",
"units": 2000
}
],
"monthlyMinimum": {
"billingMonth": "2026-11-01",
"minimumCents": 1000000,
"effectiveCents": 1000000,
"billedCents": 320000,
"previouslyBilledCents": 0,
"topUpCents": 680000,
"prorated": true
},
"agreementVersion": 3
},
"autoInvoice": true,
"nextInvoiceOn": "2026-12-01",
"outstandingCents": 2860000,
"overdueCents": 0,
"unpaidCount": 1,
"creditBalanceCents": 250000
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Your role does not have view access to \"Billing & purchases revenue\"",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/billing/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.hyperprop.com/platform/v1/organization/billing/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.hyperprop.com/platform/v1/organization/billing/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.hyperprop.com/platform/v1/organization/billing/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"currency": "usd",
"billingMonth": "2026-11-01",
"asOf": "2026-11-02T13:00:00.000Z",
"unbilledUnits": {
"cme": 1300,
"crypto": 120,
"platform": 1
},
"invoicedUnits": {
"cme": 1300,
"crypto": 120,
"platform": 1
},
"hasAgreement": true,
"pricingStartsOn": null,
"estimate": {
"usageCents": 3120000,
"monthEndCents": 3420000,
"minimumApplies": true,
"minimums": [
{
"family": "cme",
"units": 2000
}
],
"monthlyMinimum": {
"billingMonth": "2026-11-01",
"minimumCents": 1000000,
"effectiveCents": 1000000,
"billedCents": 320000,
"previouslyBilledCents": 0,
"topUpCents": 680000,
"prorated": true
},
"agreementVersion": 3
},
"autoInvoice": true,
"nextInvoiceOn": "2026-12-01",
"outstandingCents": 2860000,
"overdueCents": 0,
"unpaidCount": 1,
"creditBalanceCents": 250000
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Your role does not have view access to \"Billing & purchases revenue\"",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}