For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Status PageContact sales
HomePlatform OverviewAPI ReferenceIntegration GuidesUI GuidesChangelog
HomePlatform OverviewAPI ReferenceIntegration GuidesUI GuidesChangelog
  • Using the API
    • API overview
    • API responses
    • Postman collection
  • API reference
        • POSTCreate subscription
        • GETGet subscription
        • PUTUpdate subscription
        • DELDelete subscription
        • GETList subscriptions by paypoint
        • GETList subscriptions by organization
        • GETExport subscriptions by paypoint
        • GETExport subscriptions by org
        • GETGet subscription stats
LogoLogo
Status PageContact sales
API referencePay In endpointsSubscriptions

Get subscription stats

GET
/Statistic/subscriptions/:interval/:level/:entryId
GET
/api/Statistic/subscriptions/:interval/:level/:entryId
$curl https://api-sandbox.payabli.com/api/Statistic/subscriptions/interval/1/1000000 \
>     -H "requestToken: <apiKey>"
1[
2  {
3    "additionalProperties": {
4      "key": "value"
5    },
6    "inACHReturns": 1,
7    "inACHReturnsVolume": 1.1,
8    "inACHTransactions": 1,
9    "inACHVolume": 1.1,
10    "inCardChargeBacks": 1,
11    "inCardChargeBackVolume": 1.1,
12    "inCardTransactions": 1,
13    "inCardVolume": 1.1,
14    "inCashTransactions": 1,
15    "inCashVolume": 1.1,
16    "inCheckTransactions": 1,
17    "inCheckVolume": 1.1,
18    "inCustomers": 1,
19    "inNewCustomers": 1,
20    "inSubscriptionsPaid": 1,
21    "inSubscriptionsPaidVolume": 1.1,
22    "inTransactions": 1,
23    "inTransactionsVolume": 1.1,
24    "outACHTransactions": 1,
25    "outACHVolume": 1.1,
26    "outCardTransactions": 1,
27    "outCardVolume": 1.1,
28    "outCheckTransactions": 1,
29    "outCheckVolume": 1.1,
30    "outCustomers": 1,
31    "outNewCustomers": 1,
32    "outSubscriptionsPaid": 1,
33    "outSubscriptionsPaidVolume": 1.1,
34    "outTransactions": 1,
35    "outTransactionsVolume": 1.1,
36    "outVCardTransactions": 1,
37    "outVCardVolume": 1.1,
38    "statX": "statX"
39  }
40]
Retrieves the subscription statistics for a given interval for a paypoint or organization.
Was this page helpful?
Previous

Tokenize payment method

Next

Authentication

requestTokenstring
API Key authentication via header

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

Query parameters

parametersmap from strings to optional stringsOptional
List of parameters

Response

Success
additionalPropertiesany
inACHReturnsinteger
inACHReturnsVolumedouble
inACHTransactionsinteger
inACHVolumedouble
inCardChargeBacksinteger
inCardChargeBackVolumedouble
inCardTransactionsinteger
inCardVolumedouble
inCashTransactionsinteger
inCashVolumedouble
inCheckTransactionsinteger
inCheckVolumedouble
inCustomersinteger
inNewCustomersinteger
inSubscriptionsPaidinteger
inSubscriptionsPaidVolumedouble
inTransactionsinteger
inTransactionsVolumedouble
outACHTransactionsinteger
outACHVolumedouble
outCardTransactionsinteger
outCardVolumedouble
outCheckTransactionsinteger
outCheckVolumedouble
outCustomersinteger
outNewCustomersinteger
outSubscriptionsPaidinteger
outSubscriptionsPaidVolumedouble
outTransactionsinteger
outTransactionsVolumedouble
outVCardTransactionsinteger
outVCardVolumedouble
statXstring

Errors

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

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

The entry level for the request:

  • 0 for Organization
  • 2 for Paypoint