QueryBillOverview - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the bill overview information in a billing cycle.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
bssapi:QueryBillOverview	READ	All Resources *	bssapi:ProductCode bssapi:ProductType	none

Request parameters

Parameter	Type	Required	Description	Example
BillingCycle	string	Yes	The billing cycle, in the YYYY-MM format.	2018-07
ProductCode	string	No	The code of the service.	rds
ProductType	string	No	The type of the service.	rds
SubscriptionType	string	No	The billing method. Valid values: Subscription: the subscription billing method PayAsYouGo: the pay-as-you-go billing method	Subscription
BillOwnerId	long	No	The ID of the member. If you specify a value for this parameter, you can query the bills of the specified member. If you leave this parameter empty, the bills of the current account are queried by default.	1234

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The status code returned.	Success
Message	string	The message returned.	Successful!
RequestId	string	The ID of the request.	BCB1E1BC-05BF-4217-80EE-BF09A29407BA
Success	boolean	Indicates whether the request is successful.	true
Data	object	The data returned.
BillingCycle	string	The billing cycle, in the YYYY-MM format.	2020-03
AccountID	string	The ID of the account.	185766xxxx
AccountName	string	The name of the account.	test@test.aliyunid.com
Items	object []	The details of the bills.
RoundDownDiscount	string	The round down discount.	0
Item	string	The type of the bill. Valid values: SubscriptionOrder PayAsYouGoBill Refund Adjustment	PayAsYouGoBill
Currency	string	The type of the currency. Valid values: CNY USD JPY	CNY
SubscriptionType	string	The billing method. Valid values: Subscription: the subscription billing method PayAsYouGo: the pay-as-you-go billing method	Subscription
DeductedByCashCoupons	float	The amount deducted by using vouchers.	0
BillAccountName	string	The name of the account to which the bill belongs.	test@test.aliyunid.com
BizType	string	The business type.	trusteeship
DeductedByCoupons	float	The amount deducted by using coupons.	0
OutstandingAmount	float	The unsettled amount or the amount deducted by using credits. This may be an unsettled amount of a regular user or credits consumed by a credit user.	0
PipCode	string	The code of the service. The service code is the same as that displayed in User Center.	rds
PretaxAmount	float	The pretax amount.	100
ProductName	string	The name of the service.	NAT Gateway
CommodityCode	string	The code of the commodity. The commodity code is the same as that displayed in User Center.	rds
AdjustAmount	float	The amount deducted by using credit refunds.	0
ProductDetail	string	The details of the service.	NAT Gateway (Pay-As-You-Go)
OwnerID	string	The ID of the bill owner.	1222
DeductedByPrepaidCard	float	The amount deducted by using prepaid cards.	0
BillAccountID	string	The ID of the account to which the bill belongs.	185766xxxx
ProductType	string	The type of the service.	rds
InvoiceDiscount	float	The discount amount.	0
PaymentAmount	float	The amount paid in cash. The amount that was deducted by using credit refunds is included.	100
PretaxGrossAmount	float	The pretax gross amount.	100
ProductCode	string	The code of the service.	rds
CashAmount	float	The amount paid in cash. The amount that was deducted by using credit refunds is not included.	0

Examples

Sample success responses

JSONformat

{
  "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 Gateway\n",
          "CommodityCode": "rds",
          "AdjustAmount": 0,
          "ProductDetail": "NAT Gateway (Pay-As-You-Go)",
          "PaymentCurrency": "USD",
          "OwnerID": "1222",
          "DeductedByPrepaidCard": 0,
          "BillAccountID": "185766xxxx",
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 100,
          "PretaxGrossAmount": 100,
          "ProductCode": "rds",
          "CashAmount": 0
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.