---
title: "Reads the store's subscription stats over a period."
---

> 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 › subscription

`GET /v1/stores/{store}/subscriptions/stats`

## Authentication

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

## Path parameters

- `store` (`subscriptionStats.path.store`; string, required) — The store's id.

## Query parameters

- `from` (`subscriptionStats.query.from`; string, optional)
  - format `date`
- `to` (`subscriptionStats.query.to`; string, optional)
  - format `date`
- `bucket` (`subscriptionStats.query.bucket`; string, optional)
  - one of `"day"`, `"week"`, `"month"`
- `product` (`subscriptionStats.query.product`; string, optional) — An id.
  - minLength 1

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/subscriptions/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>/subscriptions/stats"

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

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

print(response.text)
```

## Responses

### 200

Reads the store's subscription stats over a period.

#### Example

```json
{
  "total": 0,
  "by_status": {
    "active": 0,
    "past_due": 0,
    "paused": 0
  },
  "cancelling": 0,
  "started": {
    "current": 0,
    "previous": 0
  },
  "mrr": [
    {
      "currency": "string",
      "exponent": 0,
      "active": 0,
      "at_risk": 0,
      "ending": 0
    }
  ],
  "churn": {
    "current": {
      "ended": 0,
      "base": 0
    },
    "previous": {
      "ended": 0,
      "base": 0
    }
  },
  "series": [
    {
      "previous_active": 0,
      "previous_past_due": 0,
      "previous_paused": 0,
      "start": "string",
      "end": "string",
      "active": 0,
      "past_due": 0,
      "paused": 0
    }
  ],
  "bucket": "string",
  "time_zone": "string",
  "from": "string",
  "to": "string",
  "previous_range": {
    "from": "string",
    "to": "string"
  }
}
```

- `total` (`subscriptionStats.response.200.total`; number, required)
- `by_status` (`subscriptionStats.response.200.by_status`; object, required)
  - `active` (`subscriptionStats.response.200.by_status.active`; number, required)
  - `past_due` (`subscriptionStats.response.200.by_status.past_due`; number, required)
  - `paused` (`subscriptionStats.response.200.by_status.paused`; number, required)
- `cancelling` (`subscriptionStats.response.200.cancelling`; number, required)
- `started` (`subscriptionStats.response.200.started`; object, required)
  - `current` (`subscriptionStats.response.200.started.current`; number, required)
  - `previous` (`subscriptionStats.response.200.started.previous`; number, required)
- `mrr` (`subscriptionStats.response.200.mrr`; array<object>, required)
  - `currency` (`subscriptionStats.response.200.mrr.currency`; string, required)
  - `exponent` (`subscriptionStats.response.200.mrr.exponent`; any of, required)
    - any of: `number`, `null`
  - `active` (`subscriptionStats.response.200.mrr.active`; any of, required)
    - any of: `number`, `null`
  - `at_risk` (`subscriptionStats.response.200.mrr.at_risk`; any of, required)
    - any of: `number`, `null`
  - `ending` (`subscriptionStats.response.200.mrr.ending`; any of, required)
    - any of: `number`, `null`
- `churn` (`subscriptionStats.response.200.churn`; object, required)
  - `current` (`subscriptionStats.response.200.churn.current`; object, required)
    - `ended` (`subscriptionStats.response.200.churn.current.ended`; number, required)
    - `base` (`subscriptionStats.response.200.churn.current.base`; number, required)
  - `previous` (`subscriptionStats.response.200.churn.previous`; object, required)
    - `ended` (`subscriptionStats.response.200.churn.previous.ended`; number, required)
    - `base` (`subscriptionStats.response.200.churn.previous.base`; number, required)
- `series` (`subscriptionStats.response.200.series`; array<object>, required)
  - `previous_active` (`subscriptionStats.response.200.series.previous_active`; number, required)
  - `previous_past_due` (`subscriptionStats.response.200.series.previous_past_due`; number, required)
  - `previous_paused` (`subscriptionStats.response.200.series.previous_paused`; number, required)
  - `start` (`subscriptionStats.response.200.series.start`; string, required)
  - `end` (`subscriptionStats.response.200.series.end`; string, required)
  - `active` (`subscriptionStats.response.200.series.active`; number, required)
  - `past_due` (`subscriptionStats.response.200.series.past_due`; number, required)
  - `paused` (`subscriptionStats.response.200.series.paused`; number, required)
- `bucket` (`subscriptionStats.response.200.bucket`; string, required)
- `time_zone` (`subscriptionStats.response.200.time_zone`; string, required)
- `from` (`subscriptionStats.response.200.from`; string, required)
- `to` (`subscriptionStats.response.200.to`; string, required)
- `previous_range` (`subscriptionStats.response.200.previous_range`; object, required)
  - `from` (`subscriptionStats.response.200.previous_range.from`; string, required)
  - `to` (`subscriptionStats.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` (`subscriptionStats.response.default.type`; string, required)
  - format `uri`
- `title` (`subscriptionStats.response.default.title`; string, required)
- `status` (`subscriptionStats.response.default.status`; integer, required)
- `detail` (`subscriptionStats.response.default.detail`; string, required)
- `code` (`subscriptionStats.response.default.code`; string, optional)
- `context` (`subscriptionStats.response.default.context`; object, optional)
- `reached_core` (`subscriptionStats.response.default.reached_core`; boolean, optional)
- `core_answer` (`subscriptionStats.response.default.core_answer`; string, optional)


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