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

# Update a catalog product price

> Atomically replaces a product price by creating a new active price and archiving any existing active prices for the same product/merchant scope. This endpoint is idempotent by `idempotencyKey` per merchant.



## OpenAPI

````yaml /openapi.json put /catalog/products/{productId}/price
openapi: 3.0.0
info:
  title: PayGood Merchant API
  description: Server-to-server integration surface for merchant API keys.
  version: '1.0'
  contact: {}
servers:
  - url: https://api-sandbox.paygood.co
    description: Sandbox
  - url: https://api.paygood.co
    description: Production
security: []
paths:
  /catalog/products/{productId}/price:
    put:
      tags:
        - catalog-products
      summary: Update a catalog product price
      description: >-
        Atomically replaces a product price by creating a new active price and
        archiving any existing active prices for the same product/merchant
        scope. This endpoint is idempotent by `idempotencyKey` per merchant.
      operationId: CatalogProductsController_updatePrice
      parameters:
        - name: productId
          required: true
          in: path
          description: >-
            Product TypeID (`prod_...`) whose active price set should be
            replaced.
          schema:
            example: prod_01hxy8m1nqk9g3x3y3p0azq2bg
            type: string
      requestBody:
        required: true
        description: >-
          Replacement price payload with merchant scope, idempotency key, and
          money/type fields.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProductPriceDto'
            examples:
              oneTimePrice:
                summary: Replace with one-time USD 25.00 price
                value:
                  idempotencyKey: idempo_catalog_product_price_01
                  merchantId: mer_01hxy8m1nqk9g3x3y3p0azq2bg
                  amount: 2500
                  currency: USD
                  type: one_time
              recurringPrice:
                summary: Replace with recurring monthly USD 12.00 price
                value:
                  idempotencyKey: idempo_catalog_product_price_02
                  merchantId: mer_01hxy8m1nqk9g3x3y3p0azq2bg
                  amount: 1200
                  currency: USD
                  type: recurring
                  interval: month
      responses:
        '200':
          description: >-
            Replacement active price in canonical response shape. Previously
            active prices for this product are archived.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriceResponseDto'
              example:
                priceId: price_01hxy8m1nqk9g3x3y3p0azq2bg
                merchantId: mer_01hxy8m1nqk9g3x3y3p0azq2bg
                productId: prod_01hxy8m1nqk9g3x3y3p0azq2bg
                amount: 2500
                currency: USD
                type: one_time
                createdAt: '2026-07-28T20:37:00.000Z'
        '400':
          description: >-
            Invalid payload shape, unsupported interval/type combination,
            currency/amount validation failure, or inactive product.
        '401':
          description: Missing or invalid bearer token.
        '403':
          description: >-
            Caller is authenticated but lacks `catalog.manage` capability for
            this merchant.
        '404':
          description: No product exists for the provided merchant and product id.
      security:
        - bearer: []
components:
  schemas:
    UpdateProductPriceDto:
      type: object
      properties:
        idempotencyKey:
          type: string
          minLength: 1
          description: >-
            Client-generated key used to deduplicate retries for this price
            update operation.
        merchantId:
          type: string
          description: >-
            Merchant TypeID (`mer_...`) that owns the product and replacement
            price.
        amount:
          type: integer
          exclusiveMinimum: true
          maximum: 9007199254740991
          description: Price amount in minor units (for example cents).
          minimum: 0
        currency:
          description: ISO 4217 uppercase currency code for the replacement price.
          type: string
          minLength: 3
          maxLength: 3
        type:
          default: one_time
          description: >-
            Price type. Use `one_time` for single-charge pricing or `recurring`
            for subscription-like pricing.
          type: string
          enum:
            - one_time
            - recurring
        interval:
          description: >-
            Recurring interval label (for example `month`) required when
            `type=recurring`; omit for `one_time`.
          type: string
      required:
        - idempotencyKey
        - merchantId
        - amount
        - currency
    PriceResponseDto:
      type: object
      properties:
        priceId:
          type: string
        merchantId:
          type: string
        productId:
          type: string
        amount:
          type: integer
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
        currency:
          description: Supported currency code (USD, CAD)
          type: string
          minLength: 3
          maxLength: 3
        type:
          type: string
          enum:
            - one_time
            - recurring
        interval:
          type: string
        archivedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
      required:
        - priceId
        - merchantId
        - amount
        - currency
        - type
        - createdAt
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: merchant_<prefix>_<secret>
      type: http
      description: >-
        Merchant API key bearer token. Legacy wire prefixes `api_key_` and
        `api_` are also accepted.

````