Skip to content
Navigation

Reads one of the customer's licenses with its key, status, end and activation limit.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • license
    string
    required
    minLength: 1

Returns

200

Reads one of the customer's licenses with its key, status, end and activation limit.

JSON
  • 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
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