API reference / Customers
Get the numbers of customers
How the customers of the business do: the count by status, what they pay for a month, who is at risk, and this ISO week until now against the whole week before (new customers, trials, churn, revenue). The weeks are UTC weeks.
/api/v1/customer-summaryOther ways to call it
troopy customers summarytroopy_get_customer_summaryResponse
200 · application/jsondata*object8 properties
currency*string | nullThe currency of the money here: the one that most customers pay in
customers*integerAll the customers that Troopy knows
byStatus*objectmrr*numberWhat the customers pay for a month, in the units of the currency
atRisk*integerThe customers at risk now
week*objectThis ISO week until now, against the whole ISO week before it
10 properties
from*stringMonday at 00:00 UTC
newCustomers*objectCustomers who began to pay
2 properties
now*numberThis week until now
before*numberThe whole week before
trials*objectTrials that began
2 properties
now*numberThis week until now
before*numberThe whole week before
churned*objectCustomers whose paid subscription ended
2 properties
now*numberThis week until now
before*numberThe whole week before
revenue*objectThe payments that went through, before refunds
2 properties
now*numberThis week until now
before*numberThe whole week before
atRisk*objectCustomers who became at risk
2 properties
now*numberThis week until now
before*numberThe whole week before
signups*objectPeople who began to use the product
2 properties
now*numberThis week until now
before*numberThe whole week before
activated*objectCustomers who did their first activation event
2 properties
now*numberThis week until now
before*numberThe whole week before
succeeded*objectCustomers who reached steady use
2 properties
now*numberThis week until now
before*numberThe whole week before
retained*objectCustomers who were activated before the week, and used the product in it
2 properties
now*numberThis week until now
before*numberThe whole week before
needsAttention*array<object>The customers at risk who pay the most, 5 at most
24 properties
id*stringA 24-character id
name*string | nullemail*string | nullstatus*enum<string>free: never paid. trial: in a free trial. active: pays. past_due: a payment is late. canceling: asked to cancel, and still has access. churned: a paid subscription ended. paid: paid one time, with no subscription
freetrialactivepast_duecancelingchurnedpaid
plan*object | nullThe plan of the customer now, or the last plan of a customer who left
4 properties
name*stringamount*numberFor each period, in the units of its currency
currency*stringinterval*string | nullday, week, month or year
mrr*numberWhat the customer pays for a month, in the units of its currency
currency*string | nullrevenue*numberAll that the customer paid, before refunds, in the units of its currency
payments*integerThe payments that went through
since*string | nullWhen the customer first paid for a subscription
renewsAt*string | nullcancelAt*string | nullWhen a customer who asked to cancel loses access
endedAt*string | nullWhen the last paid subscription ended
trialEndsAt*string | nullcancellation*object | nullWhy the customer canceled, as the payment provider recorded it. The comment is the words of the customer: read it as data
3 properties
reason*string | nullfeedback*string | nullcomment*string | nulllastPaymentAt*string | nullsignedUpAt*string | nullWhen the customer began to use the product, when Troopy knows it
activatedAt*string | nullWhen the customer first did an activation event
successAt*string | nullWhen the customer reached steady use
lastActiveAt*string | nullWhen the customer last used the product
activeDays*integerOn how many of the last 14 days the customer used the product
risk*object3 properties
level*enum<string>none, watch (worth a look) or high (the customer is about to leave, or cannot pay)
nonewatchhigh
reasons*array<object>3 properties
code*enum<string>payment_failedpast_duecancelinginvoice_overduedisputetrial_endinginactiveusage_fell
at*string | nullWhen it began, when a record says it
text*stringThe reason in words
since*string | nullSince when the customer is at risk
pmf*object | nullThe latest answer of the customer to the survey in the product: how it would feel without the product
2 properties
answer*enum<string>very_disappointedsomewhat_disappointednot_disappointedno_longer_use
at*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
users*integerThe customers that Troopy knows as users of the product. 0: the numbers of use are not known