跳到主要内容

WorkflowSub2ApiOrderPaymentResponse

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

用户可见订单;Sub2API 用户、订阅和密钥关联 ID 仅在后台保存。

idstring<uuid>required
userIdstringrequired
groupIdinteger<int64>

订阅套餐订单关联的分组;账户余额充值订单不返回该字段。

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

当前 Sub2API 用户的账户级共享余额,不归属于任何单个分组。

Possible values: >= 0

groups object[]required

管理员开放的配置,按当前用户 provider 使用偏好排序;未配置偏好时按分组 ID 升序。

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

    Possible values: [standard, subscription]

    statusstringrequired
    priceCentsintegerrequired
    hasApiKeybooleanrequired

    表示后台是否仍保留该分组密钥;停用密钥仍为 true,不返回密钥内容或 ID。

    apiKeyEnabledbooleanrequired

    表示该分组密钥当前是否为 active;未配置或已停用时为 false。

    paidAtstring<date-time>
    balanceUsage object
    todayUsdnumberrequired

    按 Asia/Shanghai 时区统计的今日实际扣减金额。

    Possible values: >= 0

    last30DaysUsdnumberrequired

    包含今日在内,过去 30 个自然日的实际扣减金额。

    Possible values: >= 0

    totalUsdnumberrequired

    当前用户在该余额计费分组的累计实际扣减金额。

    Possible values: >= 0

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

    Sub2API 当前每日总额度;null 表示不限。

    dailyUsageUsdnumberrequired

    Possible values: >= 0

    dailyRemainingUsdnumber | nullnullablerequired
    weeklyLimitUsdnumber | nullnullablerequired

    Sub2API 当前每周总额度;null 表示不限。

    weeklyUsageUsdnumberrequired

    Possible values: >= 0

    weeklyRemainingUsdnumber | nullnullablerequired
    monthlyLimitUsdnumber | nullnullablerequired

    Sub2API 当前每月总额度;null 表示不限。

    monthlyUsageUsdnumberrequired

    Possible values: >= 0

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

    本次响应组合余额、余额分组用量、订阅和额度的时间;Sub2API 明细可能来自短期进程内缓存。

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