> ## 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 monthly billing summary > Returns the billing summary for a specific month — total amount owed, number of billable users, one bounded page of charge line items, and your organization's current rate card. **How billing works (calendar-month model, since August 2026):** - Each billable trader is charged once per CALENDAR MONTH: platform fee + CME Group market data bundle, full month, no proration — mirroring how CME licenses market data - Month boundaries follow CME's clock — **America/Chicago**. "July" runs from Jul 1 00:00 CT to Aug 1 00:00 CT (DST handled automatically), so the billing ledger always matches CME's own subscriber month - The month is charged at the trader's first billing trigger inside it (account creation) or automatically at the start of the month while they hold at least one active account - A trader who starts on Jul 30 and is still active in August pays for July AND for August — two charges days apart is expected - No active accounts in a month → no charge for that month - The price is locked when each charge is created; rate changes only affect future months - `totalAmount` is the exact sum of all charges for the month - `platformAmount` / `marketDataAmount` split that total into the Hyperprop platform fee and the CME Group market data bundle (`platformAmount + marketDataAmount = totalAmount`); each line item carries the same split as `platformPrice` / `marketDataPrice` - Totals are aggregated server-side; `cycles` is paginated with `limit`/`offset`, so the endpoint remains bounded for organizations with 100K+ users - Months before August 2026 were billed as rolling 30-day cycles (the old model); those rows count toward the month they STARTED in **The `pricing` object (current rate card):** - `platformPricePerUser` — the Hyperprop platform fee per billable trader per month - `cmeGroupBundlePrice` — the CME Group market data bundle (CME, CBOT, NYMEX, COMEX — always billed as one bundle) per month - `totalPerBillableUser` — what each trader-month costs (`platformPricePerUser + cmeGroupBundlePrice`) - `billingPeriod` — always `calendar_month` - This reflects the rate applied to new monthly charges only; historical charges always keep the price they locked in **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/summary 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/summary: get: tags: - Billing and invoices summary: Get monthly billing summary description: >- Returns the billing summary for a specific month — total amount owed, number of billable users, one bounded page of charge line items, and your organization's current rate card. **How billing works (calendar-month model, since August 2026):** - Each billable trader is charged once per CALENDAR MONTH: platform fee + CME Group market data bundle, full month, no proration — mirroring how CME licenses market data - Month boundaries follow CME's clock — **America/Chicago**. "July" runs from Jul 1 00:00 CT to Aug 1 00:00 CT (DST handled automatically), so the billing ledger always matches CME's own subscriber month - The month is charged at the trader's first billing trigger inside it (account creation) or automatically at the start of the month while they hold at least one active account - A trader who starts on Jul 30 and is still active in August pays for July AND for August — two charges days apart is expected - No active accounts in a month → no charge for that month - The price is locked when each charge is created; rate changes only affect future months - `totalAmount` is the exact sum of all charges for the month - `platformAmount` / `marketDataAmount` split that total into the Hyperprop platform fee and the CME Group market data bundle (`platformAmount + marketDataAmount = totalAmount`); each line item carries the same split as `platformPrice` / `marketDataPrice` - Totals are aggregated server-side; `cycles` is paginated with `limit`/`offset`, so the endpoint remains bounded for organizations with 100K+ users - Months before August 2026 were billed as rolling 30-day cycles (the old model); those rows count toward the month they STARTED in **The `pricing` object (current rate card):** - `platformPricePerUser` — the Hyperprop platform fee per billable trader per month - `cmeGroupBundlePrice` — the CME Group market data bundle (CME, CBOT, NYMEX, COMEX — always billed as one bundle) per month - `totalPerBillableUser` — what each trader-month costs (`platformPricePerUser + cmeGroupBundlePrice`) - `billingPeriod` — always `calendar_month` - This reflects the rate applied to new monthly charges only; historical charges always keep the price they locked in **Access:** read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue. operationId: getV1OrganizationBillingSummary parameters: - description: Month to query (YYYY-MM). Defaults to current month. name: month in: query required: false example: 2026-03 schema: type: string pattern: ^\d{4}-\d{2}$ - description: Cycle line items per page name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Cycle line-item pagination offset name: offset in: query schema: type: integer minimum: 0 default: 0 responses: '200': description: Billing summary retrieved content: application/json: schema: $ref: '#/components/schemas/Model443' '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/Model444' security: - X-API-Key: [] components: schemas: Model443: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model442' 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 Model444: 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 Model442: type: object example: organizationId: 55555555-5555-4555-8555-555555555555 organizationName: FakePropFirm pricing: platformPricePerUser: 0.25 cmeGroupBundlePrice: 6.75 totalPerBillableUser: 7 billingPeriod: calendar_month currency: USD month: 2026-03 billableUsers: 50 totalAmount: 850 platformAmount: 700 marketDataAmount: 150 currency: USD cycles: - userId: user-1 userEmail: trader1@example.com price: 17 platformPrice: 14 marketDataPrice: 3 triggerType: account_created startedAt: '2026-03-01T10:00:00.000Z' - userId: user-2 userEmail: trader2@example.com price: 17 platformPrice: 14 marketDataPrice: 3 triggerType: auto_renewal startedAt: '2026-03-15T10:00:00.000Z' pagination: total: 50 limit: 50 offset: 0 hasMore: false properties: organizationId: type: string organizationName: type: string pricing: $ref: '#/components/schemas/Model440' month: type: string billableUsers: type: number totalAmount: type: number platformAmount: type: number description: Hyperprop platform fee portion of totalAmount marketDataAmount: type: number description: CME Group market data bundle portion of totalAmount currency: type: string cycles: $ref: '#/components/schemas/cycles' pagination: $ref: '#/components/schemas/Model441' Model440: type: object description: >- Current rate card — applies to new monthly charges; historical charges keep their locked-in price properties: platformPricePerUser: type: number cmeGroupBundlePrice: type: number totalPerBillableUser: type: number billingPeriod: $ref: '#/components/schemas/billingPeriod' currency: type: string cycles: type: array items: type: string Model441: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean billingPeriod: type: string enum: - calendar_month 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 - [Billing and invoices](https://docs.hyperprop.com/guides/billing-and-invoices.md) - [Get this month so far](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-this-month-so-far.md) - [Get all-months billing aggregates](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-all-months-billing-aggregates.md) - [Get monthly firm P&L (revenue vs payouts vs platform costs)](https://docs.hyperprop.com/platform-api/risk/get-monthly-firm-p&l-revenue-vs-payouts-vs-platform-costs.md) - [Export a month's line items as CSV](https://docs.hyperprop.com/platform-api/billing-and-invoices/export-a-months-line-items-as-csv.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.