## The subscription entitlement object

### Example

```
{
  "code": "seats",
  "name": "Number of seats",
  "description": "Number of users of the account",
  "privileges": [
    {
      "code": "max",
      "name": "Maximum",
      "value_type": "integer",
      "config": {},
      "value": 15,
      "plan_value": 10,
      "override_value": 15
    },
    {
      "code": "max_admins",
      "name": "Max Admins",
      "value_type": "integer",
      "config": {},
      "value": 5,
      "plan_value": 5,
      "override_value": null
    },
    {
      "code": "root",
      "name": "Allow root user",
      "value_type": "boolean",
      "config": {},
      "value": true,
      "plan_value": true,
      "override_value": null
    },
    {
      "code": "provider",
      "name": "SSO Provider",
      "value_type": "select",
      "value": "okta",
      "plan_value": "google",
      "override_value": "okta",
      "config": {
        "select_options": [
          "google",
          "okta"
        ]
      }
    }
  ],
  "overrides": {
    "max": 15,
    "provider": "okta"
  }
}
```

### Schema Attributes

#### code
- **Type**: string  
- **Required**: Yes  
- **Description**: Unique code used to identify the feature. Max 255 characters.  
- **Example**:  
  `"seats"`

#### name
- **Type**: string | null  
- **Required**: Yes  
- **Description**: Name of the feature. Max 255 characters.  
- **Example**:  
  `"Number of seats"`

#### description
- **Type**: string | null  
- **Required**: Yes  
- **Description**: Description of the feature. Max 600 characters.  
- **Example**:  
  `"Number of users of the account"`

#### privileges
- **Type**: object[]  
- **Required**: Yes  
- **Description**: Privileges associated with this feature. Each privilege shows the plan value and any subscription override.  
- **Example**: 
```
[
  {
    "code": "max",
    "name": "Maximum",
    "value_type": "integer",
    "config": {},
    "value": 15,
    "plan_value": 10,
    "override_value": 15
  },
  {
    "code": "max_admins",
    "name": "Max Admins",
    "value_type": "integer",
    "config": {},
    "value": 5,
    "plan_value": 5,
    "override_value": null
  },
  {
    "code": "root",
    "name": "Allow root user",
    "value_type": "boolean",
    "config": {},
    "value": true,
    "plan_value": true,
    "override_value": null
  },
  {
    "code": "provider",
    "name": "SSO Provider",
    "value_type": "select",
    "value": "okta",
    "plan_value": "google",
    "override_value": "okta",
    "config": { "select_options": ["google", "okta"] }
  }
]
```

#### overrides
- **Type**: object  
- **Required**: Yes  
- **Description**: Overrides for the privileges.  
- **Example**:  
```
{ "max": 15, "provider": "okta" }
```