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

BudgetPeriod

本页内容

一个预算周期的额度快照。分别读取上限、已用、剩余与重置时间,金额按对应单位解释。

如何阅读本模型

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

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

字段定义

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

字段必需说明
limit 是

此预算周期允许使用的金额上限。

类型:string

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

在当前预算周期中已使用的金额。

类型:string

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

此预算周期当前剩余的可用金额。

类型:string

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

本预算周期结束并重置的时间,Unix 秒。

类型:integer

查看取值约束
  • 最小值 0

相关接口

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

作为成功响应