Skip to Content
AI Agents (MCP)Tool referencelist_platform_licenses

list_platform_licenses

Licenses across all organizations, newest first: key masked as lic_…1234 (never the full key), organization, product, plan, status, customer (masked unless pii:read), activations used (active ones only) of the limit, issued and expiry dates. Filter by organization, product, status, expiring within N days, or (with pii:read; refused without it) an exact customer email. Needs the platform manage_licenses permission. Paginated.

  • Server: Platform server
  • Scope: platform.licenses:read
  • Read-only: yes

Input

{ "properties": { "organization_id": { "description": "Only this organization (UUID).", "type": "string" }, "product_id": { "type": "string" }, "status": { "enum": [ "active", "expired", "revoked", "cancelled", "suspended", "refunded" ], "type": "string" }, "expiring_within_days": { "minimum": 1, "maximum": 400, "type": "integer" }, "customer_email": { "description": "Exact email; needs pii:read.", "type": "string" }, "cursor": { "type": "string" }, "limit": { "minimum": 1, "maximum": 100, "type": "integer" } }, "type": "object" }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" } }, "type": "object", "required": [ "as_of" ] }