Skip to main content
GET
Retrieve entitlement by merchant entitlement id

Authorizations

Authorization
string
header
required

Basic authentication

Headers

X-RequestIdentifier
string

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

Path Parameters

merchantEntitlementId
string<uuid>
required

Unique identifier used on activation.

Response

Entitlement retrieved successfully

responseCode
string
Example:

"OK"

responseMessage
string
Example:

"Success"

requestId
string

Bango unique identifier representing an entitlement.

Example:

"981a55a5-b3a4-46dc-9fac-a86227b26344"

bangoUserId
string

User unique identifier.

Example:

"1549053185"

sharedCustomerId
string<uuid>

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

Example:

"414b3019-0c28-4d14-9c5f-6217b8bd1e3e"

productId
string

Entitlement product unique identifier. For example, "30_DAYS_MUSIC".

Example:

"30_DAYS_MUSIC"

offerId
string

The offer given to the user for the merchant service. For example, "FREE_FOR_6_MONTHS".

Example:

"FREE_FOR_6_MONTHS"

resellerId
string

Unique reseller identifier

Example:

"XYZ_RESELLER"

status
enum<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
  • "ACTIVE-ENDING": The entitlement is ending at the end of the current period.
Available options:
ACTIVE,
CANCELLED,
REVOKED,
SUSPENDED,
PENDING,
FAILED,
ACTIVE-ENDING
customerId
string

Unique identifier representing a specific customer of the reseller not anonymised. This value will only be sent by Bango if the Merchant and Reseller both approve the sharing of this data

dateCreated
string<date-time>

Date and time when the entitlement was created, in UTC ISO 8601 format (yyyy-MM-ddThh:mm:ssZ)

dateActivated
string<date-time>

Date and time when the entitlement was activated, in UTC ISO 8601 format (yyyy-MM-ddThh:mm:ssZ)

dateExpiry
string<date-time>

Entitlement expiry date in UTC ISO 8601 format. Null if no expiry (yyyy-MM-ddThh:mm:ssZ)

Example:

null

dateEnded
string<date-time>

Date and time when the entitlement ended due to termination, in UTC ISO 8601 format (yyyy-MM-ddThh:mm:ssZ)

Example:

null

dateSuspended
string<date-time>

Date and time when the entitlement was suspended, in UTC ISO 8601. Null if status is not Suspended. format (yyyy-MM-ddThh:mm:ssZ)

Example:

null

dateResumed
string<date-time>

Date and time when the entitlement was suspended, in UTC ISO 8601. Null if the entitlement hasn't ever been resumed before. Format (yyyy-MM-ddThh:mm:ssZ)

Example:

null

dateAutoSuspend
string<date-time>

Date and time when the entitlement will be automatically suspended at the request of the reseller, in UTC ISO 8601. Null if date is not set. format (yyyy-MM-ddThh:mm:ssZ)

Example:

null

merchantExtensionData
object
Example:
extraInformation
object
financeData
object
merchantBangoExtensionData
object
Example: