subscriptions.delete

Live

Retire a subscription.

CategorySubscriptions
JSON-RPCtools/call
EndpointPOST /mcp
Sourcepackages/subscriptions/src/tools/subscriptions-delete.ts

Description

Soft-delete; historical match records preserved. Per ADR-0021 §subscriptions.

Input schema

FieldTypeRequiredDescription
subscription_idstringyesThe subscription id.

Output shape

typescript
{ ok: true }

Example call

JSON-RPC tools/call request body (omit the JSON-RPC envelope when using an SDK; the SDK adds it for you):

jsontools/call params
{ "name": "subscriptions.delete", "arguments": { "subscription_id": "sub_01H..." } }

Example response

Tool results are always wrapped as content[0].text with a stringified JSON body. The shape below is what you get back from JSON.parse(result.content[0].text):

jsonparsed result body
{ "ok": true }

Errors this tool can return

CodeMeaning
invalid_argumentsTool input failed Zod validation.
unauthorizedMissing or invalid bearer token.
not_foundThe requested resource (action_id, decision_id, counterparty_id, etc.) was not found.

See the full error catalog for resolution steps on each code, plus the standard transport-layer responses (401, 429).