Get an entitlement

Get an entitlement

curl --request GET \
  --url https://resale.api.sandbox.bango.com/v1/entitlement/{entitlementId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://resale.api.sandbox.bango.com/v1/entitlement/{entitlementId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "customerIdentifier": "4407123456789",
  "sharedCustomerId": "414b3019-0c28-4d14-9c5f-6217b8bd1e3e",
  "bangoUserId": "2147483647",
  "productKey": "BangoMusic",
  "entitlementDisplayName": "30 days Bango music",
  "offerKey": null,
  "merchantAccountKey": "BANGO",
  "activationCode": null,
  "dateCreated": "2020-06-22T17:35:38.92Z",
  "dateActivated": "0001-01-01T00:00:00Z",
  "dateExpiry": "0001-01-01T00:00:00Z",
  "dateAutoSuspend": null,
  "dateEnded": "0001-01-01T00:00:00Z",
  "dateFailed": "0001-01-01T00:00:00Z",
  "responseCode": "OK",
  "responseMessage": "Success",
  "status": "ACTIVE",
  "externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
  "extensionData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "parameters": null,
  "extraInformation": {
    "communicationInformation": {
      "emailAddress": "123@abc.co.uk",
      "msisdn": "441234567890"
    },
    "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"
    },
    "source": {
      "channelType": "Website",
      "campaignRef": "SUMMER_PROMO",
      "referrer": "SEARCH_ENGINE",
      "bundleId": "BundleABC123",
      "country": "United Kingdom",
      "region": "East Anglia",
      "brand": "BrandABC"
    }
  },
  "financeData": {
    "source": "Merchant",
    "type": "order",
    "timestamp": "2021-10-18T11:09:44Z"
  }
}

GET

entitlement

{entitlementId}

Get an entitlement

curl --request GET \
  --url https://resale.api.sandbox.bango.com/v1/entitlement/{entitlementId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://resale.api.sandbox.bango.com/v1/entitlement/{entitlementId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entitlementId": "a25100b8-4e0c-4e37-b921-cac9cb1e930f",
  "customerIdentifier": "4407123456789",
  "sharedCustomerId": "414b3019-0c28-4d14-9c5f-6217b8bd1e3e",
  "bangoUserId": "2147483647",
  "productKey": "BangoMusic",
  "entitlementDisplayName": "30 days Bango music",
  "offerKey": null,
  "merchantAccountKey": "BANGO",
  "activationCode": null,
  "dateCreated": "2020-06-22T17:35:38.92Z",
  "dateActivated": "0001-01-01T00:00:00Z",
  "dateExpiry": "0001-01-01T00:00:00Z",
  "dateAutoSuspend": null,
  "dateEnded": "0001-01-01T00:00:00Z",
  "dateFailed": "0001-01-01T00:00:00Z",
  "responseCode": "OK",
  "responseMessage": "Success",
  "status": "ACTIVE",
  "externalEntitlementId": "124130d2-2cbc-45a1-ab9b-dfa8b67a2e63",
  "extensionData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "parameters": null,
  "extraInformation": {
    "communicationInformation": {
      "emailAddress": "123@abc.co.uk",
      "msisdn": "441234567890"
    },
    "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"
    },
    "source": {
      "channelType": "Website",
      "campaignRef": "SUMMER_PROMO",
      "referrer": "SEARCH_ENGINE",
      "bundleId": "BundleABC123",
      "country": "United Kingdom",
      "region": "East Anglia",
      "brand": "BrandABC"
    }
  },
  "financeData": {
    "source": "Merchant",
    "type": "order",
    "timestamp": "2021-10-18T11:09:44Z"
  }
}

Authorizations

x-api-key

string

header

required

Headers

X-RequestIdentifier

string<uuid>

Optional identifier to support idempotency

Path Parameters

entitlementId

string<uuid>

required

The Bango entitlementId generated when the entitlement is created

Response

Entitlement retrieved successfully

entitlementId

string

Unique identifier representing a specific entitlement

customerIdentifier

string

Unique, immutable user identifier

Example:

"123456789"

sharedCustomerId

string<uuid>

Bango generated id shared between reseller and merchant for this customer (contact support for setup)

Example:

"db2001b5-fde5-4654-9ecd-b3b04ba8f025"

merchantAccountKey

string

Unique identifier for the content provider

Example:

"BANGO_US"

productKey

string

Unique identifier for the product/offer

Example:

"MUSIC"

notificationUrl

string<url>

The endpoint where Bango will send all notifications regarding this entitlement

Example:

"https://notifications.bango.com"

offerKey

string

Entitlement offer identifier

Example:

"BUNDLE"

externalEntitlementId

string

Unique identifier for the entitlement provided by the reseller. If the previous attempt to create an entitlement failed, this value can be reused.

Example:

"124130d2-2cbc-45a1-ab9b-dfa8b67a2e63"

entitlementDisplayName

string

Entitlement display name used in reports.

Example:

"30 day free trial for Bango Music"

dateCreated

string<date>

Timestamp for the creation of the entitlement

Example:

"2024-06-22T17:35:38.920Z"

dateActivated

string<Date>

Timestamp provided by the content provider when the entitlement is activated

Example:

"2024-06-23T17:35:38.920Z"

dateEnded

string<date>

Timestamp for when the entitlement terminated

Example:

"1901-01-01T00:00:00.000Z"

dateSuspended

string<date>

Timestamp for when the entitlement was suspended

Example:

null

dateResumed

string<date>

Timestamp for when the entitlement was last resumed

Example:

null

dateExpiry

string<date>

If set, Bango will schedule a termination request to the content provider on this date. Date format must be ISO 8601

Example:

"2024-12-05T07:46:52.000Z"

dateAutoSuspend

string<date>

If set, Bango will schedule a suspension request to the content provider on this date. Date format must be ISO 8601

Example:

"2024-09-05T07:46:52.000Z"

responseCode

string

Example:

"OK"

responseMessage

string

Example:

"Success"

status

enum<string>

The entitlement status. Possible values are:

PENDING: The entitlement has been initiated, but the user has not yet completed the activation process.
ACTIVE: The entitlement has been successfully activated
SUSPENDED: The entitlement has been suspended.
ACTIVE-ENDING: The entitlement is ending at the end of the current period.
CANCELLED: The entitlement has been cancelled.
REVOKED: The entitlement has been revoked.

Available options:

PENDING,

ACTIVE,

SUSPENDED,

ACTIVE-ENDING,

CANCELLED,

REVOKED

Example:

"ACTIVE"

activationCode

string

Code or token used for the entitlement activation

Example:

null

parameters

object

Show child attributes

extensionData

object

Custom key value pairs

Show child attributes

extraInformation

object

Show child attributes

DVM APIs

Products

Offers

Consumer Offers

Entitlements

Notifications

Eligibility

Charge

Testing

Authorizations

Headers

Path Parameters

Response