> ## 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 plan performance by purchase month

> Which plans and which months' buyers make money. Accounts are grouped by the month they were created and by plan, with their revenue, outcomes, the payouts executed on them to date and the traders' net profit and loss.

## Key fields
| Field | Description |
|-------|-------------|
| `revenue` | The price you recorded on the purchase, else the plan's list price; never a list price for funded accounts |
| `payouts` / `net` / `payoutRatioPct` | Payouts on these accounts to date, revenue − payouts, and payouts ÷ revenue |
| `outcomes` / `passRatePct` | Where the accounts stand now |
| `traderPnl` | Net profit and loss of the closed trades on these accounts (from `pnlCoveredFrom`) |

`months` lists each month with its plans; `plans` sums every month per plan; `totals` sums everything. Test accounts are excluded. Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old.

## Example

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/cohorts?months=6" \
  -H "X-API-Key: hp_live_your_key_here"
```

**Permissions:** requires **view** access to "Analytics".

**Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/cohorts
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: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - 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/risk/cohorts:
    get:
      tags:
        - Risk
      summary: Get plan performance by purchase month
      description: >-
        Which plans and which months' buyers make money. Accounts are grouped by
        the month they were created and by plan, with their revenue, outcomes,
        the payouts executed on them to date and the traders' net profit and
        loss.


        ## Key fields

        | Field | Description |

        |-------|-------------|

        | `revenue` | The price you recorded on the purchase, else the plan's
        list price; never a list price for funded accounts |

        | `payouts` / `net` / `payoutRatioPct` | Payouts on these accounts to
        date, revenue − payouts, and payouts ÷ revenue |

        | `outcomes` / `passRatePct` | Where the accounts stand now |

        | `traderPnl` | Net profit and loss of the closed trades on these
        accounts (from `pnlCoveredFrom`) |


        `months` lists each month with its plans; `plans` sums every month per
        plan; `totals` sums everything. Test accounts are excluded. Results are
        recomputed at most every 15 minutes, so they can be up to 30 minutes
        old.


        ## Example


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/cohorts?months=6"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```


        **Permissions:** requires **view** access to "Analytics".


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Analytics & audit log.
      operationId: getV1OrganizationRiskCohorts
      parameters:
        - description: Months to include, this month counted. Default 12, at most 24.
          name: months
          in: query
          example: 12
          schema:
            type: integer
            minimum: 1
            maximum: 24
            default: 12
        - name: If-None-Match
          in: header
          required: false
          description: >-
            Optional. The `ETag` of the answer you already have. When the answer
            would be the same, the response is `304` without a body.
          example: '"Hq3mB1c0s8n2JkVbQy4Tz9uXw5E"'
          schema:
            type: string
      responses:
        '200':
          description: Plan performance by month
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model606'
        '304':
          description: >-
            Not modified: the answer is the same as the one whose `ETag` you
            sent in `If-None-Match`. No body; keep using the answer you have.
        '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/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '429':
          description: >-
            Too many requests: this endpoint allows 60 calls per minute per
            organization. Wait the number of seconds in the `Retry-After`
            header. Also returned while your organization already has 6 reports
            being computed at once; wait the `Retry-After` seconds.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 429
                  error:
                    type: string
                    example: Too Many Requests
                  message:
                    type: string
                    example: >-
                      Too many requests to this endpoint. Try again in 12
                      second(s).
                  code:
                    type: string
                    enum:
                      - RATE_LIMITED
                    example: RATE_LIMITED
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '500':
          description: Failed to build the cohort report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model607'
        '503':
          description: >-
            `FEATURE_NOT_READY`: the report is not available yet.
            `REPORT_TIMEOUT`: try again in a few minutes. The report took too
            long right now (`REPORT_TIMEOUT`). Wait the seconds in the
            `Retry-After` header (also `retryAfterSeconds` in the body) before
            asking again; the wait grows while the report keeps running out of
            time.
        '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/Model608'
      security:
        - X-API-Key: []
