You need to enable JavaScript to run this app.
导航
费用中心
  • 文档首页
    • /
  • 费用中心

ListBill - 分页查询账单

最近更新时间：2024.02.21 15:39:46

首次发布时间：2023.12.06 17:34:16

我的收藏

分页查询账单

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

ListBill

要执行的操作，取值：ListBill

Version
String
是

2022-01-01

API的版本，取值：2022-01-01

BillCategoryParent
Array of String
否

[consume]

账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部；

BillingMode
Array of String
否

[1]

计费模式：1：包年包月；2：按量计费；3：合同计费；4：履约计费；默认不选为全部

Product
Array of String
否

[ECS]

产品名称，默认不选为全部

Offset
Integer
否

10

偏移量

Limit
Integer
是

10

数量：[1-300]

BillPeriod
String
是

2023-08

账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2022-01（新版账单的时间）

PayStatus
String
否

CompletedSettle

支付状态：CompletedSettle：已结清；PartSettle：未结清；Unsettle：未结算；默认不选为全部；

IgnoreZero
Integer
否

1

是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略；

NeedRecordNum
Integer
否

1

是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
List
Array of Bill

账单列表

Total
Integer

100

总数

Limit
Integer

10

步长

Offset
Integer

0

偏移量

请求示例

curl --location --request POST 'https://open.volcengineapi.com?Action=ListBill&Version=2022-01-01' \
--header 'AccessKey: AKLTZm*****' \
--header 'SecretKey: T1RVek*****' \
--header 'Region: cn-north-1' \
--header 'ServiceName: billing'\
--header 'Content-Type: application/json' \
--data-raw '{
    "BillPeriod":"2022-11",
    "Limit":1,
    "Offset":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
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。