事件分组事件标识
appsubscriptionappsubscription/create
每当商家订阅应用套餐时触发。触发场景包括:
  • 创建新订阅。
  • 订阅到期后续订,开启新的计费周期。
请求头
  • X-Shopline-Topic string required
    事件的唯一标识。
    例子: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    该请求的签名。收到请求后,你需要对该签名进行 验签 以验证数据的真实性和完整性。
    例子: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺的域名。
    例子: example.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺 ID。
    例子: 1610418123456
  • X-Shopline-Merchant-Id string required
    商家 ID。
    例子: 2000001234
  • X-Shopline-API-Version string required
    API 版本号。
    例子: v20250601
  • X-Shopline-Webhook-Id string required
    该 Webhook 事件的 ID。
    例子: b54557e48a5fbf7d70bcd043
请求体
  • appkey string
    应用的全局唯一标识符。
    例子: 56978e0b3f33365396d7786a62ed0a03727e3212
  • handle string
    店铺在 SHOPLINE 系统中的唯一标识符,对应域名中 {handle}.myshopline.com{handle} 部分。
    例子: discount
  • secondChannelId string
    二级渠道标识符,用于标识线下 POS 门店等特定销售渠道。
    适用场景:
    • 当套餐以单个门店为单位销售时,该字段标识具体门店。
    • 当套餐以整个店铺为单位销售时,该字段为空。
    例子: 4567223323
  • subId string
    订阅订单的唯一标识号。
    例子: 6578332207010012345
  • subPackageobject
    订阅套餐详情信息。
  • autoRenewStatus boolean
    标识店铺是否已为该应用启用自动续费。
    • true:已开启自动续费
    • false:未开启自动续费
  • endAt long
    套餐失效时间,格式为 13 位毫秒级时间戳。
    例子: 1757239200000
  • featureKeyList array
    指套餐包含的功能点,仅做功能授权。若应用配置时未设置,则返回 null
    例子: ["\"KeyName1\":\"demo1\",\"KeyName2\":\"demo2\",\"KeyName3\":\"demo3\",\"KeyName4\":\"demo4\""]
  • gracePeriod long
    当前订阅套餐的宽限期。
    宽限期表示订阅到期后用户可继续使用应用功能的延长时段。
    宽限期按自然时间计算,例如,套餐在 22:00:00 到期时,设置 1 天宽限期将表示应用在第二天 22:00:00 精确失效。
    例子: 2
  • gracePeriodUnit string
    宽限期时间单位。跟gracePeriod共同使用标识当前订阅套餐的宽限期时长。 有效枚举值包含:
    • SECOND:秒。应用套餐和增值服务使用该单位。
    • DAY:天。一次性付费商品使用该单位。
  • isEnterpriseGift boolean
    指示当前订阅是否属于 Enterprise 套餐赠送。 如果应用未参与 Enterprise 套餐赠送计划,可忽略此字段。
    • true:属于企业打包赠品
    • false:非赠品
    默认值:false
  • period integer
    套餐周期单位(periodType)数量。 该字段与 periodType 配合使用,用于计算计费周期时长。
    例子: 1
  • periodType string
    套餐周期单位。有效枚举值包含:
    • DAY:天
    • MONTH:月
    • YEAR:年
  • serviceKeyListobject[]
    指代套餐中包含的服务,包含服务剩余的数量和服务有效时长限制。
  • availableQty long
    服务剩余可用数量。
    例子: 20
  • indefinite boolean
    标识当前套餐是否为无限期服务。
    • true:无限期服务
    • false:有限期服务
  • serviceKey string
    服务能力唯一标识符。
    例子: email_100
  • totalQty long
    服务总数量。
    例子: 100
  • spuKey string
    套餐的唯一标识符,在创建套餐时定义。
    例子: email
  • startAt long
    套餐生效时间,格式为 13 位毫秒级时间戳。
    例子: 1756977716000
  • trial boolean
    指示当前订阅是否为试用套餐。
    • true:试用套餐
    • false:正式套餐
  • subTime long
    支付成功时间,格式为 13 位毫秒级时间戳。
    例子: 1706810461000
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?