Returns the tenant's current subscription plan and per-resource usage against plan limits.

Resources

Each entry reports current usage and, where applicable, the limit and remaining quota. A null limit (and remaining) means the resource is unlimited on the current plan.

Cache

Plan data is cached. Pass force_refresh=true to invalidate the cache and fetch fresh plan limits.

Usage Example

curl -X GET "https://api.faireplace.com/api/usage/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Force a fresh fetch
curl -X GET "https://api.faireplace.com/api/usage/summary?force_refresh=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "plan": "pro",
  "resources": [
    { "resource_type": "estate", "current": 5, "limit": 10, "remaining": 5 },
    { "resource_type": "signature", "current": 42, "limit": 100, "remaining": 58, "period": "monthly" }
  ]
}

{
  "plan": "pro",
  "resources": [
    {
      "resource_type": "signature",
      "current": 42,
      "limit": 100,
      "remaining": 58,
      "period": "monthly"
    }
  ]
}