> ## 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 this month so far > The current billing month so far, not invoiced yet: trader-months per family (`unbilledUnits`), with an `estimate` at your agreed prices of the month-end invoice (minimums included) if the month ended now. Also what is unpaid on issued invoices (`outstandingCents`, `overdueCents`) and your credit balance. Billing months follow America/Chicago. Works without complete billing details. **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/usage 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/usage: get: tags: - Billing and invoices summary: Get this month so far description: >- The current billing month so far, not invoiced yet: trader-months per family (`unbilledUnits`), with an `estimate` at your agreed prices of the month-end invoice (minimums included) if the month ended now. Also what is unpaid on issued invoices (`outstandingCents`, `overdueCents`) and your credit balance. Billing months follow America/Chicago. Works without complete billing details. **Access:** read-only and full-access API keys. Dashboard members need view access to Billing & purchases revenue. operationId: getV1OrganizationBillingUsage responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Model446' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/Model11' '403': description: The credentials may not make this request content: application/json: schema: $ref: '#/components/schemas/OrganizationAccessError' '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/Model447' security: - X-API-Key: [] components: schemas: Model446: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/BillingUsageSummary' 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 OrganizationAccessError: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Your role does not have view access to "Billing & purchases revenue" code: $ref: '#/components/schemas/Model409' 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 Model447: 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 BillingUsageSummary: type: object properties: currency: $ref: '#/components/schemas/currency' billingMonth: type: string description: The billing month so far (first day of the month, America/Chicago) example: '2026-11-01' pattern: ^\d{4}-(0[1-9]|1[0-2])-01$ asOf: type: string example: '2026-11-02T13:00:00.000Z' x-format: isoDate: true unbilledUnits: $ref: '#/components/schemas/unbilledUnits' invoicedUnits: $ref: '#/components/schemas/invoicedUnits' hasAgreement: type: boolean description: An active pricing agreement covers this month example: true pricingStartsOn: type: string description: >- Without pricing for this month: the first later month an agreement prices (YYYY-MM-01), else null example: null estimate: $ref: '#/components/schemas/estimate' autoInvoice: type: boolean description: Invoices are issued automatically at the start of each month example: true nextInvoiceOn: type: string description: When the next month-end invoice is due to be issued example: '2026-12-01' outstandingCents: type: integer description: Unpaid on issued invoices example: 2860000 overdueCents: type: integer description: Unpaid on invoices past their due date example: 0 unpaidCount: type: integer description: Number of unpaid invoices example: 1 creditBalanceCents: type: integer description: Credit available for your next invoices example: 250000 Model409: 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 currency: type: string description: Invoice currency (lowercase ISO 4217) example: usd enum: - usd - eur unbilledUnits: type: object description: Trader-months of this month not on any invoice yet properties: cme: type: integer description: CME futures traders example: 1300 crypto: type: integer description: Crypto perpetuals traders example: 120 platform: type: integer description: Fixed monthly fees example: 1 invoicedUnits: type: object description: Trader-months of this month already on an interim invoice properties: cme: type: integer description: CME futures traders example: 1300 crypto: type: integer description: Crypto perpetuals traders example: 120 platform: type: integer description: Fixed monthly fees example: 1 estimate: type: object description: Null when no agreement prices this month properties: usageCents: type: integer description: The unbilled usage at your agreed prices example: 3120000 monthEndCents: type: integer description: The month-end invoice if the month ended now, minimums included example: 3420000 minimumApplies: type: boolean description: The month-end invoice would add a minimum top-up example: true minimums: $ref: '#/components/schemas/minimums' monthlyMinimum: $ref: '#/components/schemas/OrgBillingMonthlyMinimum' agreementVersion: type: integer example: 3 minimums: type: array description: Minimum traders per month, per price line items: $ref: '#/components/schemas/Model445' OrgBillingMonthlyMinimum: type: object description: >- The monthly minimum amount as it would apply if the month ended now; null without one properties: billingMonth: type: string example: '2026-11-01' pattern: ^\d{4}-(0[1-9]|1[0-2])-01$ minimumCents: type: integer description: The agreed monthly minimum example: 1000000 effectiveCents: type: integer description: The minimum for this month (prorated in the first month) example: 1000000 billedCents: type: integer description: >- What the month has billed so far, earlier invoices included, before manual lines, credits and tax example: 320000 previouslyBilledCents: type: integer description: Of billedCents, on earlier invoices for the month example: 0 topUpCents: type: integer description: >- Added on the month-end invoice: effectiveCents - billedCents, at least 0 example: 680000 prorated: type: boolean Model445: type: object properties: family: $ref: '#/components/schemas/family' units: type: integer example: 2000 family: type: string example: cme enum: - cme - crypto - platform 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 monthly billing summary](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-monthly-billing-summary.md) - [Project next month's bill from the current state](https://docs.hyperprop.com/platform-api/billing-and-invoices/project-next-months-bill-from-the-current-state.md) - [Get all-months billing aggregates](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-all-months-billing-aggregates.md) - [Get an invoice](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-an-invoice.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.