QueryBillOverview - BSS OpenAPI

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

There is currently no authorization information disclosed in the API.

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	array<object>	The details of the bills.
	object
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
AfterTaxAmount	float	The amount paid after the tax is deducted.	0
PretaxAmountLocal	float	The pretax amount paid in local currency.	0
Tax	float	The tax.	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)
PaymentCurrency	string	The currency used for payment.	USD
OwnerID	string	The ID of the bill owner.	1222
DeductedByPrepaidCard	float	The amount deducted by using prepaid cards.	0
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
BillAccountID	string	The ID of the account to which the bill belongs.	185766xxxx
PretaxGrossAmount	float	The pretax gross amount.	100
CashAmount	float	The amount paid in cash. The amount that was deducted by using credit refunds is not included.	0
ProductCode	string	The code of the service.	rds

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,
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 100,
          "BillAccountID": "185766xxxx",
          "PretaxGrossAmount": 100,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-03-28	API Description Update	View Change Details