Get a list of entitlements for a customerIdentifier, matching specific criteria

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerIdentifier": "4407123456789"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({customerIdentifier: '4407123456789'})
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report"

payload = { "customerIdentifier": "4407123456789" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success",
  "entitlements": [
    {
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateActivated": "2023-11-07T05:31:56Z",
      "dateExpiry": "0001-01-01T00:00:00Z",
      "dateAutoSuspend": null,
      "dateFailed": "0001-01-01T00:00:00Z",
      "dateEnded": "0001-01-01T00:00:00Z",
      "dateSuspended": null,
      "dateResumed": null,
      "entitlementId": "<string>",
      "activationCode": null,
      "customerIdentifier": "4407123456789",
      "productKey": "BangoMusic",
      "entitlementDisplayName": "30 days Bango music",
      "offerKey": null,
      "merchantAccountKey": "Bango",
      "status": "ACTIVE",
      "externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
      "extensionDataList": {},
      "extraInformation": {
        "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": "Firefox"
        },
        "communicationInformation": {
          "emailAddress": "123@abc.co.uk",
          "msisdn": "441234567890"
        },
        "source": {
          "channelType": "WEB_PROMOTION",
          "campaignRef": "SUMMER_PROMO",
          "referrer": "SEARCH_ENGINE",
          "bundleId": "BundleABC123",
          "country": "United Kingdom",
          "region": "East Anglia",
          "brand": "BrandABC",
          "serviceFlow": "Creation"
        }
      },
      "financeData": {
        "source": "Merchant",
        "type": "order",
        "timestamp": "2023-11-07T05:31:56Z",
        "retailCurrency": "<string>",
        "retailPrice": 123,
        "retailPriceTax": 123,
        "offerPrice": 123,
        "offerPriceTax": 123,
        "notes": "<string>"
      }
    }
  ]
}

POST

https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23

entitlement

report

Get a list of entitlements for a customerIdentifier, matching specific criteria

curl --request POST \
  --url https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerIdentifier": "4407123456789"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({customerIdentifier: '4407123456789'})
};

fetch('https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/Reseller-API/1.0.23/v1/entitlement/report"

payload = { "customerIdentifier": "4407123456789" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success",
  "entitlements": [
    {
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateActivated": "2023-11-07T05:31:56Z",
      "dateExpiry": "0001-01-01T00:00:00Z",
      "dateAutoSuspend": null,
      "dateFailed": "0001-01-01T00:00:00Z",
      "dateEnded": "0001-01-01T00:00:00Z",
      "dateSuspended": null,
      "dateResumed": null,
      "entitlementId": "<string>",
      "activationCode": null,
      "customerIdentifier": "4407123456789",
      "productKey": "BangoMusic",
      "entitlementDisplayName": "30 days Bango music",
      "offerKey": null,
      "merchantAccountKey": "Bango",
      "status": "ACTIVE",
      "externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
      "extensionDataList": {},
      "extraInformation": {
        "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": "Firefox"
        },
        "communicationInformation": {
          "emailAddress": "123@abc.co.uk",
          "msisdn": "441234567890"
        },
        "source": {
          "channelType": "WEB_PROMOTION",
          "campaignRef": "SUMMER_PROMO",
          "referrer": "SEARCH_ENGINE",
          "bundleId": "BundleABC123",
          "country": "United Kingdom",
          "region": "East Anglia",
          "brand": "BrandABC",
          "serviceFlow": "Creation"
        }
      },
      "financeData": {
        "source": "Merchant",
        "type": "order",
        "timestamp": "2023-11-07T05:31:56Z",
        "retailCurrency": "<string>",
        "retailPrice": 123,
        "retailPriceTax": 123,
        "offerPrice": 123,
        "offerPriceTax": 123,
        "notes": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication

Headers

X-RequestIdentifier

string

Request unique identifier. If present, this id will be used for idempotency.

Body

application/json

The report filters JSON.

List of filters applied to retrieve a list of existing entitlements

customerIdentifier

string

required

User unique identifier.

Example:

"4407123456789"

productKey

string

Entitlement product unique identifier. For example, "BangoMusic".

Example:

"BangoMusic"

status

string

Entitlement status. Possible values are:

"ACTIVE": The entitlement has been successfully activated
"CANCELLED": The entitlement has been cancelled.
"REVOKED": The entitlement has been revoked. This usually happens on fraud and user contract termination cases
"SUSPENDED": The entitlement has been suspended.
"PENDING": The entitlement has been initiated, but the user has not yet finalized the activation process
"FAILED": The entitlement failed

Example:

"ACTIVE"

Response

Retrieval successful

responseCode

string

Example:

"OK"

responseMessage

string

Example:

"Success"

entitlements

object[]

Show child attributes

General

Reseller

Merchant

End of Life

Get a list of entitlements for a customerIdentifier, matching specific criteria

Authorizations

Headers

Body

Response