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

SigningRedemptionReceipt

本页内容

开通密钥的核销回执。用于确认时长与权益变更,不扣余额、不支持退款,也不自动执行签名。

如何阅读本模型

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

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

字段定义

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

字段必需说明
id 是

本次开通密钥核销的回执 ID。保存后用它查询原开通结果。

类型:string

查看取值约束

持久核销回执 E 标识,绑定当前账号、业务应用及创建核销的 API 应用。

  • 格式 ^E[a-f0-9]{32}$
app_id 是

本次开通的完整应用 ID。

类型:string

查看取值约束

目标业务应用 A。

  • 格式 ^A[a-f0-9]{32}$
state 是

本次开通的处理状态。redeemed 表示密钥核销与权益变更已提交。

类型:string

查看取值约束

redeemed 表示密钥核销与权益已原子提交。

  • 可选值 redeemed
redeemed_at 是

实际核销 UTC 秒。

类型:integer

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

本次授予天数:月/季/年密钥分别为 30/90/360 天。

类型:integer

查看取值约束
  • 最小值 1
plan_id 是

密钥对应签名套餐:1 基础版、2 高级版、3 独立版。

类型:integer

查看取值约束
  • 可选值 1 / 2 / 3
previous_expires_at 是

本次核销前签名到期 UTC 秒,0 表示未开通。

类型:integer

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

核销后的签名到期 UTC 秒。原套餐仍有效时从原到期时间延长,否则从本次核销时间开始。

类型:integer

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

密钥核销固定不支持退款。

类型:boolean

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

固定为 false;开通后需要另行提交签名任务。

类型:boolean

查看取值约束

固定 false,核销不创建签名任务。另行授予 CreateJobs 并提交原包版本。

  • 固定值 false

相关接口

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

作为成功响应