Addon Binding

POST /merchant/plan/addons_binding

Addon Binding

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/plan/addons_binding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": 123,
  "addonIds": [
    123
  ],
  "onetimeAddonIds": [
    123
  ],
  "planId": 123
}
'

200

{
  "code": 123,
  "data": {
    "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
        }
      ],
      "multiCurrencies": [
        {
          "amount": 123,
          "autoExchange": true,
          "currency": "<string>",
          "disable": true,
          "exchangeRate": 123
        }
      ],
      "planName": "<string>",
      "productId": 123,
      "publishStatus": 123,
      "status": 123,
      "taxPercentage": 123,
      "trialAmount": 123,
      "trialDemand": "<string>",
      "trialDurationTime": 123,
      "type": 123,
      "usVATConfig": {
        "active": true,
        "fromAddress": {
          "address": "<string>",
          "city": "<string>",
          "countryCode": "<string>",
          "state": "<string>",
          "verified": true,
          "zipCode": "<string>"
        },
        "nexusAddresses": [
          {
            "address": "<string>",
            "city": "<string>",
            "countryCode": "<string>",
            "state": "<string>",
            "verified": true,
            "zipCode": "<string>"
          }
        ],
        "sellOnUSOnly": true,
        "taxCode": "<string>",
        "toAddress": {
          "address": "<string>",
          "city": "<string>",
          "countryCode": "<string>",
          "state": "<string>",
          "verified": true,
          "zipCode": "<string>"
        }
      }
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/plan/addons_binding

Addon Binding

---

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
action	integer	Yes	Action Type，0-override,1-add，2-delete
addonIds	array	Yes	Plan Ids Of Recurring Addon Type
onetimeAddonIds	array	Yes	Plan Ids Of Onetime Addon Type
planId	integer	Yes	PlanID

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/plan/addons_binding" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": 0,
  "addonIds": [],
  "onetimeAddonIds": 0,
  "planId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/plan/addons_binding" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": 0,
  "addonIds": [],
  "onetimeAddonIds": 0,
  "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.plan	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

action · integer<int64> · required

Action Type，0-override,1-add，2-delete

addonIds · integer<int64>[] · required

Plan Ids Of Recurring Addon Type

onetimeAddonIds · integer<int64>[] · required

Plan Ids Of Onetime Addon Type

planId · integer<int64> · required

PlanID

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>