---
title: "Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the 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.

Path: Sherpo merchant API › customer

`GET /v1/stores/{store}/products/{product}/licenses/stats`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `customer:read`

## Path parameters

- `store` (`licenseStats.path.store`; string, required) — The store's id.
- `product` (`licenseStats.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `from` (`licenseStats.query.from`; string, optional)
  - format `date`
- `to` (`licenseStats.query.to`; string, optional)
  - format `date`
- `bucket` (`licenseStats.query.bucket`; string, optional)
  - one of `"day"`, `"week"`, `"month"`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/licenses/stats' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/licenses/stats';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/licenses/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.

#### Example

```json
{
  "issued": {
    "current": 0,
    "previous": 0
  },
  "imported": {
    "current": 0,
    "previous": 0
  },
  "verifies": {
    "current": 0,
    "previous": 0
  },
  "uses": {
    "current": 0,
    "previous": 0
  },
  "active_license_days": {
    "current": 0,
    "previous": 0
  },
  "activations": {
    "current": 0,
    "previous": 0
  },
  "deactivations": {
    "current": 0,
    "previous": 0
  },
  "refusals": {
    "current": 0,
    "previous": 0
  },
  "series": [
    {
      "previous_verifies": 0,
      "previous_active_license_days": 0,
      "previous_activations": 0,
      "issued": 0,
      "imported": 0,
      "verifies": 0,
      "uses": 0,
      "active_license_days": 0,
      "activations": 0,
      "deactivations": 0,
      "refusals": 0,
      "start": "string",
      "end": "string"
    }
  ],
  "bucket": "string",
  "time_zone": "string",
  "from": "string",
  "to": "string",
  "previous_range": {
    "from": "string",
    "to": "string"
  }
}
```

- `issued` (`licenseStats.response.200.issued`; object, required)
  - `current` (`licenseStats.response.200.issued.current`; number, required)
  - `previous` (`licenseStats.response.200.issued.previous`; number, required)
- `imported` (`licenseStats.response.200.imported`; object, required)
  - `current` (`licenseStats.response.200.imported.current`; number, required)
  - `previous` (`licenseStats.response.200.imported.previous`; number, required)
- `verifies` (`licenseStats.response.200.verifies`; object, required)
  - `current` (`licenseStats.response.200.verifies.current`; number, required)
  - `previous` (`licenseStats.response.200.verifies.previous`; number, required)
- `uses` (`licenseStats.response.200.uses`; object, required)
  - `current` (`licenseStats.response.200.uses.current`; number, required)
  - `previous` (`licenseStats.response.200.uses.previous`; number, required)
- `active_license_days` (`licenseStats.response.200.active_license_days`; object, required)
  - `current` (`licenseStats.response.200.active_license_days.current`; number, required)
  - `previous` (`licenseStats.response.200.active_license_days.previous`; number, required)
- `activations` (`licenseStats.response.200.activations`; object, required)
  - `current` (`licenseStats.response.200.activations.current`; number, required)
  - `previous` (`licenseStats.response.200.activations.previous`; number, required)
- `deactivations` (`licenseStats.response.200.deactivations`; object, required)
  - `current` (`licenseStats.response.200.deactivations.current`; number, required)
  - `previous` (`licenseStats.response.200.deactivations.previous`; number, required)
- `refusals` (`licenseStats.response.200.refusals`; object, required)
  - `current` (`licenseStats.response.200.refusals.current`; number, required)
  - `previous` (`licenseStats.response.200.refusals.previous`; number, required)
- `series` (`licenseStats.response.200.series`; array<object>, required)
  - `previous_verifies` (`licenseStats.response.200.series.previous_verifies`; number, required)
  - `previous_active_license_days` (`licenseStats.response.200.series.previous_active_license_days`; number, required)
  - `previous_activations` (`licenseStats.response.200.series.previous_activations`; number, required)
  - `issued` (`licenseStats.response.200.series.issued`; number, required) — Licenses the store minted.
  - `imported` (`licenseStats.response.200.series.imported`; number, required) — Licenses recorded from another platform.
  - `verifies` (`licenseStats.response.200.series.verifies`; number, required) — Checks from the seller's server.
  - `uses` (`licenseStats.response.200.series.uses`; number, required) — Checks that counted a use.
  - `active_license_days` (`licenseStats.response.200.series.active_license_days`; number, required) — Each license that checked in while active, once a day, summed over the days.
  - `activations` (`licenseStats.response.200.series.activations`; number, required) — Devices that began counting, new or come back.
  - `deactivations` (`licenseStats.response.200.series.deactivations`; number, required) — Devices freed by their holder, the merchant, the software, or a new key.
  - `refusals` (`licenseStats.response.200.series.refusals`; number, required) — Activations refused at the limit.
  - `start` (`licenseStats.response.200.series.start`; string, required)
  - `end` (`licenseStats.response.200.series.end`; string, required)
- `bucket` (`licenseStats.response.200.bucket`; string, required)
- `time_zone` (`licenseStats.response.200.time_zone`; string, required)
- `from` (`licenseStats.response.200.from`; string, required)
- `to` (`licenseStats.response.200.to`; string, required)
- `previous_range` (`licenseStats.response.200.previous_range`; object, required)
  - `from` (`licenseStats.response.200.previous_range.from`; string, required)
  - `to` (`licenseStats.response.200.previous_range.to`; string, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`licenseStats.response.default.type`; string, required)
  - format `uri`
- `title` (`licenseStats.response.default.title`; string, required)
- `status` (`licenseStats.response.default.status`; integer, required)
- `detail` (`licenseStats.response.default.detail`; string, required)
- `code` (`licenseStats.response.default.code`; string, optional)
- `context` (`licenseStats.response.default.context`; object, optional)
- `reached_core` (`licenseStats.response.default.reached_core`; boolean, optional)
- `core_answer` (`licenseStats.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/license-stats/index.md
