Create Addon

Creates a new addon in draft status.

Mutation

Mutation

mutation CreateAddon($input: AddonCreateInput!) {
  createOneAddon(input: $input) {
    id
    refId
    displayName
    description
    status
    pricingType
    maxQuantity
    versionNumber
  }
}

{
  "input": {
    "refId": "addon-extra-seats",
    "displayName": "Extra Seats",
    "description": "Add more team members",
    "productId": "product-main",
    "pricingType": "PAID",
    "maxQuantity": 100
  }
}

{
  "data": {
    "createOneAddon": {
      "id": "addon-uuid-123",
      "refId": "addon-extra-seats",
      "displayName": "Extra Seats",
      "description": "Add more team members",
      "status": "DRAFT",
      "pricingType": "PAID",
      "maxQuantity": 100,
      "versionNumber": 1
    }
  }
}

Parameters

input · AddonCreateInput · required

Input for creating an addon

Show properties

productId · String · required

Product reference ID

displayName · String · required

Addon display name

refId · String

Unique addon reference ID

description · String

Addon description

pricingType · PricingType

FREE, PAID, or CUSTOM

maxQuantity · Float

Maximum quantity per subscription

billingId · String

Billing provider ID

dependencies · [String]

Required addon IDs

additionalMetaData · JSON

Custom metadata

environmentId · UUID

Environment ID

Return Type

Returns the created Addon object in DRAFT status.

Related Operations

• Set Package Pricing - Add pricing
• List Addons - Query addons