> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kelviq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List plan entitlements

> Returns the feature entitlements (with per-entitlement `details`) configured on the plan.



## OpenAPI

````yaml /api-reference/openapi.json get /catalog/plans/{identifier}/features/
openapi: 3.0.0
info:
  title: kelviq API
  version: 1.0.0
  description: >-
    API for interacting with kelviq services, derived from Python SDK
    documentation.
servers:
  - url: https://api.kelviq.com/api/v1
    description: kelviq API Server (General - specific operations might override)
security:
  - bearerAuth: []
tags:
  - name: Products
    description: Catalog products.
  - name: Product Settings
    description: Per-product settings (currency, VPN/Tor/proxy, product URL).
  - name: Product Files
    description: Product images and downloadable assets.
  - name: Features
    description: Catalog features that can be granted as plan entitlements.
  - name: Plans
    description: Catalog plans (CRUD, publish, versions, prices).
  - name: Plan Entitlements
    description: Feature entitlements attached to a plan.
  - name: Plan Files
    description: Files attached to plans, and signed download links.
  - name: Media
    description: Generate presigned S3 upload URLs for product/plan images and files.
  - name: Partner
    description: Partner integration APIs (organization provisioning, lookup).
  - name: Charges
    description: >-
      One-time payments charged immediately against a customer's default payment
      method.
paths:
  /catalog/plans/{identifier}/features/:
    parameters:
      - name: identifier
        in: path
        required: true
        description: Plan identifier.
        example: pro-monthly
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: Plan version to scope the listing to (GET only).
        example: 2
        schema:
          type: integer
    get:
      tags:
        - Plan Entitlements
      summary: List plan entitlements
      description: >-
        Returns the feature entitlements (with per-entitlement `details`)
        configured on the plan.
      operationId: listCatalogPlanFeatures
      responses:
        '200':
          description: Paginated list of entitlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPlanFeatureEntitlements'
        '401':
          description: Unauthorized — missing or invalid API key
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedPlanFeatureEntitlements:
      type: object
      properties:
        count:
          type: integer
          example: 2
        next:
          type: string
          nullable: true
          example: null
        previous:
          type: string
          nullable: true
          example: null
        results:
          type: array
          items:
            $ref: '#/components/schemas/PlanFeatureEntitlement'
    PlanFeatureEntitlement:
      type: object
      properties:
        feature:
          $ref: '#/components/schemas/CatalogFeature'
        details:
          $ref: '#/components/schemas/PlanEntitlementDetails'
    CatalogFeature:
      type: object
      description: A feature that can be granted as an entitlement on a plan.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01
        identifier:
          type: string
          description: URL-safe slug, auto-generated from name if not provided.
          example: api-calls
        name:
          type: string
          example: API Calls
        description:
          type: string
          example: Number of API calls per billing cycle.
        featureType:
          type: string
          enum:
            - BOOLEAN
            - CUSTOMIZABLE
            - METER
          description: >-
            BOOLEAN: on/off flag. CUSTOMIZABLE: numeric limit. METER:
            usage-based metering.
          example: METER
        featureDetails:
          type: object
          description: >-
            Configuration for the feature. For METER features, expects
            `featureSubType` (PRE_AGGREGATED_USAGE or RAW_EVENTS), `units`, and
            optionally `customerUnit` for unit conversion.
          additionalProperties: true
          example:
            featureSubType: PRE_AGGREGATED_USAGE
            units:
              singular: call
              plural: calls
        meter:
          type: object
          description: >-
            For RAW_EVENTS meter features: an object with `aggregation`
            (function, field) and `filters`.
          additionalProperties: true
          example: {}
        details:
          type: object
          readOnly: true
          additionalProperties: true
          example: {}
        metadata:
          type: object
          additionalProperties: true
          example:
            category: core
        isArchived:
          type: boolean
          readOnly: true
          example: false
        modifiedOn:
          type: string
          format: date-time
          readOnly: true
          example: '2025-04-12T08:21:14.910Z'
    PlanEntitlementDetails:
      type: object
      description: >-
        Per-feature entitlement configuration on a plan. Shape varies by
        feature_type.
      additionalProperties: true
      properties:
        value:
          description: 'For BOOLEAN: a boolean. For CUSTOMIZABLE / METER: a number.'
          example: 10000
        hasUnlimitedUsage:
          type: boolean
          example: false
        reset:
          type: string
          enum:
            - NEVER
            - EVERY_DAY
            - EVERY_MONTH
            - EVERY_QUARTER
            - EVERY_YEAR
          example: EVERY_MONTH
        resetTime:
          type: string
          nullable: true
          example: BEGINNING_OF_PERIOD
        rollover:
          type: object
          additionalProperties: true
          example: {}
        usageAlerts:
          type: object
          description: >-
            Optional usage-alert configuration for this entitlement.
            `thresholdType` is `PERCENTAGE` (thresholds are 1-100) or `BALANCE`
            (thresholds are absolute usage values).
          properties:
            enabled:
              type: boolean
              example: true
            thresholds:
              type: array
              items:
                type: number
              example:
                - 75
                - 90
            thresholdType:
              type: string
              enum:
                - PERCENTAGE
                - BALANCE
              example: PERCENTAGE
          example:
            enabled: true
            thresholds:
              - 75
              - 90
            thresholdType: PERCENTAGE
        hardLimit:
          type: boolean
          example: false
        isInherited:
          type: boolean
          example: false
        isValueOverridden:
          type: boolean
          example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Server API Key obtained from the kelviq application. Pass as a
        Bearer token in the Authorization header. Example: 'Authorization:
        Bearer __YOUR_API_KEY__'

````