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



## OpenAPI

````yaml /api-reference/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: 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/forecast:
    get:
      tags:
        - Billing
      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.
      operationId: getV1OrganizationBillingForecast
      responses:
        '200':
          description: Forecast computed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model236'
        '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:
    Model236:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model235'
    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
    Model235:
      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/Model233'
    droppingOff:
      type: array
      description: Billed this month, no billable accounts left — no charge next month
      items:
        $ref: '#/components/schemas/Model234'
    Model233:
      type: object
      properties:
        userId:
          type: string
        email:
          type: string
        amount:
          type: number
          example: 7
    Model234:
      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. Format: "hp_live_{key}". Organization admins
        manage the key in the dashboard.

````

## Related topics

- [Get all-months billing aggregates](/platform-api/billing/get-all-months-billing-aggregates.md)
- [Get monthly billing summary](/platform-api/billing/get-monthly-billing-summary.md)
- [List billing cycles](/platform-api/billing/list-billing-cycles.md)
- [Get monthly firm P&L (revenue vs payouts vs platform costs)](/platform-api/analytics/get-monthly-firm-p&l-revenue-vs-payouts-vs-platform-costs.md)
- [List all billing events](/platform-api/billing/list-all-billing-events.md)


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