Standard reasons for suspend, cancel, revoke, and terminate

When you suspend, cancel, revoke, or terminate an entitlement, you include a reason as part of the API request. The reason is defined as both a machine-readable category and code, and a human-readable description. Bango defines a standard set of reason categories and codes: always use these categories and codes. Bango also defines some sample descriptions: you can use a more specific description if you wish. If you don’t see an appropriate reason code for the category, use OTHER. The Bango Platform may reject API requests using categories and codes not listed here.

Bango Index	Reason Category	Reason Code	Reason Description	Notes
1	`CUSTOMER_CANCELLED`	`NOT_RENEWED`	Customer has not renewed their entitlement
2	`CUSTOMER_CANCELLED`	`CHANGED_SERVICE`	Customer has changed merchant service
3	`CUSTOMER_CANCELLED`	`CUSTOMER_CANCELLED`	Customer has cancelled their addon entitlement
4	`CUSTOMER_CANCELLED`	`EXPIRED`	The entitlement reached its expiry date and it was automatically cancelled by the Bango Platform	Triggered when expiry date is set in entitlement creation
5	`CUSTOMER_CHANGED`	`CUSTOMER_CANCELLED_BUNDLE`	Customer has cancelled their bundled entitlement
6	`CUSTOMER_CHANGED`	`CUSTOMER_CANCELLED_ADDON`	Customer has cancelled their addon entitlement	Can be determined via Product Key
7	`REVOKED`	`ACCOUNT_TERMINATED`	Customer has closed their account	Can be determined via Product Key
8	`REVOKED`	`SUSPENDED_CANCEL`	Entitlement cancelled due to suspension terms
9	`CUSTOMER_CHANGED`	`CHANGED_SERVICE`	Customer has activated the service through another party
10	`ACTIVATION_ROLLBACK`	`TEST_ENTITLEMENT`	This entitlement is a test
11	`ACTIVATION_ROLLBACK`	`FRAUD`	Entitlement has been cancelled due to known fraud
12	`ACTIVATION_ROLLBACK`	`FRAUD_CHECK`	Entitlement has been cancelled due to suspected fraud	Suspend/Resume API preferred
13	`ACTIVATION_ROLLBACK`	`CUSTOMER_NOT_ELIGIBLE`	Customer is no longer eligible for the service	Edge case: eligibility checks should occur before the entitlement is created
14	`ACTIVATION_ROLLBACK`	`CUSTOMER_NOT_ELIGIBLE_TEMPORARY`	Customer is temporarily no longer eligible for the service	Edge case: eligibility checks should occur before the entitlement is created. Suspend/Resume API preferred
15	`ACTIVATION_ROLLBACK`	`CUSTOMER_PAYMENT_DEFAULT`	Customer has defaulted payment.	Supsend/Resume API preferred
16	`ACTIVATION_ROLLBACK`	`MERCHANT_ACCOUNT_CHANGED`	Customer has changed merchant account
17	`REVOKED`	`OTHER`	Reseller/Merchant to provide details
18	`REVOKED`	`OTHER`	Reason unknown
19	`REVOKED`	`ROLLBACK_ERROR`	Error during activation requires rollback
20	`REVOKED`	`ROLLBACK_CONNECT_ERROR`	Timeout during activation requires rollback
21	`REVOKED`	`PRODUCT_NO_LONGER_AVAILABLE`	Reseller or merchant no longer offers this product
22	`REVOKED`	`PARTNER_RETURN`	Partner wants to return the product license they have purchased from Bango.
23	`REVOKED`	`CUSTOMER_RETURN`	Customer wants to return the product license they have purchased from Bango.

General

Reseller

Merchant

End of Life

Standard reasons for suspend, cancel, revoke, and terminate