v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Add-Ons

Create an add-on

Create a one-time charge add-on with multi-currency pricing.

post/api/add-ons

Request body

namestring required

Display name

codestring required

Unique code for the add-on

descriptionstring
invoiceDisplayNamestring

Custom name shown on invoices

createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "name": "Premium Support",
  "code": "premium_support",
  "prices": [
    {
      "currency": "UGX",
      "amount": 50000
    }
  ]
}

Response

Add-on created

idstring required
namestring required
codestring required
descriptionstring
invoiceDisplayNamestring
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "name": "Extra Storage",
  "code": "extra_storage",
  "description": "50GB additional storage",
  "invoiceDisplayName": "Storage Add-On",
  "prices": [
    {
      "id": "clx1234567890",
      "currency": "USD",
      "amount": "29.9900"
    }
  ]
}