QuerySplitItemBill - Expenses and Costs - Alibaba Cloud Documentation Center

Queries split bills. This API has been upgraded. We recommend that you use the new DescribeSplitItemBill operation.

Operation description

The API for split bills is upgraded. We recommend that you use the new DescribeSplitItemBill operation. This operation no longer supports querying more than 50,000 rows of data.
The data is consistent with the split bill data for the specified billing cycle in the User Center.
You can query split bills that were generated within the last 12 months.
To use this feature, you must first enable it on the Split Bill page in the console.

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

bssapi:QuerySplitItemBill

get

*All Resource

*

bssapi:ProductCode
bssapi:ProductType

None

Request parameters

Parameter	Type	Required	Description	Example
BillingCycle	string	Yes	The billing cycle. Format: YYYY-MM.	2020-03
ProductCode	string	No	The product code.	rds
ProductType	string	No	The product type.	rds
SubscriptionType	string	No	The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. Note: This parameter must be used with the ProductCode parameter.	PayAsYouGo
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 account that owns the resource. The resource owner 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.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	integer	The page number. Default value: 1.	1
BillingCycle	string	The billing cycle. Format: YYYY-MM.	2020-03
AccountID	string	The account ID.	185xxxx3489
PageSize	integer	The number of entries per page. Default value: 20. Maximum value: 300.	20
TotalCount	integer	The total number of records.	2
AccountName	string	The user account.	test@test.aliyunid.com
Items	object
Item	array<object>	The bill details.
	object
SplitAccountID	string	The account ID to which the attached resource belongs.	122
SubscriptionType	string	The subscription type. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go. Note: This parameter must be used with the ProductCode parameter.	PayAsYouGo
InstanceSpec	string	The instance type.	ecs.sn1ne.3xlarge
DeductedByCoupons	number	The amount deducted using coupons.	0
Region	string	The region.	cn-hangzhou
OutstandingAmount	number	The outstanding amount.	0
PipCode	string	The product code. This is the same as the product code in the bills of User Center.	rds
CommodityCode	string	The commodity code. This is the same as the product detail code in the bills of User Center.	rds
NickName	string	The instance nickname.	test
ProductDetail	string	The product details.	云数据库RDS
Usage	string	The usage. This parameter is valid only when isBillingItem is true.	100
IntranetIP	string	The internal IP address.	192.xx.xx.xx
UsageUnit	string	The unit of usage. This parameter is valid only when isBillingItem is true.	GB
SplitCommodityCode	string	The commodity code of the attached resource.	rds
ProductType	string	The product type.	rds
DeductedByResourcePackage	string	The amount deducted using resource plans.	NULL
PaymentAmount	number	The cash payment.	0
SplitBillingCycle	string	The month of the split bill.	2020-06
ServicePeriod	string	The service period.	10
SplitItemName	string	The name of the attached resource.	iZ28bycvyb4Z
ListPrice	string	The list price. This parameter is valid only when isBillingItem is true.	100
Zone	string	The zone.	cn-hangzhou-h
PretaxGrossAmount	number	The pretax gross amount.	0
CashAmount	number	The cash payment. This amount does not include the amount deducted using credit refunds.	0
InstanceConfig	string	The detailed instance configuration.	CPU:12
BillingDate	string	The billing date. Format: YYYY-MM-DD.	2020-01-20
InternetIP	string	The public IP address.	34.xx.x.x
Item	string	The bill type: SubscriptionOrder (Subscription order). PayAsYouGoBill (Pay-as-you-go bill). Refund (Refund). Adjustment (Adjustment).	PayAsYouGoBill
SplitItemID	string	The split item ID.	i-28bycvyb4
InstanceID	string	The instance ID.	i-kjhdskjgshfdlkjfdh
Tag	string	The tag.	tag
Currency	string	The currency. Valid values: CNY. USD. JPY.	CNY
DeductedByCashCoupons	number	The amount deducted using cash coupons.	0
BillingItem	string	The billing item.	其他
CostUnit	string	The cost center.	未分配
ListPriceUnit	string	The unit of the list price. This parameter is valid only when isBillingItem is true.	元
ResourceGroup	string	The resource group.	默认资源组
PretaxAmount	number	The pretax amount.	0
ServicePeriodUnit	string	The unit of the service duration.	秒
ProductName	string	The product name.	云数据库RDS
SplitProductDetail	string	The name of the product details for the attached resource.	rds
AdjustAmount	number	The amount deducted using credit refunds.	0
OwnerID	string	The account ID of the RAM user. This is used in multi-account payment scenarios.	169***013
DeductedByPrepaidCard	number	The amount deducted using prepaid cards.	0
InvoiceDiscount	number	The discount amount.	0
SplitAccountName	string	The name of the account to which the attached resource belongs.	12@test.com
BillingType	string	The billing method.	其它
ProductCode	string	The product code.	rds

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "BillingCycle": "2020-03",
    "AccountID": "185xxxx3489",
    "PageSize": 20,
    "TotalCount": 2,
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "SplitAccountID": "122",
          "SubscriptionType": "PayAsYouGo",
          "InstanceSpec": "ecs.sn1ne.3xlarge",
          "DeductedByCoupons": 0,
          "Region": "cn-hangzhou",
          "OutstandingAmount": 0,
          "PipCode": "rds",
          "CommodityCode": "rds",
          "NickName": "test",
          "ProductDetail": "云数据库RDS",
          "Usage": "100",
          "IntranetIP": "192.xx.xx.xx",
          "UsageUnit": "GB",
          "SplitCommodityCode": "rds",
          "ProductType": "rds",
          "DeductedByResourcePackage": "NULL",
          "PaymentAmount": 0,
          "SplitBillingCycle": "2020-06",
          "ServicePeriod": "10",
          "SplitItemName": "iZ28bycvyb4Z",
          "ListPrice": "100",
          "Zone": "cn-hangzhou-h",
          "PretaxGrossAmount": 0,
          "CashAmount": 0,
          "InstanceConfig": "CPU:12",
          "BillingDate": "2020-01-20",
          "InternetIP": "34.xx.x.x",
          "Item": "PayAsYouGoBill",
          "SplitItemID": "i-28bycvyb4",
          "InstanceID": "i-kjhdskjgshfdlkjfdh",
          "Tag": "tag",
          "Currency": "CNY",
          "DeductedByCashCoupons": 0,
          "BillingItem": "其他",
          "CostUnit": "未分配",
          "ListPriceUnit": "元",
          "ResourceGroup": "默认资源组",
          "PretaxAmount": 0,
          "ServicePeriodUnit": "秒",
          "ProductName": "云数据库RDS",
          "SplitProductDetail": "rds",
          "AdjustAmount": 0,
          "OwnerID": "169***013",
          "DeductedByPrepaidCard": 0,
          "InvoiceDiscount": 0,
          "SplitAccountName": "12@test.com",
          "BillingType": "其它",
          "ProductCode": "rds"
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.