ResellerUnion
Reseller API

Overview #

All endpoints are REST calls with JSON responses. A successful response always has "success": true and the payload in the "data" object; an error has "success": false and an "error" message.

https://api.resellerunion.com/v1/

Authentication #

Every request is authenticated with two headers that always go together as a pair:

copyGET https://api.resellerunion.com/v1/price_list.php
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

Errors and limits #

// Error example
{
  "success": false,
  "error":   "Field \"package_uuid\" is required."
}

Sandbox #

A test environment for developing your integration. Same paths and same response format as production, but without any real data and without consequences.

Credentials

They are public and the same for everyone — you do not need an account:

copyX-API-UUID: 00000000-0000-4000-8000-000000000001
X-API-KEY:  sandbox_kljuc_za_testiranje_1234567

How it behaves

Example

copyPOST https://sandbox.resellerunion.com/v1/order_license.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   00000000-0000-4000-8000-000000000001
X-API-KEY:    sandbox_kljuc_za_testiranje_1234567

{
  "package_uuid": "aaaaaaaa-0000-4000-8000-000000000001",
  "cycle": "monthly",
  "ip": "203.0.113.50"
}

// Response
{
  "success": true,
  "sandbox": true,
  "sandbox_napomena": "Test environment (sandbox). The data is fictitious…",
  "data": {
    "sandbox_upozorenje": "SANDBOX: the order was simulated and NOT executed…",
    "proforma_invoice": { "number": "SB-2026-04128", "total": "61.51" },
    "order":  { "order_number": "RSL-4820193756", "status": 1 },
    "license":   { "name": "cPanel Admin Cloud", "ip": "203.0.113.50", "status": 1 }
  }
}

Available endpoints

Domain price list #

Example request

copyGET https://api.resellerunion.com/v1/price_list.php
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

Response

{
  "success": true,
  "data": {
    "level": 2,
    "currency": "EUR",
    "decimal_separator": ".",
    "total_count": 42,
    "domains": [
      {
        "extension": ".com",
        "featured": true,
        "registration_price": "12.90",
        "renewal_price": "14.90",
        "registration_periods": {
          "1": "12.90",
          "2": "25.80",
          "3": "38.70",
          "4": "51.60",
          "5": "64.50"
        },
        "custom_fields": []
      },
      {
        "extension": ".us",
        "featured": false,
        "registration_price": "9.90",
        "renewal_price": "9.90",
        "registration_periods": {
          "1": "9.90",
          "2": "19.00",
          "5": "45.00"
        },
        "custom_fields": [
          {
            "slot": 1,
            "required": true,
            "type": "dropdown",
            "name": "Nexus category",
            "description": "The registrant's connection to the United States, as required by the .us registry.",
            "options": ["C11", "C12", "C21", "C31", "C32"],
            "validation": "^(C11|C12|C21|C31|C32)$"
          },
          {
            "slot": 2,
            "required": true,
            "type": "dropdown",
            "name": "Application purpose",
            "description": "The intended use of the domain, as required by the .us registry.",
            "options": ["P1", "P2", "P3", "P4", "P5"],
            "validation": "^(P1|P2|P3|P4|P5)$"
          }
        ]
      }
    ]
  }
}

Hosting offer #

Example request

copyGET https://api.resellerunion.com/v1/hosting_offer.php
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

Response (abbreviated)

{
  "success": true,
  "data": {
    "level": 2,
    "currency": "EUR",
    "total_count": 6,
    "packages": [
      {
        "uuid": "3f2a1b6c-9d4e-4f70-8a21-5e6d7c8b9a01",
        "name": "Business",
        "disk_space": "10 GB",
        "bandwidth": "Unlimited",
        "requires_domain": true,
        "prices": {
          "monthly": "9.90",
          "annually": "99.00"
        }
      }
    ]
  }
}

Check domain availability #

GET parameters

Example request

copyGET https://api.resellerunion.com/v1/whois.php?domain=example.com

Response

{
  "success": true,
  "data": {
    "domain":    "example.com",
    "extension": ".com",
    "available": true
  }
}

Text format (WHMCS whois.json)

With the format=text parameter the endpoint returns plain text — intended for the WHMCS whois.json "https://" lookup. The response is always HTTP 200 (WHMCS compares the body, not the HTTP code):

STATUS: AVAILABLE
STATUS: REGISTERED
STATUS: ERROR: <message>

Example whois.json entry. The same entry works for any extension in the offer, including extensions that have no public port-43 whois server — list the extensions you need:

copy{
  "extensions": ".com,.net",
  "uri":        "https://api.resellerunion.com/v1/whois.php?format=text&domain=",
  "available":  "STATUS: AVAILABLE"
}

Register domain #

POST JSON fields

