查询用户是否在应用开通范围

GET

/open-apis/pay/v1/paid_scope/check_user

当付费套餐是按人数收费或者限制最大使用人数时，开放平台会引导企业管理员设置“付费功能开通范围”。但是受开通范围限制，部分用户就无法使用对应的付费功能。可以通过此接口，在付费功能点入口判断是否允许某个用户进入使用。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/pay/v1/paid_scope/check_user?open_id&user_id=' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "valid",
    "price_plan_id": "price_9daf66c96968c003",
    "is_trial": false,
    "service_stop_time": "1572280518"
  }
}

请求参数

Query 参数

open_id

string

可选

用户 open_id，open_id 和 user_id 两个参数必须包含其一，若同时传入取 open_id

user_id

可选

用户 user_id，user_id 和 open_id 两个参数必须包含其一，若同时传入取 open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

返回码，非 0 表示失败

msg

string

返回码的描述

必需

data

object

返回的业务信息

必需

status

string

必需

用户是否在开通范围中，"valid" -该用户在开通范围中，"not_in_scope"-该用户不在开通范围中，"no_active_license"-企业未购买任何价格方案或价格方案已过期，"exceeds_maximum_limit"-企业当前配置的付费功能开通范围人数超出限制，需提醒管理员调整

price_plan_id

string

必需

租户当前使用的「价格方案ID」，对应开发者后台中「价格方案配置」中的「价格方案」

is_trial

boolean

必需

是否为试用版本，true-是试用版本；false-非试用版本

service_stop_time

string

必需

租户当前有生效价格方案时表示价格方案的到期时间，为时间unix时间戳