Guides and Examples
...
Entitlements
Entitlements Overview
6 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