---
title: "Get license summary"
method: GET
path: "/licenses/summary"
tags: ["Licenses"]
---

# Get license summary

`GET /licenses/summary`

## Request

- Base URL: `https://app.payna.com/api/v1`
- URL: `https://app.payna.com/api/v1/licenses/summary`
- Auth: HTTP bearer

Returns aggregate counts for all licenses. Lightweight endpoint suitable for health checks, dashboards, and startup checks. Use `renewing_30_days` to drive collection-blocking logic.

## Response `200`

Successful response.

- object
  - `data` LicenseSummary
    - `total` integer
    - `by_status` object: Count per core status.
    - `renewing_soon` integer: Active licenses with a renewal date within 90 days.
    - `renewing_30_days` integer: Active licenses with a renewal date within 30 days.
    - `expired` integer: Licenses with status=deficient and sub_status=expired.
    - `verified` integer: Licenses that Payna has verified with the regulator.
  - `meta` Meta
    - `total` integer
    - `page` integer
    - `limit` integer
    - `synced_at` string, date-time, nullable

## Other responses

- `401`: Unauthorized.
- `429`: Rate limit exceeded.
- `500`: Internal server error.

---

[API](https://skmtc.dev/payna/apis/payna-compliance-api.md) - [All operations](https://skmtc.dev/payna/apis/payna-compliance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payna/apis/payna-compliance-api/revisions/11ef1636c05a?raw)