Assign add-on
curl --request POST \
--url https://your_domain/api/platform/v1/addon/manage \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"platformId": "pf_1",
"userId": "usr_123",
"addonId": "addon_1",
"billingCycle": "monthly",
"quantity": 1
}
'import requests
url = "https://your_domain/api/platform/v1/addon/manage"
payload = {
"platformId": "pf_1",
"userId": "usr_123",
"addonId": "addon_1",
"billingCycle": "monthly",
"quantity": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platformId: 'pf_1',
userId: 'usr_123',
addonId: 'addon_1',
billingCycle: 'monthly',
quantity: 1
})
};
fetch('https://your_domain/api/platform/v1/addon/manage', 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://your_domain/api/platform/v1/addon/manage",
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([
'platformId' => 'pf_1',
'userId' => 'usr_123',
'addonId' => 'addon_1',
'billingCycle' => 'monthly',
'quantity' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://your_domain/api/platform/v1/addon/manage"
payload := strings.NewReader("{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://your_domain/api/platform/v1/addon/manage")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_domain/api/platform/v1/addon/manage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Addon assigned successfully",
"data": {
"addonId": "adn_123",
"transactionId": "txn_456"
}
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}Add-ons
Assign add-on
Assign an add-on to a user with an active base subscription. Creates transaction + active add-on record.
Authentication: API key via X-API-Key header (or Authorization: Bearer). Permissions: User API key Rate limit: api_admin_write — 20 requests/min per API user.
POST
/
api
/
platform
/
v1
/
addon
/
manage
Assign add-on
curl --request POST \
--url https://your_domain/api/platform/v1/addon/manage \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"platformId": "pf_1",
"userId": "usr_123",
"addonId": "addon_1",
"billingCycle": "monthly",
"quantity": 1
}
'import requests
url = "https://your_domain/api/platform/v1/addon/manage"
payload = {
"platformId": "pf_1",
"userId": "usr_123",
"addonId": "addon_1",
"billingCycle": "monthly",
"quantity": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platformId: 'pf_1',
userId: 'usr_123',
addonId: 'addon_1',
billingCycle: 'monthly',
quantity: 1
})
};
fetch('https://your_domain/api/platform/v1/addon/manage', 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://your_domain/api/platform/v1/addon/manage",
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([
'platformId' => 'pf_1',
'userId' => 'usr_123',
'addonId' => 'addon_1',
'billingCycle' => 'monthly',
'quantity' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://your_domain/api/platform/v1/addon/manage"
payload := strings.NewReader("{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://your_domain/api/platform/v1/addon/manage")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_domain/api/platform/v1/addon/manage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platformId\": \"pf_1\",\n \"userId\": \"usr_123\",\n \"addonId\": \"addon_1\",\n \"billingCycle\": \"monthly\",\n \"quantity\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Addon assigned successfully",
"data": {
"addonId": "adn_123",
"transactionId": "txn_456"
}
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>",
"message": "<string>"
}Authorizations
apiKeyHeaderbearerAuth
Preferred. API key value directly.
Query Parameters
Your platform id.
Example:
"pf_1"
Target user id.
Example:
"usr_123"
Add-on plan id (itemType=addon). planId accepted as alias.
Example:
"addon_1"
monthly | quarterly | annual | onetime.
Quantity override.
Example:
1
Body
application/json
Your platform id.
Example:
"pf_1"
Target user id.
Example:
"usr_123"
Add-on plan id (itemType=addon). planId accepted as alias.
Example:
"addon_1"
monthly | quarterly | annual | onetime.
Quantity override.
Example:
1
Last modified on September 20, 2026