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.
POST
Terminate Entitlement
Authorizations
Body
application/json
The entitlement revoke JSON.
To determine if the termination is effective immediatly.
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
Example:
"FRAUD"
Bango generated id shared between reseller and merchant for this customer (contact support for setup)
Example:
"414b3019-0c28-4d14-9c5f-6217b8bd1e3e"
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.
Available options:
ACTIVE, SUSPENDED, PENDING, ACTIVE-ENDING Example:
"PENDING"

