---
title: "Get usage summary"
method: GET
path: "/usage/summary"
tags: ["Usage"]
---

# Get usage summary

`GET /usage/summary`

## Request

- Base URL: `https://api.faireplace.com/api`
- URL: `https://api.faireplace.com/api/usage/summary`
- Auth: HTTP bearer

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

```bash
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**:
```json
{
  "plan": "pro",
  "resources": [
    { "resource_type": "estate", "current": 5, "limit": 10, "remaining": 5 },
    { "resource_type": "signature", "current": 42, "limit": 100, "remaining": 58, "period": "monthly" }
  ]
}
```

## Query parameters

- `force_refresh` boolean

## Response `200`

The usage summary.

- UsageSummaryResponse: Summary of the tenant's plan and current resource usage.
  - `plan` string, required: Identifier of the tenant's current subscription plan.
  - `resources` ResourceUsage[], required: Per-resource usage entries.
    - `resource_type` 'estate' | 'lease_active' | 'signature' | 'media_storage_mb' | 'team_member' | 'export', required: Identifier of the metered resource. Common values include `estate`, `lease_active`, `signature`, `media_storage_mb`, `team_member` and `export`.
    - `current` integer, required: Current usage count for this resource.
    - `limit` integer, nullable: Maximum allowed for the current plan. `null` means unlimited.
    - `remaining` integer, nullable: Remaining quota (`limit - current`). `null` when the limit is unlimited.
    - `period` string, nullable: Reset period for the resource (e.g. `monthly`). Omitted when the resource is not periodic.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)