Skip to main content
POST
/
addons
Activate an addon for the tenant
curl --request POST \
  --url https://api.royalti.io/addons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addonName": "publisher",
  "settings": {
    "defaultTerritories": [
      "US",
      "CA"
    ]
  }
}
'
import requests

url = "https://api.royalti.io/addons"

payload = {
    "addonName": "publisher",
    "settings": { "defaultTerritories": ["US", "CA"] }
}
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({addonName: 'publisher', settings: {defaultTerritories: ['US', 'CA']}})
};

fetch('https://api.royalti.io/addons', 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.royalti.io/addons",
  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([
    'addonName' => 'publisher',
    'settings' => [
        'defaultTerritories' => [
                'US',
                'CA'
        ]
    ]
  ]),
  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.royalti.io/addons"

	payload := strings.NewReader("{\n  \"addonName\": \"publisher\",\n  \"settings\": {\n    \"defaultTerritories\": [\n      \"US\",\n      \"CA\"\n    ]\n  }\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.royalti.io/addons")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addonName\": \"publisher\",\n  \"settings\": {\n    \"defaultTerritories\": [\n      \"US\",\n      \"CA\"\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/addons")

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  \"addonName\": \"publisher\",\n  \"settings\": {\n    \"defaultTerritories\": [\n      \"US\",\n      \"CA\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "data": {
    "TenantId": 123,
    "AddonName": "<string>",
    "active": true,
    "settings": {},
    "settingsVersion": 123,
    "addon": {
      "description": "<string>",
      "plans": [
        "<string>"
      ],
      "logo": "<string>",
      "isActive": true
    }
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

POST /addons Activates addonName for the tenant: merges default settings with any provided settings, validates them (hand-rolled per-addon checks plus the Phase 7 JSON-schema registry keyed by settingsVersion, which starts at 1 for new rows), writes individual TenantSetting rows ({addonName}-{key}), and creates the TenantAddon record. Fails if the tenant already has this addon. Authorization:
  • Required role: admin or higher

​
Code Examples

const response = await fetch('https://api.royalti.io/addons', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "addonName": "sample-addonName",
    "settings": {}
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
  'https://api.royalti.io/addons',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"addonName":"sample-addonName","settings":{}}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/addons \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"addonName":"sample-addonName","settings":{}}'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
​
addonName
enum<string>
required
Available options:
distro,
payment_requests,
publisher
​
settings
object

Partial settings merged over the addon's defaults before validation.

Response

Addon activated

​
success
boolean
Example:

true

​
message
string
​
data
object