A certificate is issued to a client or partner as confirmation that they meet a specific program's requirements. This document is proof that the client or partner has adhered to the vendor's standards and is now eligible to purchase or access their products.
The following rules apply to certificates:
A certificate can only be created or re-enrolled for published programs.
A client or partner can re-enroll for a certificate if it's in Active or Expired status. Re-enrollment is not permitted for terminated certificates.
A certificate can automatically expire on its expiration date, changing its status to Expired.
This object contains the following attributes:
This object contains the following attributes:
id
string, core
(Read-only) The business identifier of the certificate.
href
id
string
The identifier of the parameter definition this value refers to.
externalId
string
{
"id": "CER-1495-4162-8138",
"name": "Certainly a certificate",
"revision": 1,
"program": {
"id": "PRG-8803-8286",
"name": "Microsoft2 AI Cloud Friend",
"revision": 2,
"icon": "/v1/program/programs/PRG-8803-8286/icon",
"status": "Unpublished",
"applicableTo": "Licensee",
"products": [
{
"id": "PRD-0262-5461",
"name": "Don't touch it - testing in progress",
"icon": "/v1/catalog/products/PRD-0262-5461/icon",
"revision": 2,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-0506-8226",
"name": "iProduct",
"icon": "/v1/catalog/products/PRD-0506-8226/icon",
"revision": 2,
"externalIds": {
"operations": "12345"
},
"status": "Published"
},
{
"id": "PRD-1126-6342",
"name": "ProFour",
"icon": "/v1/catalog/products/PRD-1126-6342/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1186-8657",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1186-8657/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1324-5809",
"name": "Test",
"icon": "/v1/catalog/products/PRD-1324-5809/icon",
"revision": 1,
"externalIds": {
"operations": "1666"
},
"status": "Pending"
},
{
"id": "PRD-1361-4823",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1361-4823/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1458-4448",
"name": "ProOne",
"icon": "/v1/catalog/products/PRD-1458-4448/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-1503-5649",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1503-5649/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-1695-6569",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-1695-6569/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-1712-6041",
"name": "This is another product",
"icon": "/v1/catalog/products/PRD-1712-6041/icon",
"revision": 31,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-2370-3582",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2370-3582/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-2599-3780",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2599-3780/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-2876-3270",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-2876-3270/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-3035-5906",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-3035-5906/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-3225-9621",
"name": "Adobius Agobius",
"icon": "/v1/catalog/products/PRD-3225-9621/icon",
"revision": 4,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-4087-9832",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4087-9832/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4113-0835",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4113-0835/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4358-5858",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4358-5858/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-4438-6974",
"name": "Producto estupendo",
"icon": "/v1/catalog/products/PRD-4438-6974/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-4584-0141",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-4584-0141/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5008-6643",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5008-6643/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5423-8617",
"name": "Release 009",
"icon": "/v1/catalog/products/PRD-5423-8617/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-5469-4797",
"name": "Price List Items Test product",
"icon": "/v1/catalog/products/PRD-5469-4797/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-5486-6163",
"name": "Adobe Bo",
"icon": "/v1/catalog/products/PRD-5486-6163/icon",
"revision": 43,
"externalIds": {
"operations": "03543356356356365",
"defaultErpItem": "879878"
},
"status": "Published"
},
{
"id": "PRD-5624-3062",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5624-3062/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-5636-4901",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-5636-4901/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6435-6769",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6435-6769/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6478-2097",
"name": "AutomatedTajfunPending",
"icon": "/v1/catalog/products/PRD-6478-2097/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6847-2813",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6847-2813/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-6998-2587",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-6998-2587/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7070-4351",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7070-4351/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7162-5819",
"name": "ProTwo",
"icon": "/v1/catalog/products/PRD-7162-5819/icon",
"revision": 3,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-7399-8133",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7399-8133/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7492-6453",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7492-6453/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7622-1820",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-7622-1820/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-7811-7846",
"name": "Tajfun",
"icon": "/v1/catalog/products/PRD-7811-7846/icon",
"revision": 3,
"externalIds": {
"operations": "1234567890"
},
"status": "Published"
},
{
"id": "PRD-8265-6648",
"name": "BluewindPro",
"icon": "/v1/catalog/products/PRD-8265-6648/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-8289-7768",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8289-7768/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8557-8571",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8557-8571/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8599-9806",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8599-9806/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8674-3473",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-8674-3473/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-8854-4878",
"name": "AutomatedTajfunUnpublished",
"icon": "/v1/catalog/products/PRD-8854-4878/icon",
"revision": 1,
"externalIds": {},
"status": "Published"
},
{
"id": "PRD-8854-7061",
"name": "AutomatedTajfunPublished",
"icon": "/v1/catalog/products/PRD-8854-7061/icon",
"revision": 1,
"externalIds": {},
"status": "Unpublished"
},
{
"id": "PRD-9298-0552",
"name": "ProThree",
"icon": "/v1/catalog/products/PRD-9298-0552/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
},
{
"id": "PRD-9689-6324",
"name": "Product with mad quantity of Terms",
"icon": "/v1/catalog/products/PRD-9689-6324/icon",
"revision": 1,
"externalIds": {
"operations": "IAMD3FAULT"
},
"status": "Unpublished"
},
{
"id": "PRD-9920-1302",
"name": "MPT_QA_Product",
"icon": "/v1/catalog/products/PRD-9920-1302/icon",
"revision": 1,
"externalIds": {},
"status": "Pending"
}
]
},
"vendor": {
"id": "ACC-1762-8332",
"name": "Test Tajfun Vendor",
"icon": "/v1/accounts/accounts/ACC-1762-8332/icon",
"revision": 8,
"type": "Vendor",
"status": "Enabled"
},
"externalIds": {},
"client": {
"id": "ACC-7843-4996",
"name": "Experimental Client #37",
"revision": 1,
"type": "Client",
"status": "Active"
},
"applicableTo": "Licensee",
"licensee": {
"id": "LCE-2722-7432-2049",
"name": "US Licensee",
"revision": 1
},
"eligibility": {
"client": true,
"partner": true
},
"status": "Terminated",
"statusNotes": "this certificate needs to be terminated",
"expirationDate": "2025-01-31",
"parameters": {
"ordering": [],
"fulfillment": []
},
"audit": {
"terminated": {
"at": "2025-03-27T20:19:21.004Z",
"by": {
"id": "USR-0000-0032",
"name": "Mariya Surovtseva",
"revision": 1
}
},
"created": {
"at": "2025-02-03T10:52:56.814Z",
"by": {
"id": "USR-0000-0032",
"name": "Mariya Surovtseva",
"revision": 1
}
},
"updated": {
"at": "2025-04-25T16:45:51.902Z",
"by": {
"id": "USR-0000-0037",
"name": "Michael Saunders",
"revision": 1
}
}
}
}string, core
(Read-only) The resource URI of the certificate.
program
object, core
Represents the program to which this certificate applies.
Example:
client
object
Represents the client or partner account object to which the certificate belongs.
applicableTo
string, core
The scope in which the given enrollment is created. Allowed values are buyer or licensee.
buyer
object, core
(Optional) Represents the buyer object, if the enrollment applies to the buyer.
licensee
object, core
(Optional) Represents the licensee object if the enrollment applies to the licensee.
Example:
eligibility
eligibility, core
Configuration of the partner program.
Example:
externalIds
object
Represents the externalIds object, containing the identifier for the external system.
Example:
status
enum, core
(Read-only) The certificate's status. Allowed values are:
Pending
Updating
Active
Terminated
Expired
statusNotes
string
(Optional) Notes provided by the vendor to terminate a certificate.
expirationDate
dateTime
(Optional) The expiration date of the certificate. When the date has passed, the system expires the certificate.
template
object
(Optional) Represents the template object.
Example:
parameters.fulfillment
object
Represents the orderParameter object, which holds a definition of a parameter, its value, and associated errors.
Example:
parameters.ordering
object
Represents the orderParameter object, which contains a definition of a parameter, its value, and associated errors.
Example:
audit
object
(Read-only) Represents the audit object.
The ID of the parameter in the external system.
type
string
The type of the parameter definition.
name
string
The display name of the parameter.
value
string
The value of the parameter.
{
"id": "PRG-1234-5678",
"href": "/program/programs/PRG-1234-5678",
"name": "Microsoft AI Cloud Partner"
}{
"id": "CER-1234-1234",
"href": "v1/accounts/licensees/LIC-1234-1234-1234"
"name": "Stark Canada Limited",
"externalId": "WW-CON-12345678"
}{
"client": true,
"partner": false
}{
"vendor": "ven-1233-3222"
}{
"id": "PTP-1234-4444",
"href": "/programs/PRG-1234 1234/templates/TPP-1234-4444",
"name": "Successful Activation"
}[
{
"id": "PRM-1234-1234-1234",
"name": "Tenant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
][
{
"id": "PRM-1234-1234-1234",
"name": "Tenant Id",
"externalId": "tenant_id",
"constraints": {
"readonly": false,
"hidden": true,
"required": true,
"unique": false
},
"value": "69b73824-ce76-4866-ad47-b615ae9d8998",
"error": {
"id": "E001234",
"message": "Incorrect parameter value"
}
}
]The following diagram shows the state (status) transition process of a certificate. It shows the possible states a certificate can have and the transition between those states.
New
This is the initial status of a certificate, and it's assigned by the platform when the certificate is being created.
Pending
The certificate has been created successfully, and it's awaiting approval by the vendor.
Active
The certificate is active and can be used when placing an order.
Expired
The certificate has expired. Expired certificates can be renewed by re-enrolling in the program.
Updating
The certificate is being updated due to re-enrollment in the program.
Terminated
The certificate has been terminated. Terminated certificates can't be used to re-enroll in a program.
OK
GET /public/v1/program/certificates 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": {},
"activated": {},
"pending": {},
"terminated": {},
"expired": {},
"updating": {}
},
"$meta": {
"omitted": [
"text"
]
},
"program": {
"id": "text",
"name": "text",
"status": "text",
"applicableTo": "text",
"products": [
"[Circular Reference]"
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"program": {},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}
]
}OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/program/certificates/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"parameters": {
"ordering": [
{
"id": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"value": null
}
]
},
"template": {
"id": "text"
},
"expirationDate": "2026-01-01",
"externalIds": {
"vendor": "text"
},
"name": "text"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"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
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"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": [
{
"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
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Not Found
GET /public/v1/program/certificates/{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": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"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
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"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": [
{
"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
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}OK
Bad Request
Forbidden
Not Found
Internal Server Error
No content
POST /public/v1/program/certificates/{id}/terminate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"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
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"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": [
{
"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
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/program/certificates HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 207
{
"program": {
"id": "text"
},
"buyer": {
"id": "text"
},
"licensee": {
"id": "text"
},
"client": {
"id": "text"
},
"name": "text",
"parameters": {
"ordering": [
{
"id": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"value": null
}
]
}
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"activated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"terminated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"expired": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
},
"updating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {}
}
},
"$meta": {
"omitted": [
"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
}
}
]
},
"name": "text",
"externalIds": {
"vendor": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"applicableTo": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "text",
"expirationDate": "2026-01-01",
"template": {
"id": "text",
"name": "text",
"type": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"terms": [
{
"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": [
{
"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
}
}
]
},
"accepted": "2026-01-01T00:00:00.000Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
]
}