Get Addon

Retrieves detailed information about a specific addon.

Query

Query

query GetAddon($input: GetPackageByRefIdInput!) {
  getAddonByRefId(input: $input) {
    refId
    displayName
    description
    status
    pricingType
    maxQuantity
    versionNumber
    product {
      refId
      displayName
    }
    prices {
      billingModel
      billingPeriod
      price {
        amount
        currency
      }
    }
    packageEntitlements {
      ... on PackageEntitlement {
        feature {
          refId
          displayName
          featureType
        }
        hasUnlimitedUsage
        usageLimit
      }
    }
    dependencies {
      refId
      displayName
    }
  }
}

{
  "input": {
    "refId": "addon-extra-seats"
  }
}

{
  "data": {
    "getAddonByRefId": {
      "refId": "addon-extra-seats",
      "displayName": "Extra Seats",
      "description": "Add more team members to your workspace",
      "status": "PUBLISHED",
      "pricingType": "PAID",
      "maxQuantity": 100,
      "versionNumber": 2,
      "product": {
        "refId": "product-main",
        "displayName": "Main Product"
      },
      "prices": [
        {
          "billingModel": "FLAT_FEE",
          "billingPeriod": "MONTHLY",
          "price": {
            "amount": 10,
            "currency": "USD"
          }
        }
      ],
      "packageEntitlements": [
        {
          "feature": {
            "refId": "feature-seats",
            "displayName": "Team Seats",
            "featureType": "NUMBER"
          },
          "hasUnlimitedUsage": false,
          "usageLimit": 1
        }
      ],
      "dependencies": []
    }
  }
}

Parameters

input · GetPackageByRefIdInput · required

Input parameters for retrieving the addon

Show properties

refId · String · required

The unique addon reference ID

versionNumber · Int

Specific version to retrieve

environmentId · UUID

Environment ID

Return Type

Returns an Addon object with full addon details.

Related Operations

• List Addons - Query multiple addons
• Create Addon - Create new addon