Billing and invoices

List billing cycles

View all billing charges for your organization.

Since August 2026, each row is one CALENDAR-MONTH charge for one user (billingMonth = first day of the month it covers, full month, no proration). A charge is created when:

The trader’s first account is created (trigger: account_created)
A new month starts while the trader still holds in_progress accounts, or an account creation is their first billing trigger of the month (trigger: auto_renewal)

Rows with billingMonth: null are historical 30-day cycles from before August 2026 — the old rolling model. They count toward the month they started in.

Statuses:

Status	Meaning
`active`	Covers the current period (`expiresAt` in the future)
`expired`	Period ended
`cancelled`	Manually cancelled

Billing: Each row is an invoice line item. The price is locked in at creation — if your rate changes, only new months use the new rate.

Price breakdown: every row also carries platformPrice (the Hyperprop platform fee) and marketDataPrice (the CME Group market data bundle — CME, CBOT, NYMEX, COMEX, always billed as one bundle). platformPrice + marketDataPrice = price always holds, including for historical rows from earlier pricing eras.

Same user, multiple rows: each billed month is a separate row — a complete billing history per trader.

Paging: rows are newest first. Offset paging works as before; for long histories pass pagination.nextCursor back as cursor to fetch the next page without counting through the earlier ones. total always counts every matching row.

Access: read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue.

GET

organization

billing

cycles

List billing cycles

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/billing/cycles \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/billing/cycles', 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/cycles",
  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/cycles"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/billing/cycles")

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": {
    "organizationId": "55555555-5555-4555-8555-555555555555",
    "organizationName": "FakePropFirm",
    "cycles": [
      {
        "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
        "userId": "11111111-1111-4111-8111-111111111111",
        "userEmail": "trader@example.com",
        "cycleNumber": 3,
        "status": "active",
        "startedAt": "2026-03-01T10:00:00.000Z",
        "expiresAt": "2026-03-31T10:00:00.000Z",
        "price": 17,
        "platformPrice": 14,
        "marketDataPrice": 3,
        "currency": "USD",
        "triggerType": "auto_renewal",
        "triggerAccountId": null
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true,
      "nextCursor": "ZXhhbXBsZS1jdXJzb3ItNS1vcGFxdWUtZG8tbm90LXBhcnNl"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"limit\" must be less than or equal to 100",
  "code": "VALIDATION_ERROR"
}

{
  "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 \"Traders & accounts\"",
  "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

X-API-Key

string

header

required

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.

Query Parameters

status

enum<string>

Filter by cycle status

Available options:

active,

expired,

cancelled

limit

integer

default:50

Results per page

Required range: 1 <= x <= 100

offset

integer

default:0

Pagination offset

Required range: x >= 0

cursor

string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

A cursor that was not returned by this endpoint, or one from a request with a different sort, is rejected with 400.

Maximum string length: 512

Response

Billing cycles retrieved

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "55555555-5555-4555-8555-555555555555",
  "organizationName": "FakePropFirm",
  "cycles": [
    {
      "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
      "userId": "11111111-1111-4111-8111-111111111111",
      "userEmail": "trader@example.com",
      "cycleNumber": 3,
      "status": "active",
      "startedAt": "2026-03-01T10:00:00.000Z",
      "expiresAt": "2026-03-31T10:00:00.000Z",
      "price": 17,
      "platformPrice": 14,
      "marketDataPrice": 3,
      "currency": "USD",
      "triggerType": "auto_renewal",
      "triggerAccountId": null
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0,
    "hasMore": true,
    "nextCursor": "ZXhhbXBsZS1jdXJzb3ItNS1vcGFxdWUtZG8tbm90LXBhcnNl"
  }
}

⌘I

List billing cycles

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/billing/cycles \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/billing/cycles', 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/cycles",
  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/cycles"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/billing/cycles")

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": {
    "organizationId": "55555555-5555-4555-8555-555555555555",
    "organizationName": "FakePropFirm",
    "cycles": [
      {
        "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
        "userId": "11111111-1111-4111-8111-111111111111",
        "userEmail": "trader@example.com",
        "cycleNumber": 3,
        "status": "active",
        "startedAt": "2026-03-01T10:00:00.000Z",
        "expiresAt": "2026-03-31T10:00:00.000Z",
        "price": 17,
        "platformPrice": 14,
        "marketDataPrice": 3,
        "currency": "USD",
        "triggerType": "auto_renewal",
        "triggerAccountId": null
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true,
      "nextCursor": "ZXhhbXBsZS1jdXJzb3ItNS1vcGFxdWUtZG8tbm90LXBhcnNl"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"limit\" must be less than or equal to 100",
  "code": "VALIDATION_ERROR"
}

{
  "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 \"Traders & accounts\"",
  "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"
}

Platform API

Trade API

List billing cycles

Authorizations

Query Parameters

Response