Export list of subscriptions for an entrypoint

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

Format for the export, either XLSX or CSV.

The paypoint's entrypoint identifier. Learn more

Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2. Supported columns are:

• IdSub
• Method
• PaypointId
• TotalAmount
• NetAmount
• FeeAmount
• StartDate
• EndDate
• NextDate
• Frequency
• TotalCycles
• LeftCycles
• LastRun
• LastUpdated
• SubStatus
• UntilCancelled
• CompanyName
• FirstName
• LastName
• CustomerNumber
• BillingAddress1
• BillingAddress2
• BillingCity
• BillingCountry
• BillingEmail
• BillingPhone
• BillingState
• BillingZip
• ShippingAddress1
• ShippingAddress2
• ShippingCity
• ShippingState
• ShippingZip
• ShippingCountry
• MaskedAccount
• AccountType
• PaypointLegalname
• PaypointDbaname
• ParentOrgName
• externalPaypointID
• orderDescription

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

See Filters and Conditions Reference for help.

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)
• 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)
• additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

List of comparison accepted - enclosed between parentheses:

• 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

List of parameters accepted:

• limitRecord : max number of records for query (default="20", "0" or negative value for all)
• fromRecord : initial record in query

Example: netAmount(gt)=20 return all records with netAmount greater than 20.00