> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/agreements.md). # Agreement The Agreement object represents an instance of a relationship between the seller, buyer, and licensee. It may refer to one-time purchases or a set of subscriptions. This object contains the following attributes:

Field	Type	Description
`id`	string	(Read-only) The primary identifier for the account.
`status`	string	The key status of the object. May only be specified on creation and cannot be updated with `PUT`.
`name`	string	The agreement name. The value is assigned automatically when the agreement is created, as {product.name} for {licensee.name}. The value can be changed later.
`vendor`	object	(Read-only) Represents the vendor `account` object filled in upon creation, according to the product.
`client`	object	Represents the client `account` object.
`buyer`	object	(Read-only) Represents the `buyer` object.
`seller`	object	(Read-only) Represents the `seller` object.
`licensee`	object	Represents the `licensee` object.
`product`	object	Represents the `product` object. Example: `{ "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }`
`listing`	listing	Represents the `listing` that allows this agreement. Example: `{ "id": "LST-1234-1234" }`
`authorization`	object	(Read-only) Represents the `authorization` object used for the agreement.
`price`	object	(Read-only) Represents the agreement’s pricing details. Monthly and yearly prices exclude one‑time charges. Visibility of specific price fields varies by actor, as defined within the `price` object. Example: `{ "PPxY": 150, "PPxM": 12.50, "SPxY": 165, "SPxM": 13.75, "currency": "USD" }`
`template`	object	Represents the `template` object. Example: `{ "id": "TPL-1234-4444", "name": "Succesful Activation" }`
`error`	object	Represents the `error` object,containing a markup‑formatted text string that explains the reason for provisioning failure. Example: `{ "id": "E001234", "message": "Agreement provisioning failed due to unavailability of the item" }`
`lines`	object	Represents the `line` object, containing a list of items in the agreement. Example: `[ { "id": "ALI-1234-1234-1234-0127", "item": { "id": "ITM-1234-1234-1234-0992", "name": "Adobe Migration" }, "quantity": 10, "price": { "PPx1": 12.50, "unitPP": 1.25, "SPx1": 13.50, "unitSP": 1.35, "currency": "USD" }, "order": { "id": "ORD-6869-4529-8975-9005" } } ]`
`subscriptions`	object	Represents the `subscription` within the agreement.
`parameters.fulfillment`	object	(Optional) Represents the `orderParameter` object containing a concise definition of a parameter, its value, and any associated errors. Example: `[ { "id": "PRM-1234-1234-1234", "name": "Tennant Id", "externalId": "tenant_id", "constraints": { "readonly": false, "hidden": true, "required": true, "unique": false }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", "error": { "id": "E001234", "message": "Incorrect parameter value" } } ]`
`parameters.ordering`	object	(Optional) Represents the `orderParameter` object containing a concise definition of a parameter, its value, and any associated errors. Example: `[ { "id": "PRM-1234-1234-1234", "name": "Tennant Id", "externalId": "tenant_id", "constraints": { "readonly": false, "hidden": true, "required": true, "unique": false }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", "error": { "id": "E001234", "message": "Incorrect parameter value" } } ]`
`audit`	object	(Read-only) Represents the `audit` object.
`externalIds`	object	(Optional) Represents a set of `externalIds`.
`termsAndConditions`	object	(Read‑only) Represents the terms and conditions of the product that were accepted as part of the order. These values are then copied from the order into the agreement when the order is completed.

## Examples {% tabs %} {% tab title="MINIMAL EXAMPLE" %}

