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

# Create an entitlement definition

> Creates a new entitlement definition for the authenticated project.



## OpenAPI

````yaml /api-reference/rest-api-v4.yaml post /entitlements
openapi: 3.0.3
info:
  title: Qonversion REST API v4
  version: '4.0'
  description: >-
    Qonversion REST API v4 follows REST standards. It has predictable
    resource-oriented URLs, accepts JSON-encoded request bodies, returns
    JSON-encoded responses, and uses standard HTTP response codes,
    authentication, and verbs.
servers:
  - url: https://api.qonversion.io/v4
    description: Production
security:
  - secretAuth: []
tags:
  - name: Users
    description: Retrieve Qonversion users
  - name: User Properties
    description: Manage user-level attributes
  - name: Identities
    description: Link Qonversion users to your own auth IDs
  - name: Entitlements
    description: Entitlement definitions and user grants
  - name: Purchases
    description: A user's purchase history
  - name: Products
    description: Products configured in the Qonversion dashboard
  - name: Customers
    description: Aggregated customer records, properties, permissions, and metrics
  - name: Segments
    description: Dynamic and system segments of users
  - name: Experiments
    description: Paywall and offering A/B experiments
  - name: Screens
    description: No-code paywall screens — CRUD, publish, analytics
  - name: Analytics
    description: Charts, cards, cohorts, LTV, and insights
  - name: Exports
    description: Asynchronous data exports
  - name: Events
    description: Event catalog
  - name: Scheduled Reports
    description: Recurring reports delivered to external destinations
  - name: Integrations
    description: Third-party integrations configuration
  - name: Automations
    description: Event-driven automations
  - name: Project Settings
    description: Project-level configuration, secret, and store credentials
paths:
  /entitlements:
    post:
      tags:
        - Entitlements
      summary: Create an entitlement definition
      description: Creates a new entitlement definition for the authenticated project.
      operationId: v4CreateEntitlement
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V4EntitlementDefinitionCreate'
      responses:
        '201':
          description: Created entitlement definition.
          headers:
            Location:
              schema:
                type: string
              description: Canonical URL of the created entitlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4EntitlementDefinition'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '409':
          description: Entitlement already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '415':
          description: Unsupported Content-Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
      security:
        - secretAuth: []
components:
  schemas:
    V4EntitlementDefinitionCreate:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique entitlement identifier.
          example: premium
        description:
          type: string
          nullable: true
          description: Human-readable description of the entitlement.
          example: Premium access entitlement
        product_ids:
          type: array
          nullable: true
          description: List of product IDs to associate with this entitlement.
          items:
            type: string
          example:
            - premium_monthly
            - premium_annual
    V4EntitlementDefinition:
      type: object
      required:
        - object
        - id
        - url
        - created_at
        - updated_at
      properties:
        object:
          type: string
          enum:
            - entitlement
        id:
          type: string
          description: Unique entitlement identifier.
          example: premium
        url:
          type: string
          description: Canonical API path.
          example: /v4/entitlements/premium
        description:
          type: string
          nullable: true
          description: Human-readable description of the entitlement.
          example: Premium access entitlement
        product_ids:
          type: array
          nullable: true
          description: List of product IDs associated with this entitlement.
          items:
            type: string
          example:
            - premium_monthly
            - premium_annual
        created_at:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601 UTC).
          example: '2025-09-15T12:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601 UTC).
          example: '2025-11-03T10:26:40Z'
    V4Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
            code:
              type: string
              description: |
                Machine-readable snake_case error code. Examples include
                `invalid_data`, `invalid_request`, `invalid_product_id`,
                `not_found`, `already_exists`, `offering_already_exists`,
                `product_not_in_project`, `cannot_set_main_directly`,
                `cannot_demote_main`, `cannot_patch_experiment_variant`,
                `cannot_delete_experiment_variant`, and
                `cannot_setmain_experiment_variant`. Resource-specific codes
                are documented on the corresponding reference page.
            message:
              type: string
              description: Human-readable description. May change; do not parse.
            details:
              type: array
              nullable: true
              description: Per-field validation errors, present on 400 validation failures.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  securitySchemes:
    secretAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_…
      description: >-
        Bearer authentication using the project **Secret Key** (prefixed with
        `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the
        Secret Key — see [Authentication](/reference/v4/authentication). Never
        expose the Secret Key in client-side code.

````