Webhooks

This section describes the structure and content of the webhook payload. It explains the data fields included in each event notification so that you can process them correctly in your application.

JSON Payload

Field name Field type Description
date String The time when the activity occurred.
type String The activity type. The value is always mrr_movement.
customer.name String The name of the customer associated with the activity.
customer.uuid String The UUID of the activity object generated by ChartMogul.
customer.email String The email address associated with this customer.
customer.status String The status of this customer. One of New Lead, Working Lead, Qualified Lead, Unqualified Lead, Active, Past Due or Cancelled.
customer.company String The customer’s company name.
customer.currency String The three-letter currency code of the currency of the customer’s MRR readings, e.g. USD, EUR, GBP. Refer to the full list of supported currencies.
customer.current_arr Integer The customer’s current ARR, expressed in cents. Divide by 100 to obtain the actual amount.
customer.current_mrr Integer The customer’s current MRR, expressed in cents. Divide by 100 to obtain the actual amount.
customer.external_id String The unique external identifier for this customer.
customer.external_ids Array of strings An array containing the unique external identifiers of all customer records that have been merged into this customer.
customer.currency_symbol String Text representation to display the currency of the customer’s MRR readings, e.g. $ or €.
customer.data_source_uuid String The ChartMogul UUID of the source of this customer.
description String The activity’s description, for example, purchased the Silver Monthly plan.
subscription.external_id String The unique identifier for the subscription associated with the activity.
movement_type String The type of the MRR movement. One of new_biz, churn, expansion, contraction or reactivation.
account_currency String The three-letter currency code of the currency associated with this ChartMogul account, e.g. USD, EUR, GBP. Refer to the full list of supported currencies.
invoice_currency String The three-letter currency code of the currency in which the invoice is billed, e.g. USD, EUR, GBP. Refer to the full list of supported currencies.
account_currency_symbol String Text representation to display the currency associated with this ChartMogul account, e.g. $ or €.
invoice_currency_symbol String Text representation to display the currency in which the invoice is billed, e.g. $ or €.
movement_amount_in_cent Integer The change in MRR as a result of the activity. May be a positive or negative number. All amounts are expressed in cents in the currency selected for your account, as an integer. Divide by 100 to obtain the actual amount.
mrr_movement_in_account_currency Integer The change in MRR as a result of the activity, expressed in cents in the currency associated with this ChartMogul account.
mrr_movement_in_invoice_currency Integer The change in MRR as a result of the activity, expressed in cents in the currency in which the invoice is billed.