SoftwareLicense
/api/v1/licensesA software license your org holds.
listgetcreateupdateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| asset_id | uuid | UUID of the TechnologyAsset this license covers. Null when the license is tracked independently of a registered asset. |
| vendor | string | Name of the software vendor or publisher. |
| product_name | string | Full commercial name of the licensed software product. |
| product_sku | string | Vendor-assigned SKU or part number for this license product. |
| license_type | string | License model. 'concurrent' allows a pool of simultaneous users. 'named_user' is tied to specific individuals. 'site' covers an entire organization or location. |
| total_seats | number | Total number of licensed seats purchased. Null for unlimited or site-wide licenses. |
| used_seats | number | Number of seats currently assigned via active LicenseAssignment records. Computed by the platform. |
| available_seats | number | Number of seats available for assignment (totalSeats - usedSeats). Null when totalSeats is null. |
| cost | json | Financial cost information for this license. |
| purchase_date | date-time | Date the license was originally purchased or the subscription began. |
| expiry_date | date-time | Date the license expires. Null for open-source or licenses with no expiry. |
| renewal_date | date-time | Date on which this license is due for renewal. May differ from expiryDate due to renewal processing windows. |
| auto_renew | boolean | Whether this license is configured for automatic renewal with the vendor. |
| supplier_id | uuid | UUID of the vendor or supplier entity (if managed in cPod). Null when the vendor is tracked only by name. |
| contract_reference | string | Purchase order number, contract number, or procurement reference for this license agreement. |
| status | string | Current lifecycle status. 'expiring_soon' is set automatically when the renewal date is within 90 days. |
| compliance_status | string | License compliance posture. 'over_allocated' means usedSeats exceeds totalSeats. 'under_utilized' means utilization is below a configured threshold. |
| tags | json | Array of tag strings for grouping and filtering. |
| list_price | number | Vendor list price per seat or billing cycle before any discount is applied. |
| negotiated_discount | number | Percentage discount negotiated off the vendor list price (0–100). |
| cost_center_id | uuid | UUID of the CostCenter that funds this license. |
| contract_id | uuid | UUID of the Contract that governs this license agreement. |
API
client.licenses.*Loading manifest…