You need to enable JavaScript to run this app.
导航
OpenAPI 接口列表
最近更新时间:2024.01.09 17:21:30首次发布时间:2022.08.17 18:39:19

本文档不再维护且将与近期下线,查看最新账单OpenAPI说明文档请点击跳转至费用中心-API概览
本文档为您提供火山引擎费用中心 - 账单管理具体的 API 描述、语法、参数说明及示例等。

一、接口列表
接口名称接口功能
ListBillDetail查询账单明细
ListBill查询账单
ListBillOverviewByProd查询账单总览 - 产品汇总
ListSplitBillDetail查询分账账单
ListAmortizedCostBillDetail查询成本账单明细
ListAmortizedCostBillMonthly查询成本账单总览

注意

以上六个接口的限流情况为单账号 5 QPS,超过限流阈值请求会直接失败。

二、查询账单明细

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListBillDetail”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账务账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间);
GroupTermInteger统计项:0:计费项;1:实例;2:产品;3:账号;
GroupPeriodInteger统计周期:0:账期;1:按天;2:明细;
ProductString产品名称,默认不选为全部;
BillingModeString计费模式: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:调账-系统;
默认不选为全部;

InstanceNoString实例id:默认不选为全部;
IgnoreZeroInteger是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
BillPeriodString账期
ExpenseDateString日期
PayerIDString支付账号ID
PayerUserNameString支付账号名
PayerCustomerNameString支付账号客户名称
SellerIDStringSeller账号ID
SellerUserNameStringSeller账号名
SellerCustomerNameStringSeller账号客户名称
OwnerIDStringOwner账号ID
OwnerUserNameStringOwner账号名
OwnerCustomerNameStringOwner账号客户名称
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
ExpenseBeginTimeString消费开始时间
ExpenseEndTimeString消费结束时间
UseDurationString使用时长
UseDurationUnitString时长单位
TradeTimeString交易时间,格式:2006-01-02 15:04:05
BillIDString订单号/账单号
BillCategoryString账单类型
InstanceNoString实例ID
InstanceNameString实例名称
ConfigNameString配置名称
ElementString计费单元
RegionString地域
ZoneString可用区
FactorString影响因子
ExpandFieldString扩展字段
PriceString单价
PriceUnitString单价单位
CountString用量
UnitString用量单位
DeductionCountString资源包抵扣量
OriginalBillAmountDouble原价
PreferentialBillAmountDouble优惠金额
DiscountBillAmountDouble折后价
CouponAmountDouble代金券抵扣
PayableAmountDouble应付金额
PaidAmountDouble现金支付
UnpaidAmountDouble欠费金额
CurrencyString币种
SettlementTypeString结算类型,settle:结算,non-settle:非结算,quota-settle:Quota结算
ProjectString项目
TagString标签,格式为包含多个键值对的Json字符串
SellingModeString售卖模式,0:普通实例,1:竞价实例
SolutionZhString解决方案中文名称
ReservationInstanceString售卖模式,0:普通实例,1:弹性预约实例
BillDetailIdString账单明细ID
ElementCodeString计费单元Code
RegionCodeString地域Code
ZoneCodeString可用区Code
FactorCodeString影响因子Code
ConfigurationCodeString配置Code
DeductionUseDurationString抵扣量
三、查询账单

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListBill”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间);
ProductString产品名称,默认不选为全部;
BillingModeString计费模式:1:包年包月;2:按量计费;3:合同计费;默认不选为全部;
BillCategoryParentString账单大类类型:consume:消费;refund:退款;transfer:调账;默认不选为全部;
PayStatusString支付状态:CompletedSettle:已结清;PartSettle:未结清;Unsettle:未结算;默认不选为全部;
IgnoreZeroInteger是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
BillPeriodString账期
PayerIDString支付账号ID
PayerUserNameString支付账号名
PayerCustomerNameString支付账号客户名称
SellerIDStringSeller账号ID
SellerUserNameStringSeller账号名
SellerCustomerNameStringSeller账号客户名称
OwnerIDStringOwner账号ID
OwnerUserNameStringOwner账号名
OwnerCustomerNameStringOwner账号客户名称
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
ExpenseBeginTimeString消费开始时间
ExpenseEndTimeString消费结束时间
TradeTimeString交易时间,格式:2006-01-02 15:04:05
BillIDString订单号/账单号
BillCategoryParentString账单类型
OriginalBillAmountDouble原价
PreferentialBillAmountDouble优惠金额
RoundBillAmountDouble抹零金额
DiscountBillAmountDouble折后价
CouponAmountDouble代金券抵扣
PayableAmountDouble应付金额
PaidAmountDouble现金支付
UnpaidAmountDouble欠费金额
CurrencyString币种
PayStatusString支付状态
SettlementTypeString结算类型,settle:结算,non-settle:非结算,quota-settle:Quota结算
四、查询账单总览 - 产品汇总

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListBillOverviewByProd”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间);
ProductString产品名称,默认不选为全部;
BillingModeString计费模式:1:包年包月;2:按量计费;3:合同计费;默认不选为全部;
BillCategoryParentString账单大类类型:consume:消费;refund:退款;transfer:调账;默认不选为全部;
IgnoreZeroInteger是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
BillPeriodString账期
PayerIDString支付账号ID
PayerUserNameString支付账号名
PayerCustomerNameString支付账号客户名称
SellerIDStringSeller账号ID
SellerUserNameStringSeller账号名
SellerCustomerNameStringSeller账号客户名称
OwnerIDStringOwner账号ID
OwnerUserNameStringOwner账号名
OwnerCustomerNameStringOwner账号客户名称
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
BillCategoryParentString账单类型
OriginalBillAmountDouble原价
PreferentialBillAmountDouble优惠金额
RoundBillAmountDouble抹零金额
DiscountBillAmountDouble折后价
CouponAmountDouble代金券抵扣
PayableAmountDouble应付金额
PaidAmountDouble现金支付
UnpaidAmountDouble欠费金额
SettlementTypeString结算类型,settle:结算,non-settle:非结算,quota-settle:Quota结算
五、查询分账账单

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListSplitBillDetail”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间);
GroupPeriodInteger统计周期:0:账期;1:按天;2:明细;
ProductString产品名称,默认不选为全部;
BillingModeString计费模式:1:包年包月;2:按量计费;3:合同计费;默认不选为全部;
BillCategoryString账单类型:consume-use:消费-使用;consume-new:消费-新购;consume-renew:消费-续费;consume-formalize:消费-转正;consume-modify:消费-更配;consume-trial:消费-试用;consume-RIAdjust:消费-预留实例调整;refund-terminate:退款-退订;refund-modify:退款-更配;refund-RIAdjust:退款-预留实例调整;transfer-manual:调账-人工;transfer-system:调账-系统;
InstanceNoString实例ID
SplitItemIDString分拆项ID
IgnoreZeroInteger是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
BillPeriodString账期
ExpenseTimeString消费时间,GroupPeriod为0时无意义,GroupPeriod为1时表示消费日期,GroupPeriod为2时表示消费开始时间~消费结束时间
PayerUserNameString支付账号名
SellerUserNameStringSeller账号名
OwnerUserNameStringOwner账号名
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
UseDurationString使用时长
UseDurationUnitString时长单位
TradeTimeString交易时间,格式:2006-01-02 15:04:05,仅在GroupPeriod为2时有意义
BillIDString预付费账单为订单号,否则为账单号,仅在GroupPeriod为2时有意义
BillCategoryString账单类型
SettlementTypeString结算类型,settle:结算,non-settle:非结算,quota-settle:Quota结算,仅在GroupPeriod为2时有意义
InstanceNoString实例ID
InstanceNameString实例名称
ConfigNameString配置名称,仅在GroupPeriod为2时有意义
ElementString计费单元
RegionString地域
ZoneString可用区
FactorString影响因子
ExpandFieldString扩展字段
SplitItemIDString分拆项ID
SplitItemNameString分拆项ID对应中文名称
PriceString单价
PriceUnitString单价单位
SplitItemAmountString分拆项用量
UnitString用量单位
SplitItemRatioString分拆用量占比,仅在GroupPeriod为2时有意义
DeductionCountString资源包抵扣量
SolutionZhString解决方案中文名称
OriginalBillAmountString原价
PreferentialBillAmountString优惠金额
DiscountBillAmountString折后价
CouponDeductionAmountString代金券抵扣
PayableAmountString应付金额
PaidAmountString现金支付
UnpaidAmountString欠费金额
CurrencyString币种
ProjectString项目
TagString标签,格式为包含多个键值对的Json字符串
SellingModeString售卖模式,0:普通实例,1:竞价实例
SubjectNameString主体名
ReservationInstanceString售卖模式,0:普通实例,1:弹性预约实例
SplitBillDetailIdString分账账单明细ID
ElementCodeString计费单元Code
RegionCodeString地域Code
ZoneCodeString可用区Code
FactorCodeString影响因子Code
ConfigurationCodeString配置Code
六、查询成本账单明细

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListAmortizedCostBillDetail”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账务账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2023-04;
AmortizedMonthString分摊月:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2023-04;
AmortizedDayString分摊日:格式为YYYY-MM-DD;仅支持单日查询;最早只能查询2023-04-01;
ProductString产品名称,默认不选为全部
InstanceNoString实例id,默认不选为全部
BillingModeString计费模式:1:包年包月;2:按量计费;3:合同计费;默认不选为全部
BillCategoryString账单类型:consume-use:消费-使用;consume-new:消费-新购;consume-renew:消费-续费;consume-formalize:消费-转正;consume-modify:消费-更配;consume-trial:消费-试用;refund-terminate:退款-退订;refund-modify:退款-更配;transfer-manual:调账-人工;transfer-system:调账-系统;默认不选为全部
AmortizedTypeString分摊类型:1:履约计费分摊;2:合同计费分摊;3:按量计费分摊;4:新购分摊;5:更配分摊;6:续费分摊;7:退订分摊;8:预留实例调整分摊;9:试用分摊;10:转正分摊;默认不选为全部
IgnoreZeroInteger隐藏0元账单:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
CostIDString成本账单明细业务主键
AmortizedMonthString分摊月
AmortizedDayString分摊日
BillPeriodString账务账期
BusiPeriodString业务账期
PayerIDString支付账号ID
PayerUserNameString支付账号名
PayerCustomerNameString支付账号客户名称
SellerIDStringSeller账号ID
SellerUserNameStringSeller账号名
SellerCustomerNameStringSeller账号客户名称
OwnerIDStringOwner账号ID
OwnerUserNameStringOwner账号名
OwnerCustomerNameStringOwner账号客户名称
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
BillCategoryString账单类型
AmortizedTypeString分摊类型
AmortizedBeginTimeString分摊开始时间,格式:2023-04-02 00:00:00
AmortizedEndTimeString分摊结束时间,格式:2023-04-02 23:59:59
BillIDString预付费账单为订单号,否则为账单号
InstanceNoString实例ID
InstanceNameString实例名称
ConfigNameString配置名称
ElementString计费单元
RegionString地域
ZoneString可用区
FactorString影响因子
ExpandFieldString扩展字段
ExpenseBeginTimeString消费开始时间,格式:2023-03-02 15:04:05
ExpenseEndTimeString消费结束时间,格式:2023-04-02 23:59:59
TradeTimeString交易时间,格式:2006-01-02 15:04:05
PriceString单价
PriceUnitString单价单位
CountString用量
UnitString用量单位
UseDurationString使用时长
UseDurationUnitString使用时长单位
OriginalBillAmountString原价
PreferentialBillAmountString优惠金额
RoundAmountString抹零金额
DiscountBillAmountString折后价
CouponAmountString代金券抵扣
PayableAmountString应付金额
DailyAmortizedCouponAmountString每日分摊-代金券抵扣
DailyAmortizedPayableAmountString每日分摊-应付金额
CurrencyString币种
ProjectString项目
TagString标签,格式为包含多个键值对的Json字符串
SubjectNameString主体名
七、查询成本账单总览

