billing_status

Get billing status. The community’s PorchQ plan and subscription.

Who can use it: Owners and managers.

Scope	Effect	Hints
billing:read	read	reads only, idempotent

Description shown to assistants

Use this when the user asks about plan tier, renewal window, or subscription status.

Arguments

Argument	Type	Required	About
property_id	string	No	The community’s public id (prop_web…). Pass it on every call.

What it returns

Every result has content (one short sentence for the person) and structuredContent (the data below). A tool that could not run answers with isError: true and a sentence saying why; see Errors and limits.

• membership_role: the person’s role.
• plan: slug and name.
• subscription: status, provider, billing_interval, current_period_start, current_period_end and cancel_at_period_end.

structuredContent follows this JSON Schema, also in tools/list as outputSchema:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" },
        "addressLine1": { "type": ["string", "null"] },
        "addressLine2": { "type": ["string", "null"] },
        "city": { "type": ["string", "null"] },
        "state": { "type": ["string", "null"] },
        "postalCode": { "type": ["string", "null"] },
        "timezone": { "type": ["string", "null"] },
        "billingFrequency": { "type": ["string", "null"] },
        "demoClone": { "type": "boolean" },
        "demoPersona": { "type": ["string", "null"] },
        "demoExpiresAt": { "type": ["string", "null"] }
      },
      "required": ["id", "name"]
    },
    "membership_role": { "type": "string" },
    "plan": {
      "type": "object",
      "properties": {
        "slug": { "type": ["string", "null"] },
        "name": { "type": ["string", "null"] }
      }
    },
    "subscription": {
      "type": "object",
      "properties": {
        "status": { "type": ["string", "null"] },
        "provider": { "type": ["string", "null"] },
        "billing_interval": { "type": ["string", "null"] },
        "current_period_start": { "type": ["string", "null"] },
        "current_period_end": { "type": ["string", "null"] },
        "cancel_at_period_end": { "type": ["boolean", "null"] }
      }
    }
  },
  "required": ["property", "membership_role", "plan", "subscription"]
}

Notes

• This is the community’s subscription to PorchQ, not residents’ assessments or balances.

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "billing_status",
    "arguments": {
      "property_id": "prop_web4k2m9q7x1v8c3n5b6z0a2s4d"
    }
  }
}