“提供按产品汇总的当月费用数据；请于每月第2个自然日12点后获取上月完整账单数据；” ## 注意事项 1. 查询QPS限制为5QPS，超过限流将报错； ## 调试 [去调试](https://api.volcengine.com/api-explorer/?action=ListBillOverviewByProd&groupName=%E8%B4%A6%E5%8D%95%E4%B8%AD%E5%BF%83&serviceCode=billing&version=2022-01-01) ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string 必选 `示例值：ListBillOverviewByProd` 要执行的操作，取值：ListBillOverviewByProd。 **Version** string 必选 `示例值：2022-01-01` API的版本，取值：2022\-01\-01。 **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 个月 **IgnoreZero** integer `可选` `示例值：1` 是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略； **NeedRecordNum** integer `可选` `示例值：1` 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要，Total返回\-1 **BillingMode** string[] `可选` `示例值：[1]` 计费模式：1：包年包月，代表预付费；2：按量计费，代表后付费；3：合同计费，代表线下计费；4：履约计费；默认不选为全部； **BillCategoryParent** string[] `可选` `示例值：[consume]` 账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部； **Product** string[] `可选` `示例值：[ECS]` 产品名称，默认不选为全部 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **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账号客户名称 **BusinessMode** string `示例值：普通业务` 业务类型 **Product** string `示例值：ECS` 产品英文名称 **ProductZh** string `示例值：云服务器` 使用的产品/服务的商品中文名称； **BillingMode** string `示例值：2` 计费模式：1：包年包月，代表预付费；2：按量计费，代表后付费；3：合同计费，代表线下计费；4：履约计费； **BillCategoryParent** string `示例值：消费` 账单类型 **OriginalBillAmount** string `示例值：168.740000` 原价 **PreferentialBillAmount** string `示例值：148.500779` 优惠金额 **RoundBillAmount** string `示例值：0.559221` 抹零金额 **DiscountBillAmount** string `示例值：19.68` 折后价 **CouponAmount** string `示例值：0.00` 代金券抵扣 **PayableAmount** string `示例值：19.68` 应付金额 **PaidAmount** string `示例值：0.00` 现金支付 **UnpaidAmount** string `示例值：0.00` 欠费金额 **SettlementType** string `示例值：非结算` 结算类型，settle：结算，non\-settle：非结算，quota\-settle：Quota结算 **CreditCarriedAmount** string `示例值：0.00` 信控额度退款抵扣 **Currency** string 币种 **SubjectName** string 主体名 **SettleTax** string 结算币种税额 **SettlePretaxRealValue** string 结算币种税前真实金额 **SettlePosttaxAmount** string 结算币种税后应付金额 **SettlePretaxAmount** string 结算币种税前应付金额 **PosttaxAmount** string 税后应付金额 **PretaxAmount** string 税前应付金额 **Tax** string 税额 **CountryRegion** string 国家地区 **SettleRealValue** string 结算币种真实金额 **RealValue** string 真实金额 **PretaxRealValue** string 税前真实金额 **SavingPlanOriginalAmount** string `示例值：621.946905` 节省计划抵扣原价 **PreTaxPayableAmount** string `示例值：19.68` 税前应付金额（定价币种） **SettlePayableAmount** string `示例值：19.68` 税后应付金额（结算币种） **SettlePreTaxPayableAmount** string `示例值：19.68` 税前应付金额（结算币种） **CurrencySettlement** string `示例值：CNY` 结算币种 **PointDeductAmount** string `示例值：0.00` 积分抵扣金额 **Total** integer `示例值：100` 总数，默认返回\-1（NeedRecordNum=0时） **Limit** integer `示例值：100` 步长 **Offset** integer `示例值：0` 偏移量 ## 请求示例 ```text // 以下示例不包含签名，建议直接使用API Explorer或下载SDK调试。 curl --location 'https://open.volcengineapi.com?Action=ListBillOverviewByProd&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 }' ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "202302151539373422AB4D3113FA66F8E3", "Action": "ListBillOverviewByProd", "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测试", "BusinessMode": "普通业务", "Product": "on_line", "ProductZh": "线上测试产品-勿动", "BillingMode": "2", "BillCategoryParent": "consume", "OriginalBillAmount": "158452.248288", "PreferentialBillAmount": "0.000000", "RoundBillAmount": "2.568288", "DiscountBillAmount": "158449.68", "CouponAmount": "0.00", "PayableAmount": "0.00", "PaidAmount": "0.00", "UnpaidAmount": "0.00", "SettlementType": "非结算" } ], "Total": 1, "Limit": 10, "Offset": 0 } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6369/68677)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |RequestInvalid |Request Invalid | | |400 |InvalidParameter |The specified parameter Limit is invalid. |\-\- | |500 |InternalError |Service has some internal Error. Pls Contact With Admin. |服务内部异常 |

费用中心