Query a bill overview for a billing cycle with QueryBillOverview - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Retrieves the bill overview for an account for a specified 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

*

bssapi:ProductCode
bssapi:ProductType

None

Request parameters

Parameter	Type	Required	Description	Example
BillingCycle	string	Yes	The billing cycle in `YYYY-MM` format.	2018-07
ProductCode	string	No	The product code.	rds
ProductType	string	No	The product type.	rds
SubscriptionType	string	No	The billing method. Valid values: `Subscription`: The subscription billing method. `PayAsYouGo`: The pay-as-you-go billing method.	Subscription
BillOwnerId	integer	No	The ID of the resource owner account. This refers to the account that uses the resource.	1234

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The response message.	Successful!
RequestId	string	The request ID.	BCB1E1BC-05BF-4217-80EE-BF09A29407BA
Success	boolean	Indicates whether the request was successful.	true
Data	object	The response data.
BillingCycle	string	The billing cycle in YYYY-MM format.	2020-03
AccountID	string	The account ID.	185766xxxx
AccountName	string	The account name.	test@test.aliyunid.com
Items	object
Item	array<object>	The bill details.
	object
RoundDownDiscount	string	The round-down discount.	0
Item	string	The bill type. Valid values: `SubscriptionOrder`: subscription bill `PayAsYouGoBill`: pay-as-you-go bill `Refund`: refund `Adjustment`: adjustment	PayAsYouGoBill
Currency	string	The currency. Valid values: CNY USD JPY	CNY
SubscriptionType	string	The subscription type. Valid values: `Subscription`: subscription `PayAsYouGo`: pay-as-you-go	Subscription
BillAccountName	string	The bill's account name.	test@test.aliyunid.com
BizType	string	The business type.	trusteeship
DeductedByCoupons	number	The amount deducted by coupons.	0
OutstandingAmount	number	The outstanding amount, which includes overdue payments and amounts settled by using a credit limit.	0
AfterTaxAmount	number	The amount after tax is applied. This is the final billable amount including any applicable tax charges.
PretaxAmountLocal	number	The pretax amount in the local currency. This represents the billing amount before tax is applied, converted to the account's local currency setting.
Tax	number	The tax amount charged for the billing cycle. This is the difference between the after-tax amount and the pretax amount.
PipCode	string	The product code, which is the same as the one shown on bills in Billing Management.	rds
PretaxAmount	number	The pretax amount.	100
ProductName	string	The product name.	NAT Gateway
CommodityCode	string	The commodity code, which is the same as the one shown for product details in Billing Management.	rds
AdjustAmount	number	The amount paid using refund credit.	0
ProductDetail	string	The product details.	NAT Gateway (Pay-As-You-Go)
PaymentCurrency	string	The currency used for payment settlement. This field indicates the actual currency in which the payment was processed, which may differ from the billing currency (Currency) in cases of currency conversion or cross-border transactions.
OwnerID	string	The bill owner's ID.	1222
ProductType	string	The product type.	rds
InvoiceDiscount	number	The discount amount.	0
PaymentAmount	number	The payment amount, including any amount paid using refund credit.	100
BillAccountID	string	The bill's account ID.	185766xxxx
PretaxGrossAmount	number	The original amount.	100
CashAmount	number	The amount paid in cash. This excludes any amount paid using refund credit.	0
ProductCode	string	The product code.	rds

Examples

Success response

JSON format

{
  "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",
          "BillAccountName": "test@test.aliyunid.com",
          "BizType": "trusteeship",
          "DeductedByCoupons": 0,
          "OutstandingAmount": 0,
          "AfterTaxAmount": 0,
          "PretaxAmountLocal": 0,
          "Tax": 0,
          "PipCode": "rds",
          "PretaxAmount": 100,
          "ProductName": "NAT Gateway",
          "CommodityCode": "rds",
          "AdjustAmount": 0,
          "ProductDetail": "NAT Gateway (Pay-As-You-Go)",
          "PaymentCurrency": "",
          "OwnerID": "1222",
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 100,
          "BillAccountID": "185766xxxx",
          "PretaxGrossAmount": 100,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.