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

# Project next month's bill from the current state

> Projects the NEXT calendar month's bill from today's account state and your current rate card. Under the calendar-month model this is simple — every trader lands in exactly one bucket:

- `expectedCharges` — traders holding at least one billable in_progress account today. Each gets one full-month charge (platform fee + CME bundle) next month, billed automatically at the start of the month. `projectedTotal` is their count × your current rate.
- `droppingOff` — traders billed this month who no longer hold any billable account. No charge next month.

SIM-BOT load-test accounts and crypto-only accounts never bill and are excluded.
Month boundaries follow CME's clock (America/Chicago), matching the billing ledger and CME's own subscriber month.

**Notes:** the projection uses TODAY's rate card and TODAY's account state. Fail or delete a trader's accounts and re-query — they move from `expectedCharges` to `droppingOff` immediately, and the projected total drops by one trader-month. Traders who join mid-month are charged for that month at account creation, so the real bill can end up slightly higher than this projection.

**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/forecast
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/forecast:
    get:
      tags:
        - Billing and invoices
      summary: Project next month's bill from the current state
      description: >-
        Projects the NEXT calendar month's bill from today's account state and
        your current rate card. Under the calendar-month model this is simple —
        every trader lands in exactly one bucket:


        - `expectedCharges` — traders holding at least one billable in_progress
        account today. Each gets one full-month charge (platform fee + CME
        bundle) next month, billed automatically at the start of the month.
        `projectedTotal` is their count × your current rate.

        - `droppingOff` — traders billed this month who no longer hold any
        billable account. No charge next month.


        SIM-BOT load-test accounts and crypto-only accounts never bill and are
        excluded.

        Month boundaries follow CME's clock (America/Chicago), matching the
        billing ledger and CME's own subscriber month.


        **Notes:** the projection uses TODAY's rate card and TODAY's account
        state. Fail or delete a trader's accounts and re-query — they move from
        `expectedCharges` to `droppingOff` immediately, and the projected total
        drops by one trader-month. Traders who join mid-month are charged for
        that month at account creation, so the real bill can end up slightly
        higher than this projection.


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Billing & purchases revenue.
      operationId: getV1OrganizationBillingForecast
      responses:
        '200':
          description: Forecast computed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model427'
        '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/Model428'
      security:
        - X-API-Key: []
components:
  schemas:
    Model427:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model426'
    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
    Model428:
      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
    Model426:
      type: object
      properties:
        organizationId:
          type: string
        month:
          type: string
          description: The projected month
          example: 2026-08
        pricing:
          $ref: '#/components/schemas/pricing'
        expectedCharges:
          $ref: '#/components/schemas/expectedCharges'
        droppingOff:
          $ref: '#/components/schemas/droppingOff'
        projectedTotal:
          type: number
          example: 161
        currency:
          type: string
          example: USD
    pricing:
      type: object
      description: Current rate card used for every projected amount
    expectedCharges:
      type: array
      description: One full-month charge per trader holding billable accounts
      items:
        $ref: '#/components/schemas/Model424'
    droppingOff:
      type: array
      description: Billed this month, no billable accounts left — no charge next month
      items:
        $ref: '#/components/schemas/Model425'
    Model424:
      type: object
      properties:
        userId:
          type: string
        email:
          type: string
        amount:
          type: number
          example: 7
    Model425:
      type: object
      properties:
        userId:
          type: string
        email:
          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

- [Billing and invoices](https://docs.hyperprop.com/guides/billing-and-invoices.md)
- [List billing cycles](https://docs.hyperprop.com/platform-api/billing-and-invoices/list-billing-cycles.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 billing summary](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-monthly-billing-summary.md)


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