Use QueryBill to query settlement bills - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries the settlement bills of a user within a specific billing cycle.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeBillList

get

*All Resource

*

None

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. Valid values: SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
ProductCode	string	No	The product code.	rds
ProductType	string	No	The product type.	rds
SubscriptionType	string	No	The subscription type. Valid values: Subscription PayAsYouGo Note This parameter must be used together with the ProductCode parameter.	Subscription
IsHideZeroCharge	boolean	No	Specifies whether to filter out bills with a original price (PretaxGrossAmount) of 0. Default value: false (compatible with existing logic). Valid values: true: filters out zero-charge bills. false: does not filter out zero-charge bills.	true
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 300.	20
BillOwnerId	integer	No	The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource.	123

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful!
RequestId	string	The request ID.	AE3F4057-DFC9-4B81-8858-F620651010C9
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
BillingCycle	string	The billing cycle, in the YYYY-MM format.	2020-02
AccountID	string	The account ID.	185xxxxx489
PageSize	integer	The number of entries per page.	1
TotalCount	integer	The total number of records.	20
AccountName	string	The account name.	test@test.aliyunid.com
Items	object
Item	array<object>	The bill details.
	object
Status	string	The payment status. Valid values: PayFinish: Paid. PayUnclear: Not cleared. PayUnsettle: Not settled. NoSettle: No settlement required.	PayFinish
RoundDownDiscount	string	The round-down discount.	0
Item	string	The bill type. Valid values: SubscriptionOrder PayAsYouGoBill Refund Adjustment	SubscriptionOrder
Currency	string	The currency. Valid values: CNY USD JPY	CNY
UsageStartTime	string	The start time of the bill.	2020-03-11 07:00:00
SubscriptionType	string	The subscription type. Valid values: Subscription PayAsYouGo	PayAsYouGo
UsageEndTime	string	The end time of the bill.	2020-03-11 08:00:00
DeductedByCoupons	number	The amount deducted by coupons.	0
SubOrderId	string	The ID of the order detail that corresponds to the bill.	325345254353
OutstandingAmount	number	The outstanding amount.	0
AfterTaxAmount	number
PaymentTime	string	The payment time of the order.	2020-03-11 08:00:00
PretaxAmountLocal	number
Tax	number
PipCode	string	The product code.	rds
PaymentTransactionID	string
PretaxAmount	number	The payable amount.	100
CommodityCode	string	The commodity code.	rds
ProductName	string	The product name.	ApsaraDB RDS
RecordID	string	The order ID or bill ID.	2020xxxx5912
AdjustAmount	number	The amount deducted by credit refunds.	0
ProductDetail	string	The product details.	Relational Database Service (Subscription)
PaymentCurrency	string
OwnerID	string	The AccountID of the member account (in multi-account payment scenarios).	3532535235
ProductType	string	The product type.	rds
InvoiceDiscount	number	The discount amount.	0
PaymentAmount	number	The cash payment amount (including credit refund deductions).	0
PretaxGrossAmount	number	The original amount.	0
CashAmount	number	The cash payment amount (excluding credit refund deductions).	0
ProductCode	string	The product code.	rds

Examples

Success response

JSON format

{
  "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",
          "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": "",
          "PretaxAmount": 100,
          "CommodityCode": "rds",
          "ProductName": "ApsaraDB RDS",
          "RecordID": "2020xxxx5912",
          "AdjustAmount": 0,
          "ProductDetail": "Relational Database Service (Subscription)",
          "PaymentCurrency": "",
          "OwnerID": "3532535235",
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 0,
          "PretaxGrossAmount": 0,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.