QueryBill - BSS OpenAPI

Queries the bills 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
Type	string	No	The type of the bill. Valid values: SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
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 PayAsYouGo This parameter must be used together with the ProductCode parameter.	Subscription
IsHideZeroCharge	boolean	No	Specifies whether to filter out a bill whose pretax gross amount is 0. By default, a bill whose pretax gross amount is 0 is not filtered out. Valid values: true: filters out a bill whose pretax gross amount is 0. false: does not filter out a bill whose pretax gross amount is 0.	true
IsDisplayLocalCurrency	boolean	No	Specifies whether to display local currency information in bills. The parameter will be discontinued.	false
PageNum	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 20. Maximum value: 300.	20
BillOwnerId	long	No	The ID of the member.	123

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.	AE3F4057-DFC9-4B81-8858-F620651010C9
Success	boolean	Indicates whether the request is successful.	true
Data	object	The returned data.
PageNum	integer	The page number of the returned page.	1
BillingCycle	string	The billing cycle, in the YYYY-MM format.	2020-02
AccountID	string	The ID of the account.	185xxxxx489
PageSize	integer	The number of entries returned per page.	1
TotalCount	integer	The total number of returned entries.	20
AccountName	string	The name of the account.	test@test.aliyunid.com
Items	array<object>	The details of the bills.
	object
Status	string	The payment status of the bill. Valid values: PayFinish: The bill is paid. PayUnclear: The bill is not cleared. PayUnsettle: The bill is not settled. NoSettle: The bill is free of settlement.	PayFinish
RoundDownDiscount	string	The round down discount.	0
Item	string	The type of the bill. SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
Currency	string	The type of the currency. CNY USD JPY	CNY
UsageStartTime	string	The time when the bill starts.	2020-03-11 07:00:00
SubscriptionType	string	The billing method. Valid values: Subscription PayAsYouGo	PayAsYouGo
DeductedByCashCoupons	float	The amount deducted by using vouchers.	0
UsageEndTime	string	The time when the bill ends.	2020-03-11 08:00:00
DeductedByCoupons	float	The amount deducted by using coupons.	0
SubOrderId	string	The ID of the order corresponding to the bill.	325345254353
OutstandingAmount	float	The unsettled amount of the bill.	0
AfterTaxAmount	float	The amount paid after tax is deducted.	0
PaymentTime	string	The time when the order was paid.	2020-03-11 08:00:00
PretaxAmountLocal	float	The pretax amount paid in local currency.	0
Tax	float	The tax.	0
PipCode	string	The code of the service.	rds
PaymentTransactionID	string	The ID of the transaction.	2O3AADJFEAF2PDKSFAMFCB11918
PretaxAmount	float	The pretax amount	100
CommodityCode	string	The code of the commodity.	rds
ProductName	string	The name of the service.	ApsaraDB RDS
RecordID	string	The ID of the order or bill.	2020xxxx5912
AdjustAmount	float	The amount deducted by using credit refunds.	0
ProductDetail	string	The details of the service.	ApsaraDB RDS (subscription)
PaymentCurrency	string	The currency used for payment.	USD
OwnerID	string	The ID of the member. This parameter is returned in a multi-account payment scenario.	3532535235
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 with cash.	0
PretaxGrossAmount	float	The pretax gross amount.	0
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": "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": "ApsaraDB RDS\n",
          "RecordID": "2020xxxx5912",
          "AdjustAmount": 0,
          "ProductDetail": "ApsaraDB RDS (subscription)\n",
          "PaymentCurrency": "USD",
          "OwnerID": "3532535235",
          "DeductedByPrepaidCard": 0,
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 0,
          "PretaxGrossAmount": 0,
          "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