Appearance

License-entitlements ​

A License Entitlement object connects a License and an Entitlement. Its values are filled automatically during license creation, but you can update these after the fact for one-off changes to a license. The actual field holds the current usage.

Activations can be added to License Entitlements if their Entitlement's activationsEnabled parameter is set to true. When adding/removing/deactivating an Entry, the value of the actual field is also updated to reflect the number of active Activations in the License Entitlement. The threshold is also imposed on Activations, so you cannot add more entries than the License Entitlement's threshold allows.

Add a new license-entitlement to all licenses in a Plan ​

Endpoint: POST https://api.software-licensing.io/v1/license-entitlements/plan/{planId}

RequestBody ​

ts
{
  entitlementId?: string
  threshold?: number
}

Responses ​

  • 204

Get a license-entitlement ​

Endpoint: GET https://api.software-licensing.io/v1/license-entitlements/license-entitlement/{id}

Responses ​

  • 200 Success

application/json

ts
{
  id: string
  entitlement: {
    id: string
    name: string
    consumptionPeriod: {
      id: string
      name: string
    }
    activationsEnabled: boolean
    deactivated: boolean
  }
  threshold?: number
  actual: number
  refreshDate: string
  activations: {
    id: string
    value: string
    active: boolean
  }[]
}

Change a license-entitlement's threshold ​

Endpoint: PUT https://api.software-licensing.io/v1/license-entitlements/license-entitlement/{id}

RequestBody ​

ts
{
  actual?: integer
  threshold?: integer
}

Responses ​

  • 204

Get all license-entitlements in a license ​

Endpoint: GET https://api.software-licensing.io/v1/license-entitlements

Parameters(Query) ​

ts
licenseId?: string

Responses ​

  • 200 Success

application/json

ts
{
  id: string
  entitlement: {
    id: string
    name: string
    consumptionPeriod: {
      id: string
      name: string
    }
    activationsEnabled: boolean
    deactivated: boolean
  }
  threshold?: number
  actual: number
  refreshDate: string
  activations: {
    id: string
    value: string
    active: boolean
  }[]
}[]

Manually refresh a license-entitlement ​

Endpoint: PUT https://api.software-licensing.io/v1/license-entitlements/license-entitlement/{id}/refresh

Responses ​

  • 204