curl --request GET \
--url https://api.botsubscription.com/v1/endpoint \
--header 'Authorization: Bearer sk_live_•••'Payment Health
Read payment-status distributions, success rates, and current payment health. Use this report for your Telegram subscription bot or Discord subscription bot project.
Authorization
API key scope: analytics:charts:read for restricted keys. Unrestricted project keys also support this endpoint.
Path Parameters
project_idstringrequiredProject UUID.
Query Parameters
fromstringFirst UTC calendar day, YYYY-MM-DD; default to minus 29 days.
tostringLast UTC calendar day inclusive, YYYY-MM-DD; default today.
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.
Interpreting this report
Window counts use creation time and current status. Pending requests, retrying renewals, and unresolved anomalies are live gauges at generated_at, independent of the window. Success rates are null when there are no decided payments. The oldest pending creation date is null when there are no pending requests.
Use the project API authentication reference for API-key setup.