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

# List add-on entitlements



## OpenAPI

````yaml https://api.meteroid.com/api-docs/openapi.json get /api/v1/addons/{addon_id}/entitlements
openapi: 3.1.0
info:
  title: meteroid
  description: ''
  license:
    name: LicenseRef-Proprietary
    identifier: LicenseRef-Proprietary
  version: 0.1.0
servers: []
security: []
tags:
  - name: Meteroid
    description: Meteroid API
  - name: Add-ons
  - name: Batch Jobs
  - name: Checkout Sessions
  - name: Connect
    description: Manage connected accounts (Express & Standard)
  - name: Coupons
  - name: Credit Notes
  - name: Customers
  - name: Entitlements
  - name: Events
  - name: Features
  - name: Invoices
  - name: Metrics
  - name: OAuth
    description: OAuth 2.0 token endpoints (public, client-credentials auth)
  - name: OAuth Apps
    description: Manage OAuth applications for Connect integrations
  - name: Plans
  - name: Product Families
  - name: Products
  - name: Subscriptions
  - name: Usage
paths:
  /api/v1/addons/{addon_id}/entitlements:
    get:
      tags:
        - Add-ons
        - Entitlements
      summary: List add-on entitlements
      operationId: list_add_on_entitlements
      parameters:
        - name: addon_id
          in: path
          description: Add-on ID
          required: true
          schema:
            $ref: '#/components/schemas/AddOnId'
      responses:
        '200':
          description: Resolved entitlements for this add-on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResolvedEntitlementListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '404':
          description: Add-on not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    AddOnId:
      type: string
      format: MeteroidId
      examples:
        - add_7n42DGM5Tflk9n8mt7Fhc7
    ResolvedEntitlementListResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResolvedEntitlement'
    RestErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
    ResolvedEntitlement:
      type: object
      description: >-
        Merged entitlement value for a feature across the priority hierarchy,
        without usage data.
      required:
        - feature
        - value
      properties:
        feature:
          $ref: '#/components/schemas/FeatureRef'
        value:
          $ref: '#/components/schemas/ResolvedEntitlementValue'
    ErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - NOT_FOUND
        - CONFLICT
        - FORBIDDEN
        - UNAUTHORIZED
        - TOO_MANY_REQUESTS
        - INTERNAL_SERVER_ERROR
    FeatureRef:
      type: object
      required:
        - id
        - name
      properties:
        id:
          $ref: '#/components/schemas/FeatureId'
        name:
          type: string
        product:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ProductRef'
    ResolvedEntitlementValue:
      oneOf:
        - $ref: '#/components/schemas/BooleanResolvedEntitlementValue'
        - $ref: '#/components/schemas/MeteredResolvedEntitlementValue'
      discriminator:
        propertyName: type
        mapping:
          BOOLEAN:
            $ref: '#/components/schemas/BooleanResolvedEntitlementValue'
          METERED:
            $ref: '#/components/schemas/MeteredResolvedEntitlementValue'
    FeatureId:
      type: string
      format: MeteroidId
      examples:
        - feat_7n42DGM5Tflk9n8mt7Fhc7
    ProductRef:
      oneOf:
        - $ref: '#/components/schemas/ExistingProductRef'
        - $ref: '#/components/schemas/NewProductRef'
      discriminator:
        propertyName: type
        mapping:
          EXISTING:
            $ref: '#/components/schemas/ExistingProductRef'
          NEW:
            $ref: '#/components/schemas/NewProductRef'
    BooleanResolvedEntitlementValue:
      type: object
      required:
        - enabled
      properties:
        enabled:
          type: boolean
    MeteredResolvedEntitlementValue:
      type: object
      required:
        - metric_id
        - reset_period
        - enabled
      properties:
        enabled:
          type: boolean
        limit:
          type:
            - string
            - 'null'
          format: decimal
        metric_id:
          $ref: '#/components/schemas/BillableMetricId'
        reset_period:
          $ref: '#/components/schemas/ResetPeriod'
    ExistingProductRef:
      type: object
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/ProductId'
    NewProductRef:
      type: object
      required:
        - name
        - fee_type
        - fee_structure
      properties:
        fee_structure:
          $ref: '#/components/schemas/ProductFeeStructure'
        fee_type:
          $ref: '#/components/schemas/ProductFeeTypeEnum'
        name:
          type: string
    BillableMetricId:
      type: string
      format: MeteroidId
      examples:
        - bm_7n42DGM5Tflk9n8mt7Fhc7
    ResetPeriod:
      oneOf:
        - $ref: '#/components/schemas/BillingCycleResetPeriod'
          description: >-
            Resets each time your subscription renews — anchored to your billing
            cycle.
        - $ref: '#/components/schemas/CalendarResetPeriod'
          description: >-
            Resets on calendar boundaries (e.g. the 1st of every month) — not
            tied to subscription start date.
        - $ref: '#/components/schemas/FixedWindowResetPeriod'
          description: >-
            Resets at regular intervals — anchored to your subscription's exact
            activation time.
        - $ref: '#/components/schemas/SlidingWindowResetPeriod'
          description: >-
            Always ends at now — e.g. 30 days means the last 30 days, old usage
            drops off automatically.
        - $ref: '#/components/schemas/NeverResetPeriod'
          description: >-
            Never resets — counts all usage since the subscription was
            activated.
      discriminator:
        propertyName: type
        mapping:
          BILLING_CYCLE:
            $ref: '#/components/schemas/BillingCycleResetPeriod'
          CALENDAR:
            $ref: '#/components/schemas/CalendarResetPeriod'
          FIXED_WINDOW:
            $ref: '#/components/schemas/FixedWindowResetPeriod'
          NEVER:
            $ref: '#/components/schemas/NeverResetPeriod'
          SLIDING_WINDOW:
            $ref: '#/components/schemas/SlidingWindowResetPeriod'
    ProductId:
      type: string
      format: MeteroidId
      examples:
        - prd_7n42DGM5Tflk9n8mt7Fhc7
    ProductFeeStructure:
      oneOf:
        - $ref: '#/components/schemas/RateFeeStructure'
        - $ref: '#/components/schemas/SlotFeeStructure'
        - $ref: '#/components/schemas/CapacityFeeStructure'
        - $ref: '#/components/schemas/UsageFeeStructure'
        - $ref: '#/components/schemas/ExtraRecurringFeeStructure'
        - $ref: '#/components/schemas/OneTimeFeeStructure'
      discriminator:
        propertyName: type
        mapping:
          CAPACITY:
            $ref: '#/components/schemas/CapacityFeeStructure'
          EXTRA_RECURRING:
            $ref: '#/components/schemas/ExtraRecurringFeeStructure'
          ONE_TIME:
            $ref: '#/components/schemas/OneTimeFeeStructure'
          RATE:
            $ref: '#/components/schemas/RateFeeStructure'
          SLOT:
            $ref: '#/components/schemas/SlotFeeStructure'
          USAGE:
            $ref: '#/components/schemas/UsageFeeStructure'
    ProductFeeTypeEnum:
      type: string
      enum:
        - RATE
        - SLOT
        - CAPACITY
        - USAGE
        - EXTRA_RECURRING
        - ONE_TIME
    BillingCycleResetPeriod:
      type: object
      description: >-
        Resets each time your subscription renews — anchored to your billing
        cycle.
    CalendarResetPeriod:
      type: object
      description: >-
        Resets on calendar boundaries (e.g. the 1st of every month) — not tied
        to subscription start date.
      required:
        - unit
        - interval
      properties:
        interval:
          type: integer
          format: int32
          minimum: 0
        unit:
          $ref: '#/components/schemas/CalendarUnit'
    FixedWindowResetPeriod:
      type: object
      description: >-
        Resets at regular intervals — anchored to your subscription's exact
        activation time.
      required:
        - unit
        - interval
      properties:
        interval:
          type: integer
          format: int32
          minimum: 0
        unit:
          $ref: '#/components/schemas/CalendarUnit'
    SlidingWindowResetPeriod:
      type: object
      description: >-
        Always ends at now — e.g. 30 days means the last 30 days, old usage
        drops off automatically.
      required:
        - unit
        - interval
      properties:
        interval:
          type: integer
          format: int32
          minimum: 0
        unit:
          $ref: '#/components/schemas/CalendarUnit'
    NeverResetPeriod:
      type: object
      description: Never resets — counts all usage since the subscription was activated.
    RateFeeStructure:
      type: object
    SlotFeeStructure:
      type: object
      required:
        - slot_unit_name
        - upgrade_policy
        - downgrade_policy
      properties:
        downgrade_policy:
          $ref: '#/components/schemas/SlotDowngradePolicyEnum'
        slot_unit_name:
          type: string
        upgrade_policy:
          $ref: '#/components/schemas/SlotUpgradePolicyEnum'
    CapacityFeeStructure:
      type: object
      required:
        - metric_id
      properties:
        metric_id:
          $ref: '#/components/schemas/BillableMetricId'
    UsageFeeStructure:
      type: object
      required:
        - metric_id
        - model
      properties:
        metric_id:
          $ref: '#/components/schemas/BillableMetricId'
        model:
          $ref: '#/components/schemas/UsageModelEnum'
    ExtraRecurringFeeStructure:
      type: object
      required:
        - billing_type
      properties:
        billing_type:
          $ref: '#/components/schemas/ExtraRecurringBillingTypeEnum'
    OneTimeFeeStructure:
      type: object
    CalendarUnit:
      type: string
      enum:
        - HOUR
        - DAY
        - WEEK
        - MONTH
        - YEAR
    SlotDowngradePolicyEnum:
      type: string
      enum:
        - REMOVE_AT_END_OF_PERIOD
    SlotUpgradePolicyEnum:
      type: string
      enum:
        - PRORATED
    UsageModelEnum:
      type: string
      enum:
        - PER_UNIT
        - TIERED
        - VOLUME
        - PACKAGE
        - MATRIX
    ExtraRecurringBillingTypeEnum:
      type: string
      enum:
        - ADVANCE
        - ARREARS
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````