{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Started","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":"getting-started","__idx":0},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get started, you need to begin by choosing a name for your module."," ","The module name chosen must be unique and should be all lowercase."," ","The name must only contain letters & numbers whilst always starting with a letter."," ","Underscore is the only accepted special character."," ","For example, valid names would be:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["mymodulename"]}," OR ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["my_module_name"]}," OR ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["my_module"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have chosen your name, you need to create a directory and module file for it."," ","Addon modules are found in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/modules/addons/"]}," directory."," ","Each module can be found within it's own directory ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["/your_module_name/"]},"."," ","Then the core module file within it should be \"",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["your_module_name"]},".php\" to match the folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We make available a sample addon module on GitHub. We recommend using this as a starting point for a custom addon module."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["https://github.com/WHMCS/sample-addon-module"]}]}]},"headings":[{"value":"Getting Started","id":"getting-started","depth":1}],"frontmatter":{"title":"Getting Started","seo":{"title":"Getting Started"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/addon-modules/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}