BuyServiceMicrosoft365Request

service_idintegerrequired

ID of the Service to buy

Possible values: >= 1

quantityinteger

Number of seats (user licenses) to purchase. It must be between quantity_min and quantity_max of the chosen service, as listed by GET /api/v3/shop/microsoft-365/services. If omitted, quantity_min is used. Ignored for the services without quantity_max.

Possible values: >= 1

account_idinteger

ID of the account of the user that will be the owner of the purchase (available to Resellers only)

data objectrequired

Microsoft 365 tenant of the subscription. All the data is checked before the order is created: with "select" the tenant must be one of the account (409 if it already has 2 active subscriptions of the same service); with "transfer" and "new" no tenant can have the domain prefix already, and at Microsoft the ".onmicrosoft.com" domain must exist ("transfer") or be available ("new"), otherwise 409. Send only the fields of the chosen option.

tenant_choicestringrequired

Select whether to choose an existing tenant ("select"), transfer one ("transfer") or create a new tenant ("new"). When transferring a tenant, approve the Microsoft Partner Relationship before sending API requests

Possible values: [select, transfer, new]

tenant_selectinteger

ID of the tenant to which to assign the subscription, as listed by GET /api/v3/shop/microsoft-365/tenants. Required with "select", not allowed otherwise

Possible values: >= 1

domain_prefixstring

Prefix of the ".onmicrosoft.com" tenant domain: lowercase letters and digits, at most 27 characters. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[a-z0-9]{1,27}$

Example: mycompany

first_namestring

Contact first name for the tenant: letters, spaces and hyphens. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\p{L}\s\-]+$

Example: Mario

last_namestring

Contact last name for the tenant: letters, spaces and hyphens. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\p{L}\s\-]+$

Example: Rossi

company_namestring

Company name for the tenant: letters, digits and spaces. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\p{L}0-9\s]+$

Example: Rossi Srl

addressstring

Address for the tenant. Required with "transfer" and "new", not allowed otherwise

Possible values: non-empty

Example: Via Roma 1

citystring

City for the tenant address: letters, spaces and hyphens. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\p{L}\s\-]+$

Example: Vicenza

statestring

State/Province for the tenant address: letters, spaces and hyphens. Required with "transfer" and "new", not allowed otherwise

Possible values: >= 3 characters, Value must match regular expression ^[\p{L}\s\-]+$

Example: Vicenza

postal_codestring

Postal code for the tenant address: letters, digits and spaces. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[a-zA-Z0-9\s]+$

Example: 36100

countrystring

ISO country code with 2 letters (e.g. "IT" or "ES"). Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\p{L}\s\-]+$

Example: IT

email_addressemail

Administrative email address for the tenant. Required with "transfer" and "new", not allowed otherwise

phone_prefixstring

International phone prefix of a country, with the leading "+" sign (e.g. "+44" for UK or "+39" for Italy). Required with "transfer" and "new", not allowed otherwise

Example: +39

phone_numberstring

Phone number for the tenant contact: from 3 to 25 digits, spaces, dots, hyphens and parentheses. Required with "transfer" and "new", not allowed otherwise

Possible values: Value must match regular expression ^[\d() .-]{3,25}$

Example: 0444 123456

localestring

Locale to use for the tenant. Required with "transfer" and "new", not allowed otherwise

Possible values: [it_IT, en_US, en_GB]

BuyServiceMicrosoft365Request

{
  "service_id": 0,
  "quantity": 0,
  "account_id": 0,
  "data": {
    "tenant_choice": "select",
    "tenant_select": 0,
    "domain_prefix": "mycompany",
    "first_name": "Mario",
    "last_name": "Rossi",
    "company_name": "Rossi Srl",
    "address": "Via Roma 1",
    "city": "Vicenza",
    "state": "Vicenza",
    "postal_code": "36100",
    "country": "IT",
    "email_address": "[email protected]",
    "phone_prefix": "+39",
    "phone_number": "0444 123456",
    "locale": "it_IT"
  }
}