查询月账单列表

按账期从新到旧分页查询账户的月账单。

GET https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/monthly-bills

调用前准备

  1. 准备计费账户所属用户的有效个人访问令牌

  2. 调用查询当前账户接口,获取目标账户的 ID。

请求示例

将示例中的 $MOI_PERSONAL_ACCESS_TOKEN$ACCOUNT_ID 分别替换为个人访问令牌和所选账户的 ID。

curl -X GET \
  "https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/monthly-bills?page_size=2" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

路径参数

参数

类型

是否必填

说明

accountID

string

目标账户的 ID,取自“查询当前账户”响应中的 items[].billing_account_id

查询参数

参数

类型

是否必填

说明

page_size

integer

每页数量,1–100;省略、非正数或大于 100 时使用 50。

page_token

string

下一页标记。首次请求省略;后续使用响应的 next_page_token

成功响应

请求成功时返回 HTTP 200 和已生成的月账单列表;尚无月账单时,列表为空。

{
  "items": [],
  "total": 0,
  "next_page_token": ""
}

字段

类型

说明

items

array of object

本次返回的记录。

items[].period

string

账期,格式为 YYYY-MM

items[].status

string

月账单状态。

items[].billing_date

string

账期首日,格式为 YYYY-MM-DD

items[].usage_credit

string

用量费用,单位为 Credit,以十进制字符串返回。

items[].subscription_credit

string

订阅费用,单位为 Credit,以十进制字符串返回。

items[].adjustment_credit

string

调整费用,单位为 Credit,以十进制字符串返回。

items[].total_credit

string

账单合计,单位为 Credit,以十进制字符串返回。

items[].cleared_overdraft_credit

string

已清偿透支额,单位为 Credit,以十进制字符串返回。

items[].paid_credit

string

已支付费用,单位为 Credit,以十进制字符串返回。

items[].outstanding_credit

string

未支付费用,单位为 Credit,以十进制字符串返回。

items[].closed_at

string

关账时间,Unix 秒字符串;未关账时可能省略。

total

integer

符合筛选条件的总记录数。

next_page_token

string

下一页标记;空字符串表示没有下一页。

字段路径中的 [] 表示数组中的每一项。例如,items[].period 表示数组中每一项的对应字段。

继续查询时,将响应中的 next_page_token 保存为 $NEXT_PAGE_TOKEN,保持筛选条件不变。标记为空时停止翻页。

curl -X GET \
  "https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/monthly-bills?page_size=2&page_token=$NEXT_PAGE_TOKEN" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

错误响应

缺少认证信息时返回 HTTP 401,请提供有效的个人访问令牌。

{
  "code": "unauthenticated",
  "message": "missing bearer token",
  "error": "missing bearer token"
}

字段

类型

说明

code

string

错误代码。

message

string

错误说明。

error

string

兼容错误说明,与 message 内容相同。

最后更新于