Update Order Subscription

Updates and existing subscription

PUThttps://api.platform.softwareone.com/public/v1/commerce/orders/{orderId}/subscriptions/{id}

Path parameters

id*string

Id of the subscription to update

orderId*string

Body

application/jsontext/jsonapplication/*+json

Update details of subscription

idstring

auditobject

$metaobject

hrefstring

namestring

startDatestring (date-time)

terminationDatenullable string (date-time)

externalIdsobject

agreementobject

termsobject

productobject

autoRenewboolean

statusobject

commitmentDatenullable string (date-time)

parametersobject

priceobject

linesnullable array

Response

200403404500

Success

Body

application/json

idstring

auditobject

$metaobject

hrefstring

namestring

startDatestring (date-time)

terminationDatenullable string (date-time)

externalIdsobject

agreementobject

termsobject

productobject

autoRenewboolean

statusobject

commitmentDatestring (date-time)

priceobject

parametersobject

buyerobject

licenseeobject

sellerobject

linesnullable array

Request

JavaScriptCurlPython

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

Response

200403404

{
  "id": "text",
  "href": "text",
  "name": "text",
  "startDate": "2024-11-15T09:02:35.214Z",
  "terminationDate": "2024-11-15T09:02:35.214Z",
  "autoRenew": false,
  "commitmentDate": "2024-11-15T09:02:35.214Z",
  "lines": []
}