Skip to content

Changelog ​

Changes to the Licensing API that affect integrations, newest first. Changes that may require you to update your integration are marked Breaking. See Versioning for what counts as a compatible change.

November 2026 ​

Added ​

  • The OpenAPI spec and a Postman collection are now published with the documentation.
  • The reference now shows, for every endpoint, whether it needs an access token, which permission it needs, and which errors it can return.

Changed ​

  • Breaking: The user object in GET /v1/activity-logs entries now only contains id, firstName, lastName, and email.

October 2026 ​

Changed ​

  • regDate is now optional on POST /v1/licenses; if you leave it out, the registration date is the current server time.

September 2026 ​

Added ​

  • Entitlement objects now include a productId field. An entitlement belongs to a product from the first time it is added to that product's plan.
  • sort_by on GET /v1/licenses now also supports expirationDate, plan.name and plan.product.name, and accepts several sort keys at once.

Changed ​

  • Breaking: POST /v1/plan-entitlements, PUT /v1/plan-entitlements/plan-entitlement/{id} and POST /v1/license-entitlements/plan/{planId} now return 400 if the entitlement belongs to a different product.
  • Breaking: POST /v1/licenses now returns 400 if the plan contains an entitlement owned by a different product.
  • When previousLicenseId is set on POST /v1/licenses, the previous license must exist (otherwise 404). The new license gets that license's customer, and is recorded as the previous license's nextLicenseId.

Fixed ​

  • The customerExternalId filter on GET /v1/licenses now works without productId.
  • A failed DELETE /v1/entitlements/entitlement/{id} (not found, or still in use) no longer lowers your account's entitlement usage count.

July 2026 ​

Added ​

  • search on GET /v1/licenses now supports plan.name and customer.name.

Changed ​

  • Breaking: sort_by on GET /v1/licenses now works only on registrationDate; other sort fields are ignored.
  • Breaking: On GET /v1/licenses, search[key] (with a full license key) and search[customer.externalId] now need an exact match instead of a partial one.

April 2026 ​

Added ​

  • Customer objects now include a created timestamp.

February 2026 ​

Added ​

  • New GET /v1/licenses/activation endpoint. It finds a product's licenses by activation value and supports hideInvalid and pagination.

Changed ​

  • All API requests are now rate limited to 20 per second and 200 per minute, both per IP address and per access token. Requests over the limit get 429 Too Many Requests.
  • Request-validation errors now return a sanitized application/problem+json body that no longer includes internal type details.

January 2026 ​

Added ​

  • The activity log now records activation creation, activation status changes, activation deletion, and changes to a license-entitlement's actual or threshold.

November 2025 ​

Changed ​

  • Breaking: GET /v1/activity-logs now returns account-wide license activity, newest first. Each entry has id, license, date, user, action and value. Entries cover validations, activation checks, license updates and usage updates.
  • Breaking: GET /v1/activity-logs no longer accepts licenseEntitlementId. Filter with licenseId, action, userId, startDate and endDate instead.
  • Unexpected server errors in production no longer return detailed exception pages.

Removed ​

  • Breaking: DELETE /v1/licenses/license/{id} is no longer available.
  • Swagger UI and the OpenAPI document are no longer served from the production API host; use the OpenAPI spec on this site instead.

August 2025 ​

Added ​

  • New hideInvalid query parameter on GET /v1/licenses leaves out invalid licenses.

Changed ​

  • The path parameter for /v1/license-entitlements/license-entitlement/{licenseEntitlementId} (GET, PUT and /refresh) is now named licenseEntitlementId in the OpenAPI spec. The URLs themselves are unchanged.

July 2025 ​

Fixed ​

  • PUT /v1/license-entitlements/license-entitlement/{id} now accepts decimal values for actual and threshold.
  • POST /v1/activations/activation/delete is now documented as returning 200 OK, which is what it returns.

April 2025 ​

Added ​

  • New search (search[field]=value, case-insensitive partial match) and sort_by (field.asc / field.desc) query parameters on paginated list endpoints.
  • Customer objects now include licenseCount.

Changed ​

  • POST /v1/licenses and POST /v1/licenses/recreate now return 400 when the plan or its product is deactivated.

Fixed ​

  • Requests that fail no longer count towards your account's product, plan or entitlement usage limits.

March 2025 ​

Added ​

  • New POST /v1/licenses/license/recreated endpoint returns the latest license key in a renewal chain. It works for up to 10 days after the original license ended.
  • New PUT /v1/license-entitlements/license-entitlement/{id} endpoint updates a license-entitlement's actual and threshold.
  • License objects now include nextLicenseId.
  • New optional keepActivations field on POST /v1/licenses/recreate copies activations to the new license (default false).

Changed ​

  • POST /v1/licenses/recreate now returns 400 if the license has already been recreated.
  • GET /v1/activity-logs now returns the newest entries first.

Fixed ​

  • POST /v1/activations now works with only a license key and no access token.
  • License-entitlement lookups and refreshes now only return or affect license-entitlements in your own account.

January 2025 ​

Added ​

  • New optional previousLicenseId field on POST /v1/licenses.

Changed ​

  • Breaking: When a license is invalid or over its limit, POST /v1/licenses/license/validate now returns 400 with the full validation object (including valid) instead of a text message.
  • When your account's subscription license is inactive, requests now return Invalid license. with 401 (authenticated endpoints) or 400 (license-key endpoints) instead of 429.
  • threshold on POST /v1/license-entitlements/plan/{planId} can now be left out or set to null.

Fixed ​

  • The valid field in the POST /v1/licenses/license/validate response is now filled in.