Get Subscription Seat and Credit Statistics

Prerequisites

You have obtained the AccessKey of an Alibaba Cloud account or a RAM user, and the identity has been granted the RAM permissions required to call this operation. We recommend that you set the AccessKey as the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET instead of hard-coding it.

Request description

HTTP method: GET
Request URL
Region
Endpoint
China (Beijing)
GET https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/subscription/stats
Authentication This operation is an Alibaba Cloud OpenAPI operation that uses AccessKey-based signatures (the ACS3-HMAC-SHA256 algorithm). The Authorization: Bearer {API_KEY} scheme is not supported. A request must carry the common headers x-acs-action: GetSubscriptionStats, x-acs-version: 2026-02-10, x-acs-date, x-acs-content-sha256, x-acs-signature-nonce, and Authorization. We recommend that you call this operation with an Alibaba Cloud SDK or OpenAPI Explorer so that you do not have to calculate the signature yourself.

Region	Endpoint
China (Beijing)	`GET https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/subscription/stats`

Request parameters

This API has no request parameters.

Response parameters

Parameter	Type	Description
Success	boolean	Whether the API call was successful: true: success false: failure
Code	string	Response status code.
Message	string	Response message.
Data	object	Business data.
SubscriptionStartTime	integer	Subscription start time, in milliseconds.
SubscriptionEndTime	integer	Subscription end time, in milliseconds.
Items	Array[Object]	Seat information list (grouped by specType).
	object	List data.
SeatType	string	Seat type (specType): standard - Standard seat pro - Pro seat max - Max seat
SeatRefreshTime	integer	Refresh time for the current period, in milliseconds.
TotalSeats	integer	Total number of seats.
AssignedSeats	integer	Number of assigned seats.
SeatCredits	number	Total seat Credits quota.
SeatRemainingCredits	number	Remaining Credits for the current period.

Request example

This operation uses Alibaba Cloud OpenAPI signatures. In the following example, ${SIGNATURE} must be calculated with the ACS3-HMAC-SHA256 algorithm, and x-acs-date and x-acs-signature-nonce must be replaced with actual values.

curl -X GET "https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/subscription/stats" \
    --header "x-acs-action: GetSubscriptionStats" \
    --header "x-acs-version: 2026-02-10" \
    --header "x-acs-date: 2026-01-01T12:00:00Z" \
    --header "x-acs-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" \
    --header "x-acs-signature-nonce: 3e3b2a9f0c7d4f8e9a1b2c3d4e5f6a7b" \
    --header "Authorization: ACS3-HMAC-SHA256 Credential=${ALIBABA_CLOUD_ACCESS_KEY_ID},SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=${SIGNATURE}"

Response example

{
  "Success": true,
  "Data": {
    "SubscriptionStartTime": 1788328800000,
    "SubscriptionEndTime": 1790920800000,
    "Items": [
      {
        "SeatType": "standard",
        "SeatRefreshTime": 1790920800000,
        "TotalSeats": 2,
        "AssignedSeats": 1,
        "SeatCredits": 100,
        "SeatRemainingCredits": 40
      }
    ]
  }
}

Error codes

If the call fails, an error message is returned. For more error codes and solutions, see Error codes.

​Prerequisites

​Request description

​Request parameters

​Response parameters

​Request example

​Response example

​Error codes