Organization

Create a new trading plan

Create a new trading plan for your organization. Admin only.

Required fields:

Field	Description
`name`	Plan name (unique within org)
`price`	Plan price
`accountSize`	Account size in $
`tradingRuleId`	ID of the trading rule to use

Optional fields:

Field	Default	Description
`description`	null	Plan description
`currency`	”USD”	Currency code
`durationDays`	null	Duration in days (null = unlimited)
`isActive`	true	Whether plan is active for purchase
`metadata`	Custom organization data

Example:

curl -X POST "https://api.example.com/platform/v1/organization/trading-plans" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "100K Evaluation",
    "description": "Our flagship 100K evaluation challenge",
    "price": 299,
    "accountSize": 100000,
    "tradingRuleId": "660e8400-e29b-41d4-a716-446655440000",
    "durationDays": 30,
    "metadata": { "featured": true }
  }'

Error Codes:

Code	Description
`PLAN_NAME_EXISTS`	A plan with this name already exists
`RULE_NOT_FOUND`	Trading rule ID not found
`RULE_NOT_IN_ORG`	Trading rule belongs to different org
`ADMIN_REQUIRED`	Only admins can create plans

POST

organization

trading-plans

Create a new trading plan

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "100K Evaluation",
  "accountSize": 100000,
  "tradingRuleId": "660e8400-e29b-41d4-a716-446655440000",
  "description": "Our flagship 100K evaluation challenge",
  "price": 299,
  "currency": "USD",
  "durationDays": 30,
  "isActive": true,
  "metadata": {
    "featured": true,
    "discount": 10,
    "promoCode": "LAUNCH2025"
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-plans"

payload = {
    "name": "100K Evaluation",
    "accountSize": 100000,
    "tradingRuleId": "660e8400-e29b-41d4-a716-446655440000",
    "description": "Our flagship 100K evaluation challenge",
    "price": 299,
    "currency": "USD",
    "durationDays": 30,
    "isActive": True,
    "metadata": {
        "featured": True,
        "discount": 10,
        "promoCode": "LAUNCH2025"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '100K Evaluation',
    accountSize: 100000,
    tradingRuleId: '660e8400-e29b-41d4-a716-446655440000',
    description: 'Our flagship 100K evaluation challenge',
    price: 299,
    currency: 'USD',
    durationDays: 30,
    isActive: true,
    metadata: {featured: true, discount: 10, promoCode: 'LAUNCH2025'}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '100K Evaluation',
    'accountSize' => 100000,
    'tradingRuleId' => '660e8400-e29b-41d4-a716-446655440000',
    'description' => 'Our flagship 100K evaluation challenge',
    'price' => 299,
    'currency' => 'USD',
    'durationDays' => 30,
    'isActive' => true,
    'metadata' => [
        'featured' => true,
        'discount' => 10,
        'promoCode' => 'LAUNCH2025'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-plans"

	payload := strings.NewReader("{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-plans")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading plan created successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "100K Evaluation",
    "price": 499,
    "accountSize": 100000,
    "isActive": true,
    "tradingRule": {
      "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
      "name": "Aggressive Rules"
    },
    "createdAt": "2026-02-18T21:19:57.328Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Trading rule does not belong to your organization",
  "code": "RULE_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading rule not found",
  "code": "RULE_NOT_FOUND"
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "A trading plan with this name already exists",
  "code": "PLAN_NAME_EXISTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Body

application/json

name

string

required

Plan name (must be unique within your organization)

Example:

"100K Evaluation"

accountSize

number

required

Account size ($)

Example:

100000

tradingRuleId

string

required

Trading rule ID to use for this plan

Example:

"660e8400-e29b-41d4-a716-446655440000"

description

string

Plan description

Example:

"Our flagship 100K evaluation challenge"

price

number

default:0

Plan price in the plan currency. OPTIONAL — omit (or send 0) for plans that are provisioned via the API rather than sold through a checkout.

Required range: x >= 0

Example:

299

currency

string

default:USD

Currency code (default: USD)

Example:

"USD"

durationDays

number

Plan duration in days (null = unlimited)

Example:

30

isActive

boolean

default:true

Whether the plan is active for purchase

metadata

object

Custom metadata

Example:

{
  "featured": true,
  "discount": 10,
  "promoCode": "LAUNCH2025"
}

Response

Plan created successfully

success

boolean

Example:

true

message

string

Example:

"Trading plan created successfully"

data

object

Show child attributes

Example:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "100K Evaluation",
  "price": 499,
  "accountSize": 100000,
  "isActive": true,
  "tradingRule": {
    "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
    "name": "Aggressive Rules"
  },
  "createdAt": "2026-02-18T21:19:57.328Z"
}

⌘I

Create a new trading plan

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "100K Evaluation",
  "accountSize": 100000,
  "tradingRuleId": "660e8400-e29b-41d4-a716-446655440000",
  "description": "Our flagship 100K evaluation challenge",
  "price": 299,
  "currency": "USD",
  "durationDays": 30,
  "isActive": true,
  "metadata": {
    "featured": true,
    "discount": 10,
    "promoCode": "LAUNCH2025"
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-plans"

payload = {
    "name": "100K Evaluation",
    "accountSize": 100000,
    "tradingRuleId": "660e8400-e29b-41d4-a716-446655440000",
    "description": "Our flagship 100K evaluation challenge",
    "price": 299,
    "currency": "USD",
    "durationDays": 30,
    "isActive": True,
    "metadata": {
        "featured": True,
        "discount": 10,
        "promoCode": "LAUNCH2025"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '100K Evaluation',
    accountSize: 100000,
    tradingRuleId: '660e8400-e29b-41d4-a716-446655440000',
    description: 'Our flagship 100K evaluation challenge',
    price: 299,
    currency: 'USD',
    durationDays: 30,
    isActive: true,
    metadata: {featured: true, discount: 10, promoCode: 'LAUNCH2025'}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '100K Evaluation',
    'accountSize' => 100000,
    'tradingRuleId' => '660e8400-e29b-41d4-a716-446655440000',
    'description' => 'Our flagship 100K evaluation challenge',
    'price' => 299,
    'currency' => 'USD',
    'durationDays' => 30,
    'isActive' => true,
    'metadata' => [
        'featured' => true,
        'discount' => 10,
        'promoCode' => 'LAUNCH2025'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-plans"

	payload := strings.NewReader("{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-plans")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"100K Evaluation\",\n  \"accountSize\": 100000,\n  \"tradingRuleId\": \"660e8400-e29b-41d4-a716-446655440000\",\n  \"description\": \"Our flagship 100K evaluation challenge\",\n  \"price\": 299,\n  \"currency\": \"USD\",\n  \"durationDays\": 30,\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": true,\n    \"discount\": 10,\n    \"promoCode\": \"LAUNCH2025\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading plan created successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "100K Evaluation",
    "price": 499,
    "accountSize": 100000,
    "isActive": true,
    "tradingRule": {
      "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
      "name": "Aggressive Rules"
    },
    "createdAt": "2026-02-18T21:19:57.328Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Trading rule does not belong to your organization",
  "code": "RULE_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading rule not found",
  "code": "RULE_NOT_FOUND"
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "A trading plan with this name already exists",
  "code": "PLAN_NAME_EXISTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Create a new trading plan

Authorizations

Body

Response