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

AppPricing

本页内容

当前应用的参考价格、可用产品与退款规则。参考价格用于选择,实际付款按原有效报价确认。

如何阅读本模型

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

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

字段定义

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

字段必需说明
app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
module 是

业务模块。enterprise 为企业签名,distribution 为普通应用分发。

类型:string

查看取值约束
  • 可选值 enterprise / distribution
  • enterprise — 企业签名
  • distribution — 普通应用分发
generated_at 是

本次结果的生成时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
  • 最大值 9007199254740991
pricing_revision 是

报价所绑定的价格修订号。付款时按报价原值确认。

类型:string

查看取值约束
  • 格式 ^P[a-f0-9]{64}$
reference_only 是

此价格是否仅供展示和估算。

类型:boolean

查看取值约束
  • 固定值 true
payment_api_available 是

此参考价格接口是否直接提供付款。实际付款使用购买报价和确认接口。

类型:boolean

查看取值约束
  • 固定值 false
currency 是

站内金额单位及展示信息,按本站配置解释所有金额。

类型:object

currency.code 是

站内金额单位代码,例如 CNY、USD 或 POINT。

类型:string

查看取值约束
  • 可选值 CNY / USD / EUR / HKD / GBP / POINT / CUSTOM
currency.unit 是

站点配置的金额单位显示名称。

类型:string

currency.prefix 是

显示金额时加在数值前的符号或文字。

类型:string

currency.suffix 是

显示金额时加在数值后的符号或文字。

类型:string

currency.external_settlement 是

外部支付的结算币种以支付渠道为准。

类型:string

查看取值约束
  • 固定值 payment_provider
products 是

当前账号为此应用可选的套餐与价格。展示价格不代替实际付款报价。

类型:object[]

查看取值约束
  • 最少元素 6
  • 最多元素 12
products[].sku 是

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

类型:string

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

服务或套餐的类别。

类型:string

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

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

类型:string

products[].amount 是

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

类型:string

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

签名套餐编号。

类型:integer | null

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

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

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 2147483647
products[].quantity_unit 是

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

类型:string

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

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

类型:integer | null

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

按天购买的配置,例如是否开放、每日价格和允许天数;不是逐日用量统计。

类型:object[]

查看取值约束
  • 最多元素 3
daily[].sku 是

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

类型:string

查看取值约束
  • 格式 ^day[123]$
daily[].plan_id 是

签名套餐编号。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 3
daily[].enabled 是

此选项或预算当前是否启用。

类型:boolean

daily[].unit_amount 是

按天开通时每一天的价格。

类型:string

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

按天购买时允许的最少天数。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 3650
daily[].max_days 是

按天购买时允许的最多天数。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 3650
refund_policy 是

适用于此类套餐的退款规则。

类型:object | null

refund_policy.window_seconds 是

购买成功后允许申请退款的时间窗口,单位为秒。

类型:integer

查看取值约束
  • 最小值 0
  • 最大值 315360000
refund_policy.daily_supported 是

按天开通是否允许退款,以当前站点设置为准。

类型:boolean

refund_policy.redemption_supported 是

使用密钥兑换开通的订单是否允许退款。

类型:boolean

查看取值约束
  • 固定值 false
refund_policy.other_rules_apply 是

退款还需满足其他资格条件,实际资格由退款查询接口给出。

类型:boolean

查看取值约束
  • 固定值 true

相关接口

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

作为成功响应