Get Subscriptions
Variables - Details
| Name | Description | Required |
|---|---|---|
| customerRelationshipId | CMT based variable to uniquely identify | Required |
| serviceAccountNumber | XBO Service Account Number | Required |
| affiliate | Unique identifier of the sales affiliate | Required |
| channel | Unique identifier of the sales channel | Required |
| appId | Application Id within the sales channel | Required |
API Specs
GraphQL API
Success
This API is available in both integration and production.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/graphql |
| Method | POST |
mutation Mutation($salesContext: SalesContextInput) {
createSalesContext(salesContext: $salesContext) {
salesJourneyId
offers {
... // Offers node is available to query
}
}
}
{
"salesContext": {
"account": {
"customerRelationshipId": "82aae449-7f55-46c6-800f-89f319e38230002",
"serviceAccountNumber" : "234234876987987239"
},
"source": {
"affiliate": "XUMO",
"channel": "WEB",
"appId": "WEB_PORTAL"
}
}
}
None
None
{
"salesJourneyId" : "32423423",
"offers" :[
{
"allowedActions": [
"REMOVE"
],
"offerId": "CS_OFFER_000003",
"availToBuy": 0,
"availToRemove": 1,
"qtyInAccount": 1,
"qtyInCart": 0,
"productFamily": "",
"partnerGroup": "CONTENT_STORE",
"activationStatus": null,
"purchasedOfferId": null,
"subscriptionDetails": null,
"chargeDetails": [
{
"currency": "USD",
"recurringCharges": [
{
"chargeAmount": 6.99,
"duration": 0,
"startMonth": 1
}
]
}
],
"metadata": [
{
"name": "productName",
"value": "Anime_Network"
}
//....
]
"presentationContents" : [
{
"name": "productName",
"content": "Anime_Network"
}
//....
]
}
//.... more offers
]
}
{
"errors" : []
}
Coming soon
REST API
Info
This API is in staging. Will be available in production in few days.
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v1/salesJourneys/{salesJourneyId}/subscriptions |
| Method | GET |
None
| Param Name | Description | Required |
|---|---|---|
| salesJourneyId | salesJourneyId that we got from init step | Required |
{
"salesJourneyId" : "32423423",
"offers" :[
{
"allowedActions": [
"REMOVE"
],
"offerId": "CS_OFFER_000003",
"availToBuy": 0,
"availToRemove": 1,
"qtyInAccount": 1,
"qtyInCart": 0,
"productFamily": "",
"partnerGroup": "CONTENT_STORE",
"activationStatus": null,
"purchasedOfferId": null,
"subscriptionDetails": null,
"chargeDetails": [
{
"currency": "USD",
"recurringCharges": [
{
"chargeAmount": 6.99,
"duration": 0,
"startMonth": 1
}
]
}
],
"metadata": [
{
"name": "productName",
"value": "Anime_Network"
}
//....
]
"presentationContents" : [
{
"name": "productName",
"content": "Anime_Network"
}
//....
]
}
//.... more offers
]
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
REST API - V2
Warning
This API is in development.
Get subscriptions by account
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/subscriptions |
| Method | GET |
| Header | Description | Required |
|---|---|---|
| clprop | Client property, Eg: affiliate=XSB,channel=DEVICE,appId=UCO | Required |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
{
"salesJourneyId": "string",
"subscriptions": [
{
"publisher": "Apple",
"subscriptions": [
{
"subscriptionId": "11-232323332323-222",
"publisher": "Apple",
"autoRenewStatus": true,
"subscriptionStatus": "ACTIVE",
"purchasedOn": "2024-01-11T11:52:32Z",
"renewalDate": "2024-02-04T01:47:47Z",
"quantity": 1,
"subscriptionDetails": {
"relevantProducts": [
{
"productId": "EPC-MLS-YEARLY",
"productName": "MLS Seassson",
"productType": "Feature",
"durableAppId": "AppleTVPlus",
"appId": "AppleTVPlus",
"activationStatus": "pending_activation"
}
]
},
"offerDetails": [
{
"offerDetails": {
"publisher": "Apple",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream",
"offerCode": "EPO-90-200008",
"displayName": "MLS Monthly Subscription",
"description": "SPORTS - MLS Monthly Subscription ALC",
"offerType": "ProductOffer",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": 0,
"associatedProduct": "EPP-80-400007",
"source": "xcp",
"childrenProducts": [
{
"productId": "EPC-NOWTV",
"productType": "FEATURE",
"productName": "NOWTV",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream"
}
]
},
"price": {
"listPrice": 14.99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY",
"installments": 0,
"quantity": 0,
"stepped": false,
"priceTerms": 0,
"steppedTermsFrom": 0,
"steppedTermsTo": 0
},
"offerPresentation": {
"displayName": "Apple TV+",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Monthly) for $14.99 per month. Plan automatically renews until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged during the calendar months December and January. Pricing subject to change. Taxes and fees extra. To access MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": "Congrats for your new subscription to MLS Season Pass, you are ready to enjoy soccer as never before. Please remember to activate your subscription."
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Full HD video resolution",
"MLS updates, live events, and more",
"All remaining matches for the 2023 season, including playoffs"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": "A&E, Afro, AMC, Animal Planet, BBC America, BBC News, Comedy TV, Cooking Channel, Crime + Investigation, Discovery Channel, Discovery Life, Food Network, FYI, Get TV, Great American Family, Great American Living, GSN, Hallmark Channel, Hallmark Drama, Hallmark Movie Mysteries, HGTV, History, ID, IFC, Justice Central TV, Lifetime, LMN, Magnolia Network, Military History, Motortrend, OWN, Pursuit, Recipe TV, SCI, Sony Movies, Sundance Channel, The Weather Channel, TLC, Travel Channel, Vice, We TV"
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": [
"Do you have a subscription already?, just say \"Apple TV\" on your remote control",
"Or, just go to the Subscription App to manage it"
]
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": "http://xumo.com/subscribe/EPO-90-200008",
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": [
"Scan the QR code and continue your subscription on the portal"
]
}
]
}
}
}
]
}
]
}
]
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
Get subscriptions for a given subscription id
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/subscriptions/{subscriptionId} |
| Method | GET |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
| subscriptionId | subscriptionId of the subscription | Required |
{
"subscription": {
"subscriptionId": "11-232323332323-222",
"publisher": "Apple",
"autoRenewStatus": true,
"subscriptionStatus": "ACTIVE",
"purchasedOn": "2024-01-11T11:52:32Z",
"renewalDate": "2024-02-04T01:47:47Z",
"quantity": 1,
"subscriptionDetails": {
"relevantProducts": [
{
"productId": "EPC-MLS-YEARLY",
"productName": "MLS Seassson",
"productType": "Feature",
"durableAppId": "AppleTVPlus",
"appId": "AppleTVPlus",
"activationStatus": "pending_activation"
}
]
},
"offerDetails": [
{
"offerDetails": {
"publisher": "Apple",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream",
"offerCode": "EPO-90-200008",
"displayName": "MLS Monthly Subscription",
"description": "SPORTS - MLS Monthly Subscription ALC",
"offerType": "ProductOffer",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": 0,
"associatedProduct": "EPP-80-400007",
"source": "xcp",
"childrenProducts": [
{
"productId": "EPC-NOWTV",
"productType": "FEATURE",
"productName": "NOWTV",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream"
}
]
},
"price": {
"listPrice": 14.99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY",
"installments": 0,
"quantity": 0,
"stepped": false,
"priceTerms": 0,
"steppedTermsFrom": 0,
"steppedTermsTo": 0
},
"offerPresentation": {
"displayName": "Apple TV+",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Monthly) for $14.99 per month. Plan automatically renews until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged during the calendar months December and January. Pricing subject to change. Taxes and fees extra. To access MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": "Congrats for your new subscription to MLS Season Pass, you are ready to enjoy soccer as never before. Please remember to activate your subscription."
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Full HD video resolution",
"MLS updates, live events, and more",
"All remaining matches for the 2023 season, including playoffs"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": "A&E, Afro, AMC, Animal Planet, BBC America, BBC News, Comedy TV, Cooking Channel, Crime + Investigation, Discovery Channel, Discovery Life, Food Network, FYI, Get TV, Great American Family, Great American Living, GSN, Hallmark Channel, Hallmark Drama, Hallmark Movie Mysteries, HGTV, History, ID, IFC, Justice Central TV, Lifetime, LMN, Magnolia Network, Military History, Motortrend, OWN, Pursuit, Recipe TV, SCI, Sony Movies, Sundance Channel, The Weather Channel, TLC, Travel Channel, Vice, We TV"
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": [
"Do you have a subscription already?, just say \"Apple TV\" on your remote control",
"Or, just go to the Subscription App to manage it"
]
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": "http://xumo.com/subscribe/EPO-90-200008",
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": [
"Scan the QR code and continue your subscription on the portal"
]
}
]
}
}
}
]
}
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon
Get subscription by offer code
| HTTP Item | HTTP Value |
|---|---|
| Url | https://{host}/v2/partners/{partnerId}/accounts/{serviceAccountNumber}/offers/{offerId}/subscription |
| Method | GET |
| Header | Description | Required |
|---|---|---|
| clprop | Client property, Eg: affiliate=XSB,channel=DEVICE,appId=UCO | Required |
None
| Param Name | Description | Required |
|---|---|---|
| partnerId | Partner id such as xglobal/comcast | Required |
| serviceAccountNumber | XBO service account number | Required |
| offerId | offerId that is being queried for | Required |
{
"salesJourneyId": "string",
"subscription": {
"subscriptionId": "11-232323332323-222",
"publisher": "Apple",
"autoRenewStatus": true,
"subscriptionStatus": "ACTIVE",
"purchasedOn": "2024-01-11T11:52:32Z",
"renewalDate": "2024-02-04T01:47:47Z",
"quantity": 1,
"subscriptionDetails": {
"relevantProducts": [
{
"productId": "EPC-MLS-YEARLY",
"productName": "MLS Seassson",
"productType": "Feature",
"durableAppId": "AppleTVPlus",
"appId": "AppleTVPlus",
"activationStatus": "pending_activation"
}
]
},
"offerDetails": [
{
"offerDetails": {
"publisher": "Apple",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream",
"offerCode": "EPO-90-200008",
"displayName": "MLS Monthly Subscription",
"description": "SPORTS - MLS Monthly Subscription ALC",
"offerType": "ProductOffer",
"productType": "Feature",
"productFamily": "MLS",
"familyProductRank": 0,
"associatedProduct": "EPP-80-400007",
"source": "xcp",
"childrenProducts": [
{
"productId": "EPC-NOWTV",
"productType": "FEATURE",
"productName": "NOWTV",
"durableAppId": "Comcast_StreamApp",
"appId": "Xfinity Stream"
}
]
},
"price": {
"listPrice": 14.99,
"currency": "USD",
"chargeType": "RECURRING",
"chargeFrequency": "MONTHLY",
"installments": 0,
"quantity": 0,
"stepped": false,
"priceTerms": 0,
"steppedTermsFrom": 0,
"steppedTermsTo": 0
},
"offerPresentation": {
"displayName": "Apple TV+",
"publisherAppName": "Apple TV",
"localizedTermsAndConditions": [
{
"locale": "en",
"terms": "Subscribe to MLS Season Pass (Monthly) for $14.99 per month. Plan automatically renews until canceled. Cancel anytime at xumo.com/subscriptions at least a day before each renewal date. You will not be charged during the calendar months December and January. Pricing subject to change. Taxes and fees extra. To access MLS content, activation of an Apple account is required."
}
],
"localizedConfirmation": [
{
"locale": "en",
"confirmationMessage": "Congrats for your new subscription to MLS Season Pass, you are ready to enjoy soccer as never before. Please remember to activate your subscription."
}
],
"localizedTitle": [
{
"locale": "en",
"title": "Get the Apple TV+ app, home of Apple Originals and MLS Season Pass."
}
],
"localizedDescription": [
{
"locale": "en",
"description": "Easily add and manage Apple TV+ and MLS Season Pass with Xumo."
}
],
"localizedHighlights": [
{
"locale": "en",
"higlights": [
"Full HD video resolution",
"MLS updates, live events, and more",
"All remaining matches for the 2023 season, including playoffs"
]
}
],
"localizedChannels": [
{
"locale": "en",
"channels": "A&E, Afro, AMC, Animal Planet, BBC America, BBC News, Comedy TV, Cooking Channel, Crime + Investigation, Discovery Channel, Discovery Life, Food Network, FYI, Get TV, Great American Family, Great American Living, GSN, Hallmark Channel, Hallmark Drama, Hallmark Movie Mysteries, HGTV, History, ID, IFC, Justice Central TV, Lifetime, LMN, Magnolia Network, Military History, Motortrend, OWN, Pursuit, Recipe TV, SCI, Sony Movies, Sundance Channel, The Weather Channel, TLC, Travel Channel, Vice, We TV"
}
],
"offerImageDetails": [
{
"offerImage": {
"imageType": "ImageURL",
"imageUrl": "https://assets.xfinity.com/assets/dotcom/flex/mls_seasonpass.svg"
}
}
],
"offerFooter": [
{
"locale": "en",
"footer": [
"Do you have a subscription already?, just say \"Apple TV\" on your remote control",
"Or, just go to the Subscription App to manage it"
]
}
],
"offPlatformSubscription": true,
"offPlatformHandoffDetails": {
"offPlatformCodeUrl": "http://xumo.com/subscribe/EPO-90-200008",
"offPlatformHandoffDescription": [
{
"locale": "en",
"higlights": [
"Scan the QR code and continue your subscription on the portal"
]
}
]
}
}
}
]
}
}
{
"errorCode" : "",
"errorMessage" : "",
"severity" : ""
}
Coming soon