Upgrade Service

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_plan": "standard-vps"
}
'

import requests

url = "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade"

payload = { "new_plan": "standard-vps" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_plan: 'standard-vps'})
};

fetch('https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'new_plan' => 'standard-vps'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade"

	payload := strings.NewReader("{\n  \"new_plan\": \"standard-vps\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_plan\": \"standard-vps\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"new_plan\": \"standard-vps\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "request_id": "REQ-002386",
    "type": "upgrade",
    "request_status": "accepted",
    "service_number": 971100001,
    "current_plan": "Basic VPS",
    "requested_plan": "Standard VPS",
    "submitted_date": "2026-06-21T15:00:00.000Z"
  }
}

POST

services

{service_number}

upgrade

Upgrade Service

curl --request POST \
  --url https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_plan": "standard-vps"
}
'

import requests

url = "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade"

payload = { "new_plan": "standard-vps" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({new_plan: 'standard-vps'})
};

fetch('https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'new_plan' => 'standard-vps'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade"

	payload := strings.NewReader("{\n  \"new_plan\": \"standard-vps\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_plan\": \"standard-vps\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brokers.newyorkcityservers.com/api/v1/services/{service_number}/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"new_plan\": \"standard-vps\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "request_id": "REQ-002386",
    "type": "upgrade",
    "request_status": "accepted",
    "service_number": 971100001,
    "current_plan": "Basic VPS",
    "requested_plan": "Standard VPS",
    "submitted_date": "2026-06-21T15:00:00.000Z"
  }
}

Submit an upgrade from the current service plan to a higher plan. The API creates or reuses an upgrade request and starts background processing.

A successful response means that the API accepted the request. It does not mean that the plan change is complete.

Allowed Plan Changes

An upgrade must move from a lower plan to a higher plan in this order:

Basic VPS
Standard VPS
Professional VPS
Dedicated Server

The requested plan must be above the current plan.

Current plan	Valid upgrade plans
`Basic VPS`	`Standard VPS`, `Professional VPS`, `Dedicated Server`
`Standard VPS`	`Professional VPS`, `Dedicated Server`
`Professional VPS`	`Dedicated Server`
`Dedicated Server`	None

Use the downgrade endpoint for a move to a lower plan.

Accepted Response

The normal response is HTTP 200. The plan change runs in background processing. The response does not contain an action ID, a processed date, or a completion result. Use the request ID with the list requests endpoint to check the request state.

Upgrade Processing

A reboot of the client’s service is required for finalizing the upgrade. Therefore, once an upgrade request is submitted the client will receive an email containing the next required steps to complete the upgrade process. The upgrade to the client’s service is not applied until they perform the required steps.

Errors

HTTP status	Error code	Cause
`400`	`invalid_parameter`	The service number is invalid, or the plan is not supported.
`400`	`invalid_request`	The request body is not valid JSON.
`400`	`missing_parameter`	`new_plan` is missing, is blank, or is not a string.
`400`	`invalid_state`	The target is the current plan, the target is lower, the current plan is not recognized, or the service is cancelled or terminated.
`400`	`service_pending_provisioning`	The service is still pending provisioning.
`401`	`authentication_failed`	The Bearer token is missing, invalid, inactive, or expired.
`403`	`insufficient_permissions`	The caller IP is not allowed or the key does not have `admin:full`.
`404`	`not_found`	The service does not exist for this broker account.
`429`	`rate_limit_exceeded`	The API key reached its rate limit. Check the `Retry-After` header.
`500`	`server_error`	The API could not create the request, queue the action, or complete internal processing.

Authorizations

Authorization

string

header

required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Path Parameters

service_number

integer<int64>

required

Public service number parsed as a base-10 integer.

Body

application/json

new_plan

string

required

Target plan slug or label, accepted case-insensitively. Valid slugs are basic-vps, standard-vps, professional-vps, and dedicated-server.

Response

Upgrade accepted for processing.

success

boolean

required

data

object

required

Show child attributes

message

string

pagination

object

Show child attributes

Last modified on August 2, 2026

Getting Started

Services

Requests

Reports

Upgrade Service

Allowed Plan Changes

Accepted Response

Upgrade Processing

Errors

Authorizations

Path Parameters

Body

Response

​Allowed Plan Changes

​Accepted Response

​Upgrade Processing

​Errors

Authorizations

Path Parameters

Body

Response

Allowed Plan Changes

Accepted Response

Upgrade Processing

Errors