{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Meta Data Parameters","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":"meta-data-parameters","__idx":0},"children":["Meta Data Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/provisioning-modules","title":"Provisioning Modules"},"children":["Provisioning Modules"]}," support a number of meta data configuration parameters."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["They include:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Supported As Of"},"children":["Supported As Of"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DisplayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module Name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["An alternate display name that will be used instead of the filename if defined"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["APIVersion"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5.2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Defines API Version the module uses. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.1"]}," unless you have a need specific to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.0"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RequiresServer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Defines whether the module requires servers to function. A lot of modules these days don't require servers be configured so setting this to false prevents users from creating servers assigned to it."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DefaultNonSSLPort"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["If specified, will display by default when configuring a server with the module when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Use SSL"]}," is disabled and will allow a user to override it should they wish.  Use this if your API can operate on varying port numbers."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DefaultSSLPort"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["If specified, will display by default when configuring a server with the module when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Use SSL"]}," is enabled and will allow a user to override it should they wish.  Use this if your API can operate on varying port numbers."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ServiceSingleSignOnLabel"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["For use with Single Sign-On, define here what you want to show as the text label for the Single Sign-On option for an instance of a service under a client."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AdminSingleSignOnLabel"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["For use with Single Sign-On, define here what you want to show as the text label for the Single Sign-On option for a server assigned to the module within the admin area."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ListAccountsProductField"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.10"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["For use with Server Sync, define the config option indexed field, from the _ConfigOptions function, that identifies the product on the remote system."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ListAccountsUniqueIdentifierDisplayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.10"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Domain"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["For use with Server Sync, define the display name of the unique identifier to be displayed on the table output."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ListAccountsUniqueIdentifierField"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.10"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["For use with Server Sync and Usage Metrics, define the field in the return that matches the unique identifier. The following values are supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domain"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customfield.yourFieldName"]},". If using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customfield.yourFieldName"]}," value, replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yourFieldName"]}," with the name of the custom field to be used."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These parameters are defined by a function which is responsible for returning an associative array containing the defined meta data configuration parameters and their values."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example illustrates how one might make a simple MetaData function."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-metadata-function","__idx":1},"children":["Example MetaData Function ",{"$$mdtype":"Tag","name":"a","attributes":{"id":"example-function"},"children":[]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"function mymodule_MetaData() {\n    return array(\n        'DisplayName' => 'myModule',\n        'APIVersion' => '1.1',\n        'DefaultNonSSLPort' => '1234',\n        'DefaultSSLPort' => '4321',\n        'ServiceSingleSignOnLabel' => 'Login to myModule Client',\n        'AdminSingleSignOnLabel' => 'Login to myModule Admin',\n        'ListAccountsUniqueIdentifierDisplayName' => 'Domain',\n        'ListAccountsUniqueIdentifierField' => 'domain',\n        'ListAccountsProductField' => 'configoption1',\n    );\n}\n"},"children":[]}]},"headings":[{"value":"Meta Data Parameters","id":"meta-data-parameters","depth":1},{"value":"Example MetaData Function","id":"example-metadata-function","depth":2}],"frontmatter":{"title":"Meta Data Parameters","seo":{"title":"Meta Data Parameters"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/provisioning-modules/meta-data-params","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}