Fetch Subscription Product Relationships
1 min
GET
https://api.nue.io/subscriptions/product-relationships
Query Parameters
- subscriptionNamesstringrequiredExample
[ "SUB-000115", "SUB-000116" ]
Description
Responses
200
- objectExample
{ "status": "SUCCESS", "data": { "SUB-000115": { "currencyIsoCode": "USD", "subscriptionName": "SUB-000115", "subscriptionId": "a0udi00000484tlAAA", "productSku": "ORDER FORMS UDS", "subscriptionUomName": "User/Year", "options": { "upgrade": [ { "id": "a0odi000000y2QVAAY", "relationshipType": "Upgrade", "sameUomOnly": false, "startDate": "2025-01-16", "productRelationshipPriceTags": [ { "id": "a0xdi000001ABC", "name": "Upgrade Discount", "priceTagType": "Discount", "publishStatus": "Published" } ], "fromProduct": { "id": "01tdi000008IMqIAAW", "name": "Order Forms uds", "sku": "ORDER FORMS UDS", "priceBookEntries": [ { "id": "01udi00000341kWAAQ", "listPrice": 100, "billingTiming": "In Advance", "uom": { "name": "User/Year", "quantityDimension": "User", "termDimension": "Year" } } ] }, "toProducts": [ { "id": "01tdi000008IMqXAAW", "name": "Nue Recurring Test", "sku": "NUE RECURRING TEST", "priceBookEntries": [ { "id": "01udi00000341kXAAQ", "listPrice": 120, "billingTiming": "In Advance", "uom": { "name": "User/Year", "quantityDimension": "User", "termDimension": "Year" } } ] } ] } ], "swap": [ { "id": "a0odi000000y2QRAAY", "relationshipType": "Swap", "sameUomOnly": false, "samePriceSwap": false, "startDate": "2025-07-30", "fromProduct": { "id": "01tdi000008IMqIAAW", "name": "Order Forms uds", "sku": "ORDER FORMS UDS", "priceBookEntries": [ { "id": "01udi00000341kWAAQ", "listPrice": 100, "billingTiming": "In Advance", "uom": { "name": "User/Year" } } ] }, "toProducts": [] } ] } } } }- statusstring<SUCCESS | PARTIAL_SUCCESS>DescriptionAllowedSUCCESSPARTIAL_SUCCESS
- datamap<string, object>Description
- warningsobject[]Description
- codestringDescription
- messagestringDescription
400
- object
- statusstring<FAILURE>AllowedFAILURE
- messagestring
curl
curl --request GET \
--url 'https://api.nue.io/subscriptions/product-relationships?subscriptionNames=[%22SUB-000115%22%2C%20%22SUB-000116%22]' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/subscriptions/product-relationships?subscriptionNames=[\"SUB-000115\", \"SUB-000116\"]", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/subscriptions/product-relationships?subscriptionNames=[\"SUB-000115\", \"SUB-000116\"]")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/subscriptions/product-relationships?subscriptionNames=[\"SUB-000115\", \"SUB-000116\"]"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successfully retrieved product relationships for subscriptions
{
"status": "",
"data": "",
"warnings": [
{
"code": "",
"message": ""
}
]
}400
// Bad request - invalid or missing parameters
{
"status": "",
"message": ""
}