Organization
Get events for a billing cycle
Returns a paginated audit trail for a billing cycle owned by the authenticated organization — creation, renewal, expiry, and entitlement changes. Cross-organization cycle IDs return 404.
GET
/
v1
/
organization
/
billing
/
cycles
/
{cycleId}
/
events
Get events for a billing cycle
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/events \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/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": {
"cycleId": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
"events": [
{
"id": "e1",
"eventType": "cycle_created",
"amount": 20,
"currency": "USD",
"metadata": {
"trigger_account_id": "acc-123"
},
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"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": 404,
"error": "Not Found",
"message": "Resource not found",
"code": "NOT_FOUND"
}{
"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.
Path Parameters
Billing cycle ID
Query Parameters
Events per page
Required range:
1 <= x <= 100Pagination offset
Required range:
x >= 0Response
Cycle events retrieved
Example:
true
Show child attributes
Show child attributes
Example:
{
"cycleId": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
"events": [
{
"id": "e1",
"eventType": "cycle_created",
"amount": 20,
"currency": "USD",
"metadata": { "trigger_account_id": "acc-123" },
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"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 billing eventsList billing cyclesGet all-months billing aggregatesGet daily billing activityGet monthly billing summary⌘I
Get events for a billing cycle
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/events \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/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/cycles/{cycleId}/events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/billing/cycles/{cycleId}/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": {
"cycleId": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
"events": [
{
"id": "e1",
"eventType": "cycle_created",
"amount": 20,
"currency": "USD",
"metadata": {
"trigger_account_id": "acc-123"
},
"createdAt": "2026-03-01T10:00:00.000Z"
},
{
"id": "e2",
"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": 404,
"error": "Not Found",
"message": "Resource not found",
"code": "NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}