Skip to content
Navigation

Pages a software product's licenses, their keys shortened to their last characters.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • 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
    or
    last_verified
    or
    uses

    Sorted by last_verified, rows without a value come last either way.

  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages a software product's licenses, their keys shortened to their last characters.

JSON
  • items
    array of
    object
    required
    • activations
      object
      required

      The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; limit null when nothing limits it.

      • count
        number
        required
      • limit
        required

        One of the following:

        • number
        • null
    • key_ending
      string
      required

      The key's last characters, so a support reply can name it; getLicense answers it whole.

    • tier
      required

      The tier its access opens, else the one it last opened; null for access with no tier.

      One of the following:

      • object
      • null
    • customer
      required

      One of the following:

      • object
      • null
    • id
      string
      required
    • product_id
      string
      required
    • customer_id
      string
      required
    • source
      string
      required
    • status
      string
      required

      Where it stands now: active, expired, revoked, disabled or replaced.

    • expires_at
      required

      When access ends; null while it never does.

      One of the following:

      • string
      • null
    • reason
      required

      Why it reads its status: replaced, disabled, lapse, refund or revoke; null while active, or before any access began.

      One of the following:

      • string
      • null
    • has_access
      boolean
      required

      Whether its holder has access now, whatever its status; false before access begins.

    • activation_limit
      required

      One of the following:

      • number
      • null
    • uses
      number
      required
    • metadata
      map of
      any of
      required
    • created_at
      required

      One of the following:

      • string
      • null
    • disabled_at
      required

      One of the following:

      • string
      • null
    • disabled_reason
      required

      One of the following:

      • string
      • null
    • replaced_by
      required

      One of the following:

      • string
      • null
    • last_verified_at
      required

      One of the following:

      • string
      • null
  • cursor
    required

    One of the following:

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