本文档不再维护且将与近期下线，查看最新账单OpenAPI说明文档请点击跳转至费用中心-API概览。
本文档为您提供火山引擎费用中心 - 账单管理具体的 API 描述、语法、参数说明及示例等。
一、接口列表
| 接口名称 | 接口功能 |
|---|
| ListBillDetail | 查询账单明细 |
| ListBill | 查询账单 |
| ListBillOverviewByProd | 查询账单总览 - 产品汇总 |
| ListSplitBillDetail | 查询分账账单 |
| ListAmortizedCostBillDetail | 查询成本账单明细 |
| ListAmortizedCostBillMonthly | 查询成本账单总览 |
注意
以上六个接口的限流情况为单账号 5 QPS，超过限流阈值请求会直接失败。
二、查询账单明细
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListBillDetail” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 是 | 账务账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2022-01（新版账单的时间）； |
| GroupTerm | Integer | 是 | 统计项：0：计费项；1：实例；2：产品；3：账号； |
| GroupPeriod | Integer | 是 | 统计周期：0：账期；1：按天；2：明细； |
| Product | String | 否 | 产品名称，默认不选为全部； |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部； |
BillCategory | String | 否 | 账单类型：consume-use：消费-使用；consume-new：消费-新购；consume-renew：消费-续费；consume-formalize：消费-转正；consume-modify：消费-更配；consume-trial：消费-试用；refund-terminate：退款-退订；refund-modify：退款-更配；transfer-manual：调账-人工；transfer-system：调账-系统；
默认不选为全部； |
| InstanceNo | String | 否 | 实例id：默认不选为全部； |
| IgnoreZero | Integer | 否 | 是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| BillPeriod | String | 账期 |
| ExpenseDate | String | 日期 |
| PayerID | String | 支付账号ID |
| PayerUserName | String | 支付账号名 |
| PayerCustomerName | String | 支付账号客户名称 |
| SellerID | String | Seller账号ID |
| SellerUserName | String | Seller账号名 |
| SellerCustomerName | String | Seller账号客户名称 |
| OwnerID | String | Owner账号ID |
| OwnerUserName | String | Owner账号名 |
| OwnerCustomerName | String | Owner账号客户名称 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| ExpenseBeginTime | String | 消费开始时间 |
| ExpenseEndTime | String | 消费结束时间 |
| UseDuration | String | 使用时长 |
| UseDurationUnit | String | 时长单位 |
| TradeTime | String | 交易时间，格式：2006-01-02 15:04:05 |
| BillID | String | 订单号/账单号 |
| BillCategory | String | 账单类型 |
| InstanceNo | String | 实例ID |
| InstanceName | String | 实例名称 |
| ConfigName | String | 配置名称 |
| Element | String | 计费单元 |
| Region | String | 地域 |
| Zone | String | 可用区 |
| Factor | String | 影响因子 |
| ExpandField | String | 扩展字段 |
| Price | String | 单价 |
| PriceUnit | String | 单价单位 |
| Count | String | 用量 |
| Unit | String | 用量单位 |
| DeductionCount | String | 资源包抵扣量 |
| OriginalBillAmount | Double | 原价 |
| PreferentialBillAmount | Double | 优惠金额 |
| DiscountBillAmount | Double | 折后价 |
| CouponAmount | Double | 代金券抵扣 |
| PayableAmount | Double | 应付金额 |
| PaidAmount | Double | 现金支付 |
| UnpaidAmount | Double | 欠费金额 |
| Currency | String | 币种 |
| SettlementType | String | 结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算 |
| Project | String | 项目 |
| Tag | String | 标签，格式为包含多个键值对的Json字符串 |
| SellingMode | String | 售卖模式，0：普通实例，1：竞价实例 |
| SolutionZh | String | 解决方案中文名称 |
| ReservationInstance | String | 售卖模式，0：普通实例，1：弹性预约实例 |
| BillDetailId | String | 账单明细ID |
| ElementCode | String | 计费单元Code |
| RegionCode | String | 地域Code |
| ZoneCode | String | 可用区Code |
| FactorCode | String | 影响因子Code |
| ConfigurationCode | String | 配置Code |
| DeductionUseDuration | String | 抵扣量 |
三、查询账单
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListBill” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 是 | 账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2022-01（新版账单的时间）； |
| Product | String | 否 | 产品名称，默认不选为全部； |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部； |
| BillCategoryParent | String | 否 | 账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部； |
| PayStatus | String | 否 | 支付状态：CompletedSettle：已结清；PartSettle：未结清；Unsettle：未结算；默认不选为全部； |
| IgnoreZero | Integer | 否 | 是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| BillPeriod | String | 账期 |
| PayerID | String | 支付账号ID |
| PayerUserName | String | 支付账号名 |
| PayerCustomerName | String | 支付账号客户名称 |
| SellerID | String | Seller账号ID |
| SellerUserName | String | Seller账号名 |
| SellerCustomerName | String | Seller账号客户名称 |
| OwnerID | String | Owner账号ID |
| OwnerUserName | String | Owner账号名 |
| OwnerCustomerName | String | Owner账号客户名称 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| ExpenseBeginTime | String | 消费开始时间 |
| ExpenseEndTime | String | 消费结束时间 |
| TradeTime | String | 交易时间，格式：2006-01-02 15:04:05 |
| BillID | String | 订单号/账单号 |
| BillCategoryParent | String | 账单类型 |
| OriginalBillAmount | Double | 原价 |
| PreferentialBillAmount | Double | 优惠金额 |
| RoundBillAmount | Double | 抹零金额 |
| DiscountBillAmount | Double | 折后价 |
| CouponAmount | Double | 代金券抵扣 |
| PayableAmount | Double | 应付金额 |
| PaidAmount | Double | 现金支付 |
| UnpaidAmount | Double | 欠费金额 |
| Currency | String | 币种 |
| PayStatus | String | 支付状态 |
| SettlementType | String | 结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算 |
四、查询账单总览 - 产品汇总
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListBillOverviewByProd” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 是 | 账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2022-01（新版账单的时间）； |
| Product | String | 否 | 产品名称，默认不选为全部； |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部； |
| BillCategoryParent | String | 否 | 账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部； |
| IgnoreZero | Integer | 否 | 是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| BillPeriod | String | 账期 |
| PayerID | String | 支付账号ID |
| PayerUserName | String | 支付账号名 |
| PayerCustomerName | String | 支付账号客户名称 |
| SellerID | String | Seller账号ID |
| SellerUserName | String | Seller账号名 |
| SellerCustomerName | String | Seller账号客户名称 |
| OwnerID | String | Owner账号ID |
| OwnerUserName | String | Owner账号名 |
| OwnerCustomerName | String | Owner账号客户名称 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| BillCategoryParent | String | 账单类型 |
| OriginalBillAmount | Double | 原价 |
| PreferentialBillAmount | Double | 优惠金额 |
| RoundBillAmount | Double | 抹零金额 |
| DiscountBillAmount | Double | 折后价 |
| CouponAmount | Double | 代金券抵扣 |
| PayableAmount | Double | 应付金额 |
| PaidAmount | Double | 现金支付 |
| UnpaidAmount | Double | 欠费金额 |
| SettlementType | String | 结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算 |
五、查询分账账单
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListSplitBillDetail” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 是 | 账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2022-01（新版账单的时间）； |
| GroupPeriod | Integer | 是 | 统计周期：0：账期；1：按天；2：明细； |
| Product | String | 否 | 产品名称，默认不选为全部； |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部； |
| BillCategory | String | 否 | 账单类型：consume-use：消费-使用；consume-new：消费-新购；consume-renew：消费-续费；consume-formalize：消费-转正；consume-modify：消费-更配；consume-trial：消费-试用；consume-RIAdjust：消费-预留实例调整；refund-terminate：退款-退订；refund-modify：退款-更配；refund-RIAdjust：退款-预留实例调整；transfer-manual：调账-人工；transfer-system：调账-系统； |
| InstanceNo | String | 否 | 实例ID |
| SplitItemID | String | 否 | 分拆项ID |
| IgnoreZero | Integer | 否 | 是否忽略折后价为0的数据：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| BillPeriod | String | 账期 |
| ExpenseTime | String | 消费时间，GroupPeriod为0时无意义，GroupPeriod为1时表示消费日期，GroupPeriod为2时表示消费开始时间~消费结束时间 |
| PayerUserName | String | 支付账号名 |
| SellerUserName | String | Seller账号名 |
| OwnerUserName | String | Owner账号名 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| UseDuration | String | 使用时长 |
| UseDurationUnit | String | 时长单位 |
| TradeTime | String | 交易时间，格式：2006-01-02 15:04:05，仅在GroupPeriod为2时有意义 |
| BillID | String | 预付费账单为订单号，否则为账单号，仅在GroupPeriod为2时有意义 |
| BillCategory | String | 账单类型 |
| SettlementType | String | 结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算，仅在GroupPeriod为2时有意义 |
| InstanceNo | String | 实例ID |
| InstanceName | String | 实例名称 |
| ConfigName | String | 配置名称，仅在GroupPeriod为2时有意义 |
| Element | String | 计费单元 |
| Region | String | 地域 |
| Zone | String | 可用区 |
| Factor | String | 影响因子 |
| ExpandField | String | 扩展字段 |
| SplitItemID | String | 分拆项ID |
| SplitItemName | String | 分拆项ID对应中文名称 |
| Price | String | 单价 |
| PriceUnit | String | 单价单位 |
| SplitItemAmount | String | 分拆项用量 |
| Unit | String | 用量单位 |
| SplitItemRatio | String | 分拆用量占比，仅在GroupPeriod为2时有意义 |
| DeductionCount | String | 资源包抵扣量 |
| SolutionZh | String | 解决方案中文名称 |
| OriginalBillAmount | String | 原价 |
| PreferentialBillAmount | String | 优惠金额 |
| DiscountBillAmount | String | 折后价 |
| CouponDeductionAmount | String | 代金券抵扣 |
| PayableAmount | String | 应付金额 |
| PaidAmount | String | 现金支付 |
| UnpaidAmount | String | 欠费金额 |
| Currency | String | 币种 |
| Project | String | 项目 |
| Tag | String | 标签，格式为包含多个键值对的Json字符串 |
| SellingMode | String | 售卖模式，0：普通实例，1：竞价实例 |
| SubjectName | String | 主体名 |
| ReservationInstance | String | 售卖模式，0：普通实例，1：弹性预约实例 |
| SplitBillDetailId | String | 分账账单明细ID |
| ElementCode | String | 计费单元Code |
| RegionCode | String | 地域Code |
| ZoneCode | String | 可用区Code |
| FactorCode | String | 影响因子Code |
| ConfigurationCode | String | 配置Code |
六、查询成本账单明细
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListAmortizedCostBillDetail” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 否 | 账务账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2023-04； |
| AmortizedMonth | String | 是 | 分摊月：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2023-04； |
| AmortizedDay | String | 否 | 分摊日：格式为YYYY-MM-DD；仅支持单日查询；最早只能查询2023-04-01； |
| Product | String | 否 | 产品名称，默认不选为全部 |
| InstanceNo | String | 否 | 实例id，默认不选为全部 |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部 |
| BillCategory | String | 否 | 账单类型：consume-use：消费-使用；consume-new：消费-新购；consume-renew：消费-续费；consume-formalize：消费-转正；consume-modify：消费-更配；consume-trial：消费-试用；refund-terminate：退款-退订；refund-modify：退款-更配；transfer-manual：调账-人工；transfer-system：调账-系统；默认不选为全部 |
| AmortizedType | String | 否 | 分摊类型：1：履约计费分摊；2：合同计费分摊；3：按量计费分摊；4：新购分摊；5：更配分摊；6：续费分摊；7：退订分摊；8：预留实例调整分摊；9：试用分摊；10：转正分摊；默认不选为全部 |
| IgnoreZero | Integer | 否 | 隐藏0元账单：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| CostID | String | 成本账单明细业务主键 |
| AmortizedMonth | String | 分摊月 |
| AmortizedDay | String | 分摊日 |
| BillPeriod | String | 账务账期 |
| BusiPeriod | String | 业务账期 |
| PayerID | String | 支付账号ID |
| PayerUserName | String | 支付账号名 |
| PayerCustomerName | String | 支付账号客户名称 |
| SellerID | String | Seller账号ID |
| SellerUserName | String | Seller账号名 |
| SellerCustomerName | String | Seller账号客户名称 |
| OwnerID | String | Owner账号ID |
| OwnerUserName | String | Owner账号名 |
| OwnerCustomerName | String | Owner账号客户名称 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| BillCategory | String | 账单类型 |
| AmortizedType | String | 分摊类型 |
| AmortizedBeginTime | String | 分摊开始时间，格式：2023-04-02 00:00:00 |
| AmortizedEndTime | String | 分摊结束时间，格式：2023-04-02 23:59:59 |
| BillID | String | 预付费账单为订单号，否则为账单号 |
| InstanceNo | String | 实例ID |
| InstanceName | String | 实例名称 |
| ConfigName | String | 配置名称 |
| Element | String | 计费单元 |
| Region | String | 地域 |
| Zone | String | 可用区 |
| Factor | String | 影响因子 |
| ExpandField | String | 扩展字段 |
| ExpenseBeginTime | String | 消费开始时间，格式：2023-03-02 15:04:05 |
| ExpenseEndTime | String | 消费结束时间，格式：2023-04-02 23:59:59 |
| TradeTime | String | 交易时间，格式：2006-01-02 15:04:05 |
| Price | String | 单价 |
| PriceUnit | String | 单价单位 |
| Count | String | 用量 |
| Unit | String | 用量单位 |
| UseDuration | String | 使用时长 |
| UseDurationUnit | String | 使用时长单位 |
| OriginalBillAmount | String | 原价 |
| PreferentialBillAmount | String | 优惠金额 |
| RoundAmount | String | 抹零金额 |
| DiscountBillAmount | String | 折后价 |
| CouponAmount | String | 代金券抵扣 |
| PayableAmount | String | 应付金额 |
| DailyAmortizedCouponAmount | String | 每日分摊-代金券抵扣 |
| DailyAmortizedPayableAmount | String | 每日分摊-应付金额 |
| Currency | String | 币种 |
| Project | String | 项目 |
| Tag | String | 标签，格式为包含多个键值对的Json字符串 |
| SubjectName | String | 主体名 |
七、查询成本账单总览
1. 请求参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|
| Action | String | 是 | 接口名称：公共参数，本接口取值“ListAmortizedCostBillMonthly” |
| Version | String | 是 | 接口的版本：公共参数，本接口取值“2022-01-01” |
| Offset | Integer | 是 | 偏移量 |
| Limit | Integer | 是 | 数量：[1-300] |
| BillPeriod | String | 否 | 账期：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2023-04； |
| AmortizedMonth | String | 是 | 分摊月：格式为YYYY-MM；仅支持单月查询；最多24个月；最早只能查询2023-04； |
| Product | String | 否 | 产品名称，默认不选为全部 |
| InstanceNo | String | 否 | 实例id，默认不选为全部 |
| BillingMode | String | 否 | 计费模式：1：包年包月；2：按量计费；3：合同计费；默认不选为全部 |
| BillCategory | String | 否 | 账单类型：consume-use：消费-使用；consume-new：消费-新购；consume-renew：消费-续费；consume-formalize：消费-转正；consume-modify：消费-更配；consume-trial：消费-试用；refund-terminate：退款-退订；refund-modify：退款-更配；transfer-manual：调账-人工；transfer-system：调账-系统；默认不选为全部 |
| AmortizedType | String | 否 | 分摊类型：1：履约计费分摊；2：合同计费分摊；3：按量计费分摊；4：新购分摊；5：更配分摊；6：续费分摊；7：退订分摊；8：预留实例调整分摊；9：试用分摊；10：转正分摊；默认不选为全部 |
| IgnoreZero | Integer | 否 | 隐藏0元账单：0：不忽略；1忽略；默认为不忽略； |
| NeedRecordNum | Integer | 否 | 是否需要访问列表的总记录数：用于前端分页；1：表示需要； 0：表示不需要；默认为不需要 |
2. 返回参数
| 名称 | 类型 | 描述 |
|---|
| AmortizedMonth | String | 分摊月 |
| BillPeriod | String | 账务账期 |
| BusiPeriod | String | 业务账期 |
| PayerID | String | 支付账号ID |
| PayerUserName | String | 支付账号名 |
| PayerCustomerName | String | 支付账号客户名称 |
| SellerID | String | Seller账号ID |
| SellerUserName | String | Seller账号名 |
| SellerCustomerName | String | Seller账号客户名称 |
| OwnerID | String | Owner账号ID |
| OwnerUserName | String | Owner账号名 |
| OwnerCustomerName | String | Owner账号客户名称 |
| Product | String | 产品英文名称 |
| ProductZh | String | 产品中文名称 |
| BusinessMode | String | 业务类型 |
| BillingMode | String | 计费模式 |
| BillCategory | String | 账单类型 |
| AmortizedType | String | 分摊类型 |
| AmortizedBeginTime | String | 分摊开始时间，格式：2023-04-02 00:00:00 |
| AmortizedEndTime | String | 分摊结束时间，格式：2023-04-02 23:59:59 |
| AmortizedDayNum | String | 已分摊天数 |
| BillID | String | 预付费账单为订单号，否则为账单号 |
| InstanceNo | String | 实例ID |
| InstanceName | String | 实例名称 |
| ConfigName | String | 配置名称 |
| Element | String | 计费单元 |
| Region | String | 地域 |
| Zone | String | 可用区 |
| Factor | String | 影响因子 |
| ExpandField | String | 扩展字段 |
| ExpenseTime | String | 消费时间 |
| Price | String | 单价 |
| PriceUnit | String | 单价单位 |
| Count | String | 用量 |
| Unit | String | 用量单位 |
| UseDuration | String | 使用时长 |
| UseDurationUnit | String | 使用时长单位 |
| OriginalBillAmount | String | 原价 |
| PreferentialBillAmount | String | 优惠金额 |
| RoundAmount | String | 抹零金额 |
| DiscountBillAmount | String | 折后价 |
| CouponAmount | String | 代金券抵扣 |
| PayableAmount | String | 应付金额 |
| DailyAmortizedCouponAmount | String | 每日分摊-代金券抵扣 |
| DailyAmortizedPayableAmount | String | 每日分摊-代金券抵扣 |
| BeforeAmortizedCouponAmount | String | 期初已分摊-代金券抵扣 |
| BeforeAmortizedPayableAmount | String | 期初已分摊-应付金额 |
| NowAmortizedCouponAmount | String | 本期已分摊-代金券抵扣 |
| NowAmortizedPayableAmount | String | 本期已分摊-应付金额 |
| UnamortizedCouponAmount | String | 未分摊-代金券抵扣 |
| UnamortizedPayableAmount | String | 未分摊-应付金额 |
| Currency | String | 币种 |
| Project | String | 项目 |
| Tag | String | 标签，格式为包含多个键值对的Json字符串 |
| SubjectName | String | 主体名 |