费用中心
费用中心
文档指南
请输入
- 文档首页
费用中心API参考账单管理ListBill - 分页查询账单
复制全文
下载 pdfListBill - 分页查询账单
文档反馈
问问助手“提供产品、结算周期等的账单流水信息；请于每月第2个自然日12点后获取上月完整账单数据；”
注意事项
- 查询QPS限制为5QPS，超过限流将报错；
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ListBill
要执行的操作，取值：ListBill。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
Product string[] 可选 示例值：[ECS]
产品名称，默认不选为全部
BillingMode string[] 可选 示例值：[1]
计费模式：1：包年包月，代表预付费；2：按量计费，代表后付费；3：合同计费，代表线下计费；4：履约计费；默认不选为全部；
BillCategoryParent string[] 可选 示例值：[consume]
账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部
PayerID long[] 可选 示例值：[2100057673]
Payer账号ID
OwnerID long[] 可选 示例值：[2100057673]
Owner账号ID；财务托管场景下，不指定owner时主账号可获取自身及其下绑定所有owner子账号费用；选择owner后，可精准获取指定owner的账单费用；
Offset integer 可选 示例值：10
用于在分页查询中指定“从结果集的第几条记录开始返回”（也就是先跳过多少条记录），通常与 limit 搭配使用实现翻页：例如每页 limit=300 时，第 1 页传 offset=0 获取第 1–300 条，第 2 页传 offset=300 获取第 301–600 条，第 3 页传 offset=600 获取第 601–900 条；因此每往后一页，offset 按固定步长累加：offset = offset + limit（等价于 offset = (page-1) * limit）。
Limit integer 必选 示例值：10
数量：[1-300]，用于指定接口响应中返回记录的最大数量（上限），例如Limit=20表示每次请求最多返回20条
BillPeriod string 必选 示例值：2023-08
账期：格式为YYYY-MM；仅支持单月查询；所查账期至多距今 24 个月
PayStatus string 可选 示例值：CompletedSettle
支付状态：CompletedSettle：已结清；PartSettle：未结清；Unsettle：未结算；默认不选为全部
IgnoreZero integer 可选 示例值：1
是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略
NeedRecordNum integer 可选 示例值：1
是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要，Total返回-1
返回参数
List object[] 示例值：-
账单列表
BillPeriod string 示例值：2023-08
账期
PayerID string 示例值：2100153894
支付账号ID
PayerUserName string 示例值：Doooo
支付账号名
PayerCustomerName string 示例值：北京火山引擎科技有限公司
支付账号客户名称
SellerID string 示例值：3423
Seller账号ID
SellerUserName string 示例值：火山引擎
Seller账户名
SellerCustomerName string 示例值：北京火山引擎科技有限公司
Seller账号客户名称
OwnerID string 示例值：2100153894
Owner账号ID
OwnerUserName string 示例值：Doooo
Owner账户名
OwnerCustomerName string 示例值：北京火山引擎科技有限公司
Owner账号客户名称
Product string 示例值：ECS
产品英文名称
ProductZh string 示例值：云服务器
使用的产品/服务的商品中文名称；
BusinessMode string 示例值：普通业务
业务类型
BillingMode string 示例值：按量计费
计费模式：1：包年包月，代表预付费；2：按量计费，代表后付费；3：合同计费，代表线下计费；4：履约计费；
ExpenseBeginTime string 示例值：2023-08-01 00:00:00
消费开始时间
ExpenseEndTime string 示例值：2023-08-01 01:00:00
消费结束时间
TradeTime string 示例值：2023-08-01 01:28:14
交易时间，格式：2006-01-02 15:04:05
BillID string 示例值：Bill7262035879529697551
订单号/账单号
BillCategoryParent string 示例值：消费
账单类型
OriginalBillAmount string 示例值：0.519200
原价
PreferentialBillAmount string 示例值：0.457835
优惠金额
RoundBillAmount string 示例值：0.001365
抹零金额
DiscountBillAmount string 示例值：0.06
折后价
CouponAmount string 示例值：0.00
代金券抵扣
PayableAmount string 示例值：0.06
应付金额
PaidAmount string 示例值：0.00
现金支付
UnpaidAmount string 示例值：0.00
欠费金额
Currency string 示例值：CNY
币种
PayStatus string 示例值：已结清
支付状态
SettlementType string 示例值：非结算
结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算
SubjectName string 示例值：北京火山引擎科技有限公司
主体名
BusiPeriod string 示例值：2023-08
业务账期
CreditCarriedAmount string 示例值：0.00
信控额度退款抵扣
BillDetailNum string 示例值：1
账单明细条数
SavingPlanOriginalAmount string 示例值：621.946905
节省计划抵扣原价
Tax string 示例值：0.00
税额（定价币种）
TaxRate string 示例值：0.00
税率
PosttaxAmount string 示例值：0.06
税后应付金额（定价币种）
PretaxAmount string 示例值：0.06
税前应付金额（定价币种）
PreTaxPayableAmount string 示例值：0.06
税前应付金额（定价币种）
CountryRegion string
国家地区
RealValue string 示例值：0.00
真实金额（定价币种）
PretaxRealValue string 示例值：0.00
税前真实金额（定价币种）
SettlePosttaxAmount string 示例值：0.00
税后应付金额（结算币种）
SettlePayableAmount string 示例值：0.06
税后应付金额（结算币种）
SettlePretaxAmount string 示例值：0.06
税前应付金额（结算币种）
SettlePreTaxPayableAmount string 示例值：0.06
税前应付金额（结算币种）
SettleTax string 示例值：0.00
税额（结算币种）
SettleRealValue string 示例值：0.00
税后真实金额（结算币种）
SettlePretaxRealValue string 示例值：0.00
税前真实金额（结算币种）
CurrencySettlement string 示例值：CNY
结算币种
ExchangeRate string 示例值：1.00
汇率
PointDeductAmount string 示例值：0.00
积分抵扣金额
Total integer 示例值：100
总数，默认返回-1（NeedRecordNum=0时）
Limit integer 示例值：10
步长
Offset integer 示例值：0
偏移量
请求示例
// 以下示例不包含签名，建议直接使用API Explorer或下载SDK调试。
curl --location 'https://open.volcengineapi.com?Action=ListBill&Version=2022-01-01' \
--header 'AccessKey: AK***mE' \
--header 'SecretKey: T0***RQ==' \
--header 'Region: cn-north-1' \
--header 'ServiceName: billing' \
--header 'Content-Type: application/json' \
--header 'User-Agent: volcengine-go-sdk' \
--data '{
"BillPeriod": "2024-01",
"Limit": 10,
"Offset": 0,
"NeedRecordNum": 1,
"IgnoreZero": 0
}'
返回示例
{
"ResponseMetadata": {
"RequestId": "20230215150503A905DDFA8B7E846117A9",
"Action": "ListBill",
"Version": "2022-01-01",
"Service": "billing",
"Region": "cn-north-1"
},
"Result": {
"List": [
{
"BillPeriod": "2022-10",
"PayerID": "2000010593",
"PayerUserName": "WtestID",
"PayerCustomerName": "W测试",
"SellerID": "3423",
"SellerUserName": "火山引擎",
"SellerCustomerName": "北京火山引擎科技有限公司",
"OwnerID": "2000010593",
"OwnerUserName": "WtestID",
"OwnerCustomerName": "W测试",
"Product": "on_line",
"ProductZh": "线上测试产品-勿动",
"BusinessMode": "普通业务",
"BillingMode": "2",
"ExpenseBeginTime": "2022-10-01 00:00:00",
"ExpenseEndTime": "2022-10-01 01:00:00",
"TradeTime": "2022-10-01 01:21:18",
"BillID": "Bill7149224194994114828",
"BillCategoryParent": "消费",
"OriginalBillAmount": "212.973452",
"PreferentialBillAmount": "0.000000",
"RoundBillAmount": "0.003452",
"DiscountBillAmount": "212.97",
"CouponAmount": "0.00",
"PayableAmount": "0.00",
"PaidAmount": "0.00",
"UnpaidAmount": "0.00",
"Currency": "CNY",
"PayStatus": "已结清",
"SettlementType": "非结算",
"SubjectName": "北京火山引擎科技有限公司",
"BusiPeriod": "2022-10"
}
],
"Total": 744,
"Limit": 10,
"Offset": 0
}
}
错误码
最近更新时间：2026.06.26 11:40:17
这个页面对您有帮助吗？
有用
有用
无用
无用