查询消耗明细
POST/openapi/v1/bill/usage/detail
查询当前应用扣费空间(OwnerSpaceId)下的消耗明细(子客维度),支持按时间范围、子客空间、套餐类型过滤,分页返回。
权限
- 需要 OAuth Bearer token,且 scope 包含 bill:manage。
强制约束
- OwnerSpaceId 由服务端根据当前应用 AppID 反查 oauth_apps.owner_space_id 强制注入,调用方不允许传入。
- StartTime / EndTime 为 RFC3339 时间字符串(必须包含时区偏移),且跨度不得超过 31 天。
- Limit 默认 20,上限 50。
统计口径 - 仅统计计费流水中 action ∈ (pay, deduct) 的记录。
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
Body 请求体
application/jsonStartTime必填string(date-time)
查询起始时间,[RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) 格式(必须包含时区偏移,推荐使用 UTC 时间),例如 `2026-06-01T00:00:00Z`。必填。
EndTime必填string(date-time)
查询结束时间,[RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) 格式(必须包含时区偏移,推荐使用 UTC 时间),例如 `2026-06-30T23:59:59Z`。必填。要求 `StartTime` ≤ `EndTime`,且跨度不超过 31 天。
SpaceId选填string
空间 ID,**非必填**。
- **不传**:默认查询当前 access_token 所属空间(即应用绑定的主账号空间)的计费数据。
- **传入**:查询指定子客空间的计费数据,用于第三方应用集成场景下按子客维度对账。
QuotaType选填string
套餐类型(可选)。用于按套餐维度筛选,支持:`ses`(短信服务)/ `ekyc`(实名认证)/ `member`(成员席位)等。
Offset选填integer(int32)
分页偏移量(可选),默认 `0`。
Limit选填integer(int32)
分页大小(可选),默认 `20`,最大 `50`。
响应参数
Response.Data
Details选填array<object>
消耗明细数组
OccurredAt选填string(date-time)
消耗发生时间,RFC3339 格式(**UTC 时区**,以 `Z` 结尾),例如 `2026-06-01T02:23:45Z`。
SpaceId选填string
子客空间 ID(消耗归属的子客空间)
UserId选填string
操作用户 ID(触发消耗的操作人)
SpaceName选填string
子客企业名称(服务端回填,反查失败时可能为空)
EnvelopeId选填string
关联的合同 ID(若消耗来自合同流转)
EnvelopeName选填string
关联的合同名称(服务端回填,反查失败时可能为空)
UsageType选填string
消耗类型(对应 QuotaType 维度,如 `ses` / `ekyc` / `member`)
PackageName选填string
套餐规格名称(如资源包 SKU 键值)
Quantity选填integer(int64)
本条明细的消耗数量
Total选填integer(int64)
符合过滤条件的总条数
错误码
| 错误码 | 说明 |
|---|---|
INVALID_REQUEST | 参数无效(如 StartTime / EndTime 缺失、格式错误、跨度超限) |
UNAUTHORIZED | access_token 缺失、无效或已过期 |
FORBIDDEN | scope 未包含 bill:manage |
INTERNAL_ERROR | 服务端内部错误 |