POST
/
merchant
/
subscription
/
cancel_at_period_end
curl --request POST \
  --url https://api.unibee.top/merchant/subscription/cancel_at_period_end \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "productId": 123,
  "subscriptionId": "<string>",
  "userId": 123
}'
{
  "code": 123,
  "data": {},
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Cancel subscription at period end, the subscription will not turn to 'cancelled' at once but will cancelled at period end time, no invoice will generate, the flag 'cancelAtPeriodEnd' of subscription will be enabled

​
productId
integer

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

​
subscriptionId
string

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

​
userId
integer

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
​
data
object
​
message
string
​
redirect
string
​
requestId
string