SHshoplineapp
ProductSubscriptions

Get a list of product subscriptions

Changed on

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

get/product_subscriptions

Request

  • Base URL
    https://open.shopline.io/v1
  • URL
    https://open.shopline.io/v1/product_subscriptions
  • Auth
    HTTP bearer

Query parameters

per_pageinteger

Numbers of Products per page<br>每頁顯示 n 筆資料

pageinteger

Page Number<br>頁數

previous_idstring

Previous ID<br>上一頁的ID

idstring

Only show specific products based on IDs<br>結果只顯示哪些商品

updated_afterstring

Filter product subscriptions by specific updated_after time.<br>取得大於等於指定時間的定期購<br> *Should use UTC time'

updated_beforestring

Filter product subscriptions by specific updated_before time.<br>取得小於等於指定時間的定期購<br> *Should use UTC time'

Response

OK

Example response

{
  "items": [
    {
      "id": "5b2b64bd8d1db91156002687",
      "recurring_count": 1,
      "duration": 1,
      "next_billing_at": "2019-09-26T09:56:16.803+00:00",
      "customer_id": "5b2b64bd8d1db91156002688",
      "customer_name": "郭美玉",
      "customer_email": "testing@shopline.com",
      "product_name": {
        "en": "Sl Watch",
        "zh-hant": "Sl 手錶"
      },
      "initial_billing_at": "2019-09-26T09:56:16.803+00:00",
      "created_at": "2019-09-26T09:56:16.803+00:00",
      "updated_at": "2019-09-26T09:56:16.803+00:00",
      "enable_apply_user_credits": true
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}

Changes

  • d2518391b149Revision changes
    • info

      added the new optional query request parameter updated_after

    • info

      added the new optional query request parameter updated_before