DOCUMENTATIONv2

PATCH

Price feeds

Update subscription

/api/v2/price-feed-subscriptions/{subscription_uuid}

AUTHENTICATIONBearer token · pricing:writeAUTHORITATIVE OWNERmarket-data-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Pause, resume, or terminally cancel one owner-scoped delivery contract and retain the resulting lifecycle evidence.

WHEN THIS CALL IS USEFUL

Use the planning contract to pause delivery temporarily, resume a paused contract, or cancel it permanently after reconciling the latest subscription detail.

OUTCOME · Revise and reconcile

What changes

When promoted, updates both domain and metered-contract lifecycle state and records transition evidence. CANCEL also marks billing posture cancelled and is irreversible.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance subscription.
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.
Supply the required subscription_uuid (path), action (body) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
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

Re-read the created or updated feed or subscription and confirm its owner, plan, entitlements, lifecycle state, and effective policy.
Reconcile an ambiguous result with the same idempotency key, then verify feed provenance and freshness before dependent use.

AGENT GUIDANCE

Use subscription only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required subscription_uuid (path), action (body) exactly as defined by the live contract.
Preserve decimal values and observation timestamps exactly; distinguish source time, ingestion time, sequence, freshness, health, quality, aggregation, delivery entitlement, and business acceptance.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

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:write scope.EXAMPLEBearer hc_live_…

subscription_uuidpathRequired

32-character hexadecimal identifierOwner-scoped subscription discovered from the collection route.EXAMPLE05aa9566990f42fa8e8e74624d4ec906

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated key reused for every retry of the same logical mutation.EXAMPLEpause-price-delivery-05aa9566-20260901

Content-TypeheaderRequired

application/jsonSigned mutations accept canonical JSON only.EXAMPLEapplication/json

Content-DigestheaderRequired

RFC 9530 SHA-256 digestDigest of the exact transmitted body bytes.EXAMPLEsha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:

Signature-InputheaderRequired

RFC 9421 signature parametersCovers @method, @path, content-digest, content-type, and idempotency-key; includes keyid, nonce, created, and expires.EXAMPLEsig1=("@method" "@path" "content-digest" "content-type" "idempotency-key");created=1786582800;expires=1786583100;nonce="01J…";keyid="machine-prod"

SignatureheaderRequired

Ed25519 HTTP Message SignatureSignature made by an active public key registered to the authenticated client.EXAMPLEsig1=:base64-signature:

actionbodyRequired

PAUSE | RESUME | CANCELTarget lifecycle transition. Repeating the current state is a successful no-op; CANCEL is terminal.EXAMPLEPAUSE

REQUEST

JSON body example

{
  "action": "PAUSE"
}

RESPONSES

Status and payload examples

200Canonical post-transition delivery and metered-contract state with retained lifecycle timestamps and evidence.Mutation completed · JSON RESPONSE+

{
  "subscription_id": "05aa9566990f42fa8e8e74624d4ec906",
  "name": "Treasury valuation evidence",
  "status": "PAUSED",
  "started_at": "2026-08-01T00:00:00Z",
  "paused_at": "2026-09-01T20:15:00.000000Z",
  "cancelled_at": null,
  "last_ticket_at": "2026-08-31T22:40:00Z",
  "created_at": "2026-08-01T00:00:00Z",
  "updated_at": "2026-09-01T20:15:00.000000Z",
  "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 re-read the created or updated feed or subscription and confirm its owner, plan, entitlements, lifecycle state, and effective policy.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the feed, source mapping, observation timestamp, quality and staleness state, policy version, and delivery or command receipt.

404No subscription with this identifier belongs to the authenticated workspace.Resource not visible · JSON RESPONSE+

{
  "code": "price_feed_subscription_not_found",
  "message": "No subscription with this identifier belongs to the authenticated workspace."
}

INTEGRATION DECISIONprice_feed_subscription_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
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.

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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. 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.

403The credential lacks pricing:write or the selected resource is outside the authenticated workspace.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks pricing:write or the selected resource is outside the authenticated workspace."
}

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.

409The Idempotency-Key conflicts with another request or the requested lifecycle transition is forbidden.State reconciliation required · JSON RESPONSE+

{
  "code": "price_feed_conflict",
  "message": "The Idempotency-Key conflicts with another request or the requested lifecycle transition is forbidden."
}

INTEGRATION DECISIONprice_feed_conflict

CALLER ACTION: Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY: Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
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.

422An identifier, field, source mapping, policy bound, action, or Idempotency-Key is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_price_feed_command",
  "message": "An identifier, field, source mapping, policy bound, action, or Idempotency-Key is invalid."
}

INTEGRATION DECISIONinvalid_price_feed_command

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. 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.

503The authoritative Core pricing mutation boundary is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "price_feeds_unavailable",
  "message": "The authoritative Core pricing mutation boundary is unavailable."
}

INTEGRATION DECISIONprice_feeds_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
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

PAUSE stops live delivery under the owner policy while retained replay may remain available; RESUME restores an eligible paused contract; CANCEL is immutable and cannot be resumed.
Re-read the returned contract and use its server timestamps. Do not predict state, locally synthesize evidence, or interpret a repeated no-op as a new transition event.
The owner boundary, RFC 9421 signature, no-store policy, and retained Idempotency-Key prevent cross-workspace or ambiguous replay. Reusing a key with another action or path returns 409.
Lifecycle control changes delivery posture only. It grants no publisher, ingress, trading, matching, settlement, market-status, value-movement, or traffic authority.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