---
title: "Pages the customer'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 customer API › subscription

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

## Authentication

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

## Path parameters

- `store` (`listSubscriptions.path.store`; string, required) — A hostname of the store.

## 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)
  - one of `"created"`
- `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)

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages the customer's subscriptions.

#### Example

```json
{
  "total": 0,
  "items": [
    {
      "display_status": "string",
      "next_event": {
        "kind": "string",
        "at": "string"
      },
      "renews_on_card": true,
      "actions": {
        "cancel": {
          "period_end": true,
          "now": true
        },
        "resume": true,
        "change_plan": true
      },
      "plan_changes": [
        {
          "price_id": "string",
          "name": "string",
          "tier": {
            "id": "string",
            "product_id": "string",
            "rank": 0,
            "name": "string"
          },
          "amount": 0,
          "currency": "string",
          "exponent": 0,
          "period": {
            "unit": "string",
            "multiplier": 0
          },
          "autorenew": true
        }
      ],
      "product": {
        "id": "string",
        "slug": "string",
        "path": "string",
        "url": "string",
        "title": "string",
        "category": "string",
        "deleted": true
      },
      "plan": {
        "tier": {
          "id": "string",
          "product_id": "string",
          "rank": 0,
          "name": "string"
        },
        "id": "string",
        "price_id": "string",
        "amount": 0,
        "currency": "string",
        "exponent": 0,
        "period": {
          "unit": "string",
          "multiplier": 0
        },
        "autorenew": true
      },
      "current_period": {
        "id": "string",
        "starts_at": "string",
        "ends_at": "string",
        "status": "string",
        "lead_in": true
      },
      "next_charge": {
        "at": "string",
        "amount": 0,
        "currency": "string",
        "exponent": 0
      },
      "instrument_id": "string",
      "renews_here": true,
      "scheduled_change": {
        "plan": {
          "tier": {
            "id": "string",
            "product_id": "string",
            "rank": 0,
            "name": "string"
          },
          "id": "string",
          "price_id": "string",
          "amount": 0,
          "currency": "string",
          "exponent": 0,
          "period": {
            "unit": "string",
            "multiplier": 0
          },
          "autorenew": true
        },
        "effective_at": "string"
      },
      "id": "string",
      "product_id": "string",
      "status": "string",
      "cancel_at_period_end": true,
      "cancel_reason": "string",
      "cancel_code": "string",
      "created_at": "string",
      "ended_at": "string"
    }
  ],
  "cursor": "string"
}
```

- `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`
  - `renews_on_card` (`listSubscriptions.response.200.items.renews_on_card`; boolean, required) — Whether the store holds its saved card for its renewals: billed here, renewing and not set to stop.
  - `actions` (`listSubscriptions.response.200.items.actions`; object, required) — The moves the store offers on it as of the answer, billed here and still renewing; 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.
      - `now` (`listSubscriptions.response.200.items.actions.cancel.now`; boolean, required) — Its cancel ends it at once, every payment of it refunded.
    - `resume` (`listSubscriptions.response.200.items.actions.resume`; boolean, required) — Taking a stop back.
    - `change_plan` (`listSubscriptions.response.200.items.actions.change_plan`; boolean, required) — Scheduling another plan from `plan_changes`, or keeping the current one.
  - `plan_changes` (`listSubscriptions.response.200.items.plan_changes`; array<object>, required) — The prices `changeSubscriptionPlan` schedules for it, ordered as offers are; empty unless `actions.change_plan`.
    - `price_id` (`listSubscriptions.response.200.items.plan_changes.price_id`; string, required)
    - `name` (`listSubscriptions.response.200.items.plan_changes.name`; string, required) — The price's title, else its tier's name.
    - `tier` (`listSubscriptions.response.200.items.plan_changes.tier`; object, required)
      - `id` (`listSubscriptions.response.200.items.plan_changes.tier.id`; string, required)
      - `product_id` (`listSubscriptions.response.200.items.plan_changes.tier.product_id`; string, required)
      - `rank` (`listSubscriptions.response.200.items.plan_changes.tier.rank`; number, required)
      - `name` (`listSubscriptions.response.200.items.plan_changes.tier.name`; string, required)
    - `amount` (`listSubscriptions.response.200.items.plan_changes.amount`; number, required)
    - `currency` (`listSubscriptions.response.200.items.plan_changes.currency`; string, required)
    - `exponent` (`listSubscriptions.response.200.items.plan_changes.exponent`; any of, required)
      - any of: `number`, `null`
    - `period` (`listSubscriptions.response.200.items.plan_changes.period`; object, required)
      - `unit` (`listSubscriptions.response.200.items.plan_changes.period.unit`; string, required)
      - `multiplier` (`listSubscriptions.response.200.items.plan_changes.period.multiplier`; number, required)
    - `autorenew` (`listSubscriptions.response.200.items.plan_changes.autorenew`; boolean, required) — Whether the plan it schedules renews past its first period.
  - `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`
  - `current_period` (`listSubscriptions.response.200.items.current_period`; any of, required) — Its latest paid period, whose end is when the next payment is due; null when none is paid.
    - any of: `object`, `null`
  - `next_charge` (`listSubscriptions.response.200.items.next_charge`; any of, required) — What its next payment charges and when, a day ahead of the period's end as every renewal is, on the plan it renews on; null unless it renews. A `current_period` that is a `lead_in` makes it the first.
    - any of: `object`, `null`
  - `instrument_id` (`listSubscriptions.response.200.items.instrument_id`; any of, required) — The saved payment method its renewals charge, as `getBillingProfile` names it.
    - any of: `string`, `null`
  - `renews_here` (`listSubscriptions.response.200.items.renews_here`; boolean, required) — Whether the store bills it here, so its plan and card can change.
  - `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)
  - `product_id` (`listSubscriptions.response.200.items.product_id`; string, required)
  - `status` (`listSubscriptions.response.200.items.status`; string, required)
  - `cancel_at_period_end` (`listSubscriptions.response.200.items.cancel_at_period_end`; boolean, required)
  - `cancel_reason` (`listSubscriptions.response.200.items.cancel_reason`; any of, required) — Why it stops or stopped, in the seller's or the customer's own words; null when no one gave one.
    - any of: `string`, `null`
  - `cancel_code` (`listSubscriptions.response.200.items.cancel_code`; any of, required) — How the store stopped it, when no one gave a reason in words: `refund` (its payments were refunded), `dispute` (a payment was disputed), `upgraded` (an upgrade replaced it), `account_erased` (the customer's account was erased) or `seller_ended` (the seller ended it); null otherwise.
    - 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)

### default

A problem; see https://api.sherpo.io/customer/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/customer-api/reference/list-subscriptions/index.md
