Skip to main content
POST
Edit Merchant Metric

Endpoint Overview

POST https://api.unibee.dev/merchant/metric/edit Edit Merchant Metric

Authorization

All UniBee Merchant API requests require authentication via API key.

Parameters

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

Request body


Request examples

cURL

Sandbox


Response

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

Error handling

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
metricId
integer<int64>
required

MetricId

metricName
string<string>
required

MetricName

carryoverProrationEnabled
boolean<*bool>

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

metaData
object

meta_data(json)

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
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>