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

PurchaseQuote

本页内容

为具体应用创建的购买报价。报价本身不扣款,付款前核对有效期、金额、价格和单位修订号。

如何阅读本模型

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

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

字段定义

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

字段必需说明
id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

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

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

类型:string

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

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

类型:string

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

这份报价的当前业务状态,用来决定继续付款还是核对原回执。

类型:string

查看取值约束
  • 可选值 awaiting_payment / paid / expired
  • awaiting_payment — 等待付款
  • paid — 已支付
  • expired — 已过期
product 是

本次报价选择的套餐或服务。

类型:object

product.sku 是

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

类型:string

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

服务或套餐的类别。

类型:string

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

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

类型:string

product.amount 是

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

类型:string

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

签名套餐编号。

类型:integer | null

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

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

类型:integer

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

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

类型:string

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

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

类型:integer | null

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

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

类型:string

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

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

类型:object

currency.code 是

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

类型:string

currency.unit 是

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

类型:string

currency.external_settlement 是

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

类型:string

查看取值约束
  • 固定值 payment_provider
currency.revision 是

此金额单位配置的修订标识。确认付款时使用报价返回的原值。

类型:string

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

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

类型:string

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

记录创建时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0
expires_at 是

这份购买报价的有效截止时间,Unix 秒。过期后重新报价并再次确认。

类型:integer

查看取值约束
  • 最小值 0
price_reserved 是

此报价是否在有效期内锁定价格。

类型:boolean

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

创建报价时是否冻结余额。

类型:boolean

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

付款完成后是否自动提交签名任务。

类型:boolean

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

已付款时的原付款回执;尚未付款时为空。

类型:object | null

receipt.quote_id 是

本次购买或扩容的报价 ID。两种报价分别在各自的接口下查询。

类型:string

查看取值约束
  • 格式 ^Q[a-f0-9]{32}$
receipt.app_id 是

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

类型:string

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

订单 ID,可从付款回执获得。

类型:string

查看取值约束
  • 格式 ^O[a-f0-9]{32}$
receipt.state 是

当前记录的处理状态或请求筛选的状态。

类型:string

查看取值约束
  • 固定值 paid
receipt.payment_method 是

付款方式或订单来源。余额支付用 balance,历史订单中的 admin 表示后台充值。

类型:string

查看取值约束
  • 固定值 balance
receipt.amount 是

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

类型:string

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

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

类型:object

receipt.currency.code 是

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

类型:string

receipt.currency.unit 是

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

类型:string

receipt.currency.external_settlement 是

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

类型:string

查看取值约束
  • 固定值 payment_provider
receipt.currency.revision 是

此金额单位配置的修订标识。确认付款时使用报价返回的原值。

类型:string

查看取值约束
  • 格式 ^C[a-f0-9]{64}$
receipt.balance_before 是

本次扣款或退款前的站内余额。

类型:string

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

本次扣款或退款后的站内余额。

类型:string

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

支付成功时间,Unix 秒。允许为空时表示暂无支付记录。

类型:integer

查看取值约束
  • 最小值 0
receipt.automatic_signing 是

付款完成后是否自动提交签名任务。

类型:boolean

查看取值约束
  • 固定值 false
receipt.entitlement 是

付款到账后授予的站内权益。

类型:object

receipt.entitlement.scope 是

权益归属范围,application 为指定应用,account 为账号。

类型:string

查看取值约束
  • 可选值 application / account
receipt.entitlement.sign_expires_at 是

签名权益的到期时间,Unix 秒。

类型:integer | null

查看取值约束
  • integer (最小值 0)
receipt.entitlement.sign_plan 是

权益对应的签名套餐编号。

类型:integer | null

查看取值约束
  • integer (可选值 1 / 2 / 3)
receipt.entitlement.download_points 是

账号分发下载点数。

类型:integer | null

查看取值约束
  • integer (最小值 0)
receipt.entitlement.membership_tier 是

站内会员等级。

类型:integer | null

查看取值约束
  • integer (最小值 0,最大值 3)
receipt.entitlement.membership_expires_at 是

会员权益到期时间,Unix 秒。

类型:integer | null

查看取值约束
  • integer (最小值 0)

相关接口

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

作为成功响应