v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB

ProductSubscriptions

Get Product Subscription

To get detailed information for a specific product subscription with its ID 使用定期購ID獲取特定一個定期購的詳細資料

get/product_subscriptions/{id}

Path parameters

idstring required

Product Subscription's ID 定期購ID

Response

idstring

Order item's ID (ID of an order item's collection, including item_type, item_id..and so on) 系統自行創建訂單品項ID

recurring_countinteger

Subscription Term 定期購訂單期數

durationinteger

Number of subscription cycle intervals 定期購週期長度

duration_type'year' | 'month' | 'day'

Unit of subscription cycle interval 定期購週期單位

next_billing_atstring

Next billing date 下次產單日期

status'active' | 'inactive'

Status 狀態

customer_idstring

Customer's ID 顧客ID

customer_namestring

Customer's Name 顧客姓名

customer_emailstring

Customer's Email 顧客Email

initial_billing_atstring

Initial billing date 最初產單日期 possibly null 可能為null

created_atstring

Created date 創建時間

updated_atstring

Updated date 更新時間

enable_apply_user_creditsboolean

Enable apply user credits 是否開啟子單自動折抵購物金

Example response

{
  "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
}