...
Field Name | Description |
---|---|
Account Name | Enter the username you use to sign into Vultr |
API Key | Enter your API Key as provided by Vultr. |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
Creating a Package consists of several sections:
Basic
The Basic section consists of the following options:
Field Name | Description |
---|---|
Package Name | Enter the name of this Package, it will be visible wherever services are listed and on any order forms. |
Status | "Active" is the default, "Inactive", and "Restricted" are also available. |
Quantity Available | If this Package has a limited quantity available, enter the quantity, or leave it as "Unlimited". |
Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order forms. |
Configurable Options | A Configurable Option Group may be selected if previously created. |
Module | Select "Vultr" for the module. |
Module Options
The Module Options section consists of the following options, which are specific to Vultr:
Field Name | Description |
---|---|
Group | Groups are not supported by this module. |
Account | Select the Vultr account this package will use to provision accounts. It's possible to have multiple Vultr accounts through the module. |
Server Type | Select the server type you would like to provision. "Virtual Machine" and "Bare Metal" are supported. |
Server Plan | Select the size of the server you would like to use for this Package. |
Set Template | You can preselect an OS template for the package, or you can choose to let the client select the template during checkout. |
Surcharge Templates | Some templates may incur a surcharge. You can allow or disallow these type of OS templates. |
Pricing
Field Name | Description |
---|---|
Term | Enter the term for the desired pricing option. For example, if you wish to create a 3 month pricing option, enter 3 here. |
Period | Select the period for this pricing option. "Day", "Week", "Month", "Year", and "One time" are options. The client will be invoiced every "term period", for example every 3 months if 3 is entered for term, and Month is selected for period. |
Currency | Select the currency this pricing option is available for. |
Price | Enter the price for this pricing option. |
Setup Fee | If there is a setup fee, enter it here. |
Cancellation Fee | If there is a fee to cancel early, enter it here. |
Click the "Add Additional Price" to add more pricing options. It's common for people to create 1 Month, 3 Month, 6 Month, and 1 Year price options. There are many possible combinations.
Welcome Email
The "Tags" section describes tags that may be used in the welcome email. The welcome email content is inserted into the "Service Creation" email template under [Settings] > [Company] > [Emails] > Service Creation. Only details unique to this service should be entered into the welcome email section for the package.
Sample Email
This sample email could be used in the Package Welcome Email section to help you get started. Be sure to enter content for your welcome email in both the HTML and Text sections.
No Format |
---|
Thanks for choosing us for your VPS!
Your server {service.vultr_hostname} is now being spun up and you can manage it through our client area by clicking the "Manage" button next to the server on your Dashboard. The initial password can be found under the "Statistics" section. It may take a few minutes for the server to finish booting. |
When creating or editing a package that uses this module, the following tags will be available:
Tags | Description | Notes |
---|---|---|
{service.vultr_hostname} | The host name of the Vultr server. | e.g. "vultr.domain.com". |
{service.vultr_location} | The location of the Vultr server. | The Vultr server location. |
Expand | ||
---|---|---|
| ||
Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.
|
...
|
Configuring Vultr
...
Configurable Options Overview
...
Option Name | Possible Values | Recommended Field Type | Description |
---|---|---|---|
enable_backup | enable | Checkbox | Determines whether backups should be enabled for the instance. |
Creating Packages
Welcome Email
When creating or editing a package that uses this module, the following tags will be available:
...