Skip to main content
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
}
'
{
  "addon_id": "<string>",
  "status": "<string>",
  "effective_at": "<string>"
}
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.

​
Attach an add-on

POST /v1/billing/addons/attach
Attaches an add-on to your tenant. If the add-on has a price, the response includes a checkout_url to complete payment. Free add-ons activate immediately.

​
Request body

​
addon_key
string
required
The add-on identifier. See the table below for available keys.
​
quantity
integer
Number of units to attach. Defaults to 1. For example, set quantity to 3 for three extra seats.

​
Response

​
checkout_url
string
Payment URL if the add-on requires payment. Redirect the user to complete checkout. Not included for free add-ons.
​
status
string
active for free add-ons, pending_payment when a checkout is required.

​
Detach an add-on

POST /v1/billing/addons/detach
Removes an add-on from your tenant. The associated entitlements are removed at the end of the current billing period.

​
Request body

​
addon_key
string
required
The add-on identifier to remove.

​
Available add-ons

KeyNameDescription
addon_seatExtra Seats+1 team member per unit beyond your plan limit
addon_sla_priorityPriority SLAGuaranteed response times for support
addon_private_logPrivate LogDedicated transparency log instance
addon_complianceCompliance PackSOC 2 reports and regulatory compliance bundle
addon_whitelabelWhite-LabelRemove Truthlocks branding from badges and certificates
addon_ratelimitRate Limit Boost10x API rate limit multiplier
addon_retentionExtended RetentionLonger 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.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
addon_id
string
required

Addon identifier to attach

​
quantity
integer

Number of addon units

Response

Addon attached

​
addon_id
string
​
status
string
​
effective_at
string