查询月账单列表¶
按账期从新到旧分页查询账户的月账单。
GET https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/monthly-bills
调用前准备¶
请求示例¶
将示例中的 $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"
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
目标账户的 ID,取自“查询当前账户”响应中的 |
查询参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
每页数量,1–100;省略、非正数或大于 100 时使用 50。 |
|
string |
否 |
下一页标记。首次请求省略;后续使用响应的 |
成功响应¶
请求成功时返回 HTTP 200 和已生成的月账单列表;尚无月账单时,列表为空。
{
"items": [],
"total": 0,
"next_page_token": ""
}
字段 |
类型 |
说明 |
|---|---|---|
|
array of object |
本次返回的记录。 |
|
string |
账期,格式为 |
|
string |
月账单状态。 |
|
string |
账期首日,格式为 |
|
string |
用量费用,单位为 Credit,以十进制字符串返回。 |
|
string |
订阅费用,单位为 Credit,以十进制字符串返回。 |
|
string |
调整费用,单位为 Credit,以十进制字符串返回。 |
|
string |
账单合计,单位为 Credit,以十进制字符串返回。 |
|
string |
已清偿透支额,单位为 Credit,以十进制字符串返回。 |
|
string |
已支付费用,单位为 Credit,以十进制字符串返回。 |
|
string |
未支付费用,单位为 Credit,以十进制字符串返回。 |
|
string |
关账时间,Unix 秒字符串;未关账时可能省略。 |
|
integer |
符合筛选条件的总记录数。 |
|
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"
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误说明。 |
|
string |
兼容错误说明,与 message 内容相同。 |