Preview Active Plan Price Change

Preview how many subscriptions will be affected if we change price of an active plan.

POST /merchant/plan/active_price_change/preview

Preview Active Plan Price Change

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/plan/active_price_change/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "newAmount": 123,
  "planId": 123
}
'

200

{
  "code": 123,
  "data": {
    "activeAffectedSubscriptions": 123,
    "newAmount": 123,
    "oldAmount": 123,
    "planId": 123,
    "totalAffectedSubscriptions": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/plan/active_price_change/preview

Preview how many subscriptions will be affected if we change price of an active 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
newAmount	integer	Yes	New amount (in smallest currency unit, e.g. cents)
planId	integer	Yes	Target planId, must be active

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/plan/active_price_change/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "newAmount": 0,
  "planId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/plan/active_price_change/preview" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "newAmount": 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.activeAffectedSubscriptions	integer	Active/processing subscriptions whose future billing will be affected
data.newAmount	integer	New amount of plan
data.oldAmount	integer	Current amount of plan
data.planId	integer	Target planId
data.totalAffectedSubscriptions	integer	Total subscriptions that have used or are using this plan (by status set)
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

Preview how many subscriptions will be affected if we change price of an active plan.

newAmount · integer<int64> · required

New amount (in smallest currency unit, e.g. cents)

planId · integer<int64> · required

Target planId, must be active

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>