Skip to main content

List Shared Packages

Paginated query of shared package 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

    China (Beijing)

    GET https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/subscription/shared-packages

  • 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: ListSubscriptionSharedPackages, 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. Value range: positive integer.

PageSize

integer

No

Pagination parameter: number of entries per page, default 10.

StatusList

Array

No

Status filter list

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 entries

Array[Object]

Data entries

InstanceCode

string

Seat instance code

EquityList

Array[Object]

Currently effective equity instances

object

EquityType

string

Equity type (e.g., CREDITS, SPN, resource packages)

CycleInstanceId

string

Equity 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 of the current cycle

CycleSurplusValue

number

Remaining quota of the current cycle

CycleVersion

integer

Temporal version of the current cycle

Status

string

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

Total

integer

Total number of seats

PageNo

integer

Page number, greater than 0 and not exceeding the maximum value of the Integer data type; default 1

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.cn-beijing.aliyuncs.com/tokenplan/subscription/shared-packages?PageNo=1&PageSize=10&StatusList.1=NORMAL" \
    --header "x-acs-action: ListSubscriptionSharedPackages" \
    --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": {
    "Items": [
      {
        "InstanceCode": "subs-1234567",
        "EquityList": [
          {
            "EquityType": "CREDITS",
            "CycleInstanceId": "123456",
            "CycleStartTime": 1775232000,
            "CycleEndTime": 1756310400,
            "CycleTotalValue": 100,
            "CycleSurplusValue": 40,
            "CycleVersion": 1
          }
        ],
        "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.
Text Generation
Image Generation
Video Generation
World models
3D Model Generation
Audio
  • Audio generation
Realtime API
Text Embedding
Decision Model
TokenPlan
Model Production