Get Agreement

Get a single Agreement object by ID.

GEThttps://api.platform.softwareone.com/public/v1/commerce/agreements/{id}

Path parameters

id*string

Query parameters

Response

200404

Success

Body

application/json

idstring

auditobject

$metaobject

hrefstring

iconnullable string

statusobject

listingobject

authorizationobject

vendorobject

clientobject

priceobject

startDatenullable string (date-time)

endDatenullable string (date-time)

templateobject

errorobject

namestring

linesnullable array

subscriptionsnullable array of Subscription (object)

parametersobject

licenseeobject

buyerobject

sellerobject

productobject

externalIdsobject

termsAndConditionsarray

Request

JavaScriptCurlPython

const response = await fetch('https://api.platform.softwareone.com/public/v1/commerce/agreements/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "href": "text",
  "icon": "text",
  "startDate": "2024-11-15T01:55:47.921Z",
  "endDate": "2024-11-15T01:55:47.921Z",
  "name": "text",
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "startDate": "2024-11-15T01:55:47.921Z",
      "terminationDate": "2024-11-15T01:55:47.921Z",
      "autoRenew": false,
      "commitmentDate": "2024-11-15T01:55:47.921Z",
      "lines": []
    }
  ],
  "termsAndConditions": []
}