Order-API

Order VPS

Place a new VPS order by authenticating with your WHMCS credentials and specifying the order details in JSON format.

JSON Parameters:

billingcycle: Specifies the billing cycle, e.g., ‘monthly’ or ‘yearly’.
paymentmethod: Specifies the payment method, e.g., ‘paypal’.
applycredit: Specifies whether to apply available account credit for the order. Accepts true or false.
item: An array of product configurations:
- pid: Product ID.
- os: Operating System ID.
- hostname: Hostname for the VPS.
- additional_ram: Additional RAM requested (optional).
- additional_vcpu: Additional vCPU requested (optional).
- additional_ip: Additional IPs requested (optional).
- additional_diskboost: Additional disk boost requested (optional).
- ssh_pubkey: Public SSH key for access.

Response Behavior:

If applycredit is set to true and there is sufficient credit in the account, the response will return:
```
{ "invoicepaid": true }
```
If there is insufficient credit or the request is incorrect, the response will return:
```
{ "invoicepaid": false }
```

Example JSON:

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

POST

kvm

add

order

curl --request POST \
  --url https://order.edisglobal.com/kvm/v2/add/order \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data email=yourwhmc_email \
  --data pw=yourwhmcs_password \
  --data 'order={
  "billingcycle": "monthly",
  "paymentmethod": "paypal",
  "applycredit": true,
  "item": [
    {
      "pid": 1814,
      "os": 92,
      "hostname": "kvmtest",
      "additional_ram": 467,
      "additional_vcpu": 467,
      "additional_ip": 467,
      "additional_diskboost": 615,
      "ssh_pubkey": "ssh-rsa. ..."
    },
    {
      "pid": 1814,
      "os": 88,
      "hostname": "kvmtest2",
      "additional_ram": "",
      "additional_vcpu": "",
      "additional_ip": "",
      "additional_driveboost": "",
      "ssh_pubkey": "ssh-rsa. ..."
    }
  ]
}
'

{
  "status": "success",
  "orderid": 123456,
  "serviceids": "123456,123457",
  "invoiceid": 654321,
  "invoicepaid": true
}

Body

application/x-www-form-urlencoded

string

Your WHMCS email address.

Example:

"yourwhmc_email"

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.

Example:

"{\n \"billingcycle\": \"monthly\",\n \"paymentmethod\": \"paypal\",\n \"applycredit\": true,\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

200

application/json

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.

Example:

true

Was this page helpful?

Explore our Order API Upgrade VPS

curl --request POST \
  --url https://order.edisglobal.com/kvm/v2/add/order \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data email=yourwhmc_email \
  --data pw=yourwhmcs_password \
  --data 'order={
  "billingcycle": "monthly",
  "paymentmethod": "paypal",
  "applycredit": true,
  "item": [
    {
      "pid": 1814,
      "os": 92,
      "hostname": "kvmtest",
      "additional_ram": 467,
      "additional_vcpu": 467,
      "additional_ip": 467,
      "additional_diskboost": 615,
      "ssh_pubkey": "ssh-rsa. ..."
    },
    {
      "pid": 1814,
      "os": 88,
      "hostname": "kvmtest2",
      "additional_ram": "",
      "additional_vcpu": "",
      "additional_ip": "",
      "additional_driveboost": "",
      "ssh_pubkey": "ssh-rsa. ..."
    }
  ]
}
'

{
  "status": "success",
  "orderid": 123456,
  "serviceids": "123456,123457",
  "invoiceid": 654321,
  "invoicepaid": true
}