{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Variables","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":"variables","__idx":0},"children":["Variables"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"variables-1","__idx":1},"children":["Variables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Smarty template language, template variables take the format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{$variable_name}"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"template-parameters","__idx":2},"children":["Template Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following template parameters are made available to all system themes and order form templates:"]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$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":["{$BASE_PATH_CSS}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The base URL to common CSS assets."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$BASE_PATH_FONTS}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The base URL to common font assets."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$BASE_PATH_IMG}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The base URL to common image assets."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$BASE_PATH_JS}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The base URL to common JavaScript assets."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$charset}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configured character set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$client}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The currently logged in client, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if a client is not logged in."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$companyname}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configured company name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$date_day}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current calendar day."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$date_month}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current calendar month."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$date_year}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current calendar year."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$filename}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The base name of the current file requested by the web browser."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$language}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the language to display to the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$loggedin}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," depending on whether a client is logged in."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$logo}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The path to the configured logo image."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$pagetitle}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current page's title."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$reCaptchaPublicKey}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configured reCAPTCHA site key. This can be an empty string if the WHMCS installation does not use Google reCAPTCHA."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$systemNonSSLURL}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configured non-SSL URL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$systemsslurl}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configured SSL URL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$systemurl}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL to the WHMCS system. This is either the SSL or non-SSL URL depending on whether the current page loaded via HTTPS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$template}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the system theme used for display."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$todaysdate}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current date, presented in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["l, jS F Y"]}," format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$token}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A CSRF token to use on POST forms."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{$WEB_ROOT}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your WHMCS system's base URL."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a complete listing of all variables available to you in a given template file, add the following line to your template file. Then, use a browser to access the page that calls the template. You will receive a popup list of all available template data."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{debug}\n"},"children":[]}]},"headings":[{"value":"Variables","id":"variables","depth":1},{"value":"Variables","id":"variables-1","depth":2},{"value":"Template Parameters","id":"template-parameters","depth":2}],"frontmatter":{"title":"Variables","seo":{"title":"Variables"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/themes/variables","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}