List subscriptions by organization

GET

/Query/subscriptions/org/:orgId

GET

/api/Query/subscriptions/org/:orgId

$ curl -G https://api-sandbox.payabli.com/api/Query/subscriptions/org/123 \
>      -d fromRecord=251 \
>      -d limitRecord=0 \
>      -d sortBy=desc(field_name)

1 {
2   "Records": [
3     {
4       "EndDate": "2026-03-20T00:00:00Z",
5       "LastRun": "2024-01-02T14:32:11Z",
6       "NextDate": "2024-07-20T00:00:00Z",
7       "StartDate": "2024-07-20T00:00:00Z",
8       "StoredMethod": {
9         "IdPmethod": "6edcbb56-9c0e-4003-b3d1-99abf149ba0e",
10         "Method": "card",
11         "Descriptor": "Visa for subscriptions",
12         "MaskedAccount": "4XXXXXXX0010",
13         "ExpDate": "0924",
14         "HolderName": "Lisandra Smitch",
15         "AchSecCode": null,
16         "AchHolderType": null,
17         "IsValidatedACH": false,
18         "BIN": "",
19         "binData": {
20           "binMatchedLength": "6",
21           "binCardBrand": "Visa",
22           "binCardType": "Credit",
23           "binCardCategory": "PLATINUM",
24           "binCardIssuer": "Bank of Example",
25           "binCardIssuerCountry": "United States",
26           "binCardIssuerCountryCodeA2": "US",
27           "binCardIssuerCountryNumber": "840",
28           "binCardIsRegulated": "false",
29           "binCardUseCategory": "Consumer",
30           "binCardIssuerCountryCodeA3": "USA"
31         },
32         "ABA": "",
33         "PostalCode": "37612",
34         "MethodType": "Single Merchant",
35         "LastUpdated": "2023-12-14T08:51:10Z",
36         "CardUpdatedOn": null
37       },
38       "CreatedAt": "2023-12-14T08:51:10Z",
39       "Customer": {
40         "Identifiers": [
41           "\\\"firstname\\\"",
42           "\\\"lastname\\\"",
43           "\\\"email\\\""
44         ],
45         "FirstName": "Lisandra",
46         "LastName": "Smitch",
47         "CompanyName": "Sunshine LLC",
48         "BillingAddress1": "68 Golden Drive",
49         "BillingAddress2": "",
50         "BillingCity": "Johnson City",
51         "BillingState": "TN",
52         "BillingZip": "37612",
53         "BillingCountry": "US",
54         "BillingPhone": "",
55         "BillingEmail": "company@payabli.com",
56         "CustomerNumber": "C-90010",
57         "ShippingAddress1": "68 Golden Drive",
58         "ShippingCity": "Johnson City",
59         "ShippingState": "TN",
60         "ShippingZip": "37612",
61         "ShippingCountry": "US",
62         "customerId": 4440,
63         "customerStatus": 1,
64         "AdditionalData": null
65       },
66       "EntrypageId": 0,
67       "ExternalPaypointID": "f743aed24a-10",
68       "FeeAmount": 0,
69       "Frequency": "monthly",
70       "IdSub": 580,
71       "invoiceData": {
72         "AdditionalData": null,
73         "frequency": "onetime",
74         "invoiceAmount": 100,
75         "invoiceNumber": "INV-2345",
76         "invoiceStatus": 1,
77         "invoiceType": 1,
78         "items": [
79           {
80             "itemCost": 10,
81             "itemDescription": "service",
82             "itemMode": 1,
83             "itemProductName": "Mat replacement",
84             "itemQty": 5,
85             "itemTotalAmount": 50
86           },
87           {
88             "itemCost": 5,
89             "itemDescription": "service",
90             "itemMode": 1,
91             "itemProductName": "Mat clean",
92             "itemQty": 10,
93             "itemTotalAmount": 50
94           }
95         ]
96       },
97       "LastUpdated": "2023-12-14T08:51:10Z",
98       "LeftCycles": 20,
99       "Method": "card",
100       "NetAmount": 10,
101       "ParentOrgName": "FitnessManager",
102       "PaymentData": {
103         "AccountExp": "0924",
104         "AccountType": "unknow",
105         "AccountZip": "37612",
106         "binData": {
107           "binMatchedLength": "6",
108           "binCardBrand": "Visa",
109           "binCardType": "Credit",
110           "binCardCategory": "PLATINUM",
111           "binCardIssuer": "Bank of Example",
112           "binCardIssuerCountry": "United States",
113           "binCardIssuerCountryCodeA2": "US",
114           "binCardIssuerCountryNumber": "840",
115           "binCardIsRegulated": "false",
116           "binCardUseCategory": "Consumer",
117           "binCardIssuerCountryCodeA3": "USA"
118         },
119         "HolderName": "Lisandra Smitch",
120         "Initiator": "payor",
121         "MaskedAccount": "2222 4XXXXXX0010",
122         "paymentDetails": {
123           "totalAmount": 100,
124           "currency": "USD",
125           "serviceFee": 0
126         },
127         "Sequence": "subsequent",
128         "StoredMethodUsageType": "subscription"
129       },
130       "PaypointDbaname": "Athlete Factory LLC",
131       "PaypointEntryname": "473ac58b0",
132       "PaypointId": 3040,
133       "PaypointLegalname": "Athlete Factory LLC",
134       "PlanId": 1,
135       "SubEvents": [
136         {
137           "description": "created",
138           "eventTime": "2023-12-14T13:51:10Z",
139           "refData": "00-3470dfe2658b492811630255602f3fb5-d06fe0f72110000-00"
140         },
141         {
142           "description": "updated",
143           "eventTime": "2023-12-15T10:30:00Z",
144           "refData": "01-1234abcde6789fghij4567klmnopqr89-abcdefghi12345678-01",
145           "source": "web app"
146         }
147       ],
148       "SubStatus": 1,
149       "SubscriptionType": "Regular",
150       "TotalAmount": 100,
151       "TotalCycles": 20,
152       "UntilCancelled": false
153     }
154   ],
155   "Summary": {
156     "pageIdentifier": "XXXXXXXXXXXXXXXXXXX",
157     "pageSize": 20,
158     "totalAmount": 150.22,
159     "totalNetAmount": 150.22,
160     "totalPages": 1,
161     "totalRecords": 2
162   }
163 }

Returns a list of subscriptions for a single org. Use filters to limit results. Include the exportFormat query parameter to return the results as a file instead of a JSON response.

Path parameters

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Query parameters

exportFormatenumOptional

Export format for file downloads. When specified, returns data as a file instead of JSON.

Allowed values:

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 nullable stringsOptional

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)
subscriptionType (eq, ne, in, nin). Filters by subscription type. Accepts Regular or BalanceDriven. Case-insensitive. Example: subscriptionType(in)=Regular|BalanceDriven.
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)
idPmethod (eq, ne, ct, nct, in, nin). Filters by the subscription’s linked stored method identifier (the value returned in StoredMethod.IdPmethod). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e).
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

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](/developers/developer-guides/pay-ops-reporting-engine-overview#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) - `subscriptionType` (eq, ne, in, nin). Filters by subscription type. Accepts `Regular` or `BalanceDriven`. Case-insensitive. Example: `subscriptionType(in)=Regular|BalanceDriven`. - `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) - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`. - `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

Recordslist of objects

Summaryobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error