planCreate

Graphql fields and variables for the planCreate mutation

Create a plan

Scope required: product:write

For a complete list of input attributes see the PlanAttributes type

mutation planCreate ($attributes: PlanAttributes!) {
  planCreate (attributes: $attributes) {
      errors
      plan {
        addon
        availableFrom
        availableTo
        basePrice
        code
        contactUsLabel
        contactUsUrl
        createdAt
        description
        id
        internalNotes
        isAvailableNow
        isVisible
        name
        position
        pricingDescription
        productId
        productPlanName
        selfServiceBuy
        selfServiceCancel
        selfServiceRenew
        updatedAt
      }
      planFeatures
  }
}

Arguments

{
  "attributes": {
    "productId": "456123",
    "name": "",
    "code": "",
    "position": 123,
    "addon": true,
    "selfServiceBuy": true,
    "selfServiceCancel": true,
    "selfServiceRenew": true,
    "description": "",
    "internalNotes": "",
    "availableFrom": "2022-06-01",
    "availableTo": "2022-06-01",
    "isVisible": true,
    "featureIds": [
      "456123"
    ],
    "pricingDescription": "",
    "pricingStyle": "PlanPricingStyles",
    "contactUsLabel": "",
    "contactUsUrl": ""
  }
}

Name	Type	Description
attributes	PlanAttributes

Response

Name	Type	Description
errors	List (String)
plan	Plan
planFeatures	List (PlanFeature)