Skip to content
Navigation

Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with `count_use` an active one counts a use, and with `instance` it reads and stamps that device. An unknown key, or another product's, answers `not_found`.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Request body JSON required

  • key
    string
    required

    The key as the customer typed it: case, hyphens, spaces and Crockford's look-alikes don't matter, except for an imported key that is not hex, which matches exactly.

    maxLength: 128 · minLength: 1
  • count_use
    optional
    boolean

    Count this check as a use of the software; only an active license counts. Defaults to false.

  • instance
    optional
    string

    The device the software runs on, as it activated it, to read and stamp that activation.

    maxLength: 256 · minLength: 1

Returns

200

Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with count_use an active one counts a use, and with instance it reads and stamps that device. An unknown key, or another product's, answers not_found.

JSON
  • id
    string
    required
  • status
    string
    required

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

  • reason
    required

    Why it is not active: replaced, disabled, lapse, refund or revoke; null while active, or before any access began.

    One of the following:

    • string
    • null
  • expires_at
    required

    When all of the holder's access ends, whatever its tier; null while it never does.

    One of the following:

    • string
    • null
  • 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
  • features
    array of
    string
    required

    What that tier unlocks with every tier below it, as their settings list them; none unless active.

  • uses
    number
    required

    How many checks counted it as a use, this one included.

  • activations
    object
    required

    The devices it counts now and the most it may hold; limit null when nothing limits it.

    • count
      number
      required
    • limit
      required

      One of the following:

      • number
      • null
  • activation
    required

    The device instance names, its last seen stamped while it counts and the license is active; null without instance, or when it holds none.

    One of the following:

    • object
    • null
  • customer
    object
    required
    • id
      string
      required
  • subscription
    required

    The subscription behind that access; null for a one-time purchase or a grant.

    One of the following:

    • object
    • null
  • latest_release
    required

    The product's newest release whose files are all in, whatever tier opens them, so the software can tell an update is out; null before its first.

    One of the following:

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