GetBillingOverview

Queries billing overview information for a specified month, with support for grouping by dimensions and filtering.

Request syntax

GET /modelstudio/billing/overview HTTP/1.1

Request parameters

Name	Type	Required	Description	Example
billMonth	string	Yes	Billing month in YYYY-MM format. This field is required.	2026-08
groupBy	array<object>	Yes	List of grouping conditions. Currently, exactly one grouping dimension must be specified. See the supplementary notes below for supported dimension codes.
groupBy.code	string	Yes	Dimension code.	MAAS_TYPE
filter	object	No	Filter conditions.
filter.dimensions	array<object>	No	List of filter dimensions.
filter.dimensions.code	string	No	Dimension code.	BASE_MODEL
filter.dimensions.values	array<string>	No	List of filter values.	["qwen-max"]
filter.dimensions.selectType	string	No	Filter type. Valid values: IN NOT	IN
topNum	integer	No	Number of groups to return. Valid range: 1 to 20. Default value: 20.	20
zeroFilter	boolean	No	Whether to filter out groups with zero amount. Default value: true.	true
regionId	string	No	Region ID.	cn-beijing
locale	string	No	Response language. Default value: en-US. Valid values: en-US: English zh-CN: Chinese	zh-CN

Supplementary notes

The following values are supported for groupBy[].code and filter.dimensions[].code. We recommend using uppercase consistently:

Dimension code	Description	Valid filter.dimensions[].values
MAAS_TYPE	MaaS business type	inference (model inference), training (model training), model_units (model units), capacity_reserved (reserved capacity)
BASE_MODEL	Base model	Original base model values from billing data, such as qwen-plus
API_KEY_ID	API Key ID	Original API Key ID values from billing data
WORKSPACE_ID	Workspace ID	Original Workspace ID values from billing data
FEE_TYPE	Fee type	billing (billing fees), subscription (subscription fees)
CHARGE_TYPE	Billing method	postpaid (pay-as-you-go), prepaid (subscription)
BUSINESS_REGION	Business region	cn-beijing, ap-southeast-1, cn-hongkong, etc. Values are based on actual data
SERVICE_SITE	Service site	asia-pacific-china, global, international, etc. Values are based on actual data
ARTICLE_CODE	Article code	sfm_inferenceglobal_public_intl, etc. Values are based on actual data

NoteYou can pass DIMENSION_FILTER_NULL_VALUE in filter.dimensions[].values for any dimension to match records where the field is NULL or an empty string.

Response parameters

Name	Type	Description	Example
requestId	string	Request ID.	BB521414-5D38-5E66-AA66-963B2B4200E2
code	string	Response code.	200
message	string	Response message.	null
success	boolean	Whether the request was successful.	true
data	object	Billing overview data.
data.currency	string	Amount currency.	USD
data.totalAmount	string	Total amount.	31228.60
data.pretaxAmount	string	Total amount excluding tax.	28729.32
data.taxAmount	string	Total tax amount.	2499.28
data.groups	array<object>	TopN group list sorted by amount in descending order.
data.groups.key	string	Group dimension value. Null values return DIMENSION_FILTER_NULL_VALUE.	inference
data.groups.name	string	Group display name, affected by the locale parameter. Null values are displayed as -.	Model Inference
data.groups.articleCodes	array<string>	List of article codes involved in this group.
data.groups.amount	string	Amount for this group.	3000
data.groups.percentage	string	Ratio of the group amount to the TopN total amount.	0.10

Examples

Sample success response

JSON format

{
  "requestId": "BB521414-5D38-5E66-AA66-963B2B4200E2",
  "code": "200",
  "message": "null",
  "success": true,
  "data": {
    "currency": "USD",
    "totalAmount": "31228.60",
    "pretaxAmount": "28729.32",
    "taxAmount": "2499.28",
    "groups": [
      {
        "key": "inference",
        "name": "Model Inference",
        "articleCodes": [
          "sfm_inferenceglobal_public_intl"
        ],
        "amount": "3000",
        "percentage": "0.10"
      }
    ]
  }
}