Example request

copyPOST https://api.resellerunion.com/v1/order_domain.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "domain": "example.us",
  "period": 1,
  "registrant": {
    "is_company": 0,
    "first_name": "John",
    "last_name": "Smith",
    "address": "123 Main Street",
    "city": "Springfield",
    "postal_code": "62701",
    "country": "US",
    "email": "john@example.com",
    "phone": "+12025550142"
  },
  "nameservers": ["ns1.example.com", "ns2.example.com"],
  "custom_fields": {
    "1": "C11",
    "2": "P3"
  }
}

Response

The response is nested: data contains four objects — order, domain, proforma_invoice and currency. The order UUID is data.order.uuid and the domain UUID is data.domain.uuid — not data.uuid.

{
  "success": true,
  "data": {
    "order": {
      "uuid": "945bda1a-2a36-4f7e-acfd-4c3cfd158a99",
      "order_number": "RSL-3430439926",
      "status": 1
    },
    "domain": {
      "uuid": "4dd69549-68df-4cf7-9bd5-dc73b38acc8d",
      "domain": "example.us",
      "extension": ".us",
      "registration_period": 1,
      "level": 2,
      "price": "58.67",
      "status": 1,
      "nameservers": ["ns1.example.com", "ns2.example.com"],
      "custom_fields": {
        "1": "C11",
        "2": "P3"
      }
    },
    "proforma_invoice": {
      "proforma_number": "1564",
      "subtotal": "50.15",
      "vat_amount": "8.52",
      "total": "58.67",
      "currency": "€",
      "status": "unpaid"
    },
    "currency": {
      "code": "EUR",
      "prefix": "",
      "suffix": "€",
      "position": "after",
      "space": 1,
      "rate": "1.000000"
    },
    "decimal_separator": "."
  }
}

Transfer domain #

POST JSON fields

Flow

After payment the transfer is started at the registry and the domain gets status 2 (transfer pending). When the current registrar confirms the transfer, the domain moves to status 3 (active).

Renew domain #

copyPOST https://api.resellerunion.com/v1/renew_domain.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "uuid": "9c1f4a2e-7b3d-4e58-a690-1f2e3d4c5b6a"
}

Response

{
  "success": true,
  "data": {
    "proforma_invoice": { "proforma_number": "1043", "total": "23.00", "currency": "€", "status": "unpaid" },
    "domain": {
      "uuid": "9c1f4a2e-…", "domain": "example.com", "period_years": 1,
      "post_expiry_period": "regular", "renewal_price": "23.00",
      "grace_fee": "0.00", "redemption_fee": "0.00",
      "expires_at": "2026-10-02", "new_expires_at": "2027-10-02"
    },
    "auto_renewal": { "enabled": true, "message": "…" }
  }
}

post_expiry_period: regular, grace or redemption. In the grace and redemption periods the fee is a separate proforma item. A deleted domain (status 10), a suspended one and a pending one cannot be renewed (409). If an unpaid renewal proforma invoice already exists for the domain, the response is 409 with its number.

EPP code #

copy{
  "uuid": "9c1f4a2e-7b3d-4e58-a690-1f2e3d4c5b6a"
}

Domain nameservers #

POST JSON fields

copy{
  "uuid": "9c1f4a2e-7b3d-4e58-a690-1f2e3d4c5b6a",
  "nameservers": ["ns1.example.com", "ns2.example.com"]
}

Domain contacts #

copy{
  "uuid": "9c1f4a2e-7b3d-4e58-a690-1f2e3d4c5b6a",
  "registrant": { ... contact fields, without name and company ... },
  "admin": { ... contact fields ... },
  "tech":  { ... contact fields ... }
}

Contact fields

name, email_address, address1, city, state_province, postal_code, country (ISO-2), phone (format +387.61123456). For admin and tech name and email_address are required; for the registrant name is ignored.

Change of domain owner (registrant) #

Available only for extensions that support an owner change and have a change price for your level; for the others the response is 409.

GET ?uuid=<domain uuid>

Returns the current registrant (from the registry), the change price (change_price) and billable_change: company or full_name — the field that has to change. If a request is already waiting for payment, it returns pending_request: true and that request's data.

POST JSON fields

POST creates the request and a proforma invoice. After payment the change is applied at the registry automatically. An unpaid request is cancelled with {"uuid": "…", "action": "cancel"}.

Order hosting #

POST JSON fields

Example request

copyPOST https://api.resellerunion.com/v1/order_hosting.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "package_uuid": "3f2a1b6c-9d4e-4f70-8a21-5e6d7c8b9a01",
  "cycle": "annually",
  "domain": "example.com"
}

Response

The response is nested: data contains order, service, proforma_invoice, auto_activation and currency. The service UUID is data.service.uuid.

