---
title: "Pages the store's subscriptions."
---

> 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`

## Authentication

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

## Path parameters

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

## Query parameters

- `filter` (`listSubscriptions.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listSubscriptions.query.sort`; string, optional) — Sorted by ended, rows without a value come last either way.
  - one of `"created"`, `"ended"`, `"status"`, `"tier"`, `"amount"`
- `direction` (`listSubscriptions.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listSubscriptions.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listSubscriptions.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listSubscriptions.query.count`; boolean, optional)
- `search` (`listSubscriptions.query.search`; string, optional)
  - minLength 1; maxLength 200
- `facets` (`listSubscriptions.query.facets`; array<string>, optional)

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages the store's subscriptions.

#### Example

```json
{
  "items": [
    {
      "display_status": "string",
      "next_event": {
        "kind": "string",
        "at": "string"
      },
      "actions": {
        "cancel": {
          "period_end": true,
          "now": true
        },
        "resume": true
      },
      "period_end": "string",
      "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
      },
      "plan": {
        "created_at": "string",
        "id": "string",
        "price_id": "string",
        "amount": 0,
        "currency": "string",
        "exponent": 0,
        "period": {
          "unit": "string",
          "multiplier": 0
        },
        "autorenew": true
      },
      "periods": {
        "items": [
          {
            "id": "string",
            "subscription_id": "string",
            "starts_at": "string",
            "ends_at": "string",
            "status": "string",
            "lead_in": true,
            "settlement_id": "string",
            "grant_id": "string",
            "currency": "string",
            "exponent": 0,
            "amount": 0,
            "order": {
              "id": "string",
              "number": 0
            }
          }
        ],
        "total": 0
      },
      "scheduled_change": {
        "plan": {
          "created_at": "string",
          "id": "string",
          "price_id": "string",
          "amount": 0,
          "currency": "string",
          "exponent": 0,
          "period": {
            "unit": "string",
            "multiplier": 0
          },
          "autorenew": true
        },
        "effective_at": "string"
      },
      "id": "string",
      "customer_id": "string",
      "product_id": "string",
      "plan_id": "string",
      "processor": "string",
      "external_ref": "string",
      "account_ref": "string",
      "status": "string",
      "cancel_at_period_end": true,
      "instrument_ref": "string",
      "cancel_reason": "string",
      "created_at": "string",
      "ended_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listSubscriptions.response.200.items`; array<object>, required)
  - `display_status` (`listSubscriptions.response.200.items.display_status`; string, required) — Its status as people read it: `cancelling` while it bills and is set to stop.
  - `next_event` (`listSubscriptions.response.200.items.next_event`; any of, required) — What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.
    - any of: `object`, `null`
  - `actions` (`listSubscriptions.response.200.items.actions`; object, required) — The moves the store offers on it as of the answer; a write still decides again.
    - `cancel` (`listSubscriptions.response.200.items.actions.cancel`; object, required)
      - `period_end` (`listSubscriptions.response.200.items.actions.cancel.period_end`; boolean, required) — Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.
      - `now` (`listSubscriptions.response.200.items.actions.cancel.now`; boolean, required) — Ending it now, revoking what it paid for.
    - `resume` (`listSubscriptions.response.200.items.actions.resume`; boolean, required) — Taking a stop back: it still bills and is set to stop.
  - `period_end` (`listSubscriptions.response.200.items.period_end`; any of, required) — When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.
    - any of: `string`, `null`
  - `customer` (`listSubscriptions.response.200.items.customer`; any of, required)
    - any of: `object`, `null`
  - `product` (`listSubscriptions.response.200.items.product`; any of, required)
    - any of: `object`, `null`
  - `plan` (`listSubscriptions.response.200.items.plan`; any of, required)
    - any of: `object`, `null`
  - `periods` (`listSubscriptions.response.200.items.periods`; object, required)
    - `items` (`listSubscriptions.response.200.items.periods.items`; array<object>, required)
      - `id` (`listSubscriptions.response.200.items.periods.items.id`; string, required)
      - `subscription_id` (`listSubscriptions.response.200.items.periods.items.subscription_id`; string, required)
      - `starts_at` (`listSubscriptions.response.200.items.periods.items.starts_at`; any of, required)
        - any of: `string`, `null`
      - `ends_at` (`listSubscriptions.response.200.items.periods.items.ends_at`; any of, required)
        - any of: `string`, `null`
      - `status` (`listSubscriptions.response.200.items.periods.items.status`; string, required)
      - `lead_in` (`listSubscriptions.response.200.items.periods.items.lead_in`; boolean, required) — A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.
      - `settlement_id` (`listSubscriptions.response.200.items.periods.items.settlement_id`; any of, required)
        - any of: `string`, `null`
      - `grant_id` (`listSubscriptions.response.200.items.periods.items.grant_id`; any of, required)
        - any of: `string`, `null`
      - `currency` (`listSubscriptions.response.200.items.periods.items.currency`; any of, required)
        - any of: `string`, `null`
      - `exponent` (`listSubscriptions.response.200.items.periods.items.exponent`; any of, required)
        - any of: `number`, `null`
      - `amount` (`listSubscriptions.response.200.items.periods.items.amount`; any of, required)
        - any of: `number`, `null`
      - `order` (`listSubscriptions.response.200.items.periods.items.order`; any of, required)
        - any of: `object`, `null`
    - `total` (`listSubscriptions.response.200.items.periods.total`; number, required)
  - `scheduled_change` (`listSubscriptions.response.200.items.scheduled_change`; any of, required) — The plan it renews on from `effective_at`, the end of its paid run, as the customer scheduled; null for none.
    - any of: `object`, `null`
  - `id` (`listSubscriptions.response.200.items.id`; string, required)
  - `customer_id` (`listSubscriptions.response.200.items.customer_id`; string, required)
  - `product_id` (`listSubscriptions.response.200.items.product_id`; string, required)
  - `plan_id` (`listSubscriptions.response.200.items.plan_id`; string, required)
  - `processor` (`listSubscriptions.response.200.items.processor`; any of, required)
    - any of: `string`, `null`
  - `external_ref` (`listSubscriptions.response.200.items.external_ref`; any of, required)
    - any of: `string`, `null`
  - `account_ref` (`listSubscriptions.response.200.items.account_ref`; any of, required)
    - any of: `string`, `null`
  - `status` (`listSubscriptions.response.200.items.status`; string, required)
  - `cancel_at_period_end` (`listSubscriptions.response.200.items.cancel_at_period_end`; boolean, required)
  - `instrument_ref` (`listSubscriptions.response.200.items.instrument_ref`; any of, required)
    - any of: `string`, `null`
  - `cancel_reason` (`listSubscriptions.response.200.items.cancel_reason`; any of, required)
    - any of: `string`, `null`
  - `created_at` (`listSubscriptions.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
  - `ended_at` (`listSubscriptions.response.200.items.ended_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listSubscriptions.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listSubscriptions.response.200.total`; number, optional)
- `facets` (`listSubscriptions.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` (`listSubscriptions.response.default.type`; string, required)
  - format `uri`
- `title` (`listSubscriptions.response.default.title`; string, required)
- `status` (`listSubscriptions.response.default.status`; integer, required)
- `detail` (`listSubscriptions.response.default.detail`; string, required)
- `code` (`listSubscriptions.response.default.code`; string, optional)
- `context` (`listSubscriptions.response.default.context`; object, optional)
- `reached_core` (`listSubscriptions.response.default.reached_core`; boolean, optional)
- `core_answer` (`listSubscriptions.response.default.core_answer`; string, optional)


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