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

> Atomically replaces the plan's prices with the supplied list. If the plan's latest version is published, a new draft version is created and the new prices are attached to it. Duplicate currencies among PAID prices are rejected.



## OpenAPI

````yaml /api-reference/openapi.json post /catalog/plans/{identifier}/prices/bulk/
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}/prices/bulk/:
    parameters:
      - name: identifier
        in: path
        required: true
        description: Plan identifier.
        example: pro-monthly
        schema:
          type: string
    post:
      tags:
        - Plans
      summary: Update plan prices
      description: >-
        Atomically replaces the plan's prices with the supplied list. If the
        plan's latest version is published, a new draft version is created and
        the new prices are attached to it. Duplicate currencies among PAID
        prices are rejected.
      operationId: bulkSetCatalogPlanPrices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanPriceBulkRequest'
      responses:
        '200':
          description: Prices replaced.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanPriceBulkResponse'
        '400':
          description: >-
            Validation error (duplicate currencies, invalid price configuration,
            etc.).
        '401':
          description: Unauthorized — missing or invalid API key
      security:
        - bearerAuth: []
components:
  schemas:
    PlanPriceBulkRequest:
      type: object
      required:
        - prices
      description: >-
        Replaces the plan's prices in one atomic call. Creating multiple PAID
        prices with the same currency is rejected.
      properties:
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PlanPriceCreateRequest'
    PlanPriceBulkResponse:
      type: object
      properties:
        prices:
          type: array
          items:
            $ref: '#/components/schemas/PlanPrice'
    PlanPriceCreateRequest:
      type: object
      required:
        - priceType
      properties:
        priceType:
          type: string
          enum:
            - FREE
            - PAID
            - CUSTOM
          example: PAID
        currency:
          type: string
          example: USD
        freeTrial:
          type: boolean
          example: false
        trialPeriod:
          type: integer
          example: 0
        enabled:
          type: boolean
          example: true
        taxBehavior:
          type: string
          enum:
            - INCLUSIVE
            - EXCLUSIVE
            - UNSPECIFIED
          example: EXCLUSIVE
        chargeCatalogPrice:
          type: array
          items:
            $ref: '#/components/schemas/PlanChargeCatalogPrice'
    PlanPrice:
      type: object
      description: >-
        A price (per currency) attached to a plan, with its per-feature charge
        configuration.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: df0b9da9-58c3-4d77-9b62-3f6e4c2b1ad0
        priceType:
          type: string
          enum:
            - FREE
            - PAID
            - CUSTOM
          example: PAID
        currency:
          type: string
          example: USD
        freeTrial:
          type: boolean
          example: false
        trialPeriod:
          type: integer
          description: Trial length in days.
          example: 14
        enabled:
          type: boolean
          example: true
        taxBehavior:
          type: string
          enum:
            - INCLUSIVE
            - EXCLUSIVE
            - UNSPECIFIED
          example: EXCLUSIVE
        chargeCatalogPrice:
          type: array
          items:
            $ref: '#/components/schemas/PlanChargeCatalogPrice'
    PlanChargeCatalogPrice:
      type: object
      description: Pricing for one feature (or the plan itself if `feature` is null).
      properties:
        feature:
          type: string
          format: uuid
          nullable: true
          description: Feature UUID this pricing applies to. Required for non-FLAT models.
          example: 3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01
        priceModel:
          type: string
          enum:
            - FLAT
            - PACKAGE
            - TIERED
            - VOLUME
            - STAIRSTEP
          example: FLAT
        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
        hasUnlimitedUsage:
          type: boolean
          example: false
        paymentType:
          type: string
          enum:
            - ADVANCE_COMMITMENT
            - PAY_AS_YOU_GO
          example: ADVANCE_COMMITMENT
        rollover:
          type: object
          description: Optional `{ enabled, percentage, limit }`.
          additionalProperties: true
          example: {}
        usageAlerts:
          type: object
          description: >-
            Optional usage-alert configuration. `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
        charges:
          type: array
          items:
            $ref: '#/components/schemas/PlanCharge'
    PlanCharge:
      type: object
      description: An individual charge inside a feature's pricing definition.
      properties:
        chargePeriod:
          type: string
          enum:
            - ONE_TIME
            - DAILY
            - MONTHLY
            - QUARTERLY
            - YEARLY
          example: MONTHLY
        priceData:
          type: object
          additionalProperties: true
          description: >-
            For FLAT/PACKAGE: `{ amount, block_size? }`. For
            TIERED/VOLUME/STAIRSTEP: `{ currency }`.
          example:
            amount: 29.99
        tiers:
          type: array
          items:
            type: object
            properties:
              flatAmount:
                type: number
                example: 0
              unitAmount:
                type: number
                example: 0.001
              upTo:
                nullable: true
                description: >-
                  Upper bound of the tier. Integer, or the string "inf" for an
                  unbounded final tier.
                oneOf:
                  - type: integer
                  - type: string
                example: 1000
          example: []
        advanced:
          type: object
          additionalProperties: true
          description: >-
            Optional `{ min_quantity, max_quantity }` (FLAT only, when a feature
            is attached).
          example: {}
  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__'

````