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

BudgetScope

本页内容

账号或 API 应用这一层的付款预算。需同时核对是否启用、单笔上限和日月额度。

如何阅读本模型

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

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

字段定义

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

字段必需说明
enabled 是

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

类型:boolean

currency_current 是

预算的金额单位是否与本站当前单位一致。

类型:boolean

single_limit 是

允许的单笔付款上限。

类型:string

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

当日预算的上限、已用金额、剩余额度和重置时间。

类型:object

daily.limit 是

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

类型:string

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

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

类型:string

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

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

类型:string

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

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

类型:integer

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

当前月预算的上限、已用金额、剩余额度和重置时间。

类型:object

monthly.limit 是

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

类型:string

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

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

类型:string

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

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

类型:string

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

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

类型:integer

查看取值约束
  • 最小值 0

相关接口

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

作为成功响应