---
title: "Read license"
description: "Reads one of the customer's licenses with its key, status, end and activation limit."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Read license

Needs the read scope.

## Call

- Tool: `get_license`
- Scope: `read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `product` | `object` | Yes |  |
| `license` | `object` | Yes |  |

```json
{
  "type": "object",
  "properties": {
    "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 |
| --- | --- | --- | --- |
| `id` | `string` | Yes |  |
| `product_id` | `string` | Yes |  |
| `key` | `string or null` | Yes | The key the customer enters in the software; null to staff acting as the customer. |
| `status` | `string` | Yes |  |
| `expires_at` | `string or null` | Yes | When access ends, or ended; null for lifetime access. |
| `activation_limit` | `number or null` | Yes | How many devices it activates at once: its own limit, else its tier's, else its product's; null for no limit. |
| `activations` | `object` | Yes | The devices it counts now and the most it may hold. |
| `replaced_by` | `string or null` | Yes | The license whose key took this one's place; null until it is replaced. |
| `created_at` | `string` | Yes |  |

The answer's full shape is on [its API reference page](/customer-api/reference/get-license).

Source: https://docs.sherpo.io/customer-mcp/tools/get_license/index.mdx
