> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Override Metric Limits Of Plan

> Insert or override metric limit items of a plan

## Endpoint Overview

**POST** `https://api.unibee.dev/merchant/plan/metric_limit_override`

Insert or override metric limit items of a plan

***

## 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                                                             |
| ------------------ | ------- | -------- | ----------------------------------------------------------------------- |
| `metadataOverride` | object  | No       | Metadata to override for plan, only provided keys will be added/updated |
| `metricLimit`      | array   | No       | MetricLimit items to insert or override, identify metric by id or code  |
| `planId`           | integer | Yes      | Id of plan                                                              |

***

## Request examples

### cURL

```bash theme={null}
curl -X POST "https://api.unibee.dev/merchant/plan/metric_limit_override" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "metadataOverride": {},
  "metricLimit": [],
  "planId": 0
}'
```

### Sandbox

```bash theme={null}
curl -X POST "https://api-sandbox.unibee.top/merchant/plan/metric_limit_override" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "metadataOverride": {},
  "metricLimit": [],
  "planId": 0
}'
```

***

## 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.metadataOverrideSuccess`    | boolean | Whether metadata override processed successfully      |
| `data.metricLimitOverrideSuccess` | boolean | Whether metric limits override processed successfully |
| `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.


## OpenAPI

````yaml post /merchant/plan/metric_limit_override
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202603161017
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/plan/metric_limit_override:
    post:
      tags:
        - Plan
      summary: Override Metric Limits Of Plan
      description: Insert or override metric limit items of a plan
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/unibee.api.merchant.plan.MetricLimitOverrideReq
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      metadataOverrideSuccess:
                        description: Whether metadata override processed successfully
                        format: bool
                        properties: {}
                        type: boolean
                      metricLimitOverrideSuccess:
                        description: Whether metric limits override processed successfully
                        format: bool
                        properties: {}
                        type: boolean
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  schemas:
    unibee.api.merchant.plan.MetricLimitOverrideReq:
      description: Insert or override metric limit items of a plan
      properties:
        metadataOverride:
          additionalProperties:
            $ref: '#/components/schemas/interface'
          description: >-
            Metadata to override for plan, only provided keys will be
            added/updated
          format: map[string]interface {}
          properties: {}
          type: object
        metricLimit:
          description: >-
            MetricLimit items to insert or override, identify metric by id or
            code
          format: '[]*bean.PlanMetricLimitOverrideParam'
          items:
            $ref: '#/components/schemas/unibee.api.bean.PlanMetricLimitOverrideParam'
          properties: {}
          type: array
        planId:
          description: Id of plan
          format: int64
          properties: {}
          type: integer
      required:
        - planId
      type: object
    interface:
      properties: {}
      type: object
    unibee.api.bean.PlanMetricLimitOverrideParam:
      properties:
        metricCode:
          description: MetricCode, optional when metricId provided
          format: string
          properties: {}
          type: string
        metricId:
          description: MetricId, optional when metricCode provided
          format: int64
          properties: {}
          type: integer
        metricLimit:
          description: MetricLimit
          format: int64
          properties: {}
          type: integer
      required:
        - metricLimit
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````