GET
/
Query
/
subscriptions
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/subscriptions/org/{orgId} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalRecords": 2,
    "totalAmount": 150.22,
    "totalNetAmount": 150.22,
    "totalPages": 1,
    "pageSize": 20,
    "pageIdentifier": "XXXXXXXXXXXXXXXXXXX"
  },
  "Records": {
    "IdSub": 580,
    "Method": "card",
    "PaypointId": 10,
    "TotalAmount": 100,
    "NetAmount": 10,
    "FeeAmount": 0,
    "PaymentData": {
      "MaskedAccount": "2222 4XXXXXX0010",
      "AccountType": "unknow",
      "AccountExp": "0924",
      "HolderName": "Mr. Michael Abernathy",
      "StoredId": null,
      "orderDescription": null,
      "accountId": null,
      "SignatureData": null,
      "paymentDetails": {
        "checkImage": null,
        "splitFunding": null,
        "totalAmount": 100,
        "serviceFee": 0,
        "currency": "USD",
        "checkNumber": null,
        "orderId": null,
        "orderIdAlternative": null,
        "orderDescription": null,
        "paymentDescription": null,
        "groupNumber": null,
        "source": null,
        "categories": null
      }
    },
    "StartDate": "2024-07-20T00:00:00",
    "EndDate": "2026-03-20T00:00:00",
    "NextDate": "2024-07-20T00:00:00",
    "Frequency": "monthly",
    "TotalCycles": 20,
    "LeftCycles": 20,
    "LastRun": "2024-01-02T14:32:11.3304223+00:00",
    "SubStatus": 1,
    "EntrypageId": 0,
    "PlanId": 1,
    "UntilCancelled": false,
    "SubEvents": [
      {
        "description": "created",
        "eventTime": "2023-12-14T13:51:10.3387114+00:00",
        "refData": "00-3470dfe2658b492811630255602f3fb5-d06fe0f72110000-00",
        "extraData": null,
        "source": null
      },
      {
        "description": "updated",
        "eventTime": "2023-12-15T10:30:00.1234567+00:00",
        "refData": "01-1234abcde6789fghij4567klmnopqr89-abcdefghi12345678-01",
        "extraData": {
          "some extra data": null
        },
        "source": "web app"
      }
    ],
    "LastUpdated": "2023-12-14T08:51:10.703",
    "CreatedAt": "2023-12-14T08:51:10.703",
    "Customer": {
      "Identifiers": [
        "\\\"firstname\\\"",
        "\\\"lastname\\\"",
        "\\\"email\\\""
      ],
      "FirstName": "Lisandra",
      "LastName": "Smitch",
      "CompanyName": "Sunshine LLC",
      "BillingAddress1": "68 Golden Drive",
      "BillingAddress2": "",
      "BillingCity": "Johnson City",
      "BillingState": "TN",
      "BillingZip": "37612",
      "BillingCountry": "US",
      "BillingPhone": "",
      "BillingEmail": "company@payabli.com",
      "CustomerNumber": "1234",
      "ShippingAddress1": "68 Golden Drive",
      "ShippingAddress2": null,
      "ShippingCity": "Johnson City",
      "ShippingState": "TN",
      "ShippingZip": "37612",
      "ShippingCountry": "US",
      "customerId": 1323,
      "customerStatus": 1,
      "AdditionalData": {
        "clientId": "901102",
        "invoiceFrequency": "onetime",
        "invoiceScheduled": "false",
        "invoiceStartDate": "Tue Feb 21 2023 00:00:00 GMT-0500 (Eastern Standard Time)"
      },
      "CreatedAt": "2023-01-16T11:00:52"
    },
    "InvoiceData": {
      "invoiceNumber": "QA-1702561870",
      "invoiceDate": null,
      "invoiceDueDate": null,
      "invoiceEndDate": null,
      "invoiceStatus": 1,
      "invoiceType": 1,
      "frequency": "one-time",
      "paymentTerms": null,
      "termsConditions": null,
      "notes": null,
      "tax": null,
      "discount": null,
      "invoiceAmount": 100,
      "freightAmount": null,
      "dutyAmount": null,
      "purchaseOrder": null,
      "firstName": null,
      "lastName": null,
      "company": null,
      "shippingAddress1": null,
      "shippingAddress2": null,
      "shippingCity": null,
      "shippingState": null,
      "shippingZip": null,
      "shippingCountry": null,
      "shippingEmail": null,
      "shippingPhone": null,
      "shippingFromZip": null,
      "summaryCommodityCode": null,
      "items": [
        {
          "itemTotalAmount": 50,
          "itemTaxAmount": null,
          "itemTaxRate": null,
          "itemProductCode": null,
          "itemProductName": "Mat replacement",
          "itemDescription": "service",
          "itemCommodityCode": null,
          "itemUnitOfMeasure": null,
          "itemCost": 10,
          "itemQty": 5,
          "itemMode": 1,
          "itemCategories": null
        },
        {
          "itemTotalAmount": 50,
          "itemTaxAmount": null,
          "itemTaxRate": null,
          "itemProductCode": null,
          "itemProductName": "Mat clean",
          "itemDescription": "service",
          "itemCommodityCode": null,
          "itemUnitOfMeasure": null,
          "itemCost": 5,
          "itemQty": 10,
          "itemMode": 1,
          "itemCategories": null
        }
      ],
      "attachments": null,
      "additionalData": null
    },
    "PaypointLegalname": "Athlete Factory LLC",
    "PaypointDbaname": "Athlete Factory LLC",
    "PaypointEntryname": "473ac58b0",
    "ParentOrgName": "FitnessManager",
    "ExternalPaypointID": "f743aed24a-10",
    "Source": null
  }
}

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

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

​
parameters
object

Collection of field names, conditions, and values used to filter the query. 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
​
limitRecord
integer
default:20

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

Example:

0

​
fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

​
sortBy
string

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.

Example:

"desc(field_name)"

Response

200
application/json
Success

Subscription query response body.

​
Summary
object
​
Records
object

Was this page helpful?