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 The add-on identifier. See the table below for available keys.
Number of units to attach. Defaults to 1. For example, set quantity to 3 for three extra seats.
Response Payment URL if the add-on requires payment. Redirect the user to complete checkout. Not included for free add-ons.
active for free add-ons, pending_payment when a checkout is required.
Attach paid add-on
Attach free add-on
curl -X POST https://api.truthlocks.com/v1/billing/addons/attach \ -H "X-API-Key: tl_live_..." \ -H "Content-Type: application/json" \ -d '{ "addon_key": "addon_seat", "quantity": 2 }'
200 Paid add-on (checkout required)
200 Free add-on (activated immediately)
{ "checkout_url" : "https://checkout.stripe.com/c/pay/cs_..." , "status" : "pending_payment" }
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 The add-on identifier to remove.
curl -X POST https://api.truthlocks.com/v1/billing/addons/detach \ -H "X-API-Key: tl_live_..." \ -H "Content-Type: application/json" \ -d '{"addon_key": "addon_seat"}'
Available add-ons Key Name Description addon_seatExtra Seats +1 team member per unit beyond your plan limit addon_sla_priorityPriority SLA Guaranteed response times for support addon_private_logPrivate Log Dedicated transparency log instance addon_complianceCompliance Pack SOC 2 reports and regulatory compliance bundle addon_whitelabelWhite-Label Remove Truthlocks branding from badges and certificates addon_ratelimitRate Limit Boost 10x API rate limit multiplier addon_retentionExtended 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. 