Skip to main content
Retrieves detailed information about a specific plan using its reference ID.

​
Query

query GetPlan($input: GetPackageByRefIdInput!) {
  getPlanByRefId(input: $input) {
    refId
    displayName
    description
    status
    pricingType
    versionNumber
    basePlan {
      refId
      displayName
    }
    product {
      refId
      displayName
    }
    prices {
      billingModel
      billingPeriod
      billingCadence
      price {
        amount
        currency
      }
      tiers {
        upTo
        unitPrice {
          amount
          currency
        }
      }
    }
    packageEntitlements {
      ... on PackageEntitlement {
        feature {
          refId
          displayName
          featureType
          featureUnits
        }
        hasUnlimitedUsage
        usageLimit
        resetPeriod
      }
    }
    compatibleAddons {
      refId
      displayName
      maxQuantity
    }
    defaultTrialConfig {
      duration
      units
    }
  }
}

​
Parameters

​
input
GetPackageByRefIdInput
required
Input parameters for retrieving the plan

​
Return Type

Returns a Plan object with all plan details including entitlements, pricing, and configuration.

​
Common Use Cases

Show complete plan information on a plan detail page.
Verify what entitlements are included in a specific plan.
Retrieve specific versions to compare changes.