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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryBillOverview

系统规定参数。取值:QueryBillOverview。

BillingCycle String 2018-07

账单日期,YYYY-MM。

ProductCode String rds

产品代码。

ProductType String rds

产品类型。

SubscriptionType String Subscription

订阅类型:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
BillOwnerId Long 1234

子账号ID。设置可查看财务云子账号账单,不填默认查看当前调用账号。

返回数据

名称 类型 示例值 描述
Code String Success

状态码。

Data Struct

返回数据。

AccountID String 185766xxxx

账号ID。

AccountName String test@test.aliyunid.com

账号。

BillingCycle String 2020-03

账期,格式:YYYY-MM。

Items Array of Item

账单详情。

Item
AfterTaxAmount Float 0
CommodityCode String rds

商品Code,与费用中心产品明细Code一致

Currency String CNY

币种,取值:

  • CNY。
  • USD。
  • JPY。
DeductedByCashCoupons Float 0

代金券抵扣。

DeductedByCoupons Float 0

优惠券抵扣。

DeductedByPrepaidCard Float 0

储值卡抵扣。

InvoiceDiscount Float 0

优惠金额。

Item String PayAsYouGoBill

账单类型,取值:

  • SubscriptionOrder。
  • PayAsYouGoBill。
  • Refund。
  • Adjustment。
OutstandingAmount Float 0

未结清金额或信用结算金额(普通用户的欠费, 或者信用客户信用额度消耗)。

PaymentAmount Float 100

现金支付。

PaymentCurrency String USD
PipCode String rds

产品Code,与费用中心账单产品Code一致

PretaxAmount Float 100

应付金额。

PretaxAmountLocal Float 0
PretaxGrossAmount Float 100

原始金额。

ProductCode String rds

产品代码。

ProductDetail String NAT Gateway (Pay-As-You-Go)

产品明细。

ProductName String Nat网关

产品名称。

ProductType String rds

产品类型。

RoundDownDiscount String 0

抹零优惠。

SubscriptionType String Subscription

订阅类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
Tax Float 0
Message String Successful!

错误信息。

RequestId String BCB1E1BC-05BF-4217-80EE-BF09A29407BA

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryBillOverview
&BillingCycle=2018-07
&<公共请求参数>

正常返回示例

XML 格式

<QueryBillOverviewResponse>
      <Message>Successful!</Message>
      <RequestId>BCB1E1BC-05BF-4217-80EE-BF09A29407BA</RequestId>
      <Data>
            <BillingCycle>2020-03</BillingCycle>
            <AccountID>185xxxxxx489</AccountID>
            <Items>
                  <Item>
                        <DeductedByCoupons>0</DeductedByCoupons>
                        <RoundDownDiscount>0</RoundDownDiscount>
                        <ProductName>云数据库RDS</ProductName>
                        <ProductDetail>关系型数据库RDS(包月)</ProductDetail>
                        <ProductCode>rds</ProductCode>
                        <ProductType>rds</ProductType>
                        <OutstandingAmount>0</OutstandingAmount>
                        <DeductedByCashCoupons>0</DeductedByCashCoupons>
                        <PaymentAmount>0.01</PaymentAmount>
                        <DeductedByPrepaidCard>0</DeductedByPrepaidCard>
                        <InvoiceDiscount>11447.99</InvoiceDiscount>
                        <Item>SubscriptionOrder</Item>
                        <SubscriptionType>Subscription</SubscriptionType>
                        <PretaxGrossAmount>11448</PretaxGrossAmount>
                        <PretaxAmount>0.01</PretaxAmount>
                        <Currency>CNY</Currency>
                  </Item>
                  <Item>
                        <DeductedByCoupons>0</DeductedByCoupons>
                        <RoundDownDiscount>0</RoundDownDiscount>
                        <ProductName>云数据库RDS</ProductName>
                        <ProductDetail>关系型数据库RDS(包月)</ProductDetail>
                        <ProductCode>rds</ProductCode>
                        <ProductType>rds</ProductType>
                        <OutstandingAmount>0</OutstandingAmount>
                        <DeductedByCashCoupons>0</DeductedByCashCoupons>
                        <PaymentAmount>0</PaymentAmount>
                        <DeductedByPrepaidCard>0</DeductedByPrepaidCard>
                        <InvoiceDiscount>0</InvoiceDiscount>
                        <Item>PayAsYouGoBill</Item>
                        <SubscriptionType>PayAsYouGo</SubscriptionType>
                        <PretaxGrossAmount>0</PretaxGrossAmount>
                        <PretaxAmount>0</PretaxAmount>
                        <Currency>CNY</Currency>
                  </Item>
            </Items>
            <AccountName>test@test.aliyunid.com</AccountName>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</QueryBillOverviewResponse>

JSON 格式

{
	"Message": "Successful!",
	"RequestId": "BCB1E1BC-05BF-4217-80EE-BF09A29407BA",
	"Data": {
		"BillingCycle": "2020-03",
		"AccountID": "185xxxxxx489",
		"Items": {
			"Item": [
				{
					"DeductedByCoupons": 0,
					"RoundDownDiscount": 0,
					"ProductName": "云数据库RDS",
					"ProductDetail": "关系型数据库RDS(包月)",
					"ProductCode": "rds",
					"ProductType": "rds",
					"OutstandingAmount": 0,
					"DeductedByCashCoupons": 0,
					"PaymentAmount": 0.01,
					"DeductedByPrepaidCard": 0,
					"InvoiceDiscount": 11447.99,
					"Item": "SubscriptionOrder",
					"SubscriptionType": "Subscription",
					"PretaxGrossAmount": 11448,
					"PretaxAmount": 0.01,
					"Currency": "CNY"
				},
				{
					"DeductedByCoupons": 0,
					"RoundDownDiscount": 0,
					"ProductName": "云数据库RDS",
					"ProductDetail": "关系型数据库RDS(包月)",
					"ProductCode": "rds",
					"ProductType": "rds",
					"OutstandingAmount": 0,
					"DeductedByCashCoupons": 0,
					"PaymentAmount": 0,
					"DeductedByPrepaidCard": 0,
					"InvoiceDiscount": 0,
					"Item": "PayAsYouGoBill",
					"SubscriptionType": "PayAsYouGo",
					"PretaxGrossAmount": 0,
					"PretaxAmount": 0,
					"Currency": "CNY"
				}
			]
		},
		"AccountName": "test@test.aliyunid.com"
	},
	"Code": "Success",
	"Success": true
}

错误码

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