Licensing

Convoy has three license tiers, namely Community which is the free plan, Business and Enterprise. This documentation will guide you on how to purchase a license, and configure the license key on your convoy instance(s). The pricing of all tiers can be found here.

​

Steps

Follow the instructions below to create a license key:

1

Create an account or login to Convoy Cloud Saas

Convoy cloud

2

Navigate to the Licenses Page using the sidebar

3

Create a new License

4

Retrieve license key from your email

5

Going back to Convoy

Supply your License key either by config file, cli flag or environment variable.

a

License key in config file

{
    "database": {
        ....
   },
    "redis": {
        ...
    },
    "license_key": "",
    "server": {
        .....
    }
}

b

License key in cli flag

$ convoy server --license-key="BE4334..."

c

License key in environment variable

$ CONVOY_LICENSE_KEY="B20329...." convoy server

​

Running the Instance

Once you’ve added the license key configuration, you’re ready to proceed. Simply start the instance as usual, and you will now have access to all the features included in your license tier.

​

Upgrades

Upgrading your license will not remove any features you currently have. In addition, you’ll gain access to the new features provided by your upgraded license.

​

Downgrades

When you downgrade your license, you’ll lose access to the paid features of your previous license. You’ll only have access to the features included in your current license. If you downgrade to the community plan and have more than two projects (the limit for the community plan), Convoy will freeze all projects except two, which will be randomly selected. The frozen projects will be restricted from actions that write new data, such as creating events, endpoints, or sources. You will be able to view your dashboard per usual.