Appearance
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
userobject inGET /v1/activity-logsentries now only containsid,firstName,lastName, andemail.
October 2026
Changed
regDateis now optional onPOST /v1/licenses; if you leave it out, the registration date is the current server time.
September 2026
Added
- Entitlement objects now include a
productIdfield. An entitlement belongs to a product from the first time it is added to that product's plan. sort_byonGET /v1/licensesnow also supportsexpirationDate,plan.nameandplan.product.name, and accepts several sort keys at once.
Changed
- Breaking:
POST /v1/plan-entitlements,PUT /v1/plan-entitlements/plan-entitlement/{id}andPOST /v1/license-entitlements/plan/{planId}now return400if the entitlement belongs to a different product. - Breaking:
POST /v1/licensesnow returns400if the plan contains an entitlement owned by a different product. - When
previousLicenseIdis set onPOST /v1/licenses, the previous license must exist (otherwise404). The new license gets that license's customer, and is recorded as the previous license'snextLicenseId.
Fixed
- The
customerExternalIdfilter onGET /v1/licensesnow works withoutproductId. - 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
searchonGET /v1/licensesnow supportsplan.nameandcustomer.name.
Changed
- Breaking:
sort_byonGET /v1/licensesnow works only onregistrationDate; other sort fields are ignored. - Breaking: On
GET /v1/licenses,search[key](with a full license key) andsearch[customer.externalId]now need an exact match instead of a partial one.
April 2026
Added
- Customer objects now include a
createdtimestamp.
February 2026
Added
- New
GET /v1/licenses/activationendpoint. It finds a product's licenses by activation value and supportshideInvalidand 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+jsonbody 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
actualorthreshold.
November 2025
Changed
- Breaking:
GET /v1/activity-logsnow returns account-wide license activity, newest first. Each entry hasid,license,date,user,actionandvalue. Entries cover validations, activation checks, license updates and usage updates. - Breaking:
GET /v1/activity-logsno longer acceptslicenseEntitlementId. Filter withlicenseId,action,userId,startDateandendDateinstead. - 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
hideInvalidquery parameter onGET /v1/licensesleaves out invalid licenses.
Changed
- The path parameter for
/v1/license-entitlements/license-entitlement/{licenseEntitlementId}(GET, PUT and/refresh) is now namedlicenseEntitlementIdin the OpenAPI spec. The URLs themselves are unchanged.
July 2025
Fixed
PUT /v1/license-entitlements/license-entitlement/{id}now accepts decimal values foractualandthreshold.POST /v1/activations/activation/deleteis now documented as returning200 OK, which is what it returns.
April 2025
Added
- New
search(search[field]=value, case-insensitive partial match) andsort_by(field.asc/field.desc) query parameters on paginated list endpoints. - Customer objects now include
licenseCount.
Changed
POST /v1/licensesandPOST /v1/licenses/recreatenow return400when 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/recreatedendpoint 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'sactualandthreshold. - License objects now include
nextLicenseId. - New optional
keepActivationsfield onPOST /v1/licenses/recreatecopies activations to the new license (defaultfalse).
Changed
POST /v1/licenses/recreatenow returns400if the license has already been recreated.GET /v1/activity-logsnow returns the newest entries first.
Fixed
POST /v1/activationsnow 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
previousLicenseIdfield onPOST /v1/licenses.
Changed
- Breaking: When a license is invalid or over its limit,
POST /v1/licenses/license/validatenow returns400with the full validation object (includingvalid) instead of a text message. - When your account's subscription license is inactive, requests now return
Invalid license.with401(authenticated endpoints) or400(license-key endpoints) instead of429. thresholdonPOST /v1/license-entitlements/plan/{planId}can now be left out or set tonull.
Fixed
- The
validfield in thePOST /v1/licenses/license/validateresponse is now filled in.