Skip to navigation
APIPay In endpointsSubscriptions

Get subscription stats

View as MarkdownOpen in Claude

Retrieves subscription statistics for a paypoint or organization, bucketed by how soon active subscriptions are due to renew. This is a forward-looking forecast of upcoming renewals, not charges already taken. Request a single window with interval, or all to return every window in one call.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

entryIdlongRequired
Identifier in Payabli for the entity.
intervalstringRequired

Interval to get the data. Allowed values:

  • all - all intervals
  • 30 - 1-30 days
  • 60 - 31-60 days
  • 90 - 61-90 days
  • plus - +90 days
levelintegerRequired

The entry level for the request:

  • 0 for Organization
  • 2 for Paypoint

Response

Success
intervalstring

The renewal window this row represents: 30 (due within 30 days), 60 (31 to 60 days), 90 (61 to 90 days), or +90 (more than 90 days out). Note the response label +90 differs from its request path value plus. Requesting all returns one row per window.

countinteger

Number of active subscriptions scheduled to renew within this window. This is a forecast of upcoming renewals, not charges already taken, so it doesn't reconcile with inSubscriptionsPaid on /Statistic/basic.

volumedouble
Total value of the upcoming renewals in this window, net of fees.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error