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

查询用户某个账期内账单总览信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
bssapi:QueryBillOverview	READ	全部资源 *	bssapi:ProductCode bssapi:ProductType	无

请求参数

名称	类型	必填	描述	示例值
BillingCycle	string	是	账单日期，YYYY-MM。	2018-07
ProductCode	string	否	产品代码。	rds
ProductType	string	否	产品类型。	rds
SubscriptionType	string	否	订阅类型： Subscription：预付费。 PayAsYouGo：后付费。	Subscription
BillOwnerId	long	否	资源归属账号的 ID，资源归属账号是实际使用资源的账号。	1234

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。	Success
Message	string	错误信息。	Successful!
RequestId	string	请求 ID。	BCB1E1BC-05BF-4217-80EE-BF09A29407BA
Success	boolean	是否成功。	true
Data	object	返回数据。
BillingCycle	string	账期，格式：YYYY-MM。	2020-03
AccountID	string	账号 ID。	185766xxxx
AccountName	string	账号。	test@test.aliyunid.com
Items	object []	账单详情。
RoundDownDiscount	string	抹零优惠。	0
Item	string	账单类型，取值： SubscriptionOrder。预付费账单 PayAsYouGoBill。后付费账单 Refund。退款 Adjustment。调账	PayAsYouGoBill
Currency	string	币种，取值： CNY。 USD。 JPY。	CNY
SubscriptionType	string	订阅类型，取值： Subscription：预付费。 PayAsYouGo：后付费。	Subscription
DeductedByCashCoupons	float	代金券抵扣。	0
BillAccountName	string	账单所属账号名称。	test@test.aliyunid.com
BizType	string	业务类型。	trusteeship
DeductedByCoupons	float	优惠券抵扣。	0
OutstandingAmount	float	未结清金额或信用结算金额（普通用户的欠费，或者信用客户信用额度消耗）。	0
AfterTaxAmount	float	税后金额。仅在国际站点使用。	0
PretaxAmountLocal	float	应付金额（支付币种）。仅在国际站点使用。	0
Tax	float	税。仅在国际站点使用	0
PipCode	string	产品 Code，与费用中心账单产品 Code 一致	rds
PretaxAmount	float	应付金额。	100
ProductName	string	产品名称。	Nat网关
CommodityCode	string	商品 Code，与费用中心产品明细 Code 一致	rds
AdjustAmount	float	信用额度退款抵扣。	0
ProductDetail	string	产品明细。	NAT Gateway (Pay-As-You-Go)
PaymentCurrency	string	支付币种。仅在国际站点使用。	USD
OwnerID	string	账单 OwnerID。	1222
DeductedByPrepaidCard	float	储值卡抵扣。	0
ProductType	string	产品类型。	rds
InvoiceDiscount	float	优惠金额。	0
PaymentAmount	float	现金支付（含信用额度退款抵扣）。	100
BillAccountID	string	账单所属账号 ID。	185766xxxx
PretaxGrossAmount	float	原始金额。	100
CashAmount	float	现金支付（不包含信用额度退款抵扣）。	0
ProductCode	string	产品代码。	rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BCB1E1BC-05BF-4217-80EE-BF09A29407BA",
  "Success": true,
  "Data": {
    "BillingCycle": "2020-03",
    "AccountID": "185766xxxx",
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "RoundDownDiscount": "0",
          "Item": "PayAsYouGoBill",
          "Currency": "CNY",
          "SubscriptionType": "Subscription",
          "DeductedByCashCoupons": 0,
          "BillAccountName": "test@test.aliyunid.com",
          "BizType": "trusteeship",
          "DeductedByCoupons": 0,
          "OutstandingAmount": 0,
          "AfterTaxAmount": 0,
          "PretaxAmountLocal": 0,
          "Tax": 0,
          "PipCode": "rds",
          "PretaxAmount": 100,
          "ProductName": "Nat网关",
          "CommodityCode": "rds",
          "AdjustAmount": 0,
          "ProductDetail": "NAT Gateway (Pay-As-You-Go)",
          "PaymentCurrency": "USD",
          "OwnerID": "1222",
          "DeductedByPrepaidCard": 0,
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 100,
          "BillAccountID": "185766xxxx",
          "PretaxGrossAmount": 100,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

错误码

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