Skip to main content

WorkflowSub2ApiOrderPaymentResponse

errCodeintegerrequired
Constant value: 0
errMessagestringrequired
Constant value:
data objectrequired
order objectrequired

The order is visible to the user; the Sub2API user, subscription, and key association IDs are only saved in the background.

idstring<uuid>required
userIdstringrequired
groupIdinteger<int64>

Groups associated with subscription package orders; this field is not returned for account balance recharge orders.

groupNamestringrequired
kindstringrequired

Possible values: [subscription, balance_recharge]

amountCentsintegerrequired

Possible values: >= 1

currencystringrequired

Possible values: [CNY]

statusstringrequired

Possible values: [pending, processing, completed, failed]

paidAtstring<date-time>
fulfilledAtstring<date-time>
failureMessagestring
createdAtstring<date-time>required
updatedAtstring<date-time>required
catalog objectrequired
balancenumberrequired

The account-level shared balance of the current Sub2API user, which does not belong to any individual group.

Possible values: >= 0

groups object[]required

The configuration opened by the administrator is sorted by the current user provider preference; if the preference is not configured, the order is ascending by group ID.

  • Array [
    • groupIdinteger<int64>required
    namestringrequired
    descriptionstringrequired
    platformstringrequired
    subscriptionTypestringrequired

    Possible values: [standard, subscription]

    statusstringrequired
    priceCentsintegerrequired
    hasApiKeybooleanrequired

    Indicates whether the group key is still retained in the background; the deactivation key is still true, and the key content or ID is not returned.

    apiKeyEnabledbooleanrequired

    Indicates whether the grouping key is currently active; false if not configured or deactivated.

    paidAtstring<date-time>
    balanceUsage object
    todayUsdnumberrequired

    Today's actual deduction by Asia/Shanghai time zone.

    Possible values: >= 0

    last30DaysUsdnumberrequired

    Actual deductions for the past 30 natural days, including today.

    Possible values: >= 0

    totalUsdnumberrequired

    The cumulative actual deduction amount of the current user in the balance charging group.

    Possible values: >= 0

    subscription object
    statusstringrequired
    startsAtstring<date-time>required
    expiresAtstring<date-time>
    dailyLimitUsdnumber | nullnullablerequired

    Sub2API the current total daily quota; null means unlimited.

    dailyUsageUsdnumberrequired

    Possible values: >= 0

    dailyRemainingUsdnumber | nullnullablerequired
    weeklyLimitUsdnumber | nullnullablerequired

    Sub2API Total current weekly quota; null indicates unlimited.

    weeklyUsageUsdnumberrequired

    Possible values: >= 0

    weeklyRemainingUsdnumber | nullnullablerequired
    monthlyLimitUsdnumber | nullnullablerequired

    Sub2API Total current monthly quota; null indicates unlimited.

    monthlyUsageUsdnumberrequired

    Possible values: >= 0

    monthlyRemainingUsdnumber | nullnullablerequired
  • ]
    • fetchedAtstring<date-time>required

    The time of this response to the combined balance, balance group usage, subscription and quota; Sub2API details may come from the short-term in-process cache.

    WorkflowSub2ApiOrderPaymentResponse
    {
      "errCode": 0,
      "errMessage": "string",
      "data": {
        "order": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "userId": "string",
          "groupId": 0,
          "groupName": "string",
          "kind": "subscription",
          "amountCents": 0,
          "currency": "CNY",
          "status": "pending",
          "paidAt": "2024-07-29T15:51:28.071Z",
          "fulfilledAt": "2024-07-29T15:51:28.071Z",
          "failureMessage": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "catalog": {
          "balance": 0,
          "groups": [
            {
              "groupId": 0,
              "name": "string",
              "description": "string",
              "platform": "string",
              "subscriptionType": "standard",
              "status": "string",
              "priceCents": 0,
              "hasApiKey": true,
              "apiKeyEnabled": true,
              "paidAt": "2024-07-29T15:51:28.071Z",
              "balanceUsage": {
                "todayUsd": 0,
                "last30DaysUsd": 0,
                "totalUsd": 0
              },
              "subscription": {
                "status": "string",
                "startsAt": "2024-07-29T15:51:28.071Z",
                "expiresAt": "2024-07-29T15:51:28.071Z",
                "dailyLimitUsd": 0,
                "dailyUsageUsd": 0,
                "dailyRemainingUsd": 0,
                "weeklyLimitUsd": 0,
                "weeklyUsageUsd": 0,
                "weeklyRemainingUsd": 0,
                "monthlyLimitUsd": 0,
                "monthlyUsageUsd": 0,
                "monthlyRemainingUsd": 0
              }
            }
          ],
          "fetchedAt": "2024-07-29T15:51:28.071Z"
        }
      }
    }