Attach addon
curl --request POST \
--url https://api.truthlocks.com/v1/billing/addons/attach \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"addon_id": "<string>",
"quantity": 123
}
'import requests
url = "https://api.truthlocks.com/v1/billing/addons/attach"
payload = {
"addon_id": "<string>",
"quantity": 123
}
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({addon_id: '<string>', quantity: 123})
};
fetch('https://api.truthlocks.com/v1/billing/addons/attach', 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.truthlocks.com/v1/billing/addons/attach",
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([
'addon_id' => '<string>',
'quantity' => 123
]),
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://api.truthlocks.com/v1/billing/addons/attach"
payload := strings.NewReader("{\n \"addon_id\": \"<string>\",\n \"quantity\": 123\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://api.truthlocks.com/v1/billing/addons/attach")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addon_id\": \"<string>\",\n \"quantity\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truthlocks.com/v1/billing/addons/attach")
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 \"addon_id\": \"<string>\",\n \"quantity\": 123\n}"
response = http.request(request)
puts response.read_body{
"addon_id": "<string>",
"status": "<string>",
"effective_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Billing
Manage add-ons
Attach or detach add-ons to extend your plan with additional features and quotas.
POST
/
v1
/
billing
/
addons
/
attach
Attach addon
curl --request POST \
--url https://api.truthlocks.com/v1/billing/addons/attach \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"addon_id": "<string>",
"quantity": 123
}
'import requests
url = "https://api.truthlocks.com/v1/billing/addons/attach"
payload = {
"addon_id": "<string>",
"quantity": 123
}
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({addon_id: '<string>', quantity: 123})
};
fetch('https://api.truthlocks.com/v1/billing/addons/attach', 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.truthlocks.com/v1/billing/addons/attach",
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([
'addon_id' => '<string>',
'quantity' => 123
]),
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://api.truthlocks.com/v1/billing/addons/attach"
payload := strings.NewReader("{\n \"addon_id\": \"<string>\",\n \"quantity\": 123\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://api.truthlocks.com/v1/billing/addons/attach")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addon_id\": \"<string>\",\n \"quantity\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truthlocks.com/v1/billing/addons/attach")
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 \"addon_id\": \"<string>\",\n \"quantity\": 123\n}"
response = http.request(request)
puts response.read_body{
"addon_id": "<string>",
"status": "<string>",
"effective_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Add-ons let you extend your plan with extra capabilities — additional seats, priority SLA, a private transparency log, and more. See the billing overview for the full add-on catalog.
Attaches an add-on to your tenant. If the add-on has a price, the response includes a
Removes an add-on from your tenant. The associated entitlements are removed at the end of the current billing period.
Attach an add-on
POST /v1/billing/addons/attach
checkout_url to complete payment. Free add-ons activate immediately.
Request body
string
required
The add-on identifier. See the table below for available keys.
integer
Number of units to attach. Defaults to
1. For example, set quantity to 3 for three extra seats.Response
string
Payment URL if the add-on requires payment. Redirect the user to complete checkout. Not included for free add-ons.
string
active for free add-ons, pending_payment when a checkout is required.Detach an add-on
POST /v1/billing/addons/detach
Request body
string
required
The add-on identifier to remove.
Available add-ons
| Key | Name | Description |
|---|---|---|
addon_seat | Extra Seats | +1 team member per unit beyond your plan limit |
addon_sla_priority | Priority SLA | Guaranteed response times for support |
addon_private_log | Private Log | Dedicated transparency log instance |
addon_compliance | Compliance Pack | SOC 2 reports and regulatory compliance bundle |
addon_whitelabel | White-Label | Remove Truthlocks branding from badges and certificates |
addon_ratelimit | Rate Limit Boost | 10x API rate limit multiplier |
addon_retention | Extended Retention | Longer data and audit log retention periods |
Check your current add-ons and resolved entitlements with the entitlements endpoint. Add-on quotas are automatically merged into your plan quotas.

