> ## 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 trading plans for your organization

> Retrieve all trading plans configured for your organization.

**What is a trading plan?**
A trading plan defines the product you sell to traders. It includes the account size, price, duration, and which trading rules apply. Think of it as your "evaluation challenge" or "funded account" offering.

**What you get for each plan:**
- Plan details (name, description, price, currency)
- Account size and evaluation duration
- Default trading rules (profit target, max loss, drawdown limits)
- Active/inactive status
- Custom metadata (any JSON data you need)

**Example plans:**
- "50K Challenge" - $299, 30 days, $50,000 account
- "100K Challenge" - $499, 30 days, $100,000 account
- "200K Pro" - $999, 45 days, $200,000 account

**Filtering by metadata:**
Filter plans by any key:value in your metadata:
```http
# Find plans for beginners
GET /organization/trading-plans?metadata=targetAudience:beginner

# Find promotional plans
GET /organization/trading-plans?metadata=promo:true

# Find plans by internal code
GET /organization/trading-plans?metadata=internalCode:PLAN-100K
```
Supports strings, numbers, and booleans. Uses fast GIN index.

**Filtering archived plans:**
By default all plans are returned, including archived ones (`isActive: false`). For plan pickers and storefronts, request only live plans:
```http
GET /organization/trading-plans?isActive=true
```

