Terminate Entitlement
Request sent to merchant to end an entitlement. The body contains a flag called “IMMEDIATE” that marks if the request is for a HARD / SOFT termination.
- Immediate = true is an instruction for the merchant to terminate the entitlement effective immediately.
- Immediate = false is an instruction for the merchant to terminate the entitlement at the end of it’s current billing lifecycle.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
Request unique identifier. This id should be used for idempotency.
Path Parameters
Unique identifier used on activation.
Body
The entitlement revoke JSON.
To determine if the termination is effective immediatly.
Determines if the termination is effective immediately. Immediate termination results in HARD edning of the subscription:
- TRUE
- FALSE
Code representing the entitlement revoke reason. This code can be any value, but we recommend you use one of the following codes:
- "FRAUD": The user has not renewed the subscription
- "ACCOUNT_TERMINATED": The user is no longer a customer
- "SECURITY": For security reasons, access to this entitlement has been terminated
- "OTHER": Other
"FRAUD"
String representing the category to which a set of reason codes belong to.
Description of the entitlement revoke reason
"Personal data stolen"
Unique identifier representing a specific customer of the reseller as a Bango anonymised value.
"1549053185"
Bango generated id shared between reseller and merchant for this customer (contact support for setup)
"414b3019-0c28-4d14-9c5f-6217b8bd1e3e"
Unique reseller identifier as agreed with the merchant
"XYZ_RESELLER"
Entitlement product unique identifier. For example, "BangoMusic".
"BangoMusic"
The offer given to the user for the merchant service. For example, "FREE_FOR_6_MONTHS".
"FREE_FOR_6_MONTHS"
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
Entitlement status. Possible values are:
- "ACTIVE": The entitlement has been successfully activated
- "SUSPENDED": The entitlement has been suspended.
- "PENDING": The entitlement has been initiated, but the user has not yet finalized the activation process.
- "ACTIVE-ENDING": The entitlement is ending at the end of the current period.
ACTIVE, SUSPENDED, PENDING, ACTIVE-ENDING "PENDING"

