New Merchant Metric

POST /merchant/metric/new

New Merchant Metric

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/metric/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "metricName": "<string>",
  "aggregationProperty": "<string>",
  "aggregationType": 123,
  "carryoverProrationEnabled": true,
  "metaData": {},
  "metricDescription": "<string>",
  "prorationRefundEnabled": true,
  "type": 123,
  "unit": "<string>"
}
'

200

{
  "code": 123,
  "data": {
    "merchantMetric": {
      "aggregationProperty": "<string>",
      "aggregationType": 123,
      "archived": true,
      "carryoverProrationEnabled": true,
      "code": "<string>",
      "createTime": 123,
      "gmtModify": 123,
      "id": 123,
      "merchantId": 123,
      "metaData": {},
      "metricDescription": "<string>",
      "metricName": "<string>",
      "prorationRefundEnabled": true,
      "type": 123,
      "unit": "<string>"
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/metric/new

New Merchant Metric

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body

Name	Type	Required	Description
aggregationProperty	string	No	AggregationProperty, Will Needed When AggregationType != count
aggregationType	integer	No	AggregationType,1-count，2-count unique, 3-latest, 4-max, 5-sum
carryoverProrationEnabled	boolean	No	Enable carryover proration for this metric (default: false when not set)
code	string	Yes	Code
metaData	object	No	meta_data(json)
metricDescription	string	No	MetricDescription
metricName	string	Yes	MetricName
prorationRefundEnabled	boolean	No	Enable proration refund for this metric (reclaim metric limit on upgrade; default: false when not set)
type	integer	No	1-limit_metered，2-charge_metered，3-charge_recurring，4-limit_recurring
unit	string	No	unit

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/metric/new" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "aggregationProperty": "",
  "aggregationType": 0,
  "carryoverProrationEnabled": false,
  "code": "",
  "metaData": {},
  "metricDescription": "",
  "metricName": "",
  "prorationRefundEnabled": false,
  "type": 0,
  "unit": ""
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/metric/new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "aggregationProperty": "",
  "aggregationType": 0,
  "carryoverProrationEnabled": false,
  "code": "",
  "metaData": {},
  "metricDescription": "",
  "metricName": "",
  "prorationRefundEnabled": false,
  "type": 0,
  "unit": ""
}'

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.merchantMetric	object
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

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

Body

application/json

code · string<string> · required

Code

metricName · string<string> · required

MetricName

aggregationProperty · string<string>

AggregationProperty, Will Needed When AggregationType != count

aggregationType · integer<int>

AggregationType,1-count，2-count unique, 3-latest, 4-max, 5-sum

carryoverProrationEnabled · boolean<*bool>

Enable carryover proration for this metric (default: false when not set)

metaData · object

meta_data(json)

Show child attributes

metricDescription · string<string>

MetricDescription

prorationRefundEnabled · boolean<*bool>

Enable proration refund for this metric (reclaim metric limit on upgrade; default: false when not set)

type · integer<*int>

1-limit_metered，2-charge_metered，3-charge_recurring，4-limit_recurring

unit · string<string>

unit

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>