查看文档
示例代码
API调试
接入技术服务
财务相关API
功能描述
用户可通过此 API,查询账户中的产品套餐相关信息,包括套餐包含产品、套餐开通时间、套餐有效期、套餐余量等。
请求URL
https://api.textin.com/user/finance/package
HTTP请求方法
HTTP GET
请求头说明(Request Header)
请在HTTP请求中添加以下自定义Header。
header 名 | 值 |
---|---|
x-ti-app-id | 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id |
x-ti-secret-code | 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code |
URL参数 (Parameters)
URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头,不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2
参数名 | 数据类型 | 是否必填 | 允许的值 | 描述 |
---|---|---|---|---|
api_path | string | 是 | 要查询的产品请求路径,例如通用文档解析的路径为 https://api.textin.com/ai/service/v1/pdf_to_markdown ,api路径可以在每个产品的api文档页获取 | |
include_all | integer | 否 | 0, 1 | 是否查询所有套餐,0:只查询有效套餐,1:查询所有套餐(包含已过期套餐),默认为0 |
响应体说明(Response Data)
Content-Type:application/json
JSON结构说明如下:
字段名 | 类型 | 描述 |
---|---|---|
code | integer | 错误码,详见“错误码说明” |
message | string | 状态说明 |
data | object | 结果信息 |
+ list | array | 套餐列表 |
套餐列表
字段名 | 类型 | 描述 |
---|---|---|
id | integer | 套餐ID |
service_list | array | 套餐包含产品名称列表 |
create_time | string | 套餐开通时间,格式:yyyy-MM-dd HH:mm:ss |
start_time | string | 套餐有效期开始时间,格式:yyyy-MM-dd HH:mm:ss |
end_time | string | 套餐有效期截止时间,格式:yyyy-MM-dd HH:mm:ss |
total_count | integer | 套餐总量 |
remaining_count | integer | 套餐剩余量 |
use_count | integer | 套餐已使用量 |
JSON结构示例
错误码说明
错误码 | 描述 |
---|---|
40101 | x-ti-app-id 或 x-ti-secret-code 为空 |
40102 | x-ti-app-id 或 x-ti-secret-code 无效,验证失败 |
40004 | 参数错误,请查看技术文档,检查传参 |
500 | 服务器内部错误 |