{
  "id": "AGR-2119-4550-8674", 
  "status": "Draft",
  "name": "Microsoft Office 365 NCE E1", 
  "vendor": { "id": "ACC-1234-1234" },
  "client": { "id": "ACC-1234-4444" },
  "seller": { "id": "SEL-9121-8944" },
  "buyer": { "id": "BUY-3731-7971" },
  "licensee": { "id": "LCE-9625-9634" },
  "product": {
    "id": "PRD-1111-1111-1111",    
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
  },
  "price": {
    "PPxY": 150,
    "PPxM": 12.50,
    "SPxY": 165,
    "SPxM": 13.75,
    "markup": 0.10,
    "margin": 0.11,
    "currency": "USD"
  },
  "startDate": "2023-12-14T17:28:57.667Z",
  "endDate": "2023-12-14T17:28:57.667Z",
  "template": {
    "id": "TPL-1234-4444",    
    "name": "Succesful Activation"
  },
  "audit": {
    "created": { "at": "...", "by": { } },
    "updated": { "at": "...", "by": { } }
  },
  "lines": [
    {
      "id": "ALI-1234-1234-1234-0127",
      "item": {
        "id": "ITM-1234-1234-1234-0992",
        "name": "Adobe Migration"
      },
      "quantity": 10,
      "price": {
        "PPx1": 12.50,
        "unitPP": 1.25,
        "SPx1": 13.50,
        "unitSP": 1.35,
        "markup": 0.10,
        "margin": 0.11,
        "currency": "USD"
      },
      "order": { "id": "ORD-6869-4529-8975-9005" }
    }
  ],
  "subscriptions": [
    { "id": "SUB-0792-5000-2253" }
  ],
  "parameters": {
    "ordering": [ ],
    "fulfillment": [ ]
  },
  "externalIDs": {
    "client": "12345678",
    "operations":	"07bf766b-c767-4293-9ab3",
    "vendor": "ABC-2023-C07-dbeee0b302c0"
  },
  "termsAndConditions":[
  {
     "id": "TCS-3159-1891-0980-8679",    
     "accepted": "2024-04-29T15:37:16.071Z",
     "acceptedBy": {
        "id": "USR-0000-0001",        
        "name": "Will Smith"
      },
      "name": "Microsoft 365 Terms of Service"
    }
  ]
}

{% endtab %} {% tab title="COMPLETE EXAMPLE" %} {% code title="AGREEMENT OBJECT" overflow="wrap" lineNumbers="true" %} ```json { "id": "AGR-2119-4550-8674", "status": "Draft", "name": "Microsoft Office 365 NCE E1", "vendor": { "id": "ACC-1234-1234", "name": "Microsoft", "icon": "/static/ACC-1234-1234/account.png" }, "client": { "id": "ACC-1234-4444", "name": "Best LLC", "icon": "/static/ACC-1234-4444/account.png" }, "seller": { "id": "SEL-9121-8944", "name": "Software LN", "icon": "/static/SEL-9121-8944/icon.png" }, "buyer": { "id": "BUY-3731-7971", "name": "Adam Ruszczak", "icon": "/static/BUY-3731-7971/icon.png" }, "licensee": { "id": "LCE-9625-9634", "name": "John Smith", "icon": "/static/LCE-9625-9634/icon.png" }, "product": { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }, "price": { "PPxY": 150, "PPxM": 12.50, "SPxY": 165, "SPxM": 13.75, "markup": 0.10, "margin": 0.11, "currency": "USD" }, "startDate": "2023-12-14T17:28:57.667Z", "endDate": "2023-12-14T17:28:57.667Z", "template": { "id": "TPL-1234-4444", "name": "Succesful Activation" }, "audit": { "created": { "at": "2023-12-14T17:28:57Z", "by": { "id": "UR-1234-1234-1234", "name": "John Smith", "icon": "/static/users/UR-1234-1234-1234.icon.svg" } }, "updated": { "at": "2023-12-14T17:28:57Z", "by": { "id": "UR-1234-1234-1234", "name": "John Smith", "icon": "/static/users/UR-1234-1234-1234.icon.svg" } } }, "lines": [ { "id": "ALI-1234-1234-1234-0127", "item": { "id": "ITM-1234-1234-1234-0992", "name": "Adobe Migration" }, "quantity": 10, "price": { "PPx1": 12.50, "unitPP": 1.25, "SPx1": 13.50, "unitSP": 1.35, "markup": 0.10, "margin": 0.11, "currency": "USD" }, "order": { "id": "ORD-6869-4529-8975-9005" } } ], "subscriptions": [ { "id": "SUB-0792-5000-2253" } ], "parameters": { "ordering": [ { "id": "string", "name": "string", "value": "string", "hasError": true, "description": { "type": "SingleLine", "phase": "Configuration", "isRequired": true, "isHidden": true, "isReadOnly": true, "error": "string" } } ], "fulfillment": [ { "id": "string", "name": "string", "value": "string", "hasError": true, "description": { "type": "SingleLine", "phase": "Configuration", "isRequired": true, "isHidden": true, "isReadOnly": true, "error": "string" } } ] }, "externalIDs": { "client": "12345678", "operations": "07bf766b-c767-4293-9ab3", "vendor": "ABC-2023-C07-dbeee0b302c0" }, "termsAndConditions":[ { "id": "TCS-3159-1891-0980-8679", "accepted": "2024-04-29T15:37:16.071Z", "acceptedBy": { "id": "USR-0000-0001", "name": "Will Smith" }, "name": "Microsoft 365 Terms of Service" } ] } ``` {% endcode %} {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/agreements.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.