Get Order Subscription
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns subscription with a given ID that exists in the order.
curl -L \
--url '/v1/commerce/orders/{orderId}/subscriptions/{id}'{
"id": "text",
"audit": {
"created": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"active": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"terminated": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"terminating": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"updating": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"startDate": "2025-03-19T20:33:18.576Z",
"terminationDate": "2025-03-19T20:33:18.576Z",
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"agreement": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"active": "[Circular Reference]",
"provisioning": "[Circular Reference]",
"terminated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"icon": "text",
"status": "New",
"listing": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"authorization": "[Circular Reference]",
"product": "[Circular Reference]",
"vendor": "[Circular Reference]",
"seller": "[Circular Reference]",
"priceList": "[Circular Reference]",
"primary": true,
"notes": "text",
"statistics": {
"subscriptions": 1,
"agreements": 1
}
},
"authorization": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"currency": "text",
"notes": "text",
"product": "[Circular Reference]",
"vendor": "[Circular Reference]",
"owner": "[Circular Reference]",
"statistics": {
"subscriptions": 1,
"agreements": 1,
"sellers": 1,
"listings": 1
}
},
"vendor": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"client": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"startDate": "2025-03-19T20:33:18.576Z",
"endDate": "2025-03-19T20:33:18.576Z",
"template": {
"id": "text",
"audit": {
"created": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"content": "text",
"type": "OrderProcessing",
"default": true,
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
"[Circular Reference]"
],
"subscriptions": [
"[Circular Reference]"
],
"parameters": {
"ordering": [
{
"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
}
],
"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
}
]
},
"licensee": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"name": "text",
"externalId": "text",
"status": "Active",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"useBuyerAddress": true,
"icon": "text",
"description": "text",
"account": "[Circular Reference]",
"buyer": "[Circular Reference]",
"seller": "[Circular Reference]"
},
"buyer": {
"id": "text",
"audit": {
"created": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"activated": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
},
"unassigned": {
"at": "2025-03-19T20:33:18.576Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": {
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "hello@example.com",
"phone": {
"prefix": "text",
"number": "text"
},
"user": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-03-19T20:33:18.576Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": "[Circular Reference]",
"currentAccount": "[Circular Reference]"
},
"type": "text"
},
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
},
"seller": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalId": "text",
"status": "Active",
"icon": "text",
"currencies": [
"text"
],
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"name": "text"
},
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"allocations": "[Circular Reference]"
},
"termsAndConditions": [
"[Circular Reference]"
]
},
"terms": {
"period": "1m",
"commitment": "1m"
},
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"autoRenew": true,
"status": "Draft",
"commitmentDate": "2025-03-19T20:33:18.576Z",
"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
}
]
},
"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]"
}
]
}OK