GET
/
merchant
/
metric
/
user
/
metric
curl --request GET \
  --url https://api.unibee.top/merchant/metric/user/metric \
  --header 'Authorization: Bearer <token>'
{
  "code": 123,
  "data": {
    "userMetric": {
      "addons": [
        {
          "addonPlan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123
          },
          "quantity": 123
        }
      ],
      "description": "<string>",
      "isPaid": true,
      "limitStats": [
        {
          "CurrentUsedValue": 123,
          "metricLimit": {
            "MerchantId": 123,
            "MetricId": 123,
            "PlanLimits": [
              {
                "createTime": 123,
                "gmtModify": 123,
                "id": 123,
                "merchantId": 123,
                "merchantMetric": {
                  "aggregationProperty": "<string>",
                  "aggregationType": 123,
                  "code": "<string>",
                  "createTime": 123,
                  "gmtModify": 123,
                  "id": 123,
                  "merchantId": 123,
                  "metricDescription": "<string>",
                  "metricName": "<string>",
                  "type": 123
                },
                "metricId": 123,
                "metricLimit": 123,
                "planId": 123
              }
            ],
            "TotalLimit": 123,
            "UserId": 123,
            "aggregationProperty": "<string>",
            "aggregationType": 123,
            "code": "<string>",
            "metricName": "<string>",
            "type": 123
          }
        }
      ],
      "meteredChargeStats": [
        {
          "CurrentUsedValue": 123,
          "chargePricing": {
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "metricId": 123,
            "standardAmount": 123,
            "standardStartValue": 123
          },
          "graduatedStep": {
            "endValue": 123,
            "flatAmount": 123,
            "perAmount": 123,
            "startValue": 123
          },
          "maxEventId": 123,
          "merchantMetric": {
            "aggregationProperty": "<string>",
            "aggregationType": 123,
            "code": "<string>",
            "createTime": 123,
            "gmtModify": 123,
            "id": 123,
            "merchantId": 123,
            "metricDescription": "<string>",
            "metricName": "<string>",
            "type": 123
          },
          "metricId": 123,
          "minEventId": 123,
          "totalChargeAmount": 123
        }
      ],
      "plan": {
        "amount": 123,
        "bindingAddonIds": "<string>",
        "bindingOnetimeAddonIds": "<string>",
        "cancelAtTrialEnd": 123,
        "checkoutUrl": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "description": "<string>",
        "disableAutoCharge": 123,
        "externalPlanId": "<string>",
        "extraMetricData": "<string>",
        "gasPayer": "<string>",
        "homeUrl": "<string>",
        "id": 123,
        "imageUrl": "<string>",
        "internalName": "<string>",
        "intervalCount": 123,
        "intervalUnit": "<string>",
        "merchantId": 123,
        "metadata": {},
        "metricLimits": [
          {
            "metricId": 123,
            "metricLimit": 123
          }
        ],
        "metricMeteredCharge": [
          {
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "metricId": 123,
            "standardAmount": 123,
            "standardStartValue": 123
          }
        ],
        "metricRecurringCharge": [
          {
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "metricId": 123,
            "standardAmount": 123,
            "standardStartValue": 123
          }
        ],
        "planName": "<string>",
        "productId": 123,
        "publishStatus": 123,
        "status": 123,
        "taxPercentage": 123,
        "trialAmount": 123,
        "trialDemand": "<string>",
        "trialDurationTime": 123,
        "type": 123
      },
      "product": {
        "createTime": 123,
        "description": "<string>",
        "homeUrl": "<string>",
        "id": 123,
        "imageUrl": "<string>",
        "isDeleted": 123,
        "merchantId": 123,
        "metaData": "<string>",
        "productName": "<string>",
        "status": 123
      },
      "recurringChargeStats": [
        {
          "CurrentUsedValue": 123,
          "chargePricing": {
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "metricId": 123,
            "standardAmount": 123,
            "standardStartValue": 123
          },
          "graduatedStep": {
            "endValue": 123,
            "flatAmount": 123,
            "perAmount": 123,
            "startValue": 123
          },
          "maxEventId": 123,
          "merchantMetric": {
            "aggregationProperty": "<string>",
            "aggregationType": 123,
            "code": "<string>",
            "createTime": 123,
            "gmtModify": 123,
            "id": 123,
            "merchantId": 123,
            "metricDescription": "<string>",
            "metricName": "<string>",
            "type": 123
          },
          "metricId": 123,
          "minEventId": 123,
          "totalChargeAmount": 123
        }
      ],
      "subscription": {
        "addonData": "<string>",
        "amount": 123,
        "billingCycleAnchor": 123,
        "cancelAtPeriodEnd": 123,
        "cancelOrExpireTime": 123,
        "cancelReason": "<string>",
        "countryCode": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "currentPeriodEnd": 123,
        "currentPeriodPaid": 123,
        "currentPeriodStart": 123,
        "defaultPaymentMethodId": "<string>",
        "dunningTime": 123,
        "externalSubscriptionId": "<string>",
        "features": "<string>",
        "firstPaidTime": 123,
        "gasPayer": "<string>",
        "gatewayId": 123,
        "gatewayStatus": "<string>",
        "id": 123,
        "lastUpdateTime": 123,
        "latestInvoiceId": "<string>",
        "link": "<string>",
        "merchantId": 123,
        "metadata": {},
        "originalPeriodEnd": 123,
        "pendingUpdateId": "<string>",
        "planId": 123,
        "productId": 123,
        "quantity": 123,
        "returnUrl": "<string>",
        "status": 123,
        "subscriptionId": "<string>",
        "taskTime": "<string>",
        "taxPercentage": 123,
        "testClock": 123,
        "trialEnd": 123,
        "type": 123,
        "userId": 123,
        "vatNumber": "<string>"
      },
      "user": {
        "address": "<string>",
        "avatarUrl": "<string>",
        "billingType": 123,
        "birthday": "<string>",
        "city": "<string>",
        "companyName": "<string>",
        "countryCode": "<string>",
        "countryName": "<string>",
        "createTime": 123,
        "custom": "<string>",
        "email": "<string>",
        "externalUserId": "<string>",
        "facebook": "<string>",
        "firstName": "<string>",
        "gatewayId": 123,
        "gatewayPaymentType": "<string>",
        "gender": "<string>",
        "id": 123,
        "isRisk": 123,
        "isSpecial": 123,
        "language": "<string>",
        "lastLoginAt": 123,
        "lastName": "<string>",
        "linkedIn": "<string>",
        "merchantId": 123,
        "metadata": {},
        "mobile": "<string>",
        "otherSocialInfo": "<string>",
        "paymentMethod": "<string>",
        "phone": "<string>",
        "profession": "<string>",
        "recurringAmount": 123,
        "registrationNumber": "<string>",
        "school": "<string>",
        "status": 123,
        "subscriptionId": "<string>",
        "subscriptionName": "<string>",
        "subscriptionStatus": 123,
        "taxPercentage": 123,
        "telegram": "<string>",
        "tikTok": "<string>",
        "timeZone": "<string>",
        "type": 123,
        "userName": "<string>",
        "vATNumber": "<string>",
        "version": 123,
        "weChat": "<string>",
        "whatsAPP": "<string>",
        "zipCode": "<string>"
      }
    }
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

userId
integer

UserId, One Of UserId|ExternalUserId Needed

externalUserId
string

ExternalUserId, One Of UserId|ExternalUserId Needed

productId
integer

default product will use if productId not specified and subscriptionId is blank

Response

200 - application/json
code
integer
data
object
message
string
redirect
string
requestId
string