Skip to main content
POST
Attach addon
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

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

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

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

Request body

string
required
The add-on identifier to remove.

Available add-ons

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