Get a list of all terms for a program.
Unpublish the terms for a program.
Update the terms for a program.
Create the terms for a program.
Get the terms for a program.
Delete the terms for a program.
Publish the terms for a program.
The Program Terms object represents terms in the form of uploaded PDF or DOCX documents, as well as links to documents hosted externally.
This object contains the following attributes:
id
string
(Read-only) The business identifier of the terms.
href
string
(Read-only) The resource URI of the terms.
name
string, core
The name of the terms.
description
string, core
A description of the terms.
displayOrder
integer, core
The display order of the terms.
status
string, core
The status of the terms. Allowed values are:
Draft
Published
Unpublished
Published
program
object
Represents the program to which the term item belongs.
audit
object
(Read-only) Represents the audit object.
{
"id": "TCS-3159-1891-0980-8679",
"href": "/programs/PRG-6822-9898-4256/terms/TCS-3159-1891-0980-8679",
"name": "Microsoft 365 Terms of Service",
"description": "Description of Microsoft 365 Terms of Service",
"displayOrder": 100,
"state": "Draft",
"program": {
"id": "PRG-6822-9898-4256",
"href": "/programs/PRG-6822-9898-4256",
"name": "Microsoft AI Cloud Partner"
},
"audit": {
"created": {
"at": "2024-01-16T21:30:13.1046031",
"by": {
"id": "USR-0000-0001"
}
},
"updated": null
}
}OK
GET /public/v1/program/programs/{programId}/terms HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"published": {},
"unpublished": {}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
}
}
]
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"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
}
}
]
}
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/programs/{programId}/terms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"name": "text",
"description": "text",
"displayOrder": 1
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"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
}
}
]
}
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"name": "text",
"description": "text",
"displayOrder": 1
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"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
}
}
]
}
}OK
Not Found
GET /public/v1/program/programs/{programId}/terms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"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
}
}
]
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/program/programs/{programId}/terms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/programs/{programId}/terms/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
{
"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
}
}
]
}
}