Skip to content
Navigation

Pages the customer's licenses of a software product, the live one and the ones it replaced, newest first, each with its key and status.

GET
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/licenses

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    created
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the customer's licenses of a software product, the live one and the ones it replaced, newest first, each with its key and status.

JSON
  • items
    array of
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • key
      required

      The key the customer enters in the software; null to staff acting as the customer.

      One of the following:

      • string
      • null
    • status
      string
      required
    • expires_at
      required

      When access ends, or ended; null for lifetime access.

      One of the following:

      • string
      • null
    • activation_limit
      required

      How many devices it activates at once: its own limit, else its tier's, else its product's; null for no limit.

      One of the following:

      • number
      • null
    • activations
      object
      required

      The devices it counts now and the most it may hold.

      • count
        number
        required
      • limit
        required

        One of the following:

        • number
        • null
    • replaced_by
      required

      The license whose key took this one's place; null until it is replaced.

      One of the following:

      • string
      • null
    • created_at
      string
      required
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
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