v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB
Add-ons

Create an add-on

post/api/v1/addons

Request body

descriptionstring nullable
max_instances_per_subscriptioninteger nullable
namestring required
price_idstring MeteroidId required
product_idstring MeteroidId required
self_serviceableboolean

Example request

{
  "price_id": "pri_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
}

Response

Add-on created

archived_atstring date-time nullable
created_atstring date-time required
descriptionstring nullable
fee_type'RATE' | 'SLOT' | 'CAPACITY' | 'USAGE' | 'EXTRA_RECURRING' | 'ONE_TIME'
idstring MeteroidId required
max_instances_per_subscriptioninteger nullable
namestring required
price_idstring MeteroidId required
product_idstring MeteroidId required
self_serviceableboolean required

Example response

{
  "entitlements": [
    {
      "feature_id": "feat_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "ent_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "id": "add_7n42DGM5Tflk9n8mt7Fhc7",
  "price_id": "pri_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
}