{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Metadata 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":"metadata-parameters","__idx":0},"children":["Metadata Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[Registrar Modules][domain-registrars] support a number of metadata 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 the 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":["NonLinearRegistrationPricing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8.1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["false"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Indicates that there is a difference between the registration amount and renewal amount when importing TLDs. If you set this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", WHMCS will use a nonlinear equation to calculate the appropriate pricing."]}]}]}]}]}]},{"$$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        'NonLinearRegistrationPricing' => false,\n    );\n}\n"},"children":[]}]},"headings":[{"value":"Metadata Parameters","id":"metadata-parameters","depth":1},{"value":"Example MetaData Function","id":"example-metadata-function","depth":2}],"frontmatter":{"title":"Metadata Parameters","seo":{"title":"Metadata Parameters"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/domain-registrars/metadata-params","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}