---
title: "List"
method: GET
path: "/subscriptions/"
---

# List

`GET /subscriptions/`

Returns a list all of customer subscriptions for a merchant, or a list of subscriptions for an individual customer.

## Query parameters

- `live` boolean[]
- `product` string
- `shipping_address` string
- `customer` string
- `created` string, date
- `created_start` string, date
- `created_end` string
- `updated` string, date
- `updated_start` string, date
- `updated_end` string, date

## Response `200`

200

- object
  - `count` integer
  - `next` string
  - `previous` string
  - `results` object[]
    - `public_id` string
    - `product_attribute` unknown
    - `price` string
    - `frequency_days` integer
    - `reminder_days` integer
    - `start_date` string
    - `cancelled` unknown
    - `cancel_reason_code` string
    - `cancel_reason` string
    - `merchant_order_id` string
    - `subscription_type` string
    - `components` object[]
      - `public_id` string
      - `quantity` integer
      - `product` string
    - `created` string
    - `updated` string
    - `extra_data` string
    - `live` string

## Other responses

- `403` — 403

---

[API](https://skmtc.net/ordergroove/apis/ordergroove-restrpc.md) · [All operations](https://skmtc.net/ordergroove/apis/ordergroove-restrpc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ordergroove/ordergroove-restrpc/versions/ba97e740d08c/schema)