> ## 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 per-plan unit economics and sustainability flags > Which of your trading plans make money and which are risks. One row per plan with sales, outcomes, attributable payouts, and a sustainability flag. ## Key fields | Field | Description | |-------|-------------| | `unitsSold` / `revenueEstimated` | Paid purchases and their revenue (plan list price substituted when `price_paid` wasn't recorded, except for funded accounts) | | `accounts` / `passRatePct` | Outcomes of accounts bought under the plan (SIM-BOT test accounts excluded) | | `payoutsTotal` / `payoutRatioPct` | Executed payouts attributable to the plan | | `netRevenue` / `netPerUnit` | Revenue minus payouts, total and per unit sold — the expected value of one more sale | | `sustainability` | `red`: payout ratio ≥60% or pass rate ≥40% (rules too easy). `amber`: payout ratio ≥40% or pass rate <5% (traders churn and stop re-buying). `green` otherwise. `insufficient_data` under 20 completed accounts. | Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old. ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics" \ -H "X-API-Key: hp_live_your_key_here" ``` **Permissions:** requires **view** access to "Analytics". **Authentication:** send your organization API key in the `X-API-Key` header. **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/plan-economics 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/risk/plan-economics: get: tags: - Risk summary: Get per-plan unit economics and sustainability flags description: >- Which of your trading plans make money and which are risks. One row per plan with sales, outcomes, attributable payouts, and a sustainability flag. ## Key fields | Field | Description | |-------|-------------| | `unitsSold` / `revenueEstimated` | Paid purchases and their revenue (plan list price substituted when `price_paid` wasn't recorded, except for funded accounts) | | `accounts` / `passRatePct` | Outcomes of accounts bought under the plan (SIM-BOT test accounts excluded) | | `payoutsTotal` / `payoutRatioPct` | Executed payouts attributable to the plan | | `netRevenue` / `netPerUnit` | Revenue minus payouts, total and per unit sold — the expected value of one more sale | | `sustainability` | `red`: payout ratio ≥60% or pass rate ≥40% (rules too easy). `amber`: payout ratio ≥40% or pass rate <5% (traders churn and stop re-buying). `green` otherwise. `insufficient_data` under 20 completed accounts. | Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old. ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics" \ -H "X-API-Key: hp_live_your_key_here" ``` **Permissions:** requires **view** access to "Analytics". **Authentication:** send your organization API key in the `X-API-Key` header. **Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log. operationId: getV1OrganizationRiskPlaneconomics responses: '200': description: Success — per-plan economics content: application/json: schema: $ref: '#/components/schemas/Model518' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Model519' '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/Model74' '429': description: >- Too many requests: this endpoint allows 60 calls per minute per organization. Wait the number of seconds in the `Retry-After` header. 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: Internal error content: application/json: schema: $ref: '#/components/schemas/Model520' '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/Model521' security: - X-API-Key: [] components: schemas: Model518: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model517' Model519: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired token code: type: string example: UNAUTHORIZED Model74: 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: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model520: type: object properties: statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: Failed to fetch firm P&L code: type: string example: RISK_ERROR Model521: 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 Model517: type: object properties: organizationId: type: string example: 55555555-5555-4555-8555-555555555555 x-format: guid: true currency: type: string example: USD revenueBasis: type: string description: How revenue figures were derived plans: $ref: '#/components/schemas/Model516' Model516: type: array description: One row per trading plan, highest estimated revenue first items: $ref: '#/components/schemas/Model515' Model515: type: object properties: planId: type: string example: 7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6 x-format: guid: true planName: type: string example: 100K Pro planPrice: type: number description: Current list price example: 499 accountSize: type: number example: 100000 planIsActive: type: boolean example: true unitsSold: type: integer description: Paid purchases of this plan example: 1306 revenueRecorded: type: number example: 0 revenueEstimated: type: number example: 651694 refundedCount: type: integer example: 12 refundedAmount: type: number example: 5988 accounts: $ref: '#/components/schemas/Model514' passRatePct: type: number description: passed / (passed + failed) × 100. Null with no completed accounts. example: 5.45 payoutsTotal: type: number description: Executed payouts on accounts bought under this plan example: 12400 payoutCount: type: integer example: 9 accountsWithPayouts: type: integer example: 4 payoutRatioPct: type: number description: payoutsTotal / revenueEstimated × 100 example: 1.9 netRevenue: type: number description: revenueEstimated − payoutsTotal example: 639294 netPerUnit: type: number description: Expected value of selling one more unit of this plan example: 489.5 avgDaysToOutcome: type: number description: Average days from start to pass/fail example: 6.2 sustainability: $ref: '#/components/schemas/sustainability' Model514: type: object description: Account outcomes for this plan. SIM-BOT test accounts excluded. properties: total: type: integer example: 1300 inProgress: type: integer example: 1240 passed: type: integer example: 3 failed: type: integer example: 52 expired: type: integer example: 5 notStarted: type: integer example: 0 sustainability: type: string description: >- red: payout ratio ≥60% or pass rate ≥40% (rules too easy). amber: payout ratio ≥40% or pass rate <5% (churn risk). Requires ≥20 completed accounts, otherwise insufficient_data. example: green enum: - green - amber - red - insufficient_data 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 trading plan](https://docs.hyperprop.com/platform-api/trading-plans/get-a-specific-trading-plan.md) - [Get revenue breakdown](https://docs.hyperprop.com/platform-api/analytics/get-revenue-breakdown.md) - [Introduction](https://docs.hyperprop.com/introduction.md) - [Update a trading rule](https://docs.hyperprop.com/platform-api/trading-rules/update-a-trading-rule.md) - [Create a new trading rule](https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.