{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Configuration Options","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"configuration-options","__idx":0},"children":["Configuration Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This function defines the settings that can be configured on a per product basis for your module."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The name of this function must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yourmodulename_ConfigOptions"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The supported configuration field types include the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Password"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Yes/No Checkboxes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dropdown Menus"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Radio Buttons"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Text Areas"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below are examples of the available parameters for each type of field. Provisioning modules support up to 24 options defined in this way."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"function yourmodulename_ConfigOptions() {\n    return [\n        \"username\" => [\n            \"FriendlyName\" => \"UserName\",\n            \"Type\" => \"text\", # Text Box\n            \"Size\" => \"25\", # Defines the Field Width\n            \"Description\" => \"Textbox\",\n            \"Default\" => \"Example\",\n        ],\n        \"password\" => [\n            \"FriendlyName\" => \"Password\",\n            \"Type\" => \"password\", # Password Field\n            \"Size\" => \"25\", # Defines the Field Width\n            \"Description\" => \"Password\",\n            \"Default\" => \"Example\",\n        ],\n        \"usessl\" => [\n            \"FriendlyName\" => \"Enable SSL\",\n            \"Type\" => \"yesno\", # Yes/No Checkbox\n            \"Description\" => \"Tick to use secure connections\",\n        ],\n        \"package\" => [\n            \"FriendlyName\" => \"Package Name\",\n            \"Type\" => \"dropdown\", # Dropdown Choice of Options\n            \"Options\" => \"Starter,Advanced,Ultimate\",\n            \"Description\" => \"Sample Dropdown\",\n            \"Default\" => \"Advanced\",\n        ],\n        \"packageWithNVP\" => [\n            \"FriendlyName\" => \"Package Name v2\",\n            \"Type\" => \"dropdown\", # Dropdown Choice of Options\n            \"Options\" => [\n                'package1' => 'Starter',\n                'package2' => 'Advanced',\n                'package3' => 'Ultimate',\n            ],\n            \"Description\" => \"Sample Dropdown\",\n            \"Default\" => \"package2\",\n        ],\n        \"disk\" => [\n            \"FriendlyName\" => \"Disk Space\",\n            \"Type\" => \"radio\", # Radio Selection of Options\n            \"Options\" => \"100MB,200MB,300MB\",\n            \"Description\" => \"Radio Options Demo\",\n            \"Default\" => \"200MB\",\n        ],\n        \"comments\" => [\n            \"FriendlyName\" => \"Notes\",\n            \"Type\" => \"textarea\", # Textarea\n            \"Rows\" => \"3\", # Number of Rows\n            \"Cols\" => \"50\", # Number of Columns\n            \"Description\" => \"Description goes here\",\n            \"Default\" => \"Enter notes here\",\n        ],\n    ];\n}\n"},"children":[]}]},"headings":[{"value":"Configuration Options","id":"configuration-options","depth":1}],"frontmatter":{"title":"Configuration Options","seo":{"title":"Configuration Options"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/provisioning-modules/config-options","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}