{
  "success": true,
  "data": {
    "order": {
      "uuid": "e7a0565d-a746-456e-8938-68412977e573",
      "order_number": "RSL-3036365111",
      "status": 1
    },
    "service": {
      "uuid": "c3c3b3f0-db2f-42cc-a195-99e6a97aedb8",
      "package": "START HOSTING",
      "cycle": "annually",
      "cycle_months": 12,
      "domain": "example.com",
      "level": 1,
      "price": "54.40",
      "status": 1,
      "dedicated_ip": false,
      "package_price": "54.40",
      "dedicated_ip_price": null
    },
    "proforma_invoice": {
      "proforma_number": "1564",
      "subtotal": "46.50",
      "vat_amount": "7.90",
      "total": "54.40",
      "currency": "€",
      "status": "unpaid"
    },
    "auto_activation": {
      "enabled": true,
      "message": "Automatic activation: the available credit covers the proforma invoice amount."
    },
    "currency": {
      "prefix": "",
      "suffix": "€",
      "position": "after",
      "space": 1
    },
    "decimal_separator": "."
  }
}

My hosting services #

License offer #

Example request

copyGET https://api.resellerunion.com/v1/license_offer.php
X-API-UUID: 550e8400-e29b-41d4-a716-446655440000
X-API-KEY:  your_api_key

Response (abbreviated)

{
  "success": true,
  "data": {
    "level": 2,
    "currency": { "code": "EUR", "suffix": "€", "position": "after", "space": 1 },
    "decimal_separator": ".",
    "categories": [ { "name": "cPanel/WHM" }, { "name": "CloudLinux" } ],
    "total_count": 24,
    "licenses": [
      {
        "uuid":         "3f2a1b6c-9d4e-4f70-8a21-5e6d7c8b9a01",
        "name":        "cPanel Admin Cloud",
        "category":   "cPanel/WHM",
        "host_type":    "virtual",
        "max_accounts": 5,
        "term_months": 1,
        "featured":    true,
        "prices":       { "monthly": "61.51" }
      }
    ]
  }
}

Order license #

POST JSON fields

Example request

copyPOST https://api.resellerunion.com/v1/order_license.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "package_uuid": "3f2a1b6c-9d4e-4f70-8a21-5e6d7c8b9a01",
  "cycle": "monthly",
  "ip": "203.0.113.50"
}

Response

{
  "success": true,
  "data": {
    "proforma_invoice": { "number": "P-2026-00412", "total": "61.51", "currency": "€", "status": "unpaid" },
    "order":  { "uuid": "…", "order_number": "RSL-0000100042", "status": 1 },
    "license":   { "uuid": "…", "name": "cPanel Admin Cloud", "ip": "203.0.113.50", "status": 1 }
  }
}

The license stays in the Pending status until the proforma invoice is paid. After payment it is activated and receives a licenseid — track its state through my_licenses.php.

My licenses #

Renew hosting service #

POST JSON fields

The price is not sent — the system determines it according to your price level and the cycle the service has.

Example request

copyPOST https://api.resellerunion.com/v1/renew_hosting.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "uuid": "7c1e9a2b-4d38-4f61-9b02-1a5c8e7d3f40"
}

Response

{
  "success": true,
  "data": {
    "proforma_invoice": { "proforma_number": "P-2026-00518", "total": "19.56", "currency": "€", "status": "unpaid" },
    "service": {
      "uuid": "7c1e9a2b-…", "package": "BUSINESS HOSTING", "domain": "example.com",
      "cycle_months": 1, "expires_at": "2026-08-20", "new_period_until": "2026-09-19"
    },
    "auto_activation": { "enabled": true, "message": "Automatic renewal: the available credit…" }
  }
}

When renewal is possible

Change hosting package #

A service with a dedicated IP keeps the IP; the new package must offer an IP for your level and cycle. If the server rejects the new package (e.g. more disk used than the new package allows), the service stays on the old package.

Manage hosting service #

A suspended service is not renewed automatically — that is how a WHMCS suspension stops the renewal (see Renewals).

Renew license #

POST JSON fields

Example request

copyPOST https://api.resellerunion.com/v1/renew_license.php
Content-Type: application/json; charset=utf-8
X-API-UUID:   550e8400-e29b-41d4-a716-446655440000
X-API-KEY:    your_api_key

{
  "uuid": "9a4f2c81-6b30-4e75-8d19-3f7b2e5a1c68"
}

The response has the same shape as for hosting, with a license block instead of service. The same rules apply to the states in which renewal is not possible, as well as to an existing unpaid proforma invoice.

Terminate license #

Renewals, deadlines and expiry #

Your account has two separate settings (reseller panel, Settings; API: settings.php):

If there is not enough credit, the proforma invoice stays unpaid and waits for a payment or a credit top-up — nothing is ever charged partially.

Automatic renewal OFF

For domains, hosting, licenses and dedicated servers the renewal proforma invoice is issued in advance, before expiry (the number of days depends on the billing cycle) and emailed to you. The service is renewed as soon as it is paid. You can also start a renewal yourself at any time with the renew endpoints.

Automatic renewal ON

You can always renew manually with renew_hosting.php, renew_dedicated.php or renew_license.php, or from the WHMCS module.

New period after renewal

Domain: old expiry date + number of years. Hosting, licenses and servers: old expiry date + billing cycle, without a gap — paying a few days after expiry does not shift the date. If the service stayed expired for longer than a whole cycle, the new period starts on the payment date.

What happens to a service that is not renewed

My domains #

Dedicated server offer #

Response

The response has two parts: packages (servers) and options (additional options chosen when ordering).

{
  "success": true,
  "data": {
    "level": 2,
    "currency": { "code": "EUR", "suffix": "€", "position": "after" },
    "decimal_separator": ".",
    "total_count": 11,
    "packages": [
      {
        "uuid": "3f1c8a20-68df-4cf7-9bd5-dc73b38acc8d",
        "name": "2 x 18 Core Xeon Gold 6254",
        "subtitle": "DELL PowerEdge R640",
        "featured": false,
        "sold_out": false,
        "specification": {
          "model": "DELL PowerEdge R640",
          "cpu": "Xeon Gold 6254",
          "cpu_count": 2,
          "cores": 36,
          "cpu_speed": "32 x 3.10 GHz",
          "hyperthreading": true,
          "ram_included": "64 GB",
          "ram_type": "DDR 4",
          "disks_included": [
            { "name": "960 GB SSD Enterprise", "count": 2 }
          ],
          "drive_bays": 8,
          "included_ip_addresses": 1
        },
        "available_options": {
          "ram":  ["ram-1", "ram-2", "ram-3"],
          "raid": ["raid-1", "raid-2"],
          "disk_slots": [
            ["disk-6", "disk-7"],
            ["disk-6", "disk-7"]
          ]
        },
        "prices": { "monthly": "799.20" }
      }
    ],
    "options": {
      "ram": [
        {
          "code": "ram-2",
          "name": "Upgrade to 128 GB",
          "free": false,
          "prices": { "monthly": "96.00" }
        }
      ],
      "disks": [ ... ],
      "internet": [ ... ],
      "management": [ ... ],
      "cpanel": [ ... ],
      "raid": [ ... ],
      "ip": [ ... ],
      "operating_systems": [ ... ]
    }
  }
}

Dedicated server order #

Request

{
  "package_uuid": "dddddddd-0000-4000-8000-000000000002",
  "cycle": "monthly",
  "hostname": "srv1.example.com",
  "options": ["ram-2", "raid-2", "cp-1", "os-1"],
  "disks": ["disk-7", "disk-6"],
  "extra_ip": 4
}

Response

{
  "success": true,
  "data": {
    "order": {
      "uuid": "7c2f9a10-4e88-4a31-b0d2-1f5e77c3a904",
      "order_number": "RSL-4839947402",
      "status": 1
    },
    "server": {
      "uuid": "b41d7e60-9c2a-4f18-8ad5-3e90b21c7f56",
      "name": "2 x 18 Core Xeon Gold 6254",
      "model": "DELL PowerEdge R640",
      "hostname": "srv1.example.com",
      "cycle": "monthly",
      "cycle_months": 1,
      "level": 2,
      "price": "1044.06",
      "package_price": "849.15",
      "options_price": "194.91",
      "selected_options": ["Upgrade to 128 GB", "RAID 10"],
      "ordered_ip_addresses": 4,
      "status": 1
    },
    "proforma_invoice": {
      "number": "1587",
      "subtotal": "892.36",
      "vat_amount": "151.70",
      "total": "1044.06",
      "currency": "€",
      "status": "unpaid"
    },
    "currency": { "prefix": "", "suffix": "€", "position": "after" },
    "decimal_separator": "."
  }
}

My dedicated servers #

Renew dedicated server #

Renewal is possible for an active server and for a server expired within hosting_grace. A suspended, terminated or cancelled server returns 409, as does an existing unpaid renewal proforma invoice. The response has the same shape as renew_hosting.php (with hostname instead of package and domain).

Manage dedicated server #

On a suspended server only unsuspend and terminate are allowed. The response returns service.status and the network state (network: on / off).

My documents #

My profile #

Credit #

Settings #

Registrant details #

The registrant object sent at domain registration and transfer:

Billing cycles #

The cycle field in a hosting order accepts one of the following values (string):