CustomLicenseTypes.json File

File Structure

The CustomLicenseTypes.json file contains definitions of recurring licenses and add-on recurring licenses. Every recurring license or add-on recurring license is represented as a JSON object with the following properties:

  • name: The name of this recurring license or add-on recurring license.
  • provisioning_id: The provisioning identifier of this recurring license or add-on recurring license.
  • offerId: The offer identifier of this recurring license or add-on recurring license.
  • trialOfferId: The trial offer identifier of this recurring license. If this is set to null, this means that this recurring license does not support the ability to try it for free.
  • imFederatedID: Reserved for future use.
  • isAddon: This property defines whether this JSON object defines an add-on recurring license (true or false). If this property is absent, this means that this JSON object defines a recurring license.
  • description: The description of this recurring license or add-on recurring license.
  • possibleParents: The list of parent recurring licenses of this add-on recurring license (the property is present for only add-on recurring licenses). The list is represented as a JSON array and consists of identifiers of parent recurring licenses.
  • isUserSpecific: This property defines if this recurring license or add-on recurring license can be assigned to users (true or false).
  • possibleTransitions: The list of upgrades of this recurring license. The list is represented as a JSON array and consists of identifiers of recurring licenses.
  • prices: The list of the recommended prices of this recurring license or add-on recurring license for various currencies. The list is represented as a JSON array; each item of this array is a JSON object with the following properties:

    • currency: The name of a currency.
    • price: The recommended price for the currency.
  • Measure: The unit of measure of this recurring license or add-on recurring license (License or GB).
  • multiplier: The multiplier of this add-on recurring license (1048576 for the GB UOM, 1 for the Lincese UOM). The property is present for only add-on recurring licenses.

    Note: As of application version 19.3, this property is obsolete. It is ignored if specified.

  • ResourceCategory: The internal name of a resource category to which this recurring license or add-on recurring license belongs. Internal names are used only in these .json files.
  • possibleConflicts: The list of recurring licenses which are incompatible with this recurring license. The list is represented as a JSON array and consists of identifiers of recurring licenses.
  • points: Reserved for future use.
  • maximum: The maximum limit of this recurring license or add-on recurring license (Max Amount in resource rates).

The 'Office 365 Business Premium' Recurring License

For instance, the Office 365 Business Premium recurring license is defined in the following way (some information was omitted for simplicity):

Copy
{

        "name": "Office 365  Business Premium",

        "provisioning_id": "O365_BUSINESS_PREMIUM",

        "offerId": "031c9e47-4802-4248-838e-778fb1d2cc05",

        "trialOfferId": "c0bd2e08-11ac-4836-bdc7-3712e744922f",

        "imFederatedID": "MS_CSP_BUSINESS_PREMIUM",

        "isAddon": false,

        "description": "All the features of Business Essentials and Business in one integrated plan",

        "isUserSpecific": true,

        "possibleTransitions": [],

        "prices": [{

                "currency": "USD",

                "price": 12.5000

        }],

        "Measure": "License",

        "ResourceCategory": "XL",

        "possibleConflicts": [],

        "points": 7,

        "maximum": 300

}

The following license type is created based on this definition:

Office 365 Business Premium

  • License Name: Office 365 Business Premium
  • Offer ID: 031c9e47-4802-4248-838e-778fb1d2cc05
  • Trial Offer ID: c0bd2e08-11ac-4836-bdc7-3712e744922f
  • Provisioning ID: O365_BUSINESS_PREMIUM
  • Can be assigned to users: Yes
  • Possible upgrades: empty

Also, the following resource type (resource) is created based on this definition:

Office 365 Business Premium

  • License type instance: Office 365 Business Premium

The created resource is added to the Additional Licenses resource category. The unit of measure of the resource is set to License.

The 'Office 365 Extra File Storage' Add-on Recurring License

For instance, the Office 365 Extra File Storage add-on recurring license is defined in the following way (some information was omitted for simplicity):

Copy
{

        "name": "Office 365  Extra File Storage",

        "provisioning_id": "SHAREPOINTSTORAGE",

        "offerId": "53fc25f7-6639-4f78-bb44-3c2dfec3ed40",

        "trialOfferId": null,

        "imFederatedID": "MS_CSP_EXTRA_FILE_STORAGE",

        "isAddon": true,

        "description": "Priced per gigabyte, Office 365 offers additional file storage options to support an organization\u2019s file growth.",

        "possibleParents": ["031c9e47-4802-4248-838e-778fb1d2cc05"],

        "isUserSpecific": false,

        "possibleTransitions": [],

        "prices": [{

                "currency": "USD",

                "price": 0.2000

        }],

        "Measure": "GB",

        "multiplier": 1048576,

        "ResourceCategory": "XS",

        "possibleConflicts": [],

        "points": 0,

        "maximum": 10000000

}

The following add-on type is created based on this definition:

Office 365 Extra File Storage

  • Add-on Name: Office 365 Extra File Storage
  • Offer ID: 53fc25f7-6639-4f78-bb44-3c2dfec3ed40
  • Provisioning ID: SHAREPOINTSTORAGE
  • Can be assigned to users: No
  • Possible parent recurring licenses: Office 365 Business Premium

Also, the following resource type (resource) is created based on this definition:

Office 365 Extra File Storage

  • Add-on type instance: Office 365 Extra File Storage

The created resource is added to the Extra Storage resource category. The unit of measure of the resource is set to GB.