Update Order Subscription

Updates and existing subscription

put

/v1/commerce/orders/{orderId}/subscriptions/{id}

Path parameters

idstringrequired

Id of the subscription to update

orderIdstringrequired

Body

application/jsontext/jsonapplication/*+json

idstring

auditobject

$metaobject

hrefstring

namestring

startDatestring · date-time

terminationDatestring · date-time | nullable

externalIdsobject

agreementobject

termsobject

productobject

autoRenewboolean

statusobject

commitmentDatestring · date-time | nullable

parametersobject

priceobject

linesany[] | nullable

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/orders/{orderId}/subscriptions/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"externalIds":{},"agreement":{},"terms":{},"product":{},"status":{},"parameters":{},"price":{},"lines":[]}'

200

403

404

500

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "startDate": "2025-02-23T21:32:11.844Z",
  "terminationDate": "2025-02-23T21:32:11.844Z",
  "externalIds": {},
  "agreement": {},
  "terms": {},
  "product": {},
  "autoRenew": true,
  "status": {},
  "commitmentDate": "2025-02-23T21:32:11.844Z",
  "price": {},
  "parameters": {},
  "buyer": {},
  "licensee": {},
  "seller": {},
  "lines": []
}

Success