MailChimp User Field User Guide

MailChimp User Field is a GDPR compliant newsletter user field plugin for VirtueMart 3. It allows site visitors to directly subscribe to your MailChimp list just by checking a checkbox during registration and also before order confirmation. They can also unsubscribe later just by unchecking the checkbox from their VirtueMart account page or while placing an order in future.


You can download the latest installation package from our site's download page for MailChimp User Field. If you have an older version of Joomla! or VirtueMart or PHP please check the system requirement section to find the version of MailChimp User Field compatible with your Joomla!, VirtueMart and PHP versions.

You can install the installation package of the plugin directly through Joomla Extension Installer. It can also be used to upgrade/update the plugin; just install it without uninstalling the previous release.


You can uninstall the plugin just like any other Joomla! extensions. In your site's back-end, just go to Extensions Manager, navigate to Uninstall menu, select MailChimp User Field and click on Uninstall. This will completely remove plugin including all database information.


Once the installation is completed, you need to first provide your MailChimp API credentials in the plugin settings. After the plugin is configured and enabled, you can go to VirtueMart's Shopper Fields section and create new field for MailChimp User Field.

Plugin Configuraton

MailChimp Field for VirtueMart

Go to ExtensionsPlugins and open the plugin called MailChimp User Field.

MailChimp API Key

Provide your MailChimp API key in this field. API stands for application programming interface. To learn more about MailChimp API Keys, visit -

MailChimp List ID

Provide your MailChimp List ID where you want to add the subscribing users. Find MailChimp your list id.

Show One Time in Cart

This option is particularly useful if you are using VP One Page Checkout plugin and enabled to show the field both in Account Maintenance Page and Cart Form. If this option is enabled, then the field will be displayed only one time in cart page.

Always Reset in Cart

If this option is enabled, then the field is always displayed as unchecked irrespective to the actual subscription state of the user.

Shopper Field Configuration

MailChimp Shopper Field for VirtueMart

Go to ComponentsVirtueMart and navigate to Shopper Fields section. Click on New button located at the top left corner. When the page opens, select Field Type as MailChimp User Field. Provide a Field Name and Field Title. Set Show in account maintenance option as Yes. if you want to display the field just before order confirmation button during checkout then also set Show in cart form option as Yes. Save the field.