查询店铺生效套餐

需要 read_store_metrics 权限点。
更多权限点使用信息，请参考：
访问权限。
GET https://{handle}.myshopline.com/admin/openapi/v20260301/store/subscription
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
查询店铺生效中的的套餐，包含本期套餐和下期套餐（若有）。
  • 本期套餐：已成功订阅，且已进入套餐周期的套餐。
  • 下期套餐（若有）：已成功订阅，但还未进入套餐周期的套餐。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
  • include_trial boolean
    返回的结果是否需要包含试用类型的套餐。套餐有两种类型：试用套餐和付费套餐。
    • true：返回试用和付费类型的套餐。
    • false：仅返回付费套餐，不返回试用套餐。

    默认值：false
    例子: true
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • dataobject[]
    响应数据体。
  • auto_recurring boolean
    套餐订阅是否已开启自动续费。
    • true：该套餐订阅已开启自动续费，套餐到期时将触发自动续费。
    • false：该套餐订阅未开启自动续费。
    例子: true
  • billing_cycle string
    套餐订阅的周期。
    • 1year：年付，该套餐订阅的周期为一年。
    • monthly：月付，该套餐订阅的周期为一个月。
    例子: 1year
  • business_parameters map
    套餐的附加信息。
    例子: {"MCC_packageVersion":"pe","SLP":"Premium"}
  • cancelled_at long
    套餐订阅的取消时间，格式为 13 位毫秒级时间戳。
    废弃
    该字段预计将于 v20260301 版本废弃。
    例子: 1689504361000
  • created_at long
    套餐订阅的创建时间，格式为 13 位毫秒级时间戳。
    例子: 1689504361000
  • enable boolean
    套餐订阅是否已被激活。
    • true：已激活，即套餐订阅绑定的店铺已完成店铺创建。
    • false：未激活，即套餐订阅绑定的店铺未完成店铺创建。
    废弃
    该字段预计将于 v20260301 版本废弃。
    例子: true
  • end_at long
    套餐订阅的结束时间，格式为 13 位毫秒级时间戳。已包含套餐订阅的赠送时长，但不包含套餐订阅的宽限期时长。
    例子: 1689504361000
  • extend_peroid integer
    套餐订阅的赠送时长（单位秒）。
    例子: 6
  • grace_period integer
    套餐订阅的宽限期（单位秒）。宽限期为套餐订阅到达结束时间后，店铺欠费停用前，套餐仍能正常使用的时长。
    例子: 7
  • grace_period_end_at long
    套餐订阅的宽限期结束时间，格式为 13 位毫秒级时间戳。
    例子: 1692182769000
  • merchant_email string
    商家邮箱。
    例子: open001@shopline.com
  • merchant_id long
    商家注册帐号对应的唯一识别 ID。
    例子: 4200320559
  • next_recurring_at long
    套餐订阅下一次续费的时间，格式为 13 位毫秒级时间戳。
    废弃
    该字段预计将于 v20260301 版本废弃。
    例子: 1692182769000
  • payment_method string
    套餐订阅的支付方式。
    • CreditCard：信用卡
    • UnionPayCard：中国银联
    • Paypal：Paypal
    • WeChat：微信支付
    废弃
    该字段预计将于 v20260301 版本废弃。
    例子: CreditCard
  • product_line string
    店铺套餐的唯一标识。不同地区售卖的套餐可能不同。其中gloabl_ 开头（如 global_standard）的套餐适用于新加坡、马来西亚和泰国地区的商家，cn_ 开头（如 cn_standard）的套餐适用于上述地区之外的其他所有地区的商家。
    • enterprise：企业版。
    • global_lite：精简版。
    • global_starter：入门版。
    • global_essential：基础版。
    • global_standard：标准版。
    • global_premium：旗舰版。
    • cn_lite：精简版。
    • cn_monthly_standard：入门版。
    • cn_basic：基础版。
    • cn_standard：标准版。
    • cn_plus：旗舰版。
    • retail：零售版。
    • devstore：开发者套餐。
    • sandbox_enterprise：沙箱企业版。
    例子: cn_monthly_standard
  • product_name map
    套餐的名称。包含简体中文、英文、繁体中文、马来语和日语等。
    例子: {"en":"Starter","jp":"スターター","malay":"Versi pertama","zh-hans-cn":"入门版","zh-hant-tw":"入門版"}
  • remarks string
    套餐开通时的备注信息。
    废弃
    该字段预计将于 v20260301 版本废弃。
  • start_at long
    套餐订阅的开始时间，格式为 13 位毫秒级时间戳。
    例子: 1689504369000
  • status string
    套餐订阅的状态。
    • active： 启用中。套餐订阅正常生效中。
    • expired：已到期。套餐订阅已到达结束时间，但仍处于宽限期内。
    例子: active
  • store_handle string
    店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001。
  • store_id long
    店铺 ID。
    例子: 1666942294702
  • sub_id string
    套餐订阅 ID，可用作套餐订阅的唯一键。
    例子: SUB6025977562148654208
  • type string
    套餐订阅的类型。
    • trial：试用（本期）。即试用类型的套餐。
    • paid：付费（本期）。即付费类型的套餐，且套餐订阅已进入套餐周期。
    • preorder：付费（下一期）。即付费类型的套餐，且套餐订阅还未进入套餐周期。
    例子: trial
  • message string
    响应信息。
    废弃
    该字段预计将于 v20260301 版本废弃。
    例子: success
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "include_trial": true
}

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/store/subscription \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
查询包含试用期套餐的当前生效套餐
Response
{
  "code": "SUCCESS",
  "data": [
    {
      "auto_recurring": true,
      "billing_cycle": "monthly",
      "business_parameters": {
        "MCC_packageVersion": "pe",
        "SLP": "Premium"
      },
      "cancelled_at": null,
      "created_at": 1737096898846,
      "enable": false,
      "end_at": 1833688800000,
      "extend_peroid": null,
      "grace_period": 604800,
      "grace_period_end_at": 1834293600000,
      "merchant_email": "openapi_v2@shopline.com",
      "merchant_id": 2000234880,
      "next_recurring_at": 1833688800000,
      "payment_method": null,
      "product_line": "cn_plus",
      "product_name": {
        "en": "Premium",
        "id": "Versi unggal",
        "ja": "プレミアム",
        "ms": "Versi terakhir",
        "th": "เวอร์ชันสุดยอด",
        "vi": "Phiên bản cao cấp nhất",
        "zh-hans-cn": "旗舰版",
        "zh-hant-tw": "旗艦版"
      },
      "remarks": "This is a test",
      "start_at": 1831006800000,
      "status": "active",
      "store_handle": "openapiceshidianpu",
      "store_id": 1672369729606,
      "sub_id": "6824447848118755284",
      "type": "preorder"
    },
    {
      "auto_recurring": true,
      "billing_cycle": "1year",
      "business_parameters": {
        "MCC_packageVersion": "pe",
        "SLP": "Premium"
      },
      "cancelled_at": null,
      "created_at": 1734664595491,
      "enable": false,
      "end_at": 1831006800000,
      "extend_peroid": null,
      "grace_period": 604800,
      "grace_period_end_at": 1831611600000,
      "merchant_email": "openapi_v2@shopline.com",
      "merchant_id": 2000234880,
      "next_recurring_at": 1831006800000,
      "payment_method": null,
      "product_line": "cn_plus",
      "product_name": {
        "en": "Premium",
        "id": "Versi unggal",
        "ja": "プレミアム",
        "ms": "Versi terakhir",
        "th": "เวอร์ชันสุดยอด",
        "vi": "Phiên bản cao cấp nhất",
        "zh-hans-cn": "旗舰版",
        "zh-hant-tw": "旗艦版"
      },
      "remarks": null,
      "start_at": 1736308800000,
      "status": "active",
      "store_handle": "openapiceshidianpu",
      "store_id": 1672369729606,
      "sub_id": "6783640569002072715",
      "type": "paid"
    }
  ],
  "message": "success"
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.