---
title: "Pages what customers may reach, as their grants and subscriptions add up."
---

> 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}/entitlements`

## Authentication

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

## Path parameters

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

## Query parameters

- `customer` (`listEntitlements.query.customer`; string, optional) — An id.
  - minLength 1
- `filter` (`listEntitlements.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listEntitlements.query.sort`; string, optional)
  - one of `"rebuilt"`
- `direction` (`listEntitlements.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listEntitlements.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listEntitlements.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listEntitlements.query.count`; boolean, optional)

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages what customers may reach, as their grants and subscriptions add up.

#### Example

```json
{
  "items": [
    {
      "customer": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "erased": true
      },
      "product": {
        "id": "string",
        "slug": "string",
        "path": "string",
        "url": "string",
        "title": "string",
        "category": "string",
        "deleted": true
      },
      "customer_id": "string",
      "product_id": "string",
      "tier_rank": 0,
      "expires_at": "string",
      "tier_expires_at": "string",
      "next_change_at": "string",
      "rebuilt_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listEntitlements.response.200.items`; array<object>, required)
  - `customer` (`listEntitlements.response.200.items.customer`; any of, required)
    - any of: `object`, `null`
  - `product` (`listEntitlements.response.200.items.product`; any of, required)
    - any of: `object`, `null`
  - `customer_id` (`listEntitlements.response.200.items.customer_id`; string, required)
  - `product_id` (`listEntitlements.response.200.items.product_id`; string, required)
  - `tier_rank` (`listEntitlements.response.200.items.tier_rank`; number, required)
  - `expires_at` (`listEntitlements.response.200.items.expires_at`; any of, required)
    - any of: `string`, `null`
  - `tier_expires_at` (`listEntitlements.response.200.items.tier_expires_at`; any of, required)
    - any of: `string`, `null`
  - `next_change_at` (`listEntitlements.response.200.items.next_change_at`; any of, required)
    - any of: `string`, `null`
  - `rebuilt_at` (`listEntitlements.response.200.items.rebuilt_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listEntitlements.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listEntitlements.response.200.total`; number, optional)
- `facets` (`listEntitlements.response.200.facets`; map<map<number>>, optional)

### 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` (`listEntitlements.response.default.type`; string, required)
  - format `uri`
- `title` (`listEntitlements.response.default.title`; string, required)
- `status` (`listEntitlements.response.default.status`; integer, required)
- `detail` (`listEntitlements.response.default.detail`; string, required)
- `code` (`listEntitlements.response.default.code`; string, optional)
- `context` (`listEntitlements.response.default.context`; object, optional)
- `reached_core` (`listEntitlements.response.default.reached_core`; boolean, optional)
- `core_answer` (`listEntitlements.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/list-entitlements/index.md
