options.html

The options.html page is shown to the customer when adding a package that requires customisation, such as when you are using variables.

Root Object

Variables
Type
Description

options.package

An object containing information about the current package.

options.variables

array[Variable]

An array containing the variables the customer needs to select.

Package Object

Variable
Type
Description

name

string

The name of the package.

chooseServer

boolean

If the package requires the customer to select a game server.

customPrice

boolean

If the package requires the customer to enter how much they want to pay for the package.

category

string

The category ID of the package.

price

string

The price of the package.

Variable Object

Variable
Type
Description

description

string

A summary of the description of the variable.

type

string

Either dropdown, discord_id, or show an input field for freehand input by the customer.

id

string

The ID of the variable.

options

If the type is dropdown, we include an array of options the customer should select from.

value

string

The current value of the variable.

discord_tag

string

If the variable is type is discord_id and the value is not empty, this will include their discord tag once they have logged in.

Variable Option Object

Variable
Type
Description

default

boolean

If this variable option should be selected by default.

name

string

The name of the dropdown option.

price

string

The additional price the customer would pay by selecting this variable option.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

Last updated