Skip to main content

WorkflowSub2ApiCatalogGroup

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
WorkflowSub2ApiCatalogGroup
{
"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
}
}