Get Agreement

Get a single Agreement object by ID.

get

/v1/commerce/agreements/{id}

Path parameters

idstringrequired

Query parameters

selectstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/agreements/{id}'

200

404

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "icon": "text",
  "status": {},
  "listing": {},
  "authorization": {},
  "vendor": {},
  "client": {},
  "price": {},
  "startDate": "2025-02-23T06:06:59.217Z",
  "endDate": "2025-02-23T06:06:59.217Z",
  "template": {},
  "error": {},
  "name": "text",
  "parameters": {},
  "licensee": {},
  "buyer": {},
  "seller": {},
  "product": {},
  "externalIds": {},
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "startDate": "2025-02-23T06:06:59.217Z",
      "terminationDate": "2025-02-23T06:06:59.217Z",
      "externalIds": {},
      "agreement": {},
      "terms": {},
      "product": {},
      "autoRenew": true,
      "status": {},
      "commitmentDate": "2025-02-23T06:06:59.217Z",
      "price": {},
      "parameters": {},
      "buyer": {},
      "licensee": {},
      "seller": {},
      "lines": []
    }
  ],
  "termsAndConditions": []
}

Success