Organization

Update a trading plan

Update an existing trading plan. Admin only.

Only provide fields you want to change.

Example - Update price:

curl -X PATCH "https://api.example.com/platform/v1/organization/trading-plans/{planId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"price": 349}'

Example - Deactivate plan:

curl -X PATCH ".../{planId}" \
  -d '{"isActive": false}'

Example - Change trading rule:

curl -X PATCH ".../{planId}" \
  -d '{"tradingRuleId": "new-rule-uuid"}'

Note: Existing purchases are not affected by changes. Changes only apply to new purchases.

Error Codes:

Code	Description
`PLAN_NOT_FOUND`	No plan exists with this ID
`PLAN_NOT_IN_ORG`	Plan belongs to different organization
`PLAN_NAME_EXISTS`	Another plan already has this name
`RULE_NOT_FOUND`	New trading rule not found
`RULE_NOT_IN_ORG`	New trading rule belongs to different org
`NO_FIELDS_TO_UPDATE`	No valid fields provided
`ADMIN_REQUIRED`	Only admins can update plans

PATCH

organization

trading-plans

{planId}

Update a trading plan

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Plan Name",
  "description": "Updated description",
  "price": 349,
  "currency": "EUR",
  "durationDays": 45,
  "accountSize": 150000,
  "tradingRuleId": "<string>",
  "isActive": true,
  "metadata": {
    "featured": false
  },
  "mergeMetadata": true
}
'

import requests

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

payload = {
    "name": "Updated Plan Name",
    "description": "Updated description",
    "price": 349,
    "currency": "EUR",
    "durationDays": 45,
    "accountSize": 150000,
    "tradingRuleId": "<string>",
    "isActive": True,
    "metadata": { "featured": False },
    "mergeMetadata": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Plan Name',
    description: 'Updated description',
    price: 349,
    currency: 'EUR',
    durationDays: 45,
    accountSize: 150000,
    tradingRuleId: '<string>',
    isActive: true,
    metadata: {featured: false},
    mergeMetadata: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}', 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/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Plan Name',
    'description' => 'Updated description',
    'price' => 349,
    'currency' => 'EUR',
    'durationDays' => 45,
    'accountSize' => 150000,
    'tradingRuleId' => '<string>',
    'isActive' => true,
    'metadata' => [
        'featured' => false
    ],
    'mergeMetadata' => true
  ]),
  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/{planId}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}"

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

{
  "success": true,
  "message": "Trading plan updated successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Plan Name",
    "price": 349,
    "isActive": true,
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

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

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This plan does not belong to your organization",
  "code": "PLAN_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading plan not found",
  "code": "PLAN_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.

Path Parameters

planId

string

required

The plan ID to update

Body

application/json

name

string

New plan name (must be unique)

Example:

"Updated Plan Name"

description

string

New description (null to clear)

Example:

"Updated description"

price

number

New price

Example:

349

currency

string

New currency code

Example:

"EUR"

durationDays

number

New duration (null = unlimited)

Example:

45

accountSize

number

New account size

Example:

150000

tradingRuleId

string

New trading rule ID

isActive

boolean

Enable/disable plan

metadata

object

New metadata. Replaces existing metadata wholesale unless mergeMetadata is true.

Example:

{ "featured": false }

mergeMetadata

boolean

When true, the provided metadata keys are merged into the existing metadata instead of replacing it entirely

Example:

true

Response

Plan updated successfully

success

boolean

Example:

true

message

string

Example:

"Trading plan updated successfully"

data

object

Show child attributes

⌘I

Update a trading plan

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Plan Name",
  "description": "Updated description",
  "price": 349,
  "currency": "EUR",
  "durationDays": 45,
  "accountSize": 150000,
  "tradingRuleId": "<string>",
  "isActive": true,
  "metadata": {
    "featured": false
  },
  "mergeMetadata": true
}
'

import requests

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

payload = {
    "name": "Updated Plan Name",
    "description": "Updated description",
    "price": 349,
    "currency": "EUR",
    "durationDays": 45,
    "accountSize": 150000,
    "tradingRuleId": "<string>",
    "isActive": True,
    "metadata": { "featured": False },
    "mergeMetadata": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Plan Name',
    description: 'Updated description',
    price: 349,
    currency: 'EUR',
    durationDays: 45,
    accountSize: 150000,
    tradingRuleId: '<string>',
    isActive: true,
    metadata: {featured: false},
    mergeMetadata: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}', 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/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Plan Name',
    'description' => 'Updated description',
    'price' => 349,
    'currency' => 'EUR',
    'durationDays' => 45,
    'accountSize' => 150000,
    'tradingRuleId' => '<string>',
    'isActive' => true,
    'metadata' => [
        'featured' => false
    ],
    'mergeMetadata' => true
  ]),
  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/{planId}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Plan Name\",\n  \"description\": \"Updated description\",\n  \"price\": 349,\n  \"currency\": \"EUR\",\n  \"durationDays\": 45,\n  \"accountSize\": 150000,\n  \"tradingRuleId\": \"<string>\",\n  \"isActive\": true,\n  \"metadata\": {\n    \"featured\": false\n  },\n  \"mergeMetadata\": true\n}"

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

{
  "success": true,
  "message": "Trading plan updated successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Plan Name",
    "price": 349,
    "isActive": true,
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

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

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This plan does not belong to your organization",
  "code": "PLAN_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading plan not found",
  "code": "PLAN_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

Update a trading plan

Authorizations

Path Parameters

Body

Response