1. 请求参数

名称类型是否必填描述
ActionString接口名称:公共参数,本接口取值“ListAmortizedCostBillMonthly”
VersionString接口的版本:公共参数,本接口取值“2022-01-01”
OffsetInteger偏移量
LimitInteger数量:[1-300]
BillPeriodString账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2023-04;
AmortizedMonthString分摊月:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2023-04;
ProductString产品名称,默认不选为全部
InstanceNoString实例id,默认不选为全部
BillingModeString计费模式:1:包年包月;2:按量计费;3:合同计费;默认不选为全部
BillCategoryString账单类型:consume-use:消费-使用;consume-new:消费-新购;consume-renew:消费-续费;consume-formalize:消费-转正;consume-modify:消费-更配;consume-trial:消费-试用;refund-terminate:退款-退订;refund-modify:退款-更配;transfer-manual:调账-人工;transfer-system:调账-系统;默认不选为全部
AmortizedTypeString分摊类型:1:履约计费分摊;2:合同计费分摊;3:按量计费分摊;4:新购分摊;5:更配分摊;6:续费分摊;7:退订分摊;8:预留实例调整分摊;9:试用分摊;10:转正分摊;默认不选为全部
IgnoreZeroInteger隐藏0元账单:0:不忽略;1忽略;默认为不忽略;
NeedRecordNumInteger是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

2. 返回参数

名称类型描述
AmortizedMonthString分摊月
BillPeriodString账务账期
BusiPeriodString业务账期
PayerIDString支付账号ID
PayerUserNameString支付账号名
PayerCustomerNameString支付账号客户名称
SellerIDStringSeller账号ID
SellerUserNameStringSeller账号名
SellerCustomerNameStringSeller账号客户名称
OwnerIDStringOwner账号ID
OwnerUserNameStringOwner账号名
OwnerCustomerNameStringOwner账号客户名称
ProductString产品英文名称
ProductZhString产品中文名称
BusinessModeString业务类型
BillingModeString计费模式
BillCategoryString账单类型
AmortizedTypeString分摊类型
AmortizedBeginTimeString分摊开始时间,格式:2023-04-02 00:00:00
AmortizedEndTimeString分摊结束时间,格式:2023-04-02 23:59:59
AmortizedDayNumString已分摊天数
BillIDString预付费账单为订单号,否则为账单号
InstanceNoString实例ID
InstanceNameString实例名称
ConfigNameString配置名称
ElementString计费单元
RegionString地域
ZoneString可用区
FactorString影响因子
ExpandFieldString扩展字段
ExpenseTimeString消费时间
PriceString单价
PriceUnitString单价单位
CountString用量
UnitString用量单位
UseDurationString使用时长
UseDurationUnitString使用时长单位
OriginalBillAmountString原价
PreferentialBillAmountString优惠金额
RoundAmountString抹零金额
DiscountBillAmountString折后价
CouponAmountString代金券抵扣
PayableAmountString应付金额
DailyAmortizedCouponAmountString每日分摊-代金券抵扣
DailyAmortizedPayableAmountString每日分摊-代金券抵扣
BeforeAmortizedCouponAmountString期初已分摊-代金券抵扣
BeforeAmortizedPayableAmountString期初已分摊-应付金额
NowAmortizedCouponAmountString本期已分摊-代金券抵扣
NowAmortizedPayableAmountString本期已分摊-应付金额
UnamortizedCouponAmountString未分摊-代金券抵扣
UnamortizedPayableAmountString未分摊-应付金额
CurrencyString币种
ProjectString项目
TagString标签,格式为包含多个键值对的Json字符串
SubjectNameString主体名