# EntitlementResponse

## Example Usage

```typescript
import { EntitlementResponse } from "@flexprice/sdk/sdk/models";

let value: EntitlementResponse = {
  addon: {
    prices: [
      {
        addon: {},
        meter: {
          createdAt: new Date("2024-03-20T15:04:05Z"),
          eventName: "api_request",
          id: "550e8400-e29b-41d4-a716-446655440000",
          name: "API Usage Meter",
          status: "published",
          tenantId: "tenant123",
          updatedAt: new Date("2024-03-20T15:04:05Z"),
        },
        plan: {},
      },
    ],
  },
  feature: {
    meter: {
      createdAt: new Date("2024-03-20T15:04:05Z"),
      eventName: "api_request",
      id: "550e8400-e29b-41d4-a716-446655440000",
      name: "API Usage Meter",
      status: "published",
      tenantId: "tenant123",
      updatedAt: new Date("2024-03-20T15:04:05Z"),
    },
  },
  plan: {},
};
```

## Fields

| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `addon`                                                                                                | [models.AddonResponse](../../sdk/models/addon-response.md)                                             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `aggregationMode`                                                                                      | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `configValue`                                                                                          | Record<string, *any*>                                                                                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `createdAt`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `createdBy`                                                                                            | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `displayOrder`                                                                                         | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `endDate`                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `entityId`                                                                                             | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `entityType`                                                                                           | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                            | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `environmentId`                                                                                        | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `feature`                                                                                              | [models.FeatureResponse](../../sdk/models/feature-response.md)                                         | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `featureId`                                                                                            | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `featureType`                                                                                          | [models.FeatureType](../../sdk/models/feature-type.md)                                                 | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `grantAllocationBehavior`                                                                              | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `grantDurationUnit`                                                                                    | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `grantDurationValue`                                                                                   | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `grantMeasure`                                                                                         | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)                        | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `grantQuota`                                                                                           | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `id`                                                                                                   | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `isEnabled`                                                                                            | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `isSoftLimit`                                                                                          | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `parentEntitlementId`                                                                                  | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `plan`                                                                                                 | [models.PlanResponse](../../sdk/models/plan-response.md)                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `planId`                                                                                               | *string*                                                                                               | :heavy_minus_sign:                                                                                     | TODO: Remove this once we have a proper entitlement entity type                                        |
| `startDate`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `staticValue`                                                                                          | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `status`                                                                                               | [models.Status](../../sdk/models/status.md)                                                            | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `tenantId`                                                                                             | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `updatedAt`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `updatedBy`                                                                                            | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `usageLimit`                                                                                           | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
| `usageResetPeriod`                                                                                     | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |