Skip to content
Navigation

Updates a price's fields.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/prices/{price}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • price
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • amount
    optional
    integer
    maximum: 9007199254740991 · minimum: 0
  • title
    optional

    Null clears it.

    One of the following:

    • string
    • null
  • description
    optional

    One of the following:

    • string
    • null
  • settings
    optional
    object

    Merged onto the stored settings; null deletes a key.

    • autorenew
      optional

      Recurring only; false stops the renewal, absent renews.

      One of the following:

      • boolean
      • null
    • renewal_discount
      optional

      Recurring only, a percent off every renewal.

      One of the following:

      • integer
      • null
    • upgrade_multiplier
      optional

      One-time only, a factor on the difference paid to move up a tier.

      One of the following:

      • number
      • null
    • refund_policy
      optional

      Overrides the product's.

      One of the following:

      • string
      • null

Returns

200

Updates a price's fields.

JSON
  • in_use
    object
    required
    • orders
      number
      required
    • subscriptions
      number
      required
    • checkouts
      number
      required
    • automations
      number
      required
    • discounts
      number
      required
  • id
    string
    required
  • product_id
    string
    required
  • tier_id
    string
    required
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • amount
    number
    required
  • kind
    string
    required
  • period
    required

    One of the following:

    • object
    • null
  • highlighted
    boolean
    required
  • title
    required

    One of the following:

    • string
    • null
  • description
    required

    One of the following:

    • string
    • null
  • settings
    object
    required
    • autorenew
      optional
      boolean

      Recurring only; false stops the renewal, absent renews.

    • renewal_discount
      optional
      integer

      Recurring only, a percent off every renewal.

      maximum: 100 · minimum: 0
    • upgrade_multiplier
      optional
      number

      One-time only, a factor on the difference paid to move up a tier.

      maximum: 10 · minimum: 1
    • refund_policy
      optional
      string

      Overrides the product's.

  • archived_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close