Count paying customers, first-time payers, and completed invoice sales. Use this report for your Telegram subscription bot or Discord subscription bot project.
GET/v2/projects/{project_id}/analytics/customers
Authorization
Bearer API KeyRequired
API key scope:analytics:charts:read for restricted keys. Unrestricted project keys also support this endpoint.
Path Parameters
project_idstringrequired
Project UUID.
Query Parameters
fromstring
First UTC calendar day, YYYY-MM-DD; default to minus 29 days.
tostring
Last UTC calendar day inclusive, YYYY-MM-DD; default today.
intervalstring
day (default), week (ISO Monday start), or month (calendar).
Dates must be real calendar days between 2000-01-01 and 2099-12-31, with from no later than to and at most 366 days inclusive. Unknown query parameters are rejected. There is no request body. See the shared analytics date, money, and cache rules.
Customers are distinct within each bucket and across the window. Overall paying customers need not equal the sum of bucket counts. A customer is new only at their first completed invoice payment ever. Balance top-ups and unfinished payments do not make someone a returning payer.