Terms & Conditions

The Terms and Conditions object represents terms as a collection of uploaded PDF or DOCX documents or links to externally hosted documents as an element of a product. The object contains the following properties:

Field
Type
Description

id

string

The identifier for the terms.

Example: TCS-1234-1234-1234

href

string

A relative reference to the terms.

Example:

/products/PRD-6822-9898-4256/terms-and-conditions/TCS-3159-1891-0980-8679

name

string

The name for the terms.

Example: Terms of Service

description

string

A description of the terms.

Example: Terms of Service description

displayOrder

integer

The display order for the terms.

Example: 10

status

string

The status of the terms.

Example: Draft

product

The product to which the item is assigned.

audit

A reference to the Audit object.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

Example

{
  "id": "TCS-3159-1891-0980-8679",
  "name": "Microsoft 365 Terms of Service",
  "description": "Description of Microsoft 365 Terms of Service",
  "displayOrder": 100,
  "state": "Draft",
  "product": {
    "id": "PRD-6822-9898-4256",
    "name": "Microsoft 365 online services for commercial"
  },
  "audit": {
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}

TermsVariant

The TermsVariant object represents terms variant as an uploaded PDF or DOCX document or a link to an externally hosted document as an element of terms for a product.

Field
Type
Description

id

string

A unique identifier for the terms variant.

Example: TCS-1234-1234-1234-1234

href

string

Example:

/products/PRD-1234-1234/terms/tcs-1234-1234-1234/terms-item/tcs-1234-1234-1234-1234

type

string

The type of terms variant.

Example: Online

name

string

A name for the terms variant.

Example: TCS-1234-1234-1234-1234

description

string

A description of the terms variant.

Example: Terms of Service description in English

assetUrl

string

The URL of the uploaded document or online document/resource.

Example: https://www.test.com/terms-of-service

languageCode

string

The 2-digit language code for the terms item.

Example: en

status

string

The status of the terms.

Example: Draft

termsAndConditions

string

The terms to which the item has been assigned.

audit

auditObject

A reference to the Audit object.

Example

{
  "id": "TCS-1234-1234-1234-1234",
  "name": "Terms and Conditions Variant - EN",
  "description": "Terms and Conditions Variant in English",
  "type": "Online",
  "assetUrl": "https://www.microsoft.com",
  "languageCode": "en",
  "state": "Draft",
  "termsAndConditions": {
    "id": "TCS-1234-1234-1234",
    "name": "Microsoft 365 Terms of Service"
  },
  "audit": {
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}

Last updated

Was this helpful?