Create Agreement

Creates a new agreement.

POSThttps://api.platform.softwareone.com/public/v1/commerce/agreements

Body

application/jsontext/jsonapplication/*+json

Details of the agreement to create

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

Response

201400403500

Created

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

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.platform.softwareone.com/public/v1/commerce/agreements', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403

{
  "id": "text",
  "href": "text",
  "icon": "text",
  "startDate": "2025-01-23T20:56:09.705Z",
  "endDate": "2025-01-23T20:56:09.705Z",
  "name": "text",
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "startDate": "2025-01-23T20:56:09.705Z",
      "terminationDate": "2025-01-23T20:56:09.705Z",
      "autoRenew": false,
      "commitmentDate": "2025-01-23T20:56:09.705Z",
      "lines": []
    }
  ],
  "termsAndConditions": []
}