跳转到主要内容
1签 (OneSign)

PricedProduct

本页内容

当前应用可选择的一个计费项目。先向使用者展示名称、金额与单位,再按需要创建实际报价。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
sku 是

套餐标识,从当前应用价格表取得。

类型:string

查看取值约束
  • 格式 ^(?:[1-6]|100[1-4]|300[1-4]|day[123])$
category 是

服务或套餐的类别。

类型:string

查看取值约束
  • 可选值 enterprise_signature / distribution_points / distribution_membership
  • enterprise_signature — 企业签名套餐
  • distribution_points — 分发下载点数
  • distribution_membership — 分发会员
name 是

这项套餐或服务的展示名称。

类型:string

amount 是

以站内单位表示的金额,小数字符串应原样传递。

类型:string

查看取值约束
  • 格式 ^(?:0|[1-9][0-9]{0,9})\.[0-9]{2}$
plan_id 是

签名套餐编号。

类型:integer | null

查看取值约束
  • integer (最小值 1,最大值 3)
quantity 是

购买数量,具体单位见 quantity_unit。安装扩容时单位为设备台数。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 2147483647
quantity_unit 是

套餐购买数量的计量单位。

类型:string

查看取值约束
  • 可选值 days / months / download_points / years
  • days — 天
  • months — 月
  • download_points — 下载点数
  • years — 年
service_days 是

该套餐提供的服务有效天数。

类型:integer | null

查看取值约束
  • integer (最小值 1,最大值 3650)

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应