Get Order Subscription

Returns subscription with a given ID that exists in the order.

get

Path parameters

orderIdstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/commerce/orders/{orderId}/subscriptions HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "active": "[Circular Reference]",
        "terminated": "[Circular Reference]",
        "terminating": "[Circular Reference]",
        "updating": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "startDate": "2025-06-27T11:48:59.155Z",
      "terminationDate": "2025-06-27T11:48:59.155Z",
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "terms": {
        "period": "1m",
        "commitment": "1m"
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "autoRenew": true,
      "status": "Draft",
      "commitmentDate": "2025-06-27T11:48:59.155Z",
      "parameters": {
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "SingleLineText",
            "phase": "Configuration",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "New",
        "name": "text"
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1,
        "defaultMarkup": 1,
        "defaultMargin": 1
      },
      "lines": [
        {
          "id": "text",
          "oldQuantity": 1,
          "quantity": 1,
          "price": {
            "currency": "text",
            "markup": 1,
            "margin": 1,
            "unitSP": 1,
            "unitPP": 1,
            "PPx1": 1,
            "SPx1": 1,
            "SPxY": 1,
            "SPxM": 1,
            "PPxY": 1,
            "PPxM": 1
          },
          "item": "[Circular Reference]",
          "subscription": "[Circular Reference]"
        }
      ],
      "template": {
        "id": "text",
        "name": "text"
      }
    }
  ]
}