Get an organization's plan and usage (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

Close
GET /admin/orgs/{orgId}/billing

Returns the organization's current plan (tier, cadence, billing mode and card on file), or null when it is not on case billing, its use of seats, storage, cases and AI tokens against their caps or budget, and whether its base fee is overdue. Super admin only.

Path parameters

  • orgId string Required

    Id of the organization

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • plan object Required
        Hide plan attributes Show plan attributes object
        • tier string Required

          Values are public, solo, firm, or firm-plus.

        • cadence string Required

          Values are monthly or annual.

        • billingMode string Required

          Values are payg, per-source, or flat-case.

        • paymentMethodOnFile boolean Required

          Whether a usable card is on file, read live from Stripe rather than from the stored flag.

        • paymentMethod object Required

          The card that will actually be charged (the customer default), or null when there is none.

          Hide paymentMethod attributes Show paymentMethod attributes object
          • brand string Required
          • last4 string Required
          • expMonth number Required
          • expYear number Required
      • usage object Required
        Hide usage attributes Show usage attributes object
        • seats object Required
          Hide seats attributes Show seats attributes object
          • used number Required
          • cap number | null Required
        • storageGB object Required
          Hide storageGB attributes Show storageGB attributes object
          • used number Required
          • cap number | null Required
        • aiTokens object Required
          Hide aiTokens attributes Show aiTokens attributes object
          • used number Required
          • budget number Required
        • cases object Required
          Hide cases attributes Show cases attributes object
          • used number Required
          • cap number | null Required
      • delinquent boolean Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /admin/orgs/{orgId}/billing
curl \
 --request GET 'http://api.example.com/admin/orgs/{orgId}/billing' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": {
    "plan": {
      "tier": "firm",
      "cadence": "monthly",
      "billingMode": "payg",
      "paymentMethodOnFile": true,
      "paymentMethod": {
        "brand": "visa",
        "last4": "4242",
        "expMonth": 4,
        "expYear": 2044
      }
    },
    "usage": {
      "seats": {
        "used": 12,
        "cap": 50
      },
      "storageGB": {
        "used": 12,
        "cap": 50
      },
      "aiTokens": {
        "used": 250000,
        "budget": 1000000
      },
      "cases": {
        "used": 12,
        "cap": 50
      }
    },
    "delinquent": false
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}