> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/billing/cycles/{cycleId}/events
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history and real-time event stream.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance and plan economics.
  - name: Billing
    description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.'
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: Manage your organization's API key.
  - name: Logs and health
    description: API request logs, the audit log, and integration health.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/billing/cycles/{cycleId}/events:
    get:
      tags:
        - Billing
      summary: Get events for a billing cycle
      description: >-
        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.
      operationId: getV1OrganizationBillingCyclesCycleidEvents
      parameters:
        - description: Billing cycle ID
          x-format:
            guid: true
          name: cycleId
          in: path
          required: true
          schema:
            type: string
        - description: Events per page
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - description: Pagination offset
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Cycle events retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model458'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '404':
          description: Resource not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model24'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model458:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model457'
    Model9:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model24:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Resource not found
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: NOT_FOUND
    Model5:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: An unexpected error occurred
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INTERNAL_ERROR
    Model457:
      type: object
      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
      properties:
        cycleId:
          type: string
        events:
          $ref: '#/components/schemas/Model455'
        pagination:
          $ref: '#/components/schemas/Model456'
    Model455:
      type: array
      items:
        type: string
    Model456:
      type: object
      properties:
        total:
          type: number
        limit:
          type: number
        offset:
          type: number
        hasMore:
          type: boolean
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key. Format: "hp_live_{key}". Organization admins
        manage the key in the dashboard.

````

## Related topics

- [List all billing events](/platform-api/billing/list-all-billing-events.md)
- [List billing cycles](/platform-api/billing/list-billing-cycles.md)
- [Get all-months billing aggregates](/platform-api/billing/get-all-months-billing-aggregates.md)
- [Get daily billing activity](/platform-api/billing/get-daily-billing-activity.md)
- [Get monthly billing summary](/platform-api/billing/get-monthly-billing-summary.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.