Needs the customer:write scope.
Call
- Tool:
rotate_license - Scope:
customer:write - Writes, and may change or remove what is there.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
product |
object |
Yes | |
license |
object |
Yes |
{
"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
}
]
},
"license": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"product",
"license"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
key |
string |
Yes | |
subscription |
object or null |
Yes | The subscription behind its access; null for a one-time purchase or a grant, or without subscription:read. |
activations |
object |
Yes | 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. |
key_ending |
string |
Yes | The key’s last characters, so a support reply can name it; getLicense answers it whole. |
tier |
object or null |
Yes | The tier its access opens, else the one it last opened; null for access with no tier. |
customer |
object or null |
Yes | |
id |
string |
Yes | |
product_id |
string |
Yes | |
customer_id |
string |
Yes | |
source |
string |
Yes | |
status |
string |
Yes | Where it stands now: active, expired, revoked, disabled or replaced. |
expires_at |
string or null |
Yes | When access ends; null while it never does. |
reason |
string or null |
Yes | Why it reads its status: replaced, disabled, lapse, refund or revoke; null while active, or before any access began. |
has_access |
boolean |
Yes | Whether its holder has access now, whatever its status; false before access begins. |
activation_limit |
number or null |
Yes | |
uses |
number |
Yes | |
metadata |
object |
Yes | |
created_at |
string or null |
Yes | |
disabled_at |
string or null |
Yes | |
disabled_reason |
string or null |
Yes | |
replaced_by |
string or null |
Yes | |
last_verified_at |
string or null |
Yes |
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.