**Use cases:**
- Display available plans on your website
- Validate plan IDs before creating accounts
- Check which rules are attached to each plan
- Audit your product offerings



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/trading-plans
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/trading-plans:
    get:
      tags:
        - Trading plans
      summary: Get trading plans for your organization
      description: >-
        Retrieve all trading plans configured for your organization.


        **What is a trading plan?**

        A trading plan defines the product you sell to traders. It includes the
        account size, price, duration, and which trading rules apply. Think of
        it as your "evaluation challenge" or "funded account" offering.


        **What you get for each plan:**

        - Plan details (name, description, price, currency)

        - Account size and evaluation duration

        - Default trading rules (profit target, max loss, drawdown limits)

        - Active/inactive status

        - Custom metadata (any JSON data you need)


        **Example plans:**

        - "50K Challenge" - $299, 30 days, $50,000 account

        - "100K Challenge" - $499, 30 days, $100,000 account

        - "200K Pro" - $999, 45 days, $200,000 account


        **Filtering by metadata:**

        Filter plans by any key:value in your metadata:

        ```http

        # Find plans for beginners

        GET /organization/trading-plans?metadata=targetAudience:beginner


        # Find promotional plans

        GET /organization/trading-plans?metadata=promo:true


        # Find plans by internal code

        GET /organization/trading-plans?metadata=internalCode:PLAN-100K

        ```

        Supports strings, numbers, and booleans. Uses fast GIN index.


        **Filtering archived plans:**

        By default all plans are returned, including archived ones (`isActive:
        false`). For plan pickers and storefronts, request only live plans:

        ```http

        GET /organization/trading-plans?isActive=true

        ```


        **Use cases:**

        - Display available plans on your website

        - Validate plan IDs before creating accounts

        - Check which rules are attached to each plan

        - Audit your product offerings
      operationId: getV1OrganizationTradingplans
      parameters:
        - description: Filter by metadata key:value (e.g., "priority:high", "active:true")
          name: metadata
          in: query
          required: false
          schema:
            type: string
        - description: >-
            Filter by active status. Use isActive=true to exclude archived
            plans, isActive=false for archived only. Omit to get all plans.
          name: isActive
          in: query
          required: false
          schema:
            type: boolean
        - description: 'Results per page (default: 50, max: 100)'
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - description: Pagination offset
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
        - description: >-
            Cursor for pagination. Pass the `nextCursor` value from the previous
            response to get the next page. When using cursor, do not send
            `offset` — it will be ignored.


            **How it works:** The cursor is an opaque string that points to the
            last item you received. The server uses it to efficiently fetch the
            next set of results without scanning previous pages.


            **Backwards compatible:** If you don't send a cursor, offset/limit
            pagination works as before.
          name: cursor
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success - Returns all trading plans
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model147'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model148'
        '403':
          description: Forbidden - Your account is not associated with an organization
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model149'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model147:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model146'
    Model148:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Invalid or expired session
    Model149:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: This endpoint is only available for organization users
        code:
          type: string
          example: NOT_ORGANIZATION_USER
    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
    Model146:
      type: object
      example:
        organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34
        organizationName: FakePropFirm
        plans:
          - id: 09c93da5-f057-4cc5-82da-ff9220292c94
            name: 50K Challenge
            description: >-
              Our most popular evaluation. Standard risk rules with a solid
              balance of target and protection.
            price: 299
            currency: USD
            durationDays: 30
            accountSize: 50000
            isActive: true
            metadata:
              targetAudience: beginner
              internalCode: PLAN-50K-V2
            tradingRule:
              id: 6bec94a1-425b-47be-bb41-a80e3140e2e7
              name: Standard Rules
              profitTarget: 4000
              dailyLoss: 1000
              maxLoss: 2500
              maxDrawdown: 5
              drawdownType: static
            createdAt: '2025-12-30T12:28:04.204Z'
            updatedAt: '2025-12-30T12:28:04.204Z'
          - id: d838c81a-b343-4984-aba2-f8ced8877192
            name: 100K Pro
            description: For experienced traders ready for a bigger challenge.
            price: 499
            currency: USD
            durationDays: 45
            accountSize: 100000
            isActive: true
            metadata:
              targetAudience: experienced
              internalCode: PLAN-100K-V1
            tradingRule:
              id: 6cf3821e-0ad4-427f-85a5-c3d498aa342e
              name: Aggressive Rules
              profitTarget: 10000
              dailyLoss: 3000
              maxLoss: 6000
              maxDrawdown: 6
              drawdownType: trailing
            createdAt: '2026-02-18T21:19:57.328Z'
            updatedAt: '2026-02-18T21:19:57.328Z'
        pagination:
          total: 5
          limit: 50
          offset: 0
          hasMore: false
      properties:
        organizationId:
          type: string
          description: Your organization ID
        organizationName:
          type: string
          description: Your organization name
        plans:
          $ref: '#/components/schemas/plans'
        pagination:
          $ref: '#/components/schemas/Model145'
    plans:
      type: array
      description: Array of trading plans
      items:
        $ref: '#/components/schemas/Model144'
    Model145:
      type: object
      description: Pagination info
      properties:
        total:
          type: number
          description: Total number of plans
        limit:
          type: number
          description: Results per page
        offset:
          type: number
          description: Current offset
        hasMore:
          type: boolean
          description: Whether more results exist
        nextCursor:
          type: string
          description: >-
            Cursor for the next page. Pass as ?cursor= to get the next set of
            results. Null if no more results.
    Model144:
      type: object
      properties:
        id:
          type: string
          description: Unique plan ID (use this when creating accounts)
        name:
          type: string
          description: Plan display name
        description:
          type: string
          description: Plan description for marketing
        price:
          type: number
          description: Plan price
        currency:
          type: string
          description: Price currency
        durationDays:
          type: number
          description: Evaluation period in days (null = unlimited)
        accountSize:
          type: number
          description: Starting account balance
        isActive:
          type: boolean
          description: Whether this plan can be purchased
        metadata:
          $ref: '#/components/schemas/Model142'
        tradingRule:
          $ref: '#/components/schemas/Model143'
        createdAt:
          type: string
        updatedAt:
          type: string
    Model142:
      type: object
      description: Custom metadata
    Model143:
      type: object
      description: Default trading rules for this plan
      properties:
        id:
          type: string
        name:
          type: string
        profitTarget:
          type: number
          description: Profit needed to pass ($)
        dailyLoss:
          type: number
          description: Max daily loss limit ($)
        maxLoss:
          type: number
          description: Max total loss limit ($)
        maxDrawdown:
          type: number
          description: Max drawdown (%)
  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)
- [Get trading accounts for your organization](/platform-api/trading-accounts/get-trading-accounts-for-your-organization.md)
- [Get purchases for your organization](/platform-api/purchases/get-purchases-for-your-organization.md)
- [Get trading rules for your organization](/platform-api/trading-rules/get-trading-rules-for-your-organization.md)
- [Quickstart](/quickstart.md)


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