Organization
Get a specific purchase
Retrieve complete details for a single purchase by its ID.
When to use this:
- Display purchase details in your admin dashboard
- Look up a specific transaction for support
- Verify payment details for refund processing
- Track which accounts were created from a purchase
What you get:
- Purchase details (date, price, currency, status)
- Full trading plan info
- All accounts created from this purchase (with their current status)
- Custom metadata (payment IDs, promo codes, etc.)
Example:
GET /organization/purchases/f47ac10b-58cc-4372-a567-0e02b2c3d479
Understanding the response:
accounts= All trading accounts created from this purchasetradingPlan= The plan that was purchased (full details)metadata= Any custom data you stored (payment IDs, promo codes, etc.)
GET
/
v1
/
organization
/
purchases
/
{purchaseId}
Get a specific purchase
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}', 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/purchases/{purchaseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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/purchases/{purchaseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"purchaseDate": "2026-01-28T10:00:00.000Z",
"startDate": "2026-01-28T10:00:00.000Z",
"endDate": "2026-02-27T10:00:00.000Z",
"status": "paid",
"pricePaid": 299,
"currency": "USD",
"metadata": {
"stripePaymentId": "pi_3ABC123",
"promoCode": "SUMMER25"
},
"tradingPlan": {
"id": "09c93da5-f057-4cc5-82da-ff9220292c94",
"name": "50K Challenge",
"description": "Our most popular evaluation.",
"price": 299,
"currency": "USD",
"durationDays": 30,
"accountSize": 50000
},
"accounts": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-7845KXPQ",
"status": "in_progress",
"initialBalance": 50000,
"currentBalance": 52150,
"startedAt": "2026-02-01T09:00:00.000Z",
"completedAt": null,
"userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
"userEmail": "trader@example.com"
}
],
"createdAt": "2026-01-28T10:00:00.000Z",
"updatedAt": "2026-01-28T10:00:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This purchase does not belong to your organization",
"code": "PURCHASE_NOT_IN_ORG"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Purchase not found",
"code": "PURCHASE_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Authorizations
BearerX-API-Key
JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.
Path Parameters
The purchase ID to retrieve
Response
Success - Returns the purchase
Example:
true
Show child attributes
Show child attributes
Example:
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"purchaseDate": "2026-01-28T10:00:00.000Z",
"startDate": "2026-01-28T10:00:00.000Z",
"endDate": "2026-02-27T10:00:00.000Z",
"status": "paid",
"pricePaid": 299,
"currency": "USD",
"metadata": {
"stripePaymentId": "pi_3ABC123",
"promoCode": "SUMMER25"
},
"tradingPlan": {
"id": "09c93da5-f057-4cc5-82da-ff9220292c94",
"name": "50K Challenge",
"description": "Our most popular evaluation.",
"price": 299,
"currency": "USD",
"durationDays": 30,
"accountSize": 50000
},
"accounts": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-7845KXPQ",
"status": "in_progress",
"initialBalance": 50000,
"currentBalance": 52150,
"startedAt": "2026-02-01T09:00:00.000Z",
"completedAt": null,
"userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
"userEmail": "trader@example.com"
}
],
"createdAt": "2026-01-28T10:00:00.000Z",
"updatedAt": "2026-01-28T10:00:00.000Z"
}
Related topics
Get purchases for your organizationGet a specific traderGet a specific trading accountGet a specific trading planGet a specific trading rule⌘I
Get a specific purchase
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}', 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/purchases/{purchaseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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/purchases/{purchaseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/purchases/{purchaseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"purchaseDate": "2026-01-28T10:00:00.000Z",
"startDate": "2026-01-28T10:00:00.000Z",
"endDate": "2026-02-27T10:00:00.000Z",
"status": "paid",
"pricePaid": 299,
"currency": "USD",
"metadata": {
"stripePaymentId": "pi_3ABC123",
"promoCode": "SUMMER25"
},
"tradingPlan": {
"id": "09c93da5-f057-4cc5-82da-ff9220292c94",
"name": "50K Challenge",
"description": "Our most popular evaluation.",
"price": 299,
"currency": "USD",
"durationDays": 30,
"accountSize": 50000
},
"accounts": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-7845KXPQ",
"status": "in_progress",
"initialBalance": 50000,
"currentBalance": 52150,
"startedAt": "2026-02-01T09:00:00.000Z",
"completedAt": null,
"userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
"userEmail": "trader@example.com"
}
],
"createdAt": "2026-01-28T10:00:00.000Z",
"updatedAt": "2026-01-28T10:00:00.000Z"
}
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired session"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "This purchase does not belong to your organization",
"code": "PURCHASE_NOT_IN_ORG"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Purchase not found",
"code": "PURCHASE_NOT_FOUND"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}