Microsoft365Response

Successful response with one Microsoft365

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Microsoft 365 subscription of the account, with its status at the supplier and its tenant

microsoft365_idintegerrequired

purchase_idintegerrequired

Id of the purchase of the subscription (GET /api/v3/purchases/{purchase_id})

tenant_idinteger | nullnullablerequired

Id of the tenant of the subscription (GET /api/v3/microsoft-365-tenants/{microsoft_365_tenant_id})

service_namestring | nullnullablerequired

Name of the service of the purchase, in Italian

purchase_namestring | nullnullablerequired

Object name of the purchase (purchase_name.object_name of the purchase): the prefix of the tenant domain, null until it is set

supplier_codestring | nullnullablerequired

Reference of the subscription at the supplier; null until the supplier provisions it

supplier_statusstring | nullnullablerequired

Status of the subscription as the supplier reports it, for example active, suspended or canceled; null until known

order_codestring | nullnullablerequired

Code of the order placed at the supplier for the subscription; null until it is placed

order_referencestring | nullnullablerequired

Reference of the order at the supplier; null until the supplier assigns it

order_statusstring | nullnullablerequired

Status of the order at the supplier, for example Order queued, Fulfilled or Archived; null until the order is placed

order_need_submitbooleanrequired

Whether the order at the supplier ended with a warning and must be submitted again

autorenew_enabledbooleanrequired

Whether the subscription renews automatically at the supplier

is_trialbooleanrequired

Whether the subscription is a trial

subscription_activation_datedatenullablerequired

Activation date of the subscription at the supplier; null until known

subscription_expiry_datedatenullablerequired

Expiry date of the subscription at the supplier; null until known

tenant objectrequired

Tenant of the subscription

anyOf

• Microsoft365Tenant
• null

tenant_idintegerrequired

microsoft_uuidstring | nullnullablerequired

Id of the tenant at Microsoft (tenant UUID); null until detected

domain_prefixstring | nullnullablerequired

Prefix of the .onmicrosoft.com domain of the tenant

microsoft_domainstring | nullnullablerequired

Full .onmicrosoft.com domain of the tenant

importedbooleanrequired

Whether the tenant was transferred from another partner (tenant_choice transfer) instead of created new (new)

first_namestring | nullnullablerequired

last_namestring | nullnullablerequired

countrystring | nullnullablerequired

Country of the tenant, as an ISO 3166-1 alpha-2 code, for example IT

company_namestring | nullnullablerequired

addressstring | nullnullablerequired

citystring | nullnullablerequired

statestring | nullnullablerequired

State or province of the tenant address

postal_codestring | nullnullablerequired

email_addressemailnullablerequired

phone_prefixstring | nullnullablerequired

International phone prefix with the leading +, for example +39

phone_numberstring | nullnullablerequired

localestring | nullnullablerequired

Locale of the tenant, for example it_IT or en_US

account_loginstring | nullnullablerequired

Username of the administrator account of the tenant, whose password is sent by email; null when not available

mca_compliantboolean | nullnullablerequired

Whether the Microsoft Customer Agreement (MCA) has been accepted for the tenant; null until checked

mca_sign_datedate-timenullablerequired

Date and time the Microsoft Customer Agreement was accepted; null when not known

mca_template_idstring | nullnullablerequired

Template of the accepted Microsoft Customer Agreement, as an id or as the URL of the agreement; null when not accepted

mca_errorstring | nullnullablerequired

Message of the supplier on the check of the Microsoft Customer Agreement, for example customer is not provisioned yet; null when there is none

metarequired

Always null: only the paginated lists have a meta

Constant value: null

Microsoft365Response

{
  "error": 0,
  "message": "string",
  "data": {
    "microsoft365_id": 0,
    "purchase_id": 0,
    "tenant_id": 0,
    "service_name": "string",
    "purchase_name": "string",
    "supplier_code": "string",
    "supplier_status": "string",
    "order_code": "string",
    "order_reference": "string",
    "order_status": "string",
    "order_need_submit": true,
    "autorenew_enabled": true,
    "is_trial": true,
    "subscription_activation_date": "2024-07-29",
    "subscription_expiry_date": "2024-07-29",
    "tenant": {
      "tenant_id": 0,
      "microsoft_uuid": "string",
      "domain_prefix": "string",
      "microsoft_domain": "string",
      "imported": true,
      "first_name": "string",
      "last_name": "string",
      "country": "string",
      "company_name": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "email_address": "[email protected]",
      "phone_prefix": "string",
      "phone_number": "string",
      "locale": "string",
      "account_login": "string",
      "mca_compliant": true,
      "mca_sign_date": "2024-07-29T15:51:28.071Z",
      "mca_template_id": "string",
      "mca_error": "string"
    }
  }
}