# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## cancel_dialer_addon

Schedule the dialer add-on to end at the close of the paid period, with the reason the workspace gave.

Use when a workspace has decided to stop dialing. Service continues until the effective date, so nothing is cut off mid-call.

Cancelling does not release numbers or revoke seats, and re-subscribing is a new purchase. Confirm with a human before running it.

Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.

Scopes: dialer:manage_billing

Risk: destructive; confirmation: explicit; idempotency: supported.

### Input schema (personal API key)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "cancel": {
      "type": "object",
      "properties": {
        "reason": {
          "type": "string",
          "enum": [
            "cost",
            "missing_features",
            "bugs_quality",
            "not_using",
            "switching",
            "other"
          ]
        },
        "feedback": {
          "type": "string",
          "maxLength": 2000
        },
        "fairPrice": {
          "type": "string",
          "maxLength": 100
        }
      },
      "required": [
        "reason"
      ],
      "patternProperties": {
        "^(?!(?:reason|feedback|fairPrice)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "reason",
          "feedback",
          "fairPrice"
        ]
      }
    }
  },
  "required": [
    "workspaceId",
    "cancel"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|cancel)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "cancel"
    ]
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "cancel": {
      "type": "object",
      "properties": {
        "reason": {
          "type": "string",
          "enum": [
            "cost",
            "missing_features",
            "bugs_quality",
            "not_using",
            "switching",
            "other"
          ]
        },
        "feedback": {
          "type": "string",
          "maxLength": 2000
        },
        "fairPrice": {
          "type": "string",
          "maxLength": 100
        }
      },
      "required": [
        "reason"
      ],
      "patternProperties": {
        "^(?!(?:reason|feedback|fairPrice)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "reason",
          "feedback",
          "fairPrice"
        ]
      }
    }
  },
  "required": [
    "workspaceId",
    "cancel"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|cancel)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "cancel"
    ]
  }
}
```

### Output schema (structuredContent)

```json
{
  "$defs": {
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    }
  },
  "type": "object",
  "anyOf": [
    {
      "allOf": [
        {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "canceled": {
                  "type": "boolean"
                },
                "effectiveAt": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "canceled",
                "effectiveAt"
              ],
              "patternProperties": {
                "^(?!(?:canceled|effectiveAt)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "type": "string",
                "enum": [
                  "canceled",
                  "effectiveAt"
                ]
              }
            },
            {
              "type": "object",
              "properties": {
                "active": {
                  "type": "boolean"
                },
                "cancelAtPeriodEnd": {
                  "type": "boolean"
                },
                "plan": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "dialer_5",
                        "dialer_10"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "purchasedSeats": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                "assignedSeats": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                "numbersPerSeat": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "active",
                "cancelAtPeriodEnd",
                "plan",
                "purchasedSeats",
                "assignedSeats",
                "numbersPerSeat"
              ],
              "patternProperties": {
                "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "type": "string",
                "enum": [
                  "active",
                  "cancelAtPeriodEnd",
                  "plan",
                  "purchasedSeats",
                  "assignedSeats",
                  "numbersPerSeat"
                ]
              }
            }
          ]
        },
        {
          "type": "object"
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "allOf": [
            {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "canceled": {
                      "type": "boolean"
                    },
                    "effectiveAt": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/UtcDateTimeEncoded"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "canceled",
                    "effectiveAt"
                  ],
                  "patternProperties": {
                    "^(?!(?:canceled|effectiveAt)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "canceled",
                      "effectiveAt"
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "active": {
                      "type": "boolean"
                    },
                    "cancelAtPeriodEnd": {
                      "type": "boolean"
                    },
                    "plan": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "dialer_5",
                            "dialer_10"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "purchasedSeats": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    "assignedSeats": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    "numbersPerSeat": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    }
                  },
                  "required": [
                    "active",
                    "cancelAtPeriodEnd",
                    "plan",
                    "purchasedSeats",
                    "assignedSeats",
                    "numbersPerSeat"
                  ],
                  "patternProperties": {
                    "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "active",
                      "cancelAtPeriodEnd",
                      "plan",
                      "purchasedSeats",
                      "assignedSeats",
                      "numbersPerSeat"
                    ]
                  }
                }
              ]
            },
            {
              "not": {
                "type": "object"
              }
            }
          ]
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false
    }
  ]
}
```

### Underlying API operations

- `dialerBilling.cancel`: `POST /v1/workspaces/:workspaceId/dialer/billing/cancel`
- `dialerBilling.status`: `GET /v1/workspaces/:workspaceId/dialer/billing/status`