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

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



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/billing/cycles
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:
    get:
      tags:
        - Billing
      summary: List billing cycles
      description: >-
        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.
      operationId: getV1OrganizationBillingCycles
      parameters:
        - description: Filter by cycle status
          name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - expired
              - cancelled
        - description: Results 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: Billing cycles retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model228'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model228:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model227'
    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
    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
    Model227:
      type: object
      example:
        organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34
        organizationName: FakePropFirm
        cycles:
          - id: b1c2d3e4-f5a6-7890-abcd-ef1234567890
            userId: f994bc02-343c-4026-8a57-afc085eca8d5
            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
      properties:
        organizationId:
          type: string
        organizationName:
          type: string
        cycles:
          $ref: '#/components/schemas/cycles'
        pagination:
          $ref: '#/components/schemas/Model226'
    cycles:
      type: array
      items:
        type: string
    Model226:
      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)
- [Get events for a billing cycle](/platform-api/billing/get-events-for-a-billing-cycle.md)
- [Get all-months billing aggregates](/platform-api/billing/get-all-months-billing-aggregates.md)
- [List roles (system presets + your custom roles)](/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md)
- [Get daily billing activity](/platform-api/billing/get-daily-billing-activity.md)


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