HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Product Subscriptions

Function

Get Product Subscriptions 定期購

URL

GET https://open.shopline.io/v1/product_subscriptions

Request Parameters

ParameterTypeDescriptionExample
per_ageIntegerNumbers of Customers per Page
每頁顯示 n 筆資料
ruby per_page: 24
pageIntegerPage Number
頁數
(Default: 1)
ruby per_page: 1
idsStringid filterid=in: 609bece6395f98004436b504,5f8fba8ae38809e23367b923

Request Example

Get product subscriptions with id filter

curl --location --request GET 'http://open.shoplineapp.com/v1/product_subscriptions?id=in:609bece6395f98004436b504,5f8fba8ae38809e23367b923' \
--header 'Authorization: Bearer ${token}'

Get Product subscription without id filter

curl --location --request GET 'https://open.shoplineapp.com/v1/product_subscriptions' \
--header 'Authorization: Bearer ${token}'

Get product subscription with per_page parameter

curl --location --request GET 'https://open.shoplineapp.com/v1/product_subscriptions/609bddf1985811004b9e542a' \
--header 'Authorization: Bearer ${token}'

Response Example

{
    "items": [
        {
            "id": "609bece6395f98004436b504",
            "recurring_count": 1,
            "duration": 30,
            "duration_type": "day",
            "next_billing_at": "2021-06-10T16:00:00.000+00:00",
            "status": "active",
            "customer_name": "王小V",
            "customer_email": "[email protected]",
            "product_name": {
                "zh-hant": "<~!@#$%^&*()_+test~~~~~~~>",
                "en": "(product name)",
                "zh-cn": "简体中文",
                "th": "ภาษาจีนตัวย่อ",
                "vi": "Tiếng Trung giản thể"
            },
            "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",
        },
        {
            "id": "5f8fba8ae38809e23367b923",
            "recurring_count": 1,
            "duration": 30,
            "duration_type": "day",
            "next_billing_at": "2020-11-19T16:00:00.000+00:00",
            "status": "active",
            "customer_name": "王小V",
            "customer_email": "[email protected]",
            "product_name": {
                "zh-hant": "定期購"
            },
            "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",
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 24,
        "total_count": 2,
        "total_pages": 1
    }
}