Skip to main content
POST
Cancel Subscription Immediately

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.

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body


Request examples

cURL

Sandbox


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

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>