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
    }
  }
}

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