# Entitlement REST API Changelog

All notable changes to the Entitlement REST API and related documentation will be documented in this file.

BETA Version
The Entitlement REST API is currently in its beta version and remains under active development. As such, it is not yet fully optimized, and may undergo significant changes or enhancements. Revenera strongly advises against using this API in production environments.

## 2026.09 Release [BETA]

### New API Endpoints

The following email APIs have been introduced to simplify entitlement communication workflows:

- **POST** `/v1/entitlements/line-items/{activationId}/email` sends an activation notification email for an existing line item.
- **POST** `/v1/entitlements/{entitlementId}/email` sends an entitlement notification email for an existing entitlement.


### Miscellaneous Changes

- **Improved Error Handling and Validation**—Improved API validation and error responses for invalid entitlement identifiers and malformed filter parameters to return more meaningful client-facing messages instead of internal server errors.
- **Support for Rate Table Series**—Added support for specifying `RATE_TABLE_SERIES` when creating Dynamic Monetization entitlements through REST APIs, enabling parity with Dynamic Monetization entitlement requirements.
- **Payload Schema Improvements**—Updated the entitlement creation payload schema by renaming the `product` array to `products` to improve consistency and better represent support for multiple associated products.
- **Multiple Product Support in Line Items**—Enhanced line-item APIs to allow association of multiple products within a single line item, reducing the need for multiple entitlement creation requests and enabling bundled product offerings.
- **Multiple Suite Support in Line Items**—Enhanced entitlement line-item APIs to support associating multiple suites with a single line item while maintaining backward compatibility with existing payload formats.


## 2025.12 Release [BETA]

Added endpoint:

- Updated pattern for `entitlementId` when creating a simple entitlement
- Updated pattern for `activationId` when creating a line item
- `product` is no longer a required object in the `lineItems` array when creating a simple entitlement or line item
- Added the optional `partNumber` object to the `lineItems` array when creating a simple entitlement


## 2025.07 Release [BETA]

Added entitlement and line-item management capabilities. The following endpoints were introduced:

- **POST** `/entitlement/{entitlementId}/maintenance-line-items`
- **POST** `/entitlement`
- **GET** `/entitlement/{entitlementId}/line-items`
- **POST** `/entitlement/{entitlementId}/line-items`
- **PATCH** `/entitlement/{entitlementId}/line-items/{activationId}/policies`
- **PATCH** `/entitlement/{entitlementId}/additional-properties`


## 2025.04 Release [BETA]

Initial version of the Entitlement REST API Reference