Custom Metadata - Hyperprop Platform API

Trading accounts, purchases, traders, plans, and rules all carry a free-form metadata JSON object. Use it to store your own references — payment IDs, campaign tags, payout records, internal notes. Hyperprop stores and returns it verbatim and never interprets it.

curl -X PATCH "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": { "stripePaymentId": "pi_123", "campaign": "august-sale" },
    "mergeMetadata": true
  }'

Merging vs. replacing

Update endpoints replace the whole metadata object by default. Pass mergeMetadata: true for a shallow (top-level) merge instead — existing keys you don’t mention are kept.

Filtering by metadata

List endpoints can filter on metadata, e.g.:

GET /v1/organization/trading-accounts?metadata=stripePaymentId:pi_123

This makes metadata the natural place to store the identifiers you’ll later need to look accounts up by — order IDs, customer IDs, invoice references.

Related topics

Update a trader Get a specific purchase Quickstart Get purchases for your organization Get trading plans for your organization

⌘I