Organization
List all billing events
Returns the complete billing event audit trail for your organization.
Event types:
| Type | Description |
|---|---|
subscription_started | First ever billing cycle for a user |
cycle_created | New billing cycle started (account created) |
cycle_renewed | New month charged (user has active accounts) |
cycle_expired | Billing period ended, no renewal |
cycle_cancelled | Manually cancelled |
entitlement_granted | CME Group DOB bundle access turned on |
entitlement_revoked | CME Group DOB bundle access turned off |
price_changed | Organization rate was updated |
GET
/
v1
/
organization
/
billing
/
events
List all billing events
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/events \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/events"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/billing/events', 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/events",
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: <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/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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/events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
"organizationName": "FakePropFirm",
"events": [
{
"id": "e1",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "subscription_started",
"amount": 20,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "entitlement_granted",
"amount": null,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:01.000Z"
}
],
"pagination": {
"total": 2,
"limit": 50,
"offset": 0,
"hasMore": false
}
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Authorizations
BearerX-API-Key
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Query Parameters
Results per page
Required range:
1 <= x <= 100Pagination offset
Required range:
x >= 0Response
Billing events retrieved
Example:
true
Show child attributes
Show child attributes
Example:
{
"organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
"organizationName": "FakePropFirm",
"events": [
{
"id": "e1",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "subscription_started",
"amount": 20,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "entitlement_granted",
"amount": null,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:01.000Z"
}
],
"pagination": {
"total": 2,
"limit": 50,
"offset": 0,
"hasMore": false
}
}
Related topics
List all organization eventsList billing cyclesGet events for a billing cycleList all webhooksList roles (system presets + your custom roles)⌘I
List all billing events
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/events \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/events"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/billing/events', 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/events",
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: <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/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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/events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
"organizationName": "FakePropFirm",
"events": [
{
"id": "e1",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "subscription_started",
"amount": 20,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"billingCycleId": "cycle-1",
"userId": "user-1",
"eventType": "entitlement_granted",
"amount": null,
"currency": "USD",
"metadata": {},
"createdAt": "2026-03-01T10:00:01.000Z"
}
],
"pagination": {
"total": 2,
"limit": 50,
"offset": 0,
"hasMore": false
}
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}