Skip to main content

Get Subscription Seat Details

Paginated query of subscription seat details.

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

    Singapore

    GET https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/subscription/seat-detail

  • 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: GetSubscriptionSeatDetails, 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.

Request parameters

All parameters are passed in the query string. Array parameters (StatusList) use the Flat format: pass each element as ParameterName.N, where N starts from 1. For example, StatusList.1=NORMAL and StatusList.2=<second value>.

Parameter

Type

Required

Description

PageNo

integer

No

Page number. Default: 1. Valid values: positive integers.

PageSize

integer

No

Pagination parameter: number of entries per page. Default: 10.

StatusList

Array

No

Seat status filter list.

SeatId

string

No

Seat ID.

SeatType

string

No

Seat type (specType).
standard - Standard seat
pro - Pro seat
max - Max seat

QueryAssigned

boolean

No

Seat assignment status filter. true=assigned, false=unassigned, null=all.

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.

Items

Array[Object]

Data items.

Array[Object]

Data items.

InstanceCode

string

Seat instance code.

EquityList

Array[Object]

The currently effective entitlement instance. For the TokenPlan product, this list contains only one effective entitlement instance.

object

EquityType

string

Entitlement type (e.g., CREDITS, SPN, resource package).

CycleInstanceId

string

Entitlement code (subscription code; not consumed in credits scenarios).

CycleStartTime

integer

Current cycle start time, in milliseconds.

CycleEndTime

integer

Current cycle end time, in milliseconds.

CycleTotalValue

number

Total quota for the current cycle.

CycleSurplusValue

number

Remaining quota for the current cycle.

CycleVersion

integer

Temporal version of the current cycle.

EndTime

integer

Seat expiration time.

SeatId

string

Seat ID.

SpecType

string

Seat type.
standard - Standard seat
pro - Pro seat
max - Max seat

StartTime

integer

Seat start time.

AssignedStatus

string

Assignment status.
ASSIGNED
UNASSIGNED

AccountId

string

Bound member account ID.

AccountName

string

Member account name.

AccountEmail

string

Member account email.

Status

string

Seat status:
CREATING — Creating
NORMAL — Active
LIMIT — Restricted due to overdue payment
RELEASE — Released upon expiration
STOP — Suspended upon expiration
REFUNDED — Refunded

Total

integer

Total number of seats.

PageNo

integer

Page number. The value must be greater than 0 and not exceed the maximum value of the Integer data type.

PageSize

integer

Number of entries per page.

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.ap-southeast-1.aliyuncs.com/tokenplan/subscription/seat-detail?PageNo=1&PageSize=10&StatusList.1=NORMAL&SeatId=seat-123456&SeatType=standard&QueryAssigned=true" \
    --header "x-acs-action: GetSubscriptionSeatDetails" \
    --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: ${SIGNATURE_NONCE}" \
    --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": {
    "Items": [
      {
        "InstanceCode": "subs-1234567",
        "EquityList": [
          {
            "EquityType": "CREDITS",
            "CycleInstanceId": "123456",
            "CycleStartTime": 1788328800000,
            "CycleEndTime": 1790920800000,
            "CycleTotalValue": 100,
            "CycleSurplusValue": 40,
            "CycleVersion": 1
          }
        ],
        "EndTime": 1790920800000,
        "SeatId": "seat_123456",
        "SpecType": "standard",
        "StartTime": 1788328800000,
        "AssignedStatus": "ASSIGNED",
        "AccountId": "acc_123456789",
        "AccountName": "ExampleName",
        "AccountEmail": "test@email.com",
        "Status": "NORMAL"
      }
    ],
    "Total": 100,
    "PageNo": 1,
    "PageSize": 10
  }
}

Error codes

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