Get Order Subscription
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns subscription with a given ID that exists in the order.
GET /public/v1/commerce/orders/{orderId}/subscriptions HTTP/1.1
Host:
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"active": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"terminated": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"terminating": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updating": {
"at": "2025-06-06T12:37:40.729Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"startDate": "2025-06-06T12:37:40.729Z",
"terminationDate": "2025-06-06T12:37:40.729Z",
"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": "text",
"commitmentDate": "2025-06-06T12:37:40.729Z",
"parameters": {
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"agreement": {
"id": "text",
"icon": "text",
"status": "text",
"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": {
"id": "text",
"name": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
}
},
"subscription": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
}
}
],
"template": {
"id": "text",
"name": "text"
}
}
]
}