components:
  schemas:
    Model606:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model605'
    Model15:
      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
    Model511:
      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: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model607:
      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: Failed to build the cohort report
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: COHORTS_ERROR
    Model608:
      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
    Model605:
      type: object
      properties:
        organizationId:
          type: string
          example: 55555555-5555-4555-8555-555555555555
          x-format:
            guid: true
        generatedAt:
          type: string
          example: '2026-11-14T08:00:00.000Z'
          x-format:
            isoDate: true
        currency:
          type: string
          example: USD
        fromMonth:
          type: string
          description: First month included
          example: 2025-12
        pnlCoveredFrom:
          type: string
          description: Trader profit and loss counts trades from this trading day on
          example: '2026-08-14'
        months:
          $ref: '#/components/schemas/Model603'
        plans:
          $ref: '#/components/schemas/Model604'
        totals:
          $ref: '#/components/schemas/totals'
    Model603:
      type: array
      description: Newest month first
      items:
        $ref: '#/components/schemas/Model602'
    Model604:
      type: array
      description: Every month together, by plan
      items:
        $ref: '#/components/schemas/Model600'
    totals:
      type: object
      properties:
        accounts:
          type: integer
          description: Accounts created (test accounts excluded)
          example: 1306
        revenue:
          type: number
          description: >-
            Price you recorded, else the plan's list price; never a list price
            for funded accounts
          example: 651694
        payouts:
          type: number
          description: Payouts executed on these accounts, to date
          example: 12400
        net:
          type: number
          description: revenue − payouts
          example: 639294
        netPerAccount:
          type: number
          example: 489.5
        payoutRatioPct:
          type: number
          description: payouts ÷ revenue × 100
          example: 1.9
        outcomes:
          $ref: '#/components/schemas/Model599'
        passRatePct:
          type: number
          description: passed ÷ (passed + failed) × 100
          example: 5.45
        funded:
          type: integer
          description: Funded accounts among them
          example: 41
        payoutCount:
          type: integer
          example: 9
        accountsWithPayouts:
          type: integer
          example: 4
        traderPnl:
          type: number
          description: Traders' net profit and loss on these accounts, from closed trades
          example: -372928.4
        trades:
          type: integer
          example: 18220
        accountsTraded:
          type: integer
          example: 1188
    Model602:
      type: object
      properties:
        month:
          type: string
          description: Month the accounts were created (UTC)
          example: 2026-10
        accounts:
          type: integer
          description: Accounts created (test accounts excluded)
          example: 1306
        revenue:
          type: number
          description: >-
            Price you recorded, else the plan's list price; never a list price
            for funded accounts
          example: 651694
        payouts:
          type: number
          description: Payouts executed on these accounts, to date
          example: 12400
        net:
          type: number
          description: revenue − payouts
          example: 639294
        netPerAccount:
          type: number
          example: 489.5
        payoutRatioPct:
          type: number
          description: payouts ÷ revenue × 100
          example: 1.9
        outcomes:
          $ref: '#/components/schemas/Model599'
        passRatePct:
          type: number
          description: passed ÷ (passed + failed) × 100
          example: 5.45
        funded:
          type: integer
          description: Funded accounts among them
          example: 41
        payoutCount:
          type: integer
          example: 9
        accountsWithPayouts:
          type: integer
          example: 4
        traderPnl:
          type: number
          description: Traders' net profit and loss on these accounts, from closed trades
          example: -372928.4
        trades:
          type: integer
          example: 18220
        accountsTraded:
          type: integer
          example: 1188
        plans:
          $ref: '#/components/schemas/Model601'
    Model600:
      type: object
      properties:
        planId:
          type: string
          example: 7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6
          x-format:
            guid: true
        planName:
          type: string
          example: 100K Pro
        accounts:
          type: integer
          description: Accounts created (test accounts excluded)
          example: 1306
        revenue:
          type: number
          description: >-
            Price you recorded, else the plan's list price; never a list price
            for funded accounts
          example: 651694
        payouts:
          type: number
          description: Payouts executed on these accounts, to date
          example: 12400
        net:
          type: number
          description: revenue − payouts
          example: 639294
        netPerAccount:
          type: number
          example: 489.5
        payoutRatioPct:
          type: number
          description: payouts ÷ revenue × 100
          example: 1.9
        outcomes:
          $ref: '#/components/schemas/Model599'
        passRatePct:
          type: number
          description: passed ÷ (passed + failed) × 100
          example: 5.45
        funded:
          type: integer
          description: Funded accounts among them
          example: 41
        payoutCount:
          type: integer
          example: 9
        accountsWithPayouts:
          type: integer
          example: 4
        traderPnl:
          type: number
          description: Traders' net profit and loss on these accounts, from closed trades
          example: -372928.4
        trades:
          type: integer
          example: 18220
        accountsTraded:
          type: integer
          example: 1188
    Model599:
      type: object
      properties:
        inProgress:
          type: integer
          example: 1240
        passed:
          type: integer
          example: 3
        failed:
          type: integer
          example: 52
        expired:
          type: integer
          example: 5
    Model601:
      type: array
      description: This month by plan, highest revenue first
      items:
        $ref: '#/components/schemas/Model600'
  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

- [Get a specific purchase](https://docs.hyperprop.com/platform-api/purchases/get-a-specific-purchase.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)
- [Get organization analytics](https://docs.hyperprop.com/platform-api/analytics/get-organization-analytics.md)
- [Get purchases for your organization](https://docs.hyperprop.com/platform-api/purchases/get-purchases-for-your-organization.md)
- [Get this month so far](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-this-month-so-far.md)


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