Configure contract statuses

Who can use this feature?

Every account must have a value for "Status" to classify customer contracts within these groups: 

  1. Free: Non-paying account
  2. Paying: Paying account on an active subscription
  3. Canceled: Churned or disabled account

Once set, Totango updates the "Contract Status" built-in metric, which you can leverage for "change" filters to get context when values change.

Totango calculates health and other key metrics for active customers. Accounts that do not have status value set correctly will be classified as "Unknown" and will not take part in daily health calculation.

Define new contract statuses

Within the contract status groups, you can define new status values that represent your business. If your business supports a freemium model through Totango, you can also set a specific data retention policy free accounts.

An example of custom statuses include the following:

  • Free
    • Trial: Assuming your application has a free trial accounts that you are managing with Totango
    • Internal-use:  For non-production accounts, such as demos or testing tenants
  • Paying
    • Personal
    • Pro
    • Enterprise
  • Cancelled
    • Cancelled 
  1. Within Settings, expand Data Management > Data Modeler.
  2. On the Contract Status tab, click Add Contract Status.
  3. Choose the group (Free, Paying, Canceled).
  4. Add a name for the status.
  5. Click Create.

Update the status on an account

Because Status is a required field, you must choose a status when creating an account manually via data entry or via data file (e.g., CSV) or data source integration (e.g., Salesforce). You can also set the status from your web application using the Totango API. Totango users can update status like any other attribute:


You must define the status attribute as outlined under Define new contract status in order to update a status via Totango API.

Once set, the value for the built-in custom metric Contract Status is also updated. 

Was this article helpful?

2 out of 2 found this helpful

Have more questions? Submit a request