Needs the customer:read scope.
Call
- Tool:
verify_license - Scope:
customer:read - Writes, adding without changing what is there.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
product |
object |
Yes | |
key |
string |
Yes | 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. |
count_use |
boolean |
No | Count this check as a use of the software; only an active license counts. Defaults to false. |
instance |
string |
No | The device the software runs on, as it activated it, to read and stamp that activation. |
{
"type": "object",
"properties": {
"store": {
"type": "string",
"description": "The store to act on."
},
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"slug"
],
"additionalProperties": false
}
]
},
"key": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"count_use": {
"description": "Count this check as a use of the software; only an active license counts. Defaults to false.",
"type": "boolean"
},
"instance": {
"description": "The device the software runs on, as it activated it, to read and stamp that activation.",
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"product",
"key"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | |
status |
string |
Yes | Where it stands now: active, expired, revoked, disabled or replaced. |
reason |
string or null |
Yes | Why it is not active: replaced, disabled, lapse, refund or revoke; null while active, or before any access began. |
expires_at |
string or null |
Yes | When all of the holder’s access ends, whatever its tier; null while it never does. |
tier |
object or null |
Yes | The tier its access opens, else the one it last opened; null for access with no tier. |
features |
array of string |
Yes | What that tier unlocks with every tier below it, as their settings list them; none unless active. |
uses |
number |
Yes | How many checks counted it as a use, this one included. |
activations |
object |
Yes | The devices it counts now and the most it may hold; limit null when nothing limits it. |
activation |
object or null |
Yes | The device instance names, its last seen stamped while it counts and the license is active; null without instance, or when it holds none. |
customer |
object |
Yes | |
subscription |
object or null |
Yes | The subscription behind that access; null for a one-time purchase or a grant. |
latest_release |
object or null |
Yes | 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. |
The answer’s full shape is on its API reference page.
Errors
A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:
invalid: an argument is malformed;context.pathnames it.invalidat["store"]:storeis missing while the connection reaches more than one store, or names a store it doesn’t reach.not_found: nothing matches a reference given.conflict: the call clashes with the current state;contextnames the field and, where it helps, its current value, and for afrom,live,expector version that no longer matches, the argument (path) and what it takes (reason).not_permitted: this connection may not make this call. Whencontext.reasonislimit, too many calls:retry_aftersays when to try again.internalorunavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.client-fault: the server failed around the call.core_answerokmeans the write landed, so don’t send it again. Whenreached_coreis false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.- HTTP 403 with
insufficient_scope: the connection lacks the scope this tool needs. - HTTP 401 with
invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.
Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.