Get a single Agreement object by ID.
OK
Not Found
Last updated
Was this helpful?
Was this helpful?
GET /public/v1/commerce/agreements/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"updated": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"active": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"provisioning": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"terminated": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"status": "text",
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1,
"defaultMarkup": 1,
"defaultMargin": 1
},
"startDate": "2025-12-14T07:00:23.232Z",
"endDate": "2025-12-14T07:00:23.232Z",
"template": {
"id": "text",
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"terminated": {},
"deleted": {}
},
"$meta": {
"omitted": [
"text"
]
},
"quantity": 1,
"item": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
},
"group": {
"id": "text",
"name": "text"
},
"unit": {
"id": "text",
"description": "text",
"name": "text"
},
"terms": {
"model": "one-time",
"period": "1m",
"commitment": "1m"
},
"quantityNotApplicable": true,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"externalId": "text",
"type": "text",
"name": "text",
"value": null,
"displayValue": "text"
}
]
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"unitSP": 1,
"unitPP": 1,
"PPx1": 1,
"SPx1": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"order": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"type": "text",
"status": "text",
"notes": "text",
"comments": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"name": "text"
},
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "text",
"name": "text"
},
"assignee": {
"id": "text",
"name": "text",
"icon": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"defaultMarkup": 1,
"PPx1": 1,
"SPx1": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"lines": [
"[Circular Reference]"
],
"subscriptions": [
"[Circular Reference]"
],
"assets": [
"[Circular Reference]"
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"billTo": {
"id": "text",
"icon": "text",
"name": "text"
},
"pricingPolicy": {},
"termsAndConditions": [
"[Circular Reference]"
],
"certificates": [
{
"id": "text",
"name": "text"
}
],
"defaultMarkupSource": "text"
},
"status": "text",
"subscription": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"startDate": "2025-12-14T07:00:23.232Z",
"terminationDate": "2025-12-14T07:00:23.232Z",
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"terms": {
"model": "one-time",
"period": "1m",
"commitment": "1m"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"autoRenew": true,
"status": "text",
"commitmentDate": "2025-12-14T07:00:23.232Z",
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1,
"defaultMarkup": 1,
"defaultMargin": 1
},
"parameters": {
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"agreement": {
"id": "text",
"icon": "text",
"status": "text",
"name": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"split": {
"id": "text"
},
"splitStatus": "text",
"lines": [
"[Circular Reference]"
],
"template": {
"id": "text",
"name": "text"
}
},
"asset": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"status": "text",
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"PPx1": 1,
"SPx1": 1,
"defaultMarkup": 1,
"defaultMargin": 1
},
"template": {
"id": "text",
"name": "text"
},
"parameters": {
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": {
"model": "one-time",
"period": "1m",
"commitment": "1m"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"priceList": {
"id": "text",
"currency": "text"
},
"listing": {
"id": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"lines": [
"[Circular Reference]"
]
},
"agreement": {
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"updated": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"active": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"provisioning": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
},
"terminated": {
"at": "2025-12-14T07:00:23.232Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"status": "text",
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"defaultMarkupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"markupSource": {
"type": "text",
"ref": {
"id": "text",
"name": "text"
}
},
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1,
"defaultMarkup": 1,
"defaultMargin": 1
},
"startDate": "2025-12-14T07:00:23.232Z",
"endDate": "2025-12-14T07:00:23.232Z",
"template": {
"id": "text",
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
"[Circular Reference]"
],
"assets": [
{
"id": "text",
"name": "text",
"status": "text"
}
],
"subscriptions": [
{
"id": "text",
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {},
"termsAndConditions": [
"[Circular Reference]"
],
"certificates": [
{
"id": "text",
"name": "text"
}
]
},
"client": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"name": "text",
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
}
},
"vendor": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"name": "text",
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
}
},
"buyer": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"contact": {},
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": [
{
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
}
]
},
"seller": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"externalId": "text",
"status": "text",
"currencies": [
"text"
],
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"name": "text",
"erpLink": {
"id": "text",
"icon": "text",
"name": "text",
"companyName": "text",
"status": "text"
}
},
"product": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
}
],
"assets": [
{
"id": "text",
"name": "text",
"status": "text"
}
],
"subscriptions": [
{
"id": "text",
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {},
"termsAndConditions": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"pending": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"accepted": "2025-12-14T07:00:23.232Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
],
"certificates": [
{
"id": "text",
"name": "text"
}
]
}