Cancel Community Member Subscription
cancel_community_member_subscriptionCancel a community member's subscription by ID, with immediate or period-end timing and optional refund. Requires confirm=true to proceed.
Instructions
Cancel Community Member Subscription. Changes community state and requires confirm=true for the user-requested action.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"subscription_id": "<subscription_id>"
},
"name": "cancel_community_member_subscription"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private Circle account; selects credentials, not a remote community ID. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| ends_at | No | Cancellation timing: 'now' or 'at_period_end'. | |
| payload | No | Complete JSON request body instead of body flags. Supports nested Tiptap, maps and nullable values. | |
| refund_type | No | Optional refund type when canceling immediately: 'prorated' or 'full'. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| subscription_id | Yes | Community Member Subscription ID |