Agreements

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	Primary account identifier. Example: AGR-2119-4550-8674
href	string	Relative reference to the object in the API. Example: /v1/commerce/agreements/AGR-2119-4550-8674
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. Example: Microsoft Office 365 NCE E1
vendor	account	A reference to the vendor account object filled in upon creation, according to the product. Example: { "id": "ACC-1234-1234", "name": "Microsoft", "icon": "/static/ACC-1234-1234/account.png" }
client	account	A reference to the client account object. Example: { "id": "ACC-1234-4444", "name": "Best LLC", "icon": "/static/ACC-1234-4444/account.png" }
buyer	buyer	A reference to the Buyer object. Example: { "id": "BUY-3731-7971", "name": "Adam Ruszczak", "icon": "/static/BUY-3731-7971/icon.png" }
seller	seller	A reference to the Seller object. Example: { "id": "SEL-9121-8944", "name": "Software LN", "icon": "/static/SEL-9121-8944/icon.png" }
licensee	licensee	A reference to the Licensee object. Example: { "id": "LCE-9625-9634", "name": "John Smith", "icon": "/static/LCE-9625-9634/icon.png" }
product	product	A reference to the Product object. Example: { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }
listing	listing	A reference to the listing that allows this agreement. Example: { "id": "LST-1234-1234" }
authorization	authorization	A reference to the Authorization object used for the agreement. Example: { "id": "AUT-1234-4567", "name": "Salesforce Enterprise License" }
price	price	The agreement's pricing details including the monthly and yearly costs, excluding one-time charges. Different aspects of the price object are visible to different actors, as indicated in the Price Object. Example: { "PPxY": 150, "PPxM": 12.50, "SPxY": 165, "SPxM": 13.75, "currency": "USD" }
template	template	A reference to the Template object. Example: { "id": "TPL-1234-4444", "name": "Succesful Activation" }
error	errorObject	Markup text string explaining the reason for provisioning failure. Example: { "id": "E001234", "message": "Agreement provisioning failed due to unavailability of the item" }
lines	lines	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	subscription	A list of subscriptions in the agreement. Example: [ { "id": "SUB-0792-5000-2253", } ]
parameters.fulfillment	orderParameter	An object that holds a concise definition of a parameter, its value, and any associated errors. Example: [ { "id": "PRM-1234-1234-1234", "name": "Tennant Id", "externalId": "tennant_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	orderParameter	An object that holds a concise definition of a parameter, its value, and any associated errors. Example: [ { "id": "PRM-1234-1234-1234", "name": "Tennant Id", "externalId": "tennant_id", "constraints": { "readonly": false, "hidden": true, "required": true, "unique": false }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", "error": { "id": "E001234", "message": "Incorrect parameter value" } } ]
audit	audit	A reference to the Audit object. Possible audit events include Created, Updated, Activated, Terminated, or Failed.
externalIds	externalIds	A set of external IDs. Example: { "client": "12345678", "operations": "07bf766b-c767-4293-9ab3", "vendor": "ABC-2023-C07-dbeee0b302c0" }

Example

SHORT FORM

{
  "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,
    "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,
        "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"
  }
}

LONG EXAMPLE