QueryBill - 账单查询服务 - 阿里云交易和账单管理API

查询用户某个账期内结算账单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
BillingCycle	string	是	账期，YYYY-MM。	2018-07
Type	string	否	类型。取值： SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
ProductCode	string	否	产品代码。	rds
ProductType	string	否	产品类型。	rds
SubscriptionType	string	否	订阅类型。取值： Subscription PayAsYouGo 说明必须和 ProductCode 参数一起使用。	Subscription
IsHideZeroCharge	boolean	否	根据原价（PretaxGrossAmount）是否为 0 做过滤，默认为否（兼容现有逻辑）。 true：是。 false：否。	true
IsDisplayLocalCurrency	boolean	否	是否展示本币（待删除）。	false
PageNum	integer	否	页码，默认值为 1。	1
PageSize	integer	否	每页数量，默认值：20，最大值：300。	20
BillOwnerId	long	否	资源归属账号的 ID，资源归属账号是实际使用资源的账号。	123

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。	Success
Message	string	错误信息。	Successful!
RequestId	string	请求 ID。	AE3F4057-DFC9-4B81-8858-F620651010C9
Success	boolean	是否成功。	true
Data	object	返回数据。
PageNum	integer	页码。	1
BillingCycle	string	账期，YYYY－MM。	2020-02
AccountID	string	账号 ID。	185xxxxx489
PageSize	integer	每页条数。	1
TotalCount	integer	总记录数。	20
AccountName	string	账号。	test@test.aliyunid.com
Items	array<object>	账单详情。
	object
Status	string	支付状态。取值： PayFinish：已支付 PayUnclear：未结清 PayUnsettle：未结算 NoSettle：免结算	PayFinish
RoundDownDiscount	string	抹零优惠。	0
Item	string	账单类型： SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
Currency	string	币种。 CNY USD JPY	CNY
UsageStartTime	string	账单开始时间。	2020-03-11 07:00:00
SubscriptionType	string	订阅类型。取值： Subscription PayAsYouGo	PayAsYouGo
DeductedByCashCoupons	float	代金券抵扣。	0
UsageEndTime	string	账单结束时间。	2020-03-11 08:00:00
DeductedByCoupons	float	优惠券抵扣。	0
SubOrderId	string	该条账单对应的订单明细 ID。	325345254353
OutstandingAmount	float	未结清金额。	0
AfterTaxAmount	float	税后金额。	0
PaymentTime	string	订单支付时间。	2020-03-11 08:00:00
PretaxAmountLocal	float	本币金额。	0
Tax	float	税费。	0
PipCode	string	产品 Code。	rds
PaymentTransactionID	string	交易号。	2O3AADJFEAF2PDKSFAMFCB11918
PretaxAmount	float	应付金额。	100
CommodityCode	string	商品 Code。	rds
ProductName	string	产品名称。	云数据库RDS
RecordID	string	订单号、账单号。	2020xxxx5912
AdjustAmount	float	信用额度退款抵扣。	0
ProductDetail	string	产品明细。	关系型数据库RDS（包月）
PaymentCurrency	string	支付币种。	USD
OwnerID	string	子账号 AccountID（多账号代付场景）。	3532535235
DeductedByPrepaidCard	float	储值卡抵扣。	0
ProductType	string	产品类型。	rds
InvoiceDiscount	float	优惠金额。	0
PaymentAmount	float	现金支付（含信用额度退款抵扣）。	0
PretaxGrossAmount	float	原始金额。	0
CashAmount	float	现金支付（不包含信用额度退款抵扣）。	0
ProductCode	string	产品代码。	rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "AE3F4057-DFC9-4B81-8858-F620651010C9",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "BillingCycle": "2020-02",
    "AccountID": "185xxxxx489",
    "PageSize": 1,
    "TotalCount": 20,
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "Status": "PayFinish",
          "RoundDownDiscount": "0",
          "Item": "SubscriptionOrder",
          "Currency": "CNY",
          "UsageStartTime": "2020-03-11 07:00:00",
          "SubscriptionType": "PayAsYouGo",
          "DeductedByCashCoupons": 0,
          "UsageEndTime": "2020-03-11 08:00:00",
          "DeductedByCoupons": 0,
          "SubOrderId": "325345254353",
          "OutstandingAmount": 0,
          "AfterTaxAmount": 0,
          "PaymentTime": "2020-03-11 08:00:00",
          "PretaxAmountLocal": 0,
          "Tax": 0,
          "PipCode": "rds",
          "PaymentTransactionID": "2O3AADJFEAF2PDKSFAMFCB11918",
          "PretaxAmount": 100,
          "CommodityCode": "rds",
          "ProductName": "云数据库RDS",
          "RecordID": "2020xxxx5912",
          "AdjustAmount": 0,
          "ProductDetail": "关系型数据库RDS（包月）",
          "PaymentCurrency": "USD",
          "OwnerID": "3532535235",
          "DeductedByPrepaidCard": 0,
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 0,
          "PretaxGrossAmount": 0,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-03-28	OpenAPI 描述信息更新	查看变更详情