# Entitlement

Entitlement management and license operations.

## Get Entitlements Utilization Summaries

 - [POST /entitlements/utilizations/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getsummary.md): Retrieve entitlement usage details. Usage summaries provide information on the number of entitlements used and active devices.

## Get Entitlements

 - [POST /entitlements/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getentitlements.md): Retrieves all purchased entitlements for the authenticated tenant. Purchased entitlements represent the licenses, subscriptions, and service rights that an organization has acquired through purchases, contracts, or promotions. Each entitlement includes details about the license type, stock keeping unit (SKU), quantity, effective dates, expiration dates, device compatibility, and current usage status. 

What constitutes a purchased entitlement: subscription licenses with defined quantities and terms, promotional licenses granted for trials or special offers, perpetual licenses with unlimited duration, device specific licenses (access points, switches, analytics), and feature specific entitlements (security, guest access, location services). 

Available filters: filter by license type (subscription, trial, promotional), device type (wifi, switch, analytics, edge), license status (active, expired, pending), date ranges (effective date, expiration date), and SKU identifiers. Supports pagination, sorting, and field selection to customize the response. 

Response: returns a paginated list of entitlement objects with license details, quantities, dates, usage metrics, and associated device types.

## Query License Mileage Report

 - [POST /entitlements/mileageReports/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/licensemileagereports.md): Mileage reports offer clear insights into how licenses have been consumed and released across different periods.

Request payload structure:
accepts a mileage request object containing:
- license type filters
- pagination parameters (page size, page number)

Available filters:
- filter by specific license types
- filter by date range (if applicable)
- additional filters based on business requirements

Response format:
returns a mileage response containing a list of mileage report entries.
each entry provides:
- monthly usage data
- breakdown of license increases and decreases
- key metrics reflecting license life cycle changes.

## Get Compliance

 - [POST /entitlements/compliances/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getcompliances.md): Retrieve detailed license availability reports that calculate how many licenses are currently available for assignment or consumption. This endpoint performs real-time calculations to determine remaining license capacity by analyzing purchased entitlements, active assignments, expired licenses, and reserved allocations. Availability reports are essential for capacity planning and preventing over allocation.

## Get Entitlements Banners

 - [POST /entitlements/banners/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getbanners.md): Retrieve entitlement banner data for display in the user interface. Banners are visual notifications that alert administrators about critical license conditions requiring attention. They provide information about entitlements that are either near their expiry or have expired, helping prevent service disruptions. Version application/vnd.ruckus.v1+JSON will be removed no sooner than 08/31/2026. application/JSON and application/vnd.ruckus.v1.1+JSON are now available.

## Query Availability Reports

 - [POST /entitlements/availabilityReports/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/licenseavailabilityreports.md): This endpoint allows you to query availability reports for entitlements.

## Query License Attention Notes

 - [POST /entitlements/attentionNotes/query](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/queryattentionnote.md): Queries license attention notes, which are alerts and notifications related to license status that require administrator attention. Attention notes are automatically generated for important license events such as upcoming change in licensing system.

## Update Entitlements

 - [PATCH /entitlements](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/syncentitlements.md): Synchronizes entitlements by triggering a refresh of license data from external licensing systems. This operation fetches the latest license purchases, renewals, and modifications, then updates the local entitlement cache to reflect current entitlements.

What is synchronized:  new license purchases, license quantity changes, expiration date updates, license type modifications, subscription renewals.

Prerequisites:  the tenant must have an active entitlement ID and at least one active subscription.

## Get Entitlement Usage Report

 - [GET /entitlements/licenseUsageReports](https://docs.ruckus.cloud/api/entitlement-0.2.0/entitlement/getusagereport.md): Get the entitlement usage report.