Categories & Codes
When you terminate (cancel/revoke) an entitlement, you can provide a category, code and description as part of the API request. Please use the standard list of categories and codes shown below. The description can be anything you like.
| Category | Code | Definition |
|---|---|---|
| CUSTOMER_CANCELLED | NOT_RENEWED | Customer has not renewed their entitlement |
| CUSTOMER_CANCELLED | CHANGED_SERVICE | Customer has changed content provider/service |
| CUSTOMER_CANCELLED | SUBSCRIPTION_CANCELLED | Customer has cancelled the subscription |
| CUSTOMER_CANCELLED | ADDON_CANCELLED | Customer has cancelled the add-on |
| CUSTOMER_CANCELLED | EXPIRED | Scheduled cancellation by Bango (based on dateExpiry set during entitlement creation by the reseller) |
| CUSTOMER_CANCELLED | OTHER | Cancelled for any other reason |
| REVOKED | ACCOUNT_TERMINATED | Customer has closed their account with the reseller |
| REVOKED | SUSPEND_TERMINATED | Suspended entitlement has been terminated based on suspension terms |
| REVOKED | ERROR | Entitlement created/activated in error, or there was an error during the activation process |
| REVOKED | FRAUD | Immediate termination for fraud or suspected fraud reasons |
| REVOKED | IMMEDIATE_CANCELLATION | Immediate termination by the reseller scheduling end-of-period cancellations |
| REVOKED | OTHER | Revoked for any other reason |