Skip to main content
Creates a new subscription plan in draft status.

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

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