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

List subscriptions by paypoint

GET
/Query/subscriptions/:entry
GET
/api/Query/subscriptions/:entry
$curl -G https://api-sandbox.payabli.com/api/Query/subscriptions/8cfec329267 \
>     -H "requestToken: <apiKey>" \
>     -d fromRecord=251 \
>     -d limitRecord=0 \
>     -d sortBy=desc(field_name)
1{
2  "Records": {
3    "CreatedAt": "2023-12-14T08:51:10Z",
4    "Customer": {
5      "AdditionalData": "AdditionalData",
6      "BillingAddress1": "68 Golden Drive",
7      "BillingAddress2": "",
8      "BillingCity": "Johnson City",
9      "BillingCountry": "US",
10      "BillingEmail": "company@payabli.com",
11      "BillingPhone": "",
12      "BillingState": "TN",
13      "BillingZip": "37612",
14      "CompanyName": "Sunshine LLC",
15      "CreatedAt": "2023-01-16T11:00:52Z",
16      "customerId": 1323,
17      "CustomerId": 4440,
18      "CustomerNumber": "1234",
19      "customerStatus": 1,
20      "FirstName": "Lisandra",
21      "Identifiers": [
22        "\\\"firstname\\\"",
23        "\\\"lastname\\\"",
24        "\\\"email\\\""
25      ],
26      "LastName": "Smitch",
27      "ShippingAddress1": "68 Golden Drive",
28      "ShippingCity": "Johnson City",
29      "ShippingCountry": "US",
30      "ShippingState": "TN",
31      "ShippingZip": "37612"
32    },
33    "EndDate": "2026-03-20T00:00:00Z",
34    "EntrypageId": 0,
35    "ExternalPaypointID": "f743aed24a-10",
36    "FeeAmount": 0,
37    "Frequency": "monthly",
38    "IdSub": 580,
39    "InvoiceData": {
40      "AdditionalData": "AdditionalData",
41      "frequency": "one-time",
42      "invoiceAmount": 100,
43      "invoiceNumber": "QA-1702561870",
44      "invoiceStatus": 1,
45      "invoiceType": 1,
46      "items": [
47        {
48          "itemCost": 10,
49          "itemDescription": "service",
50          "itemMode": 1,
51          "itemProductName": "Mat replacement",
52          "itemQty": 5,
53          "itemTotalAmount": 50
54        },
55        {
56          "itemCost": 5,
57          "itemDescription": "service",
58          "itemMode": 1,
59          "itemProductName": "Mat clean",
60          "itemQty": 10,
61          "itemTotalAmount": 50
62        }
63      ]
64    },
65    "LastRun": "2024-01-02T14:32:11Z",
66    "LastUpdated": "2023-12-14T08:51:10Z",
67    "LeftCycles": 20,
68    "Method": "card",
69    "NetAmount": 10,
70    "NextDate": "2024-07-20T00:00:00Z",
71    "ParentOrgName": "FitnessManager",
72    "PaymentData": {
73      "AccountExp": "0924",
74      "AccountType": "unknown",
75      "AccountZip": "90210",
76      "binData": {
77        "binCardBrand": "Visa",
78        "binCardCategory": "PLATINUM",
79        "binCardIssuer": "Bank of Example",
80        "binCardIssuerCountry": "United States",
81        "binCardIssuerCountryCodeA2": "US",
82        "binCardIssuerCountryNumber": 840,
83        "binCardType": "Credit",
84        "binMatchedLength": 6
85      },
86      "HolderName": "Mr. Michael Abernathy",
87      "Initiator": "payor",
88      "MaskedAccount": "2222 4XXXXXX0010",
89      "paymentDetails": {
90        "totalAmount": 100,
91        "currency": "USD",
92        "serviceFee": 0
93      },
94      "Sequence": "subsequent",
95      "StoredMethodUsageType": "subscription"
96    },
97    "PaypointDbaname": "Athlete Factory LLC",
98    "PaypointEntryname": "473ac58b0",
99    "PaypointId": 10,
100    "PaypointLegalname": "Athlete Factory LLC",
101    "PlanId": 1,
102    "StartDate": "2024-07-20T00:00:00Z",
103    "SubEvents": [
104      {
105        "description": "created",
106        "eventTime": "2023-12-14T13:51:10Z",
107        "refData": "00-3470dfe2658b492811630255602f3fb5-d06fe0f72110000-00"
108      },
109      {
110        "description": "updated",
111        "eventTime": "2023-12-15T10:30:00Z",
112        "refData": "01-1234abcde6789fghij4567klmnopqr89-abcdefghi12345678-01",
113        "source": "web app"
114      }
115    ],
116    "SubStatus": 1,
117    "TotalAmount": 100,
118    "TotalCycles": 20,
119    "UntilCancelled": false
120  },
121  "Summary": {
122    "pageIdentifier": "XXXXXXXXXXXXXXXXXXX",
123    "pageSize": 20,
124    "totalAmount": 150.22,
125    "totalNetAmount": 150.22,
126    "totalPages": 1,
127    "totalRecords": 2
128  }
129}
Returns a list of subscriptions for a single paypoint. Use filters to limit results.
Was this page helpful?
Previous

List subscriptions by organization

Next

Authentication

requestTokenstring
API Key authentication via header

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Query parameters

fromRecordintegerOptionalDefaults to 0
The number of records to skip before starting to collect the result set.
limitRecordintegerOptionalDefaults to 20

Max number of records to return for the query. Use 0 or negative value to return all records.

parametersmap from strings to optional stringsOptional
Collection of field names, conditions, and values used to filter the query. <Info> **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20 should become: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20 </Info> See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for more information. **List of field names accepted:** - `startDate` (gt, ge, lt, le, eq, ne) - `endDate` (gt, ge, lt, le, eq, ne) - `nextDate` (gt, ge, lt, le, eq, ne) - `frequency` (in, nin, ne, eq) - `method` (in, nin, eq, ne) - `totalAmount` (gt, ge, lt, le, eq, ne) - `netAmount` (gt, ge, lt, le, eq, ne) - `feeAmount` (gt, ge, lt, le, eq, ne) - `status` (in, nin, eq, ne) - `untilcancelled` (eq, ne) - `payaccountLastfour` (nct, ct) - `payaccountType` (ne, eq, in, nin) - `payaccountCurrency` (ne, eq, in, nin) - `customerFirstname` (ct, nct, eq, ne) - `customerLastname` (ct, nct, eq, ne) - `customerName` (ct, nct) - `customerId` (eq, ne) - `customerNumber` (ct, nct, eq, ne) - `customerCompanyname` (ct, nct, eq, ne) - `customerAddress` (ct, nct, eq, ne) - `customerCity` (ct, nct, eq, ne) - `customerZip` (ct, nct, eq, ne) - `customerState` (ct, nct, eq, ne) - `customerCountry` (ct, nct, eq, ne) - `customerPhone` (ct, nct, eq, ne) - `customerEmail` (ct, nct, eq, ne) - `customerShippingAddress` (ct, nct, eq, ne) - `customerShippingCity` (ct, nct, eq, ne) - `customerShippingZip` (ct, nct, eq, ne) - `customerShippingState` (ct, nct, eq, ne) - `customerShippingCountry` (ct, nct, eq, ne) - `orgId` (eq) - `paypointId` (ne, eq) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) - `externalPaypointId` (ct, nct, ne, eq) - `subId` (eq, ne) - `orderDescription` (ct, nct) - `cycles` (eq, ne, gt, ge, lt, le) - `leftcycles` (eq, ne, gt, ge, lt, le) - `createdAt` (eq, ne, gt, ge, lt, le) - `updatedOn` (eq, ne, gt, ge, lt, le) - `invoiceNumber` (ct, nct) - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name **List of comparison operators accepted:** - `eq` or empty => equal - `gt` => greater than - `ge` => greater or equal - `lt` => less than - `le` => less or equal - `ne` => not equal - `ct` => contains - `nct` => not contains - `in` => inside array - `nin` => not inside array
sortBystringOptional

The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.

Response

Success
Recordsobject
Summaryobject

Errors

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

Collection of field names, conditions, and values used to filter the query.

You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.

Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.

For example:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

See Filters and Conditions Reference for more information.

List of field names accepted:

  • startDate (gt, ge, lt, le, eq, ne)
  • endDate (gt, ge, lt, le, eq, ne)
  • nextDate (gt, ge, lt, le, eq, ne)
  • frequency (in, nin, ne, eq)
  • method (in, nin, eq, ne)
  • totalAmount (gt, ge, lt, le, eq, ne)
  • netAmount (gt, ge, lt, le, eq, ne)
  • feeAmount (gt, ge, lt, le, eq, ne)
  • status (in, nin, eq, ne)
  • untilcancelled (eq, ne)
  • payaccountLastfour (nct, ct)
  • payaccountType (ne, eq, in, nin)
  • payaccountCurrency (ne, eq, in, nin)
  • customerFirstname (ct, nct, eq, ne)
  • customerLastname (ct, nct, eq, ne)
  • customerName (ct, nct)
  • customerId (eq, ne)
  • customerNumber (ct, nct, eq, ne)
  • customerCompanyname (ct, nct, eq, ne)
  • customerAddress (ct, nct, eq, ne)
  • customerCity (ct, nct, eq, ne)
  • customerZip (ct, nct, eq, ne)
  • customerState (ct, nct, eq, ne)
  • customerCountry (ct, nct, eq, ne)
  • customerPhone (ct, nct, eq, ne)
  • customerEmail (ct, nct, eq, ne)
  • customerShippingAddress (ct, nct, eq, ne)
  • customerShippingCity (ct, nct, eq, ne)
  • customerShippingZip (ct, nct, eq, ne)
  • customerShippingState (ct, nct, eq, ne)
  • customerShippingCountry (ct, nct, eq, ne)
  • orgId (eq)
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • externalPaypointId (ct, nct, ne, eq)
  • subId (eq, ne)
  • orderDescription (ct, nct)
  • cycles (eq, ne, gt, ge, lt, le)
  • leftcycles (eq, ne, gt, ge, lt, le)
  • createdAt (eq, ne, gt, ge, lt, le)
  • updatedOn (eq, ne, gt, ge, lt, le)
  • invoiceNumber (ct, nct)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

List of comparison operators accepted:

  • eq or empty => equal
  • gt => greater than
  • ge => greater or equal
  • lt => less than
  • le => less or equal
  • ne => not equal
  • ct => contains
  • nct => not contains
  • in => inside array
  • nin => not inside array