Skip to main content
DELETE
/
addons
/
{addonId}
Toggle addon active state (legacy route, same handler as PUT /toggle)
curl --request DELETE \
  --url https://api.royalti.io/addons/{addonId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'
import requests

url = "https://api.royalti.io/addons/{addonId}"

payload = { "active": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({active: true})
};

fetch('https://api.royalti.io/addons/{addonId}', 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/{addonId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'active' => true
]),
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/{addonId}"

payload := strings.NewReader("{\n \"active\": true\n}")

req, _ := http.NewRequest("DELETE", 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.delete("https://api.royalti.io/addons/{addonId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "<string>",
  "data": {
    "TenantId": 123,
    "AddonName": "<string>",
    "active": true,
    "settings": {},
    "settingsVersion": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "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

DELETE /addons/ Despite the HTTP verb, this does not delete the TenantAddon row — it calls the identical toggleTenantAddon handler as PUT /addons/{addonId}/toggle, reading active from the request body. Kept for backward compatibility; prefer the PUT .../toggle route for new integrations. Authorization:
  • Required role: admin or higher

Code Examples

const response = await fetch('https://api.royalti.io/addons/example-id', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

response = requests.delete(
  'https://api.royalti.io/addons/example-id',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)
curl -X DELETE https://api.royalti.io/addons/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

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

Path Parameters

addonId
enum<string>
required
Available options:
distro,
payment_requests,
publisher

Body

application/json
active
boolean
required

Response

Addon activated or deactivated

success
boolean
Example:

true

message
string
data
object

A tenant's activation record for one addon (TenantAddon model, composite PK TenantId + AddonName).