抖音开放平台Logo
开发者文档
控制台
  • OpenAPI 列表
  • 移动/网站应用 OpenAPI SDK 总览
  • 状态码排查工具
  • 个人资料
  • 关系能力
  • 内容能力
  • 互动评论
  • 私信群聊
  • 企业号开放能力(内测结束暂不开放)
  • 生活服务开放能力
  • 工具能力
  • 服务市场开放能力
  • 服务订购关系
  • 查询用户的服务购买信息
  • 扣除用户服务的剩余使用次数/条数
  • 导入外部订购数据
  • 删除导入的外部订购数据
  • 小程序推广计划
  • 联合授权
  • 查询用户的服务购买信息

    收藏
    我的收藏

    接口说明

    Scope: market.service.user 需要申请权限 不需要用户授权

    该接口用于查询用户的服务购买信息。如果服务商提供的服务是付费服务,可以使用该接口进行用户身份校验配置,防止用户通过其他手段绕开服务市场付费流程,自行打开应用,从而给服务商带来损失。

    • 业务场景
      • 对于未设置体验版、定制版、标准版的服务,不返回服务规格类型 specification_type
      • 响应参数中的 remain_service_times、effective_time 和 expire_time,根据服务周期的不同返回不同的结果:
        • 对于服务周期为“按次服务”和“按条服务”的服务,返回 remain_service_times
        • 对于服务周期为“时间类型”的服务,返回 effective_time 和 expire_time
      • 对于服务周期为“时间类型”且时间设置为“永久”的服务,expire_time 固定返回-1
      • 为了方便服务商对创建的服务进行测试,允许服务商在服务创建/修改界面中配置测试用户白名单。对于测试环境和 open_id 为白名单中的用户,使用下面的逻辑进行返回:

    环境

    是否为白名单用户

    处理逻辑

    测试环境

    (请求参数:is_test_env = true)

    • 服务周期为“按次服务”或“按条服务”的服务,remain_service_times固定返回1
    • 服务周期为“时间类型”的服务,effective_time和expire_time固定返回-1

    返回空数据

    正式环境

    (请求参数:is_test_env = false)

    是/否

    根据用户实际购买情况返回

    使用限制

    • 该接口仅适用于平台应用类服务
    • 服务商只能查询自己创建的服务

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/market/service/user/purchase/list/
    HTTP Method
    GET
    Scope
    market.service.user
    权限要求
    • 需要申请服务市场服务订购相关权限(scope:market.service.user),申请路径:抖音开放平台控制台 > 移动应用(或网站应用) > 应用详情 > 能力管理 > 特殊权限
    • 不需要用户授权

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    示例:application/json
    固定值"application/json"
    Query
    is_test_env必填Bool
    示例:true

    是否为测试环境:

    • true为测试环境,在服务未发布前或需要测试时使用测试环境参数
    • false为正式环境,需要传入的服务已发布
    open_id必填String
    示例:ba253642-0590-40bc-9bdf-9a1334******

    查询订阅信息目标用户的唯一标识,通过/oauth/access_token/获取

    service_id必填String
    示例:7021602203591******

    服务id,服务的唯一标识,可在发布“平台应用类”功能中【应用配置页】和【服务详情页】中获取

    请求示例
    curl --location --request GET 'https://open.douyin.com/market/service/user/purchase/list/?open_id=ba253642-0590-40bc-9bdf-9a1334******&service_id=7021602203591******&is_test_env=true' \ --header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******' \ --header 'Content-Type: application/json'

    响应参数

    Body展开全部子属性
    dataStruct
    展开子属性
    extraStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "data": { "error_code": 0, "description": "", "purchase_info_list": [ { "service_id": "7021602203591******", "service_name": "服务名称", "service_status": 1, "specification_type": 1, "specification_title": "体验版", "service_mode_id": "free", "remain_service_times": 10 }, { "service_id": "7021602203591******", "service_name": "服务名称", "service_status": 1, "specification_type": 3, "specification_title": "标准版", "service_mode_id": "standard_1", "effective_time": 1651409686000, "expire_time": 1651841686602 } ] }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202008121419360101980821035705926A", "now": 1597213176393 } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2002190008
    access_token过期,请刷新或重新授权
    参考生成 client_token 获取接口(https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/openapi/account-permission/client-token)调用的凭证 client_access_token
    2002190002
    access_token无效
    检查请求头的access-token参数
    2002100007
    无权限操作
    检查请求参数的service_id
    2002100004
    系统繁忙,此时请开发者稍候再试
    稍后重试
    2002100005
    参数不合法
    检查请求参数