GET

Price feeds

List subscriptions

/api/v2/price-feed-subscriptions
AUTHENTICATIONBearer token · pricing:readService ownermarket-data-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

List the authenticated workspace's delivery entitlements, replay limits, lifecycle posture, billing posture, and current-month transport usage.

When to use it

Call this to inventory the workspace's delivery contracts, entitlements, replay limits, lifecycle state, billing posture, and current usage before creating or changing a subscription.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to discover subscriptions.
  • Makes feed provenance, quality, delivery entitlement, replay limits, and workspace-owned composite policy explicit before price data enters valuation or decision workflows.

ISOLATION + AUTHORITY

Instrument, provider, observation, signature, hash-chain, aggregation, composite owner, subscription, delivery, billing, valuation, market, and trading boundaries remain distinct. A feed, snapshot, replay, plan, or subscription supplies data only and grants no oracle-finality, valuation approval, publisher, order, matching, settlement, or trading authority.

BEFORE YOU CALL

  • Authenticate at the documented boundary: bearer+scope.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • Resolve the canonical instrument and feed, source and aggregation policy, required freshness and quality, and any subscription entitlement or replay window.

WHAT TO DO NEXT

  • Compare lifecycle state, entitled feeds, plan limits, replay window, usage, and billing posture before changing delivery behavior.
  • Open the exact feed contract for each entitlement and verify observation provenance independently of subscription status.

AGENT GUIDANCE

  • Use subscriptions only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • Preserve decimal values and observation timestamps exactly; distinguish source time, ingestion time, sequence, freshness, health, quality, aggregation, delivery entitlement, and business acceptance.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE
AuthorizationheaderRequired

Bearer tokenCredential containing the pricing:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Workspace delivery entitlements, lifecycle, replay limits, contract posture, and current-month usage.Read completed · JSON RESPONSE+
{
  "items": [
    {
      "subscription_id": "05aa9566990f42fa8e8e74624d4ec906",
      "name": "Treasury valuation evidence",
      "status": "ACTIVE",
      "started_at": "2026-08-01T00:00:00Z",
      "paused_at": null,
      "cancelled_at": null,
      "last_ticket_at": "2026-08-31T22:40:00Z",
      "created_at": "2026-08-01T00:00:00Z",
      "updated_at": "2026-08-31T22:40:00Z",
      "plan": {
        "code": "DEVELOPER",
        "name": "Developer",
        "max_feeds": 5,
        "max_connections": 2,
        "replay_window_minutes": 1440,
        "min_cadence_ms": 1000,
        "retained_history_days": 7
      },
      "feeds": [
        {
          "feed_id": "8c1490adbe524bb79b8be0618e58fe55",
          "cadence_ms": 1000,
          "enabled": true,
          "name": "BTC / USD composite",
          "mode": "AGGREGATED",
          "instrument": "BTC-USD",
          "asset_class": "DIGITAL_ASSET"
        }
      ],
      "usage_current_month": {
        "delivered_messages": 184221,
        "delivered_bytes": 42199112,
        "connection_seconds": 2389200,
        "reconnect_count": 3,
        "replayed_messages": 1200
      },
      "contract": {
        "billing_mode": "METERED",
        "billing_state": "ACTIVE",
        "renewal_mode": "AUTOMATIC",
        "current_period_started_at": "2026-08-01T00:00:00Z",
        "current_period_ends_at": "2026-09-01T00:00:00Z",
        "payload_schema": "price-evidence-v1",
        "usage_schema": "price-delivery-usage-v1",
        "retention_days": 7,
        "entitlements": {
          "feeds": 5,
          "connections": 2,
          "replay_window_minutes": 1440
        }
      }
    }
  ]
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then compare lifecycle state, entitled feeds, plan limits, replay window, usage, and billing posture before changing delivery behavior.
RETRY SAFETY
Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION
Use returned identifiers and versions as the comparison point for later reads. Refresh the feed, source mapping, observation timestamp, quality and staleness state, policy version, and delivery or command receipt.
401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, or invalid."
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY
Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION
Authentication failed before an authoritative read was returned for workspace price-feed definitions, source mappings, observations, quality status, subscriptions, and delivery receipts.
ESCALATE WHEN
Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.
403The credential lacks pricing:read or the subscription does not entitle this replay.Authority or policy denied · JSON RESPONSE+
{
  "code": "insufficient_scope",
  "message": "The credential lacks pricing:read or the subscription does not entitle this replay."
}
INTEGRATION DECISIONinsufficient_scope
CALLER ACTION
Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY
Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION
Confirm the caller and resource resolve to the same authority boundary for workspace price-feed definitions, source mappings, observations, quality status, subscriptions, and delivery receipts.
ESCALATE WHEN
Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.
503The authoritative Core pricing projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "price_feeds_unavailable",
  "message": "The authoritative Core pricing projection is unavailable."
}
INTEGRATION DECISIONprice_feeds_unavailable
CALLER ACTION
Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY
Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION
Refresh the feed, source mapping, observation timestamp, quality and staleness state, policy version, and delivery or command receipt.
ESCALATE WHEN
Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • Use feeds[].enabled and the plan's replay_window_minutes to select an entitlement before history replay.
  • Usage counters describe delivery operations, not invoice, payment, or settlement finality. Contract billing_state is commercial posture, not proof of external settlement.
  • Lifecycle timestamps are nullable. A paused subscription can remain replay-eligible while live delivery is paused, subject to owner policy.
  • The gateway derives the workspace and excludes owner-vault, client, datastream, internal contract, and terms-hash identifiers. No query parameters or request body are accepted; responses are no-store.
Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory