> ## 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 custom property definitions



## OpenAPI

````yaml https://api.meteroid.com/api-docs/openapi.json get /api/v1/custom-property-definitions
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: Custom Properties
  - 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/custom-property-definitions:
    get:
      tags:
        - Custom Properties
      summary: List custom property definitions
      operationId: list_definitions
      parameters:
        - name: entity_type
          in: query
          description: Filter to a single entity type.
          required: false
          schema:
            $ref: '#/components/schemas/CustomPropertyEntityType'
        - name: include_archived
          in: query
          description: Include archived (soft-deleted) definitions. Defaults to false.
          required: false
          schema:
            type: boolean
        - name: page
          in: query
          description: Page number (0-indexed)
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
        - name: per_page
          in: query
          description: Number of items per page
          required: false
          schema:
            type: integer
            format: int32
            maximum: 100
            minimum: 1
      responses:
        '200':
          description: List of custom property definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPropertyDefinitionListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    CustomPropertyEntityType:
      type: string
      enum:
        - CUSTOMER
        - SUBSCRIPTION
        - INVOICE
        - CREDIT_NOTE
    CustomPropertyDefinitionListResponse:
      type: object
      required:
        - data
        - pagination_meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomPropertyDefinition'
        pagination_meta:
          $ref: '#/components/schemas/PaginationResponse'
    RestErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
    CustomPropertyDefinition:
      type: object
      required:
        - id
        - entity_type
        - key
        - name
        - property_type
        - config
        - required
        - display_order
        - archived
      properties:
        archived:
          type: boolean
        config:
          $ref: '#/components/schemas/PropertyConfig'
        default_value: {}
        description:
          type:
            - string
            - 'null'
        display_order:
          type: integer
          format: int32
        entity_type:
          $ref: '#/components/schemas/CustomPropertyEntityType'
        id:
          $ref: '#/components/schemas/CustomPropertyDefinitionId'
        key:
          type: string
        name:
          type: string
        property_type:
          $ref: '#/components/schemas/CustomPropertyType'
        required:
          type: boolean
    PaginationResponse:
      type: object
      required:
        - page
        - per_page
        - total_items
        - total_pages
      properties:
        page:
          type: integer
          format: int32
          minimum: 0
        per_page:
          type: integer
          format: int32
          minimum: 0
        total_items:
          type: integer
          format: int64
          minimum: 0
        total_pages:
          type: integer
          format: int32
          minimum: 0
    ErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - NOT_FOUND
        - CONFLICT
        - FORBIDDEN
        - UNAUTHORIZED
        - TOO_MANY_REQUESTS
        - INTERNAL_SERVER_ERROR
    PropertyConfig:
      type: object
      description: >-
        Type-specific configuration. Only the fields relevant to `property_type`
        are interpreted.
      properties:
        max:
          type:
            - number
            - 'null'
          format: double
        max_length:
          type:
            - integer
            - 'null'
          format: int32
          description: Maximum length for `TEXT`.
          minimum: 0
        min:
          type:
            - number
            - 'null'
          format: double
          description: Inclusive numeric bounds for `NUMBER`.
        options:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/SelectOption'
          description: Allowed choices for `SINGLE_SELECT` / `MULTI_SELECT`.
    CustomPropertyDefinitionId:
      type: string
      format: MeteroidId
      examples:
        - cpd_7n42DGM5Tflk9n8mt7Fhc7
    CustomPropertyType:
      type: string
      enum:
        - TEXT
        - NUMBER
        - BOOLEAN
        - DATE
        - DATETIME
        - SINGLE_SELECT
        - MULTI_SELECT
        - JSON
        - URL
        - EMAIL
    SelectOption:
      type: object
      required:
        - value
      properties:
        label:
          type:
            - string
            - 'null'
        value:
          type: string
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````