Skip to main content
POST
Create add-on
This reference describes API version 2026-07-24. Send Commet-Version: 2026-07-24 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-24

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
name
string
required
Required string length: 1 - 100
basePrice
integer
required
Required range: 0 <= x <= 9007199254740991
featureId
string
required
Minimum string length: 1
consumptionModel
string
required
Allowed value: "boolean"
description
string
Maximum string length: 255
planIds
string[]

Plans that sell the add-on. Omitted or empty, every plan sells it. Plans created later sell it too.

Response

Success

id
string
required
name
string
required
slug
string
required
description
string | null
required
basePrice
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
featureCode
string
required
featureName
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
consumptionModel
enum<string>
required
Available options:
boolean,
metered,
credits,
balance
includedUnits
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
overageRate
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
creditCost
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
planIds
string[]
required

Plans that sell the add-on.

object
string
required
Allowed value: "addon"
livemode
boolean
required