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’.
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.

Example JSON:

{
  "billingcycle": "monthly",
  "paymentmethod": "paypal",
  "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",
  "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
}

Body

application/x-www-form-urlencoded

string

Your WHMCS email address.

string

Your WHMCS password.

order

string

JSON-encoded string that includes order details such as billing cycle, payment method, 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.

Response

200

application/json

Successfully added a new VPS order.

status

string

orderid

integer

serviceids

string

invoiceid

integer

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",
  "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
}