---
title: "Get Customers's Membership Info"
method: GET
path: "/customers/membership_info"
tags: ["Customers"]
---
# Get Customers's Membership Info
`GET /customers/membership_info`
To get detailed information of the membership of the customers
獲取顧客的會員資料
## Query parameters
- `page` integer
- `per_page` integer
- `customer_ids[]` string[]
## Response `200`
OK
- object
- `items` MembershipInfo[]
- `id` string — Membership tier's ID
會員等級ID
- `membership_tier` object — Membership Tier Data
顧客會員等級
- `_id` string — Membership tier's ID
會員等級ID
- `level` integer — Level of Current Membership Tier
等級高低
- `name_translations` object — Name Translations
欄位名稱
- `en` string — Merchant defined English name
店家定義英文名稱
- `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱
- `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱
- `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱
- `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱
- `ja` string — Merchant defined Japanese name
店家定義日文名稱
- `th` string — Merchant defined Thai name
店家定義泰文名稱
- `id` string — Merchant defined Indian name
店家定義印度文名稱
- `de` string — Merchant defined Deutsch name
店家定義德文名稱
- `fr` string — Merchant defined France name
店家定義法文名稱
- `merchant_id` string — merchant ID
- `exclusive_product_count` integer — Number of exlcusive products in this membership tier
這個會員級別不能購買的產品數目
- `promotion_count` integer — Number of promotions in this membership tier
這個會員級別的優惠數目
- `valid_period` object — Valid period of this membership tier
這個會員級別的有效時段
- `type` string — Type
種類
- `time_unit` string — Time unit
時間單位
- `time_value` string — Time value
時間值
- `membership_tier_rules` MembershipTierRule[]
- `id` string — Membership tier rule's ID
會員等級規則ID
- `effect_type` 'upgrade' | 'extend' — Type of the membership_tier_rule
會員級別規則的類別
- `condition_interval` object
- `type` 'within_interval' | 'single_purchase' — Membership Upgrade Condition Type
會員升級條件類別
- within_interval: 指定期限內購物
- single_purchase: 單次購物
- `time_unit` 'month' — Membership Upgrade Condition Time Unit
會員升級條件時間單位
- `time_value` integer — Valid Period of the conditional interval if the type is "within_interval"
如類別是"within_interval"，升級條件時間的值
- `effect_interval` object
- `type` 'within_interval' | 'unlimited' — Membership Valid Period
會員有效期限
- `time_unit` 'month' — Unit of Valid Period
有效期限單位
- `time_value` integer — Valid Period of the effect interval if the type is "within_interval"
如類別是"within_interval"，有效期間的值
- `total_spending` object
- `cents` integer — Total Spending Requirement represent in cents
以仙為單位表示總消費要求
- `currency_symbol` string — Total Spending Requirement represent in currency_symbol
以currency_symbol表示總消費要求
- `currency_iso` string — Total Spending Requirement represent in currency_iso
以currency_iso表示總消費要求
- `label` string — Total Spending Requirement represent in label
以標籤表示總消費要求
- `dollars` number, float — Total Spending Requirement represent in dollars
以元為單位表示總消費要求
- `created_at` string — The timestamp that the rule is created at
規則創造時間
- `updated_at` string — The timestamp that the rule is updated at
規則更新時間
- `created_at` string
- `updated_at` string
- `tier_expires_at` string — The Membership Tier Expiry Time
會員到期時間
- `membership_tier_gap` object — Next membership tier's info
下一個會員等級的資料
- `next_tier` object — Membership Tier Data
顧客會員等級
- `id` string — Membership tier's ID
會員等級ID
- `level` integer — Level of Current Membership Tier
等級高低
-
*Having higher level with larger number.
等級數越高，數字越大
- `name_translations` object — Name Translations
欄位名稱
- `en` string — Merchant defined English name
店家定義英文名稱
- `zh-hant` string — Merchant defined Traditional Chinese name
店家定義繁體中文名稱
- `zh-cn` string — Merchant defined Simplified Chinese name
店家定義簡體中文名稱
- `vi` string — Merchant defined Vietnamese name
店家定義越南文名稱
- `ms` string — Merchant defined Malaysian name
店家定義馬來西亞文名稱
- `ja` string — Merchant defined Japanese name
店家定義日文名稱
- `th` string — Merchant defined Thai name
店家定義泰文名稱
- `id` string — Merchant defined Indian name
店家定義印度文名稱
- `de` string — Merchant defined Deutsch name
店家定義德文名稱
- `fr` string — Merchant defined France name
店家定義法文名稱
- `membership_tier_rules` MembershipTierRule[]
- `id` string — Membership tier rule's ID
會員等級規則ID
- `effect_type` 'upgrade' | 'extend' — Type of the membership_tier_rule
會員級別規則的類別
- `condition_interval` object
- `type` 'within_interval' | 'single_purchase' — Membership Upgrade Condition Type
會員升級條件類別
- within_interval: 指定期限內購物
- single_purchase: 單次購物
- `time_unit` 'month' — Membership Upgrade Condition Time Unit
會員升級條件時間單位
- `time_value` integer — Valid Period of the conditional interval if the type is "within_interval"
如類別是"within_interval"，升級條件時間的值
- `effect_interval` object
- `type` 'within_interval' | 'unlimited' — Membership Valid Period
會員有效期限
- `time_unit` 'month' — Unit of Valid Period
有效期限單位
- `time_value` integer — Valid Period of the effect interval if the type is "within_interval"
如類別是"within_interval"，有效期間的值
- `total_spending` object
- `cents` integer — Total Spending Requirement represent in cents
以仙為單位表示總消費要求
- `currency_symbol` string — Total Spending Requirement represent in currency_symbol
以currency_symbol表示總消費要求
- `currency_iso` string — Total Spending Requirement represent in currency_iso
以currency_iso表示總消費要求
- `label` string — Total Spending Requirement represent in label
以標籤表示總消費要求
- `dollars` number, float — Total Spending Requirement represent in dollars
以元為單位表示總消費要求
- `created_at` string — The timestamp that the rule is created at
規則創造時間
- `updated_at` string — The timestamp that the rule is updated at
規則更新時間
- `next_discount` number, float — The discount of next membership tier
下一個會員等級的折扣優惠
- `user_spending` number, float — The amount used to determine if a member meets the upgrade criteria, based on the "Membership Upgrade Condition" in the SHOPLINE Admin:
- For "Single Purchase," returns the highest order amount that meets the threshold during the membership period, or 0 if none meet the threshold.
- For "Purchase within specified period," returns the total spending within that period.
Returns null if the member is already at the highest tier.
用於判斷會員是否符合升級條件的消費金額，依據 Admin 中的「會員升級條件」設定決定回傳值：
- 若條件為「單次購物」，檢查目前會籍期間內是否有任一筆訂單達到門檻。若有訂單達門檻，則回傳金額最高者；若皆未達門檻，回傳 0。
- 若條件為「指定期限內購物」，回傳在指定期限內的累積消費金額。
若會員已達最高等級，則回傳 null。
- `user_spendings_for_extend` number, float — The amount used to determine if a member meets the extend criteria, based on the "Membership extension condition" in the SHOPLINE Admin:
- For "Single Purchase," returns the highest order amount that meets the threshold during the membership period, or 0 if none meet the threshold.
- For "Purchase within specified period," returns the total spending within that period.
Returns null if the current membership has a permanent duration.
用於判斷會員是否符合續會條件的消費金額，依據 Admin 中的「會員續會條件」設定決定回傳值：
- 若條件為「單次購物」，檢查目前會籍期間內是否有任一筆訂單達到門檻。若有訂單達門檻，則回傳金額最高者；若皆未達門檻，回傳 0。
- 若條件為「指定期限內購物」，回傳在指定期限內的累積消費金額。
若當前會籍為永久期限，則回傳 null。
- `next_total_spending` number, float — The amount of upgrading to next membership tier.
升等到下一會員等級所需之消費金額（Admin 設定的升級金額條件）
*若沒有下一級則回傳 null
- `extend_total_spending` number, float — The amount of extending in current membership tier.
續會目前會員等級所需之消費金額（Admin 設定的續會金額條件）
*若沒有設定則回傳 null
- `pagination` Paginatable
- `current_page` integer — The current page number
當前分頁
- `per_page` integer — Number of result per page
每頁顯示 n 筆資料
(Default: 24)
- `total_count` integer — Number of result in total
資料總量
- `total_pages` integer — Number of pages in total
總頁數量
## Other responses
- `401` — Bad authentication
- `403` — Forbidden
- `422` — Unprocessable entity error
- `500` — Server error
---
[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)