GET/api/v1/admin/subscriptions检索订阅

分页检索全部订阅,支持用户、状态与业务服务过滤。

Request

Headers

NameData TypeRequiredDescription
AuthorizationstringYes会话令牌认证,格式 `Bearer <sessionToken>`
type RequestHeaders = {
  /** 会话令牌认证,格式 `Bearer <sessionToken>` */
  Authorization: string
}

Query Parameters

NameData TypeRequiredDescription
pagenumberNo页码,默认 1
pageSizenumberNo每页数量,默认 20,上限 100
userIdstringNo按用户过滤
statusstringNoactive / canceled / expired
businessServicestringNo按业务服务过滤
type QueryParams = {
  /** 页码,默认 1 */
  page?: number
  /** 每页数量,默认 20,上限 100 */
  pageSize?: number
  /** 按用户过滤 */
  userId?: string
  /** active / canceled / expired */
  status?: string
  /** 按业务服务过滤 */
  businessService?: string
}
{
  "page": 1,
  "pageSize": 20,
  "status": "active"
}

Response

Body

NameData TypeRequiredDescription
itemsarrayYes订阅列表
totalnumberYes总数
pagenumberYes当前页码
pageSizenumberYes每页数量
type ResponseBody = {
  /** 订阅列表 */
  items: Record<string, unknown>[]
  /** 总数 */
  total: number
  /** 当前页码 */
  page: number
  /** 每页数量 */
  pageSize: number
}
{
  "items": [
    {
      "subscriptionId": "01JD8SOBHV0C3D9JD",
      "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
      "title": "Xeegam Cloud · 专业版",
      "businessService": "cloud",
      "amount": 28,
      "currency": "USD",
      "interval": "monthly",
      "status": "active",
      "nextRenewalAt": "2026-11-13T09:00:00Z",
      "createdAt": "2026-10-14T15:30:00Z"
    }
  ],
  "total": 312,
  "page": 1,
  "pageSize": 20
}

HTTP Code

HTTP Status Meaning Notes
200 成功 返回订阅列表

Response Code

响应使用统一信封 {id, code, messages, result},其 code 字段:

code Meaning Notes
0 成功 返回订阅列表

Examples

GET /api/v1/admin/subscriptions?status=active
Authorization: Bearer st_7c1f9e05b28d4a63
{
  "id": "01JD8STE4J9E2F6",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      {
        "subscriptionId": "01JD8SOBHV0C3D9JD",
        "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
        "title": "Xeegam Cloud · 专业版",
        "businessService": "cloud",
        "amount": 28,
        "currency": "USD",
        "interval": "monthly",
        "status": "active",
        "nextRenewalAt": "2026-11-13T09:00:00Z",
        "createdAt": "2026-10-14T15:30:00Z"
      }
    ],
    "total": 312,
    "page": 1,
    "pageSize": 20
  }
}