Skip to main content
POST
Order-VPS.

Body

application/x-www-form-urlencoded
email
string

Your WHMCS email address.

Example:

"yourwhmc_email"

pw
string

Your WHMCS password.

Example:

"yourwhmcs_password"

order
string

JSON-encoded string that includes order details such as billing cycle, payment method, apply credit, and VPS item configurations. Each item specifies properties like product ID (pid), operating system (os), hostname, additional resources (RAM, vCPU, IP), and an optional SSH public key. The optional applycredit field belongs inside this JSON and accepts a JSON boolean: omit it or set it to true to apply available account credit automatically; explicitly set it to false to prevent credit from being applied to this order. This endpoint creates real orders; disabling account credit does not make the request a test.

Example:

"{\n \"billingcycle\": \"monthly\",\n \"paymentmethod\": \"paypal\",\n \"item\": [\n {\n \"pid\": 1814,\n \"os\": 92,\n \"hostname\": \"kvmtest\",\n \"additional_ram\": 467,\n \"additional_vcpu\": 467,\n \"additional_ip\": 467,\n \"additional_diskboost\": 615,\n \"ssh_pubkey\": \"ssh-rsa. ...\"\n },\n {\n \"pid\": 1814,\n \"os\": 88,\n \"hostname\": \"kvmtest2\",\n \"additional_ram\": \"\",\n \"additional_vcpu\": \"\",\n \"additional_ip\": \"\",\n \"additional_driveboost\": \"\",\n \"ssh_pubkey\": \"ssh-rsa. ...\"\n }\n ]\n}\n"

Response

Successfully added a new VPS order.

status
string
Example:

"success"

orderid
integer
Example:

123456

serviceids
string
Example:

"123456,123457"

invoiceid
integer
Example:

654321

invoicepaid
boolean

Indicates whether the invoice was paid successfully using available credit or another payment method. A value of false means the invoice remains unpaid; it does not by itself mean that order creation failed.

Example:

true

Last modified on January 20, 2025