Plan Apply Preview

Check discount can apply to plan, Only check rules about plan，the actual usage is subject to the subscription interface

POST /merchant/discount/plan_apply_preview

Plan Apply Preview

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/discount/plan_apply_preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "addonParams": [
    {
      "addonPlanId": 123,
      "quantity": 123
    }
  ],
  "currency": "<string>",
  "email": "<string>",
  "externalPlanId": "<string>",
  "isChangeToLongPlan": true,
  "isChangeToSameIntervalPlan": true,
  "isUpgrade": true,
  "planId": 123,
  "quantity": 123
}
'

200

{
  "code": 123,
  "data": {
    "allPlansAllowed": true,
    "allowedPlanIds": [
      123
    ],
    "discountAmount": 123,
    "discountCode": {
      "advance": true,
      "billingType": 123,
      "code": "<string>",
      "createTime": 123,
      "currency": "<string>",
      "cycleLimit": 123,
      "discountAmount": 123,
      "discountPercentage": 123,
      "discountType": 123,
      "endTime": 123,
      "id": 123,
      "isDeleted": 123,
      "merchantId": 123,
      "metadata": {},
      "name": "<string>",
      "planApplyGroup": {
        "currency": [
          "<string>"
        ],
        "groupPlanIntervalSelector": [
          {
            "intervalCount": 123,
            "intervalUnit": "<string>"
          }
        ],
        "type": [
          123
        ]
      },
      "planApplyType": 123,
      "planIds": [
        123
      ],
      "quantity": 123,
      "startTime": 123,
      "status": 123,
      "upgradeLongerOnly": true,
      "upgradeOnly": true,
      "userLimit": 123,
      "userScope": 123
    },
    "failureReason": "<string>",
    "valid": true
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/discount/plan_apply_preview

Check discount can apply to plan, Only check rules about plan，the actual usage is subject to the subscription interface

---

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
addonParams	array	No	Addon list with quantity, align with subscription create preview
code	string	Yes	The discount’s unique code, customize by merchant
currency	string	No	The currency of plan which code to apply
email	string	No	Email
externalPlanId	string	No	The externalId of plan which code to apply, either planId or externalPlanId is needed
isChangeToLongPlan	boolean	No	IsChangeToLongPlan
isChangeToSameIntervalPlan	boolean	No	IsChangeToSameIntervalPlan
isUpgrade	boolean	No	IsUpgrade
planId	integer	No	The id of plan which code to apply, either planId or externalPlanId is needed
quantity	integer	No	Main plan quantity, default 1; align with subscription create preview

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/discount/plan_apply_preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "addonParams": [],
  "code": "",
  "currency": "",
  "email": "[e-mail]",
  "externalPlanId": "id_example",
  "isChangeToLongPlan": false,
  "isChangeToSameIntervalPlan": false,
  "isUpgrade": false,
  "planId": 0,
  "quantity": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/discount/plan_apply_preview" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "addonParams": [],
  "code": "",
  "currency": "",
  "email": "[e-mail]",
  "externalPlanId": "id_example",
  "isChangeToLongPlan": false,
  "isChangeToSameIntervalPlan": false,
  "isUpgrade": false,
  "planId": 0,
  "quantity": 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.allPlansAllowed	boolean	True = discount applies to all plans in cart; false = only to allowedPlanIds
data.allowedPlanIds	array	Plan ids that get this discount (when partial apply); empty or same as main+addons when all plans allowed
data.discountAmount	integer	The discount amount can apply to plan
data.discountCode	object
data.failureReason	string	The apply preview failure reason
data.valid	boolean	The apply preview result, true or false
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

Check discount can apply to plan, Only check rules about plan，the actual usage is subject to the subscription interface

code · string<string> · required

The discount's unique code, customize by merchant

addonParams · object[]

Addon list with quantity, align with subscription create preview

Show child attributes

currency · string<string>

The currency of plan which code to apply

email · string<string>

Email

externalPlanId · string<string>

The externalId of plan which code to apply, either planId or externalPlanId is needed

isChangeToLongPlan · boolean<*bool>

IsChangeToLongPlan

isChangeToSameIntervalPlan · boolean<*bool>

IsChangeToSameIntervalPlan

isUpgrade · boolean<*bool>

IsUpgrade

planId · integer<int64>

The id of plan which code to apply, either planId or externalPlanId is needed

quantity · integer<int64>

Main plan quantity, default 1; align with subscription create preview

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>