Query
Parameters
Filter criteria for plans
Pagination options
Sorting options with fields:
createdAt, displayName, refId, statusReturn Type
Returns aPlanConnection with plan objects containing:
| Field | Type | Description |
|---|---|---|
refId | String | Plan reference ID |
displayName | String | Display name |
description | String | Plan description |
status | PackageStatus | DRAFT, PUBLISHED, ARCHIVED |
pricingType | PricingType | FREE, PAID, CUSTOM |
versionNumber | Int | Current version |
basePlan | Plan | Parent plan (if inheriting) |
product | Product | Associated product |
prices | [Price] | Plan pricing |
packageEntitlements | [PackageEntitlement] | Included entitlements |
compatibleAddons | [Addon] | Compatible addons |
Common Use Cases
Build pricing page
Build pricing page
Fetch all published plans to display on a pricing page.
Admin catalog management
Admin catalog management
List all plans including drafts for admin interfaces.
Plan comparison
Plan comparison
Query plans to build feature comparison tables.
Related Operations
- Get Plan - Get single plan by ID
- Paywall - Get formatted paywall data
- Create Plan - Create new plan
