查询订阅合同列表

需要 read_subscription_contracts 权限点。
更多权限点使用信息，请参考：
访问权限。
POST https://{handle}.myshopline.com/admin/openapi/v20261201/subscription/contract.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
查询订阅合同列表
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
请求体
  • ids array
    合同id列表
    例子: [""]
  • next_billing_date_at_max string
    订阅下一次账单生成时间（结束）（格式见IOS8601）
  • next_billing_date_at_min string
    订阅下一次账单生成时间（开始）（格式见IOS8601）
  • last integer
    返回最后N个元素,最大支持50， 与first必须并且只有一个不能为空
  • created_at_max string
    订阅合同生成时间（结束）（格式见IOS8601）
  • first integer
    返回前N个元素,最大支持50， 与last必须并且只有一个不能为空
  • reverse boolean
    排序反转
  • user_ids array
    用户id列表，最多50个
    例子: [""]
  • updated_at_min string
    订阅合同更新时间（开始）（格式见IOS8601）
  • after string
    某个cursor之后，值可以是 orderId, contractId等，根据具体的API表示具体的业务数据id，before 和 after 只允许其一有值
  • before string
    某个之前，值可以是 orderId, contractId等，根据具体的API表示具体的业务数据id，before 和 after 只允许其一有值
  • status array
    订阅合同状态（ ACTIVE, FAILED, CANCELLED, EXPIRED）
    例子: [""]
  • updated_at_max string
    订阅合同更新时间（结束）（格式见IOS8601）
  • created_at_min string
    订阅合同生成时间（开始）（格式见IOS8601）
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • subscription_contractsobject[]
    订阅合同信息列表
  • status string
    订阅合同状态（ ACTIVE, FAILED, CANCELLED, EXPIRED）
  • periods integer
    当前合同已执行的期数
  • next_billing_date string
    下一个账单日期
  • last_payment_status string
    上一次付款状态
  • created_at string
    创建时间
  • appobject
    订阅插件信息
  • app_key string
    app插件的key
  • customerobject
    用户信息
  • email string
    用户邮箱
  • id string
    用户id
  • nick_name string
    用户名称
  • phone string
    用户电话
  • shipping_addressobject
    收货地址
  • district string
    收货人区
  • district_code string
    收货人区code
  • province_code string
    收货人省份code
  • country_code string
    国家或地区，请参考国家代码规范传参，https://aurogon-portal.yy.com/document/interface/478
  • city string
    收货人市
  • phone string
    收货人联系方式
  • last_name string
    收货人姓
  • company string
    公司名称
  • zip string
    邮编
  • province string
    收货人省份
  • address1 string
    收货人详细地址
  • country string
    国家或者地区
  • address2 string
    收货人详细地址附加
  • city_code string
    收货人市code
  • first_name string
    收货人名
  • origin_orderobject
    原始订单信息
  • id string
    订单号
  • line_itemsobject[]
    合同关联的商品
  • variant_attribute string
    商品属性
  • amount string
    商品的金额（两位精度的字符串，如"88.10"）
  • image_url string
    商品主图
  • pricing_policyobject[]
    订阅周期折扣
  • cycle_discountsobject[]
    订阅行的每个周期的调整
  • adjustment_type string
    优惠类型, FIXED_AMOUNT: 减额，PERCENTAGE: 折扣(减去百分比)
  • adjustment_value long
    优惠值 扣减金额（分）或万分比
  • sku string
    商品码
  • group_id string
    商品组id
  • quantity integer
    商品数量
  • attributesobject[]
    商品属性
  • key string
    属性key或者name
  • value string
    属性值
  • title string
    商品标题
  • version string
    商品版本
  • product_source string
    商品来源 main_site主站商品、customize自定义商品
  • variant_id string
    商品sku序列号
  • amount_setobject
    商品的金额
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
  • currency_code string
    货币
  • shop_moneyobject
    卖家侧金额
  • currency_code string
    货币
  • amount string
    金额
  • updated_at string
    更新时间
  • billing_policyobject
    订阅协议计费策略
  • max_cycles integer
    最大的订阅周期
  • min_cycles integer
    最小的订阅周期
  • interval string
    间隔单位, (DAY,MONTH,WEEK,YEAR)
  • interval_count integer
    间隔值
  • currency_code string
    币种
  • delivery_infoobject
    运送信息
  • delivery_name string
    方案名称
  • delivery_seq string
    运费方案的seq
  • id string
    合同id
  • customer_payment_methodobject
    付款方式
  • method_code string
    支付方式编码
  • store_payment_id string
    支付方式ID
  • channel_code string
    支付渠道编码
  • instrument_detailobject
    支付工具详情
  • cardobject
    卡信息
  • expire_year string
    有效期：年
  • first string
    卡号前置展示位
  • holder string
    持卡人姓名
  • last string
    卡号后置展示位
  • brand string
    卡品牌
  • brand_icon string
    卡图标
  • expire_month string
    有效期：月
  • type string
    类型 card / account. card: 卡基；account: 账基
  • instrument_seq string
    支付工具ID
  • page_infoobject
    分页信息
  • has_previous_page boolean
    1
  • start_cursor string
    1
  • end_cursor string
    1
  • has_next_page boolean
    1
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

— header required

Body

required
{
  "last": 0,
  "reverse": false,
  "before": "",
  "next_billing_date_at_max": "",
  "status": [
    ""
  ],
  "after": "",
  "created_at_max": "",
  "ids": [
    ""
  ],
  "next_billing_date_at_min": "",
  "created_at_min": "",
  "updated_at_min": "",
  "user_ids": [
    ""
  ],
  "first": 0,
  "updated_at_max": ""
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/subscription/contract.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.