# 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)

## inspect_billing

Read an Organization's subscription (plan, status, seats, billing period, pending cancellation, frozen state, and plan limits).

Use to answer what plan a customer is on, why a workspace is frozen, or what it is entitled to.

Do not use it to change the plan or cancel; those need a person. Use the product-specific retention eligibility tools when a person asks about an offboarding offer. A Workspace id resolves to its parent billing Organization.

Scopes: billing:read

Risk: read; confirmation: none; idempotency: none.

### 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"
    },
    "action": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "subscription"
          ]
        }
      },
      "required": [
        "kind"
      ],
      "patternProperties": {
        "^(?!(?:kind)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "kind"
            ]
          }
        ]
      }
    }
  },
  "required": [
    "workspaceId",
    "action"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "action"
    ]
  }
}
```

### 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"
    },
    "action": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "subscription"
          ]
        }
      },
      "required": [
        "kind"
      ],
      "patternProperties": {
        "^(?!(?:kind)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "kind"
            ]
          }
        ]
      }
    }
  },
  "required": [
    "workspaceId",
    "action"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "action"
    ]
  }
}
```

### Output schema (structuredContent)

```json
{
  "type": "object",
  "properties": {
    "subscriptions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "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"
          },
          "plan": {
            "type": "string",
            "enum": [
              "trial",
              "starter",
              "growth",
              "pro"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "incomplete",
              "incomplete_expired",
              "trialing",
              "active",
              "past_due",
              "canceled",
              "unpaid",
              "paused",
              "frozen"
            ]
          },
          "billingCycle": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "monthly",
                  "annual"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "seats": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "trialStart": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "trialEnd": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "periodStart": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "periodEnd": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "cancelAtPeriodEnd": {
            "type": "boolean"
          },
          "pastDueSince": {
            "anyOf": [
              {
                "$ref": "#/$defs/UtcDateTimeEncoded"
              },
              {
                "type": "null"
              }
            ]
          },
          "stripeCustomerId": {
            "anyOf": [
              {
                "$ref": "#/$defs/ProviderId"
              },
              {
                "type": "null"
              }
            ]
          },
          "stripeSubscriptionId": {
            "anyOf": [
              {
                "$ref": "#/$defs/ProviderId"
              },
              {
                "type": "null"
              }
            ]
          },
          "priceId": {
            "anyOf": [
              {
                "$ref": "#/$defs/ProviderId"
              },
              {
                "type": "null"
              }
            ]
          },
          "frozen": {
            "type": "boolean"
          },
          "limits": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "maxEmailsPerMonth": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "maxInboxes": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "maxCampaigns": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "maxContactsPerCampaign": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "whiteLabelEnabled": {
                    "type": "boolean"
                  },
                  "prioritySupport": {
                    "type": "boolean"
                  },
                  "warmupPoolTier": {
                    "type": "string",
                    "enum": [
                      "standard",
                      "premium"
                    ]
                  },
                  "maxWarmupEmailsPerDay": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "maxWarmupInboxes": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "privatePoolEnabled": {
                    "type": "boolean"
                  },
                  "dedicatedEgressEnabled": {
                    "type": "boolean"
                  },
                  "maxActiveEgressIps": {
                    "type": "integer",
                    "minimum": -1
                  },
                  "egressInfrastructureBudgetCents": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  "byokEnabled": {
                    "type": "boolean"
                  },
                  "fullMailboxSyncEnabled": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "maxEmailsPerMonth",
                  "maxInboxes",
                  "maxCampaigns",
                  "maxContactsPerCampaign",
                  "whiteLabelEnabled",
                  "prioritySupport",
                  "warmupPoolTier",
                  "maxWarmupEmailsPerDay",
                  "maxWarmupInboxes",
                  "privatePoolEnabled",
                  "dedicatedEgressEnabled",
                  "maxActiveEgressIps",
                  "egressInfrastructureBudgetCents",
                  "byokEnabled",
                  "fullMailboxSyncEnabled"
                ],
                "patternProperties": {
                  "^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign|whiteLabelEnabled|prioritySupport|warmupPoolTier|maxWarmupEmailsPerDay|maxWarmupInboxes|privatePoolEnabled|dedicatedEgressEnabled|maxActiveEgressIps|egressInfrastructureBudgetCents|byokEnabled|fullMailboxSyncEnabled)$)[\\s\\S]*$": false
                },
                "additionalProperties": true,
                "propertyNames": {
                  "type": "string",
                  "enum": [
                    "maxEmailsPerMonth",
                    "maxInboxes",
                    "maxCampaigns",
                    "maxContactsPerCampaign",
                    "whiteLabelEnabled",
                    "prioritySupport",
                    "warmupPoolTier",
                    "maxWarmupEmailsPerDay",
                    "maxWarmupInboxes",
                    "privatePoolEnabled",
                    "dedicatedEgressEnabled",
                    "maxActiveEgressIps",
                    "egressInfrastructureBudgetCents",
                    "byokEnabled",
                    "fullMailboxSyncEnabled"
                  ]
                }
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "plan",
          "status",
          "billingCycle",
          "seats",
          "trialStart",
          "trialEnd",
          "periodStart",
          "periodEnd",
          "cancelAtPeriodEnd",
          "pastDueSince",
          "stripeCustomerId",
          "stripeSubscriptionId",
          "priceId",
          "frozen",
          "limits"
        ],
        "patternProperties": {
          "^(?!(?:id|plan|status|billingCycle|seats|trialStart|trialEnd|periodStart|periodEnd|cancelAtPeriodEnd|pastDueSince|stripeCustomerId|stripeSubscriptionId|priceId|frozen|limits)$)[\\s\\S]*$": false
        },
        "additionalProperties": true,
        "propertyNames": {
          "type": "string",
          "enum": [
            "id",
            "plan",
            "status",
            "billingCycle",
            "seats",
            "trialStart",
            "trialEnd",
            "periodStart",
            "periodEnd",
            "cancelAtPeriodEnd",
            "pastDueSince",
            "stripeCustomerId",
            "stripeSubscriptionId",
            "priceId",
            "frozen",
            "limits"
          ]
        }
      },
      "maxItems": 20
    }
  },
  "required": [
    "subscriptions"
  ],
  "patternProperties": {
    "^(?!(?:subscriptions)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "anyOf": [
      {
        "type": "string",
        "enum": [
          "subscriptions"
        ]
      }
    ]
  },
  "$defs": {
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    },
    "ProviderId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    }
  }
}
```

### Underlying API operations

- `billing.getSubscription`: `GET /v1/organizations/:organizationId/billing/subscription`