Cancel Subscription Immediately

Cancel subscription immediately, no proration invoice will generate

POST /merchant/subscription/cancel

Cancel Subscription Immediately

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/subscription/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invoiceNow": true,
  "productId": 123,
  "prorate": true,
  "reason": "<string>",
  "subscriptionId": "<string>",
  "userId": 123
}
'

200

{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/subscription/cancel

Cancel subscription immediately, no proration invoice will generate

---

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
invoiceNow	boolean	No	Default false
productId	integer	No	default product will use if productId not specified and subscriptionId is blank
prorate	boolean	No	Prorate Generate Invoice，Default false
reason	string	No	Reason
subscriptionId	string	No	SubscriptionId, id of subscription, either SubscriptionId or UserId needed, The only one active subscription of userId will effect
userId	integer	No	UserId, either SubscriptionId or UserId needed, The only one active subscription will effect if userId provide instead of subscriptionId

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/subscription/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "invoiceNow": false,
  "productId": 0,
  "prorate": false,
  "reason": "",
  "subscriptionId": "id_example",
  "userId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/subscription/cancel" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "invoiceNow": false,
  "productId": 0,
  "prorate": false,
  "reason": "",
  "subscriptionId": "id_example",
  "userId": 0
}'

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success. The response schema for this endpoint is shown below.

---

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

Cancel subscription immediately, no proration invoice will generate

invoiceNow · boolean<bool> · deprecated

Default false

productId · integer<int64>

default product will use if productId not specified and subscriptionId is blank

prorate · boolean<bool> · deprecated

Prorate Generate Invoice，Default false

reason · string<string>

Reason

subscriptionId · string<string>

SubscriptionId, id of subscription, either SubscriptionId or UserId needed, The only one active subscription of userId will effect

userId · integer<int64>

UserId, either SubscriptionId or UserId needed, The only one active subscription will effect if userId provide instead of subscriptionId

Response

200 - application/json

code · integer<int>

data · object

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>