For Developers

Licenses Overview

A License is the relationship between a Product and an Integration.

When a product is "shared" with an integration, a license is created to represent that relationship. This allows the developer and/or school to create rules which can license products to schools, classes, or people.

Each license includes usage counts for the number of schools, classes, and people that are assigned to the product through the integration.

Properties

PropertyTypeDescription
idstringThe UUID for the license.
product_idstringThe UUID of the licensed product.
integration_idstringThe UUID of the associated integration.
school_countnumberA count of the schools assigned a license.
class_countnumberA count of the classes assigned a license.
person_countnumberA count of the people assigned a license.

JSON Example

{
    "id": "eb023cdc-f69e-40ff-aeb6-b2e25b42ac4a",
    "product_id": "430171b5-8fd5-4bed-8bc1-d8a580f93d74",
    "integration_id": "2212144d-2ec7-46a1-84a0-355fca213e1d",
    "school_count": 0,
    "class_count": 4,
    "person_count": 12
}