> ## 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.

# Update plan entitlement

> Updates only the `details` (value, reset, hardLimit, rollover, etc.) of one feature entitlement on the plan. A new draft version is created if the latest is published.



## OpenAPI

````yaml /api-reference/openapi.json patch /catalog/plans/{identifier}/features/{feature_id}/
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/{feature_id}/:
    parameters:
      - name: identifier
        in: path
        required: true
        description: Plan identifier.
        example: pro-monthly
        schema:
          type: string
      - name: feature_id
        in: path
        required: true
        description: Feature identifier (slug, not UUID).
        example: api-calls
        schema:
          type: string
    patch:
      tags:
        - Plan Entitlements
      summary: Update plan entitlement
      description: >-
        Updates only the `details` (value, reset, hardLimit, rollover, etc.) of
        one feature entitlement on the plan. A new draft version is created if
        the latest is published.
      operationId: updateCatalogPlanFeature
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanFeaturePatchRequest'
      responses:
        '200':
          description: Entitlement updated.
          content:
            application/json:
              example:
                details:
                  value: 20000
                  hasUnlimitedUsage: false
        '401':
          description: Unauthorized — missing or invalid API key
      security:
        - bearerAuth: []
components:
  schemas:
    PlanFeaturePatchRequest:
      type: object
      required:
        - details
      description: Updates only the entitlement `details` for a single feature on the plan.
      properties:
        details:
          $ref: '#/components/schemas/PlanEntitlementDetails'
    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__'

````