Cancel Subscription At Period End

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

import requests

url = "https://api.unibee.dev/merchant/subscription/cancel_at_period_end"

payload = {
    "productId": 123,
    "subscriptionId": "<string>",
    "userId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productId: 123, subscriptionId: '<string>', userId: 123})
};

fetch('https://api.unibee.dev/merchant/subscription/cancel_at_period_end', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unibee.dev/merchant/subscription/cancel_at_period_end",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'productId' => 123,
    'subscriptionId' => '<string>',
    'userId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unibee.dev/merchant/subscription/cancel_at_period_end"

	payload := strings.NewReader("{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/subscription/cancel_at_period_end")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unibee.dev/merchant/subscription/cancel_at_period_end")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}"

response = http.request(request)
puts response.read_body

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

POST

merchant

subscription

cancel_at_period_end

Cancel Subscription At Period End

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

import requests

url = "https://api.unibee.dev/merchant/subscription/cancel_at_period_end"

payload = {
    "productId": 123,
    "subscriptionId": "<string>",
    "userId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productId: 123, subscriptionId: '<string>', userId: 123})
};

fetch('https://api.unibee.dev/merchant/subscription/cancel_at_period_end', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unibee.dev/merchant/subscription/cancel_at_period_end",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'productId' => 123,
    'subscriptionId' => '<string>',
    'userId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unibee.dev/merchant/subscription/cancel_at_period_end"

	payload := strings.NewReader("{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/subscription/cancel_at_period_end")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unibee.dev/merchant/subscription/cancel_at_period_end")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productId\": 123,\n  \"subscriptionId\": \"<string>\",\n  \"userId\": 123\n}"

response = http.request(request)
puts response.read_body

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

Endpoint Overview

POST https://api.unibee.dev/merchant/subscription/cancel_at_period_end 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

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
`productId`	integer	No	default product will use if productId not specified and subscriptionId is blank
`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_at_period_end" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": 0,
  "subscriptionId": "id_example",
  "userId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/subscription/cancel_at_period_end" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": 0,
  "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 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<int64>

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

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>

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

Cancel Subscription At Period End

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling

Authorizations

Body

Response

​Endpoint Overview

​Authorization

​Parameters

​Request body

​Request examples

​cURL

​Sandbox

​Response

​Error handling

Authorizations

Body

Response

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling