> ## 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. **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. ## OpenAPI ````yaml https://api.hyperprop.com/platform/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: Instruments description: >- The contracts your organization's accounts can trade, with their specifications. - 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: Mass credit description: >- Credit back losses across many accounts after an incident, as background jobs you can follow, pause, export and reverse. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history, to replay or audit what happened. - name: Real-time streams description: >- Live events and trading data over a WebSocket, for dashboards and CRMs that update as things happen. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance, revenue and top traders. - name: Risk description: Firm profit and loss and plan economics. - name: Billing and invoices description: >- Your Hyperprop invoices, credits and billing details, with usage so far this month, billing cycles, forecasts and CSV exports. - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: >- Manage your organization's API keys: rotation, read-only keys and IP allowlists. - name: Logs and health description: >- API request logs, the audit log, integration health, and idempotency key recovery. - 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 and invoices 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. **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. 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 - description: >- 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. name: cursor in: query required: false example: ZXhhbXBsZS1jdXJzb3ItNi1vcGFxdWUtZG8tbm90LXBhcnNl schema: type: string maxLength: 512 responses: '200': description: Billing cycles retrieved content: application/json: schema: $ref: '#/components/schemas/Model413' '400': description: >- The request does not match the documented parameters or body; `message` names the field content: application/json: schema: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: integer example: 400 error: type: string example: Bad Request message: type: string example: '"limit" must be less than or equal to 100' code: type: string enum: - VALIDATION_ERROR example: VALIDATION_ERROR description: >- Machine-readable error code — switch on this, not on message text '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/Model11' '403': description: The API key may not make this request content: application/json: schema: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: integer example: 403 error: type: string example: Forbidden message: type: string example: >- Your role does not have view access to "Traders & accounts" code: type: string description: >- `INSUFFICIENT_PERMISSIONS` = the role or key lacks the permission this endpoint needs; `READ_ONLY_KEY` = a read-only API key sent a request that changes data; `IP_NOT_ALLOWED` = the request came from an address outside the key's IP allowlist; `ORG_INACTIVE` = the organization is not active example: INSUFFICIENT_PERMISSIONS enum: - INSUFFICIENT_PERMISSIONS - READ_ONLY_KEY - IP_NOT_ALLOWED - ORG_INACTIVE '500': description: An unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/Model6' '504': description: >- Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range). content: application/json: schema: $ref: '#/components/schemas/Model414' security: - X-API-Key: [] components: schemas: Model413: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model412' Model11: 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 Model6: 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 Model414: type: object properties: statusCode: type: number example: 504 error: type: string example: Gateway Timeout message: type: string example: >- The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range). code: type: string description: Machine-readable error code — switch on this, not on message text example: REQUEST_TIMEOUT Model412: type: object 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 properties: organizationId: type: string organizationName: type: string cycles: $ref: '#/components/schemas/cycles' pagination: $ref: '#/components/schemas/Model411' cycles: type: array items: type: string Model411: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean nextCursor: type: string securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- 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**. ```` ## Related topics - [List all billing events](https://docs.hyperprop.com/platform-api/billing-and-invoices/list-all-billing-events.md) - [Get events for a billing cycle](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-events-for-a-billing-cycle.md) - [Billing and invoices](https://docs.hyperprop.com/guides/billing-and-invoices.md) - [Get all-months billing aggregates](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-all-months-billing-aggregates.md) - [Get daily billing activity](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-daily-billing-activity.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.