Preview Active Plan Price Change
Plan
Preview Active Plan Price Change
Preview how many subscriptions will be affected if we change price of an active plan.
POST
Preview Active Plan Price Change
Endpoint Overview
POSThttps://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
Sandbox
Response
Success responses return a JSON envelope withcode, 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. |
code in the response body is non-zero, check message for details. Use requestId when contacting support.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json

