Skip to main content

WorkflowAdminSub2ApiSubscriptionPage

items object[]required
  • Array [
    • subscriptionIdinteger<int64>required
    statusstringrequired

    Possible values: [active, expired, revoked]

    startsAtstring<date-time>required
    expiresAtstring<date-time>
    revokedAtstring<date-time>
    dailyUsageUsdnumberrequired

    Possible values: >= 0

    weeklyUsageUsdnumberrequired

    Possible values: >= 0

    monthlyUsageUsdnumberrequired

    Possible values: >= 0

    user objectrequired
    workflowUserIdstring

    Returns when it can match the Workflow account number.

    sub2apiUserIdinteger<int64>required
    displayNamestringrequired
    emailstring<email>
    avatarUrlstring<uri>
    group objectrequired
    groupIdinteger<int64>required
    namestringrequired
    platformstringrequired
    statusstringrequired
    paidAmountCentsintegerrequired

    Possible values: >= 0

    refundableAmountCentsintegerrequired

    Possible values: >= 0

    refund object
    idstring<uuid>required
    amountCentsintegerrequired

    Possible values: >= 1

    currencystringrequired

    Possible values: [CNY]

    statusstringrequired

    Possible values: [processing, completed, failed]

    failureMessagestring
    completedAtstring<date-time>
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
    • groups object[]required
  • Array [
    • groupIdinteger<int64>required
    namestringrequired
    platformstringrequired
    statusstringrequired
  • ]
    • totalintegerrequired

    Possible values: >= 0

    pageintegerrequired

    Possible values: >= 1

    pageSizeintegerrequired

    Possible values: >= 1

    totalPagesintegerrequired

    Possible values: >= 1

    fetchedAtstring<date-time>required

    Time of this response combination subscription paging; subscription details may come from short-term in-process cache.

    WorkflowAdminSub2ApiSubscriptionPage
    {
      "items": [
        {
          "subscriptionId": 0,
          "status": "active",
          "startsAt": "2024-07-29T15:51:28.071Z",
          "expiresAt": "2024-07-29T15:51:28.071Z",
          "revokedAt": "2024-07-29T15:51:28.071Z",
          "dailyUsageUsd": 0,
          "weeklyUsageUsd": 0,
          "monthlyUsageUsd": 0,
          "user": {
            "workflowUserId": "string",
            "sub2apiUserId": 0,
            "displayName": "string",
            "email": "user@example.com",
            "avatarUrl": "string"
          },
          "group": {
            "groupId": 0,
            "name": "string",
            "platform": "string",
            "status": "string"
          },
          "paidAmountCents": 0,
          "refundableAmountCents": 0,
          "refund": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "amountCents": 0,
            "currency": "CNY",
            "status": "processing",
            "failureMessage": "string",
            "completedAt": "2024-07-29T15:51:28.071Z",
            "createdAt": "2024-07-29T15:51:28.071Z",
            "updatedAt": "2024-07-29T15:51:28.071Z"
          }
        }
      ],
      "groups": [
        {
          "groupId": 0,
          "name": "string",
          "platform": "string",
          "status": "string"
        }
      ],
      "total": 0,
      "page": 0,
      "pageSize": 0,
      "totalPages": 0,
      "fetchedAt": "2024-07-29T15:51:28.071Z"
    }