Skip to main content
Retrieves a paginated list of addons with optional filtering and sorting.

Query

query ListAddons(
  $filter: AddonFilter
  $paging: CursorPaging
  $sorting: [AddonSort!]
) {
  addons(filter: $filter, paging: $paging, sorting: $sorting) {
    edges {
      node {
        refId
        displayName
        description
        status
        pricingType
        maxQuantity
        versionNumber
        product {
          refId
          displayName
        }
        prices {
          billingModel
          billingPeriod
          price {
            amount
            currency
          }
        }
        packageEntitlements {
          ... on PackageEntitlement {
            feature {
              refId
              displayName
            }
            usageLimit
          }
        }
        dependencies {
          refId
          displayName
        }
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}
{
  "filter": {
    "status": { "eq": "PUBLISHED" },
    "isLatest": { "is": true }
  },
  "paging": {
    "first": 20
  }
}
{
  "data": {
    "addons": {
      "edges": [
        {
          "node": {
            "refId": "addon-extra-seats",
            "displayName": "Extra Seats",
            "description": "Add more team members",
            "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"
                },
                "usageLimit": 1
              }
            ],
            "dependencies": []
          },
          "cursor": "abc123"
        }
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "abc123"
      },
      "totalCount": 3
    }
  }
}

Parameters

filter
AddonFilter
Filter criteria for addons
paging
CursorPaging
Pagination options
sorting
[AddonSort]
Sorting options

Return Type

Returns an AddonConnection with addon objects.