---
title: "Get a list of product subscriptions"
method: GET
path: "/product_subscriptions"
tags: ["ProductSubscriptions"]
---

# Get a list of product subscriptions

`GET /product_subscriptions`

Retrieve information of multiple product subscriptions<br>抓取多筆定期購的信息

## Query parameters

- `per_page` integer
- `page` integer
- `previous_id` string
- `id` string

## Response `200`

OK

- object
  - `items` ProductSubscription[]
    - `id` string — Order item's ID (ID of an order item's collection, including item_type, item_id..and so on) <br>系統自行創建訂單品項ID
    - `recurring_count` integer — Subscription Term<br>定期購訂單期數
    - `duration` integer — Number of subscription cycle intervals<br>定期購週期長度
    - `duration_type` 'year' | 'month' | 'day' — Unit of subscription cycle interval<br>定期購週期單位
    - `next_billing_at` string — Next billing date<br>下次產單日期
    - `status` 'active' | 'inactive' — Status<br>狀態
    - `customer_id` string — Customer's ID<br>顧客ID
    - `customer_name` string — Customer's Name<br>顧客姓名
    - `customer_email` string — Customer's Email<br>顧客Email
    - `product_name` object — Product name<br>商品名稱
      - `en` string — Merchant defined English name<br>店家定義英文名稱
      - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
      - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
      - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
      - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
      - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
      - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
      - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
      - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
      - `fr` string — Merchant defined France name<br>店家定義法文名稱
    - `initial_billing_at` string — Initial billing date<br>最初產單日期<br>possibly null<br>可能為null
    - `created_at` string — Created date<br>創建時間
    - `updated_at` string — Updated date<br>更新時間
    - `enable_apply_user_credits` boolean — Enable apply user credits<br>是否開啟子單自動折抵購物金
  - `pagination` Paginatable
    - `current_page` integer — The current page number<br>當前分頁
    - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
    - `total_count` integer — Number of result in total<br>資料總量
    - `total_pages` integer — Number of pages in total<br>總頁數量

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)