> ## 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) | | `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. | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics" \ -H "X-API-Key: hp_live_your_key_here" ``` **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/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: 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/risk/plan-economics: get: tags: - Analytics 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) | | `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. | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics" \ -H "X-API-Key: hp_live_your_key_here" ``` **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationRiskPlaneconomics responses: '200': description: Success — per-plan economics content: '*/*': schema: $ref: '#/components/schemas/Model286' '401': description: Unauthorized content: '*/*': schema: $ref: '#/components/schemas/Model287' '500': description: Internal error content: '*/*': schema: $ref: '#/components/schemas/Model288' security: - X-API-Key: [] components: schemas: Model286: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model285' Model287: 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 Model288: 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 Model285: type: object properties: organizationId: type: string example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 x-format: guid: true currency: type: string example: USD revenueBasis: type: string description: How revenue figures were derived plans: $ref: '#/components/schemas/Model284' Model284: type: array description: One row per trading plan, highest estimated revenue first items: $ref: '#/components/schemas/Model283' Model283: 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/Model282' 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' Model282: 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. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get a specific trading plan](/platform-api/trading-plans/get-a-specific-trading-plan.md) - [Create a new trading rule](/platform-api/trading-rules/create-a-new-trading-rule.md) - [Update a trading rule](/platform-api/trading-rules/update-a-trading-rule.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) - [Introduction](/introduction.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.