Skip to content
Navigation

Renames a tier or changes its settings, such as the features a software tier's licenses unlock.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • tier
    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

  • name
    optional
    string
    maxLength: 120 · minLength: 1
  • settings
    optional
    object

    Merged onto the stored settings; null deletes a key.

    • software
      optional

      A software tier: what its licenses unlock, answered by a license check.

      One of the following:

      • object
      • null
    • event
      optional

      An event's ticket type: how many guests it takes.

      One of the following:

      • object
      • null

Returns

200

Renames a tier or changes its settings, such as the features a software tier's licenses unlock.

JSON
  • in_use
    object
    required
    • prices
      number
      required
    • grants
      number
      required
    • orders
      number
      required
    • discounts
      number
      required
    • gates
      number
      required
  • id
    string
    required
  • product_id
    string
    required
  • rank
    number
    required
  • name
    string
    required
  • settings
    object
    required
    • software
      optional
      object

      A software tier: what its licenses unlock, answered by a license check.

      • features
        optional
        array of
        string

        Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.

        maxLength: 64 · minLength: 1 · pattern: ^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$
      • activation_limit
        optional
        integer

        The devices its licenses activate at once, over the product's default; none holds the product's.

        maximum: 10000 · minimum: 1
    • event
      optional
      object

      An event's ticket type: how many guests it takes.

      • capacity
        optional
        integer

        How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.

        maximum: 1000000 · minimum: 1
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