For Developers

Shared Products Overview

A Shared Product represents an application product or tier licensed to a specific integration. Developers share products with integrations to enforce license limits, soft caps, and hard caps across schools.

Properties

PropertyTypeDescription
idUUIDProduct identifier.
nameStringProduct name.
codeStringProduct SKU or code.
soft_capNumberWarning threshold for licensed seat counts.
hard_capNumberStrict ceiling for licensed seat counts.
application_idUUIDApplication that owns the product catalog entry.

JSON Example

{
    "id": "e891024b-3211-479c-9c3f-918239023412",
    "name": "Math Mastery Suite - Grade 6-8",
    "code": "MMS-G68",
    "soft_cap": 500,
    "hard_cap": 550,
    "application_id": "4b7b2520-410a-4bf3-9118-2e11893c5289"
}