Trading plans

Delete a trading plan

Delete a trading plan. Admin only.

Two outcomes, by design:

Plan state	Result
Never used in a purchase	Permanently deleted (hard delete)
Used in ≥1 purchase	Delete refused with `409 PLAN_IN_USE` — archive it instead

Plans with purchase history can never be hard-deleted: your billing records, accounts, and audit trail reference them (same model as Stripe products). The 409 response includes a hint field with the exact archive call.

Archiving instead of deleting:

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

Archived plans can’t be purchased and can be excluded from listings with GET /trading-plans?isActive=true.

Example:

curl -X DELETE "https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId}" \
  -H "X-API-Key: hp_live_your_key_here"

Error Codes:

Code	Description
`PLAN_NOT_FOUND`	No plan exists with this ID
`PLAN_NOT_IN_ORG`	Plan belongs to different organization
`PLAN_IN_USE`	Plan has purchase history — archive it instead (see `hint` in response)
`ADMIN_REQUIRED`	Only admins can delete plans

DELETE

organization

trading-plans

{planId}

Delete a trading plan

curl --request DELETE \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId} \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

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 => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Delete.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "success": true,
  "message": "Trading plan deleted successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Deleted Plan Name",
    "deleted": true
  }
}

{
  "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": "Cannot delete plan: it has been used in 10+ account purchase(s)",
  "code": "PLAN_IN_USE",
  "hint": "Plans with purchase history cannot be deleted (it would orphan your billing and account records). Archive it instead: PATCH /platform/v1/organization/trading-plans/{planId} with {\"isActive\": false}. Archived plans are hidden from new purchases; exclude them from listings with GET /trading-plans?isActive=true."
}

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

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

planId

string

required

The plan ID to delete

Response

Plan deleted successfully

success

boolean

Example:

true

message

string

Example:

"Trading plan deleted successfully"

data

object

Show child attributes

⌘I

Delete a trading plan

curl --request DELETE \
  --url https://api.hyperprop.com/platform/v1/organization/trading-plans/{planId} \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-API-Key': '<api-key>'}};

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 => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Delete.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "success": true,
  "message": "Trading plan deleted successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Deleted Plan Name",
    "deleted": true
  }
}

{
  "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": "Cannot delete plan: it has been used in 10+ account purchase(s)",
  "code": "PLAN_IN_USE",
  "hint": "Plans with purchase history cannot be deleted (it would orphan your billing and account records). Archive it instead: PATCH /platform/v1/organization/trading-plans/{planId} with {\"isActive\": false}. Archived plans are hidden from new purchases; exclude them from listings with GET /trading-plans?isActive=true."
}

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

Platform API

Trade API

Delete a trading plan

Authorizations

Path Parameters

Response