Search for entitlements
curl --request POST \
--url https://resale.api.sandbox.bango.com/v1/entitlement/report \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerIdentifier": "4407123456789"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerIdentifier: '4407123456789'})
};
fetch('https://resale.api.sandbox.bango.com/v1/entitlement/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://resale.api.sandbox.bango.com/v1/entitlement/report"
payload = { "customerIdentifier": "4407123456789" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"responseCode": "OK",
"responseMessage": "Success",
"entitlements": [
{
"entitlementId": "<string>",
"customerIdentifier": "123456789",
"sharedCustomerId": "db2001b5-fde5-4654-9ecd-b3b04ba8f025",
"merchantAccountKey": "BANGO_US",
"productKey": "MUSIC",
"notificationUrl": "https://notifications.bango.com",
"offerKey": "BUNDLE",
"externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
"entitlementDisplayName": "30 day free trial for Bango Music",
"dateCreated": "2024-06-22T17:35:38.920Z",
"dateActivated": "2024-06-23T17:35:38.920Z",
"dateEnded": "1901-01-01T00:00:00.000Z",
"dateSuspended": null,
"dateResumed": null,
"dateExpiry": "2024-12-05T07:46:52.000Z",
"dateAutoSuspend": "2024-09-05T07:46:52.000Z",
"responseCode": "OK",
"responseMessage": "Success",
"status": "ACTIVE",
"activationCode": null,
"parameters": {
"Action": "NAVIGATE_TO_URL",
"Url": "https://activation-link.bango.com"
},
"extensionData": {
"customField1": "value1",
"customField2": "value2"
},
"extraInformation": {
"communicationInformation": {
"msisdn": "441234567890",
"emailAddress": "example@bango.com"
},
"clientDevice": {
"type": "STB",
"id": "bc449c9e-406f-4399-a3ff-8671a27ac410",
"typeId": "P49AJFND8NFN23NANGAJG",
"modelName": "STB Model X7",
"modelNumber": "IAH45IAOF/5",
"serialNumber": "JHFJHA43JNFA9393GFD",
"osType": "Linux",
"osVersion": "10.3.8",
"macAddress": "4A-0F-99-F2-D3-DD",
"browser": "Chrome"
},
"source": {
"channelType": "Retail",
"campaignRef": "SUMMER_PROMO",
"referrer": "SEARCH_ENGINE",
"bundleId": "BundleABC123",
"country": "United Kingdom",
"region": "CB1 3ED",
"brand": "BrandA"
}
}
}
]
}Search for entitlements
Get a list of entitlements for a customerIdentifier, matching specific criteria
POST
/
v1
/
entitlement
/
report
Search for entitlements
curl --request POST \
--url https://resale.api.sandbox.bango.com/v1/entitlement/report \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"customerIdentifier": "4407123456789"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customerIdentifier: '4407123456789'})
};
fetch('https://resale.api.sandbox.bango.com/v1/entitlement/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://resale.api.sandbox.bango.com/v1/entitlement/report"
payload = { "customerIdentifier": "4407123456789" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"responseCode": "OK",
"responseMessage": "Success",
"entitlements": [
{
"entitlementId": "<string>",
"customerIdentifier": "123456789",
"sharedCustomerId": "db2001b5-fde5-4654-9ecd-b3b04ba8f025",
"merchantAccountKey": "BANGO_US",
"productKey": "MUSIC",
"notificationUrl": "https://notifications.bango.com",
"offerKey": "BUNDLE",
"externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
"entitlementDisplayName": "30 day free trial for Bango Music",
"dateCreated": "2024-06-22T17:35:38.920Z",
"dateActivated": "2024-06-23T17:35:38.920Z",
"dateEnded": "1901-01-01T00:00:00.000Z",
"dateSuspended": null,
"dateResumed": null,
"dateExpiry": "2024-12-05T07:46:52.000Z",
"dateAutoSuspend": "2024-09-05T07:46:52.000Z",
"responseCode": "OK",
"responseMessage": "Success",
"status": "ACTIVE",
"activationCode": null,
"parameters": {
"Action": "NAVIGATE_TO_URL",
"Url": "https://activation-link.bango.com"
},
"extensionData": {
"customField1": "value1",
"customField2": "value2"
},
"extraInformation": {
"communicationInformation": {
"msisdn": "441234567890",
"emailAddress": "example@bango.com"
},
"clientDevice": {
"type": "STB",
"id": "bc449c9e-406f-4399-a3ff-8671a27ac410",
"typeId": "P49AJFND8NFN23NANGAJG",
"modelName": "STB Model X7",
"modelNumber": "IAH45IAOF/5",
"serialNumber": "JHFJHA43JNFA9393GFD",
"osType": "Linux",
"osVersion": "10.3.8",
"macAddress": "4A-0F-99-F2-D3-DD",
"browser": "Chrome"
},
"source": {
"channelType": "Retail",
"campaignRef": "SUMMER_PROMO",
"referrer": "SEARCH_ENGINE",
"bundleId": "BundleABC123",
"country": "United Kingdom",
"region": "CB1 3ED",
"brand": "BrandA"
}
}
}
]
}Authorizations
XApiKeyBasicAuthOAuth2
Headers
Optional identifier to support idempotency
Body
application/json
The report filters JSON.