Entitlements Overview
3 min
In the Nue Self-Service API, Entitlements represent services that customers are authorized to access. Entitlements are automatically created when orders containing service-based products are activated.
What Are Entitlements?
Entitlements are services that provide access to:
- Professional services (implementation, consulting)
- Support services (training, customer support)
- Service quotas (hours, incidents, usage limits)
Examples
Based on the actual product data:
Entitlements (productCategory: "ProfessionalServices" or "CustomerSupport"):
- Implementation Service (20 hours)
- Unlimited Online Training
Not Entitlements:
- USB Security Key (Asset - productCategory: "PhysicalGoods")
- Nue Platform (Subscription - productCategory: "RecurringServices")
How Entitlements Are Created
Entitlements are automatically created when:
- Orders are activated - Products with productCategory "ProfessionalServices" or "CustomerSupport" become entitlements
- Bundle orders are processed - Service components are automatically provisioned as entitlements
Important: Entitlements cannot be created individually - they are generated from subscriptions when orders contain service-related products.
Key Entitlement Fields
From the API response, entitlements contain:
- entitlementNumber - Unique identifier (UUID format)
- name - Service name (e.g., "Unlimited Online Training")
- status - Current state (Active, Pending, etc.)
- quantity - Service allocation (e.g., 4 units)
- startDate / endDate - Service period
- parentEntitlementObject - Always "Subscription"
- productCategory - "ProfessionalServices" or "CustomerSupport"
Common Use Cases
- Track service usage - Monitor consumption of professional services
- Manage service access - Control what services customers can use
- Bill for services - Calculate charges for consumed services
- Support operations - Understand what services customers are entitled to
Entitlements bridge the gap between purchased services and actual service delivery, enabling effective service management and billing.