Create Plan

Creates a new subscription plan in draft status.

Mutation

Mutation

mutation CreatePlan($input: PlanCreateInput!) {
  createOnePlan(input: $input) {
    id
    refId
    displayName
    description
    status
    pricingType
    versionNumber
  }
}

{
  "input": {
    "refId": "plan-pro",
    "displayName": "Pro Plan",
    "description": "For growing teams",
    "productId": "product-main",
    "pricingType": "PAID"
  }
}

{
  "data": {
    "createOnePlan": {
      "id": "plan-uuid-123",
      "refId": "plan-pro",
      "displayName": "Pro Plan",
      "description": "For growing teams",
      "status": "DRAFT",
      "pricingType": "PAID",
      "versionNumber": 1
    }
  }
}

Parameters

input · PlanCreateInput · required

Input for creating a plan

Show properties

productId · String · required

Product reference ID

displayName · String · required

Plan display name

refId · String

Unique plan reference ID (auto-generated if not provided)

description · String

Plan description

pricingType · PricingType

FREE, PAID, or CUSTOM

billingId · String

Billing provider product/price ID

parentPlanId · String

Parent plan ID for inheritance

hiddenFromWidgets · [WidgetType]

Widgets to hide this plan from

additionalMetaData · JSON

Custom metadata

environmentId · UUID

Environment ID

Return Type

Returns the created Plan object in DRAFT status.

Next Steps

After creating a plan:

1. Add entitlements with createPackageEntitlements
2. Set pricing with setPackagePricing
3. Configure compatible addons with setCompatibleAddonsOnPlan
4. Publish with publishPlan

Related Operations

• Set Package Pricing - Add pricing
• Publish Plan - Publish draft
• List Plans - Query plans