Partner API

The Partner API allows UpCloud partners to create and manage customer accounts. This API is only available to accounts provisioned as partner accounts.

GET/1.3/partner/accounts

List accounts

Returns a list of all accounts associated with the partner.

Request

GET

/1.3/partner/accounts

curl -X GET https://api.upcloud.com/1.3/partner/accounts \
  -u your_username:your_password

POST/1.3/partner/accounts

Create account

Creates a new UpCloud account linked to the partner's invoicing.

Attributes

Name
username
Type
string
Description
Account username (4-64 characters, lowercase alphanumeric with underscores). Required.
Name
password
Type
string
Description
Account password (8-256 characters, must include lowercase, uppercase, and digit). Required.
Name
contact_details
Type
object
Description
Contact details object. If omitted, copied from partner account.

Contact details attributes

Name
first_name
Type
string
Description
First name (1-50 characters). Required if contact_details provided.
Name
last_name
Type
string
Description
Last name (1-50 characters). Required if contact_details provided.
Name
email
Type
string
Description
Valid email address. Required if contact_details provided.
Name
phone
Type
string
Description
Phone in international format (+countrycode.nationalpart). Required if contact_details provided.
Name
country
Type
string
Description
ISO 3166-1 alpha-3 country code. Required if contact_details provided.
Name
company
Type
string
Description
Company name (1-100 characters).
Name
address
Type
string
Description
Street address (1-2 lines, 1-100 characters each).
Name
postal_code
Type
string
Description
Postal/zip code (1-20 characters).
Name
city
Type
string
Description
City (1-100 characters).
Name
state
Type
string
Description
State (required if country is USA).
Name
vat_number
Type
string
Description
Valid VAT number.

Request

POST

/1.3/partner/accounts

curl -X POST https://api.upcloud.com/1.3/partner/accounts \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "username": "newuser",
    "password": "superSecret123",
    "contact_details": {
      "country": "FIN",
      "email": "new@example.com",
      "first_name": "New",
      "last_name": "User",
      "phone": "+358.91111111"
    }
  }'

GET/1.3/account/billing/summary/{month}

Access billing summary

Partners can access the billing summary of associated accounts by adding the username query parameter to the billing summary endpoint.

Query parameters

Name
username
Type
string
Description
Username of the associated account to retrieve billing for. Required.

Request

GET

/1.3/account/billing/summary/{month}

curl -X GET "https://api.upcloud.com/1.3/account/billing/summary/2025-05?username=someuser" \
  -u your_username:your_password