LicenseForge Developer REST API Reference

LicenseForge REST API Reference

Reference documentation for developers integrating entitlement, usage metering, activation, and provisioning workflows into their applications.

These references are generated from the OpenAPI specifications deployed with each LicenseForge service.

API specification

Open a rendered reference or download its OpenAPI document for SDK generation, request validation, and integration automation.

Entitlement API

Contracts, activations, assignees, subscriptions, and product catalogue.

Usage API

Usage plans, activity reporting, consumption, and balances.

Orchestration API

Provisioning and entitlement workflow orchestration.

Before you begin

  • Choose a service. Use Entitlement for license lifecycle operations, Usage for metering, and Orchestration for multi-step workflows.
  • Configure access. Obtain the service base URL and credentials for the target environment before sending requests.
  • Review schemas. Confirm required identifiers, request bodies, response models, and error responses in the relevant reference.

Organization

Each API reference provides resource navigation on the left, endpoint descriptions and request schemas in the center, and response examples on the right. Operations are grouped by their OpenAPI tags.

API explorer

The rendered references are read-only Redoc views. Use the downloadable OpenAPI files with an OpenAPI-compatible client when you need interactive requests or generated SDKs. Requests made against a live environment can change production data.