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

# List price modifiers

> Returns reusable early payment discounts and late payment interest rules.



## OpenAPI

````yaml /openapi.yaml get /v1/price-modifiers
openapi: 3.1.0
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
security:
  - organizationApiKey: []
  - oauthAccessToken: []
tags:
  - name: Auth
  - name: Management
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
  - name: Messaging
paths:
  /v1/price-modifiers:
    get:
      tags:
        - Catalog
      summary: List price modifiers
      description: >-
        Returns reusable early payment discounts and late payment interest
        rules.
      operationId: price_modifiers_list
      parameters:
        - schema:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/StringFilter'
              createdAt:
                $ref: '#/components/schemas/DateTimeFilter'
              updatedAt:
                $ref: '#/components/schemas/DateTimeFilter'
              name:
                $ref: '#/components/schemas/StringFilter'
              type:
                $ref: '#/components/schemas/StringFilter'
              adjustmentType:
                $ref: '#/components/schemas/StringFilter'
              value:
                type: object
                properties:
                  equals:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  in:
                    type: array
                    items:
                      anyOf:
                        - type: number
                          description: Number
                        - type: string
                          description: Numeric string
                  notIn:
                    type: array
                    items:
                      anyOf:
                        - type: number
                          description: Number
                        - type: string
                          description: Numeric string
                  lt:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  lte:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  gt:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  gte:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                additionalProperties: false
              timeUnit:
                $ref: '#/components/schemas/StringFilter'
              isRecurring:
                type: object
                properties:
                  equals:
                    anyOf:
                      - type: boolean
                        description: Boolean
                      - type: string
                        description: Boolean string
            additionalProperties: false
            description: Fields encoded with `qs` bracket notation.
          required: false
          description: Fields encoded with `qs` bracket notation.
          style: deepObject
          explode: true
          name: filter
          in: query
        - schema:
            type: object
            properties:
              id:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
              createdAt:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
              updatedAt:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
              name:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
              type:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
              value:
                anyOf:
                  - type: string
                    enum:
                      - asc
                    description: Ascending
                  - type: string
                    enum:
                      - desc
                    description: Descending
            additionalProperties: false
            description: Fields encoded with `qs` bracket notation.
          required: false
          description: Fields encoded with `qs` bracket notation.
          style: deepObject
          explode: true
          name: orderBy
          in: query
        - schema:
            type: number
            minimum: 0
            default: 0
            description: Pagination offset.
            example: 0
          required: false
          description: Pagination offset.
          name: skip
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
            description: Pagination limit.
            example: 20
          required: false
          description: Pagination limit.
          name: take
          in: query
      responses:
        '200':
          description: Price modifiers list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPriceModifiersResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    StringFilter:
      type: object
      properties:
        equals:
          type: string
        in:
          type: array
          items:
            type: string
        notIn:
          type: array
          items:
            type: string
        lt:
          type: string
        lte:
          type: string
        gt:
          type: string
        gte:
          type: string
        contains:
          type: string
        startsWith:
          type: string
        endsWith:
          type: string
        search:
          type: string
        not:
          $ref: '#/components/schemas/StringFilter'
      additionalProperties: false
    DateTimeFilter:
      type: object
      properties:
        equals:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        lt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        lte:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        gt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        gte:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        not:
          $ref: '#/components/schemas/DateTimeFilter'
      additionalProperties: false
    GetPriceModifiersResponse:
      type: array
      items:
        $ref: '#/components/schemas/PriceModifier'
      description: List of price modifiers returned by the query.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    PriceModifier:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the price modifier.
          example: prm_1234567890abcdefghij
        createdAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the modifier was created.
          example: '2025-01-01T00:00:00.000Z'
        updatedAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the modifier was last updated.
          example: '2025-01-01T00:00:00.000Z'
        name:
          type: string
          description: Display name of the modifier.
          example: Descuento por pago anticipado 10%
        type:
          type: string
          enum:
            - EARLY_PAYMENT_DISCOUNT
            - LATE_PAYMENT_INTEREST
          description: >-
            Whether this is an early payment discount or a late payment interest
            charge.
          example: EARLY_PAYMENT_DISCOUNT
        adjustmentType:
          type: string
          enum:
            - FIXED
            - PERCENTAGE
            - SET_PRICE
          description: >-
            Whether the adjustment is a fixed amount, a percentage, or a
            resulting set price.
          example: PERCENTAGE
        value:
          type: number
          description: >-
            Adjustment value: cents for FIXED and SET_PRICE, percentage points
            for PERCENTAGE.
          example: 10
        timeUnit:
          type: string
          enum:
            - MINUTES
            - HOURS
            - DAYS
            - WEEKS
            - MONTHS
            - YEARS
            - BUSINESS_DAYS
          description: Time unit for offset and frequency calculations.
          example: DAYS
        anchorOffsetStart:
          type: number
          description: >-
            Start of the eligibility window (in time units) relative to the
            anchor date.
          example: 1
        anchorOffsetEnd:
          type:
            - number
            - 'null'
          description: >-
            End of the eligibility window (in time units) relative to the anchor
            date, if bounded.
        maxAdjustmentAmount:
          type:
            - number
            - 'null'
          description: Maximum total adjustment in minor currency units.
          example: null
        description:
          type:
            - string
            - 'null'
          description: Optional description of the modifier.
          example: null
        isRecurring:
          type: boolean
          description: Whether the modifier is applied repeatedly over time.
          example: false
        organizationId:
          type: string
          description: Identifier of the owning organization.
          example: org_1234567890abcdefghij
        compoundInterest:
          type: boolean
          description: >-
            Whether interest compounds on accumulated interest (late payment
            only).
          example: false
        recurringFrequency:
          type:
            - number
            - 'null'
          description: How often the modifier is applied (in time units) when recurring.
          example: null
        maxApplications:
          type:
            - number
            - 'null'
          description: Maximum number of times this modifier can be applied.
          example: null
        priority:
          type: number
          description: >-
            Application order when multiple modifiers are active. Lower values
            run first.
          example: 0
        oneOff:
          type: boolean
          description: Whether this modifier is single-use.
          example: false
      required:
        - id
        - createdAt
        - updatedAt
        - name
        - type
        - adjustmentType
        - value
        - timeUnit
        - anchorOffsetStart
        - anchorOffsetEnd
        - maxAdjustmentAmount
        - isRecurring
        - organizationId
        - compoundInterest
        - recurringFrequency
        - maxApplications
        - priority
        - oneOff
      description: >-
        A configurable rule that adjusts invoice amounts for early payment
        discounts or late payment interest.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'
    oauthAccessToken:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1
      description: 'OAuth access token using `Authorization: Bearer qoa_at_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.