Skip to main content

Get List

Get subscriptions list.

Post
https://store.payproglobal.com/api/Subscriptions/GetList
Request Parametersapplication/json
SubscriptionsListRequestModel
object
skip
integer
optional
Define how many results you want to skip. The default value is 0.
take
integer
optional
Define how many first results to display after the skipped ones.
Default - 50. Maximum - 100.
search
object
The search options.
subscriptionIds
integer
conditional
The subscription ID for which you want to get the details.
statusIds
integer
optional
The ID of the subscription status. Possible values:
1 – Active, 2 – Suspended, 3 – Terminated, 4 – Finished.
customerEmail
string
conditional
The email of the customer whose subscription details you want to retrieve.
dateFrom
string
optional
Start date of the search period. Date format "yyyy-MM-ddTHH:mm:ss.fff".
dateTo
string
optional
End date of the search period. Date format "yyyy-MM-ddTHH:mm:ss.fff".
sortByDate
string
optional
Sort the subscriptions by the creation date. Possible values:
"asc" - ascending order. Default.
"desc" - descending order.
dateFormat
string
optional
The date format in which you want to get the order details.
Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
includeOrders
boolean
optional
Possible values are true or false. False by default.
If true, it includes order ID values associated with the subscription ID.'
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
subscriptionsListResponseModel
object
response
object
id
integer
The subscription ID value.
name
string
The subscription name value.
status
string
The status of the subscription.
createdAt
string
The date when order has been placed.
nextPayment
string
The date of the upcoming subscription payment.
lastPayment
string
The date of the last subscription payment.
currentChargeCounter
integer
The number of the subscription payments that took place.
subscriptionPrice
number
The subscription recurring price.
subscriptionCurrency
string
The currency in which the subscription is paid.
subscriptionPeriod
string
The subscription billing period.
subscriptionPeriodValue
integer
The value of the subscription billing period.
isTrial
boolean
Possible values are true or false.
If true, the subscription is on trial period.
If false, there is no trial period.
renewalType
string
The subscription renewal type.
orders
array[object]
The collection of orders.
request
object
skip
integer
Define how many results you want to skip. The default value is 0.
take
integer
Define how many first results to display after the skipped ones. Default - 50. Maximum - 100.
search
object
The search options.
subscriptionIds
integer
The subscription ID for which you want to get the details.
statusIds
integer
optional
The ID of the subscription status. Possible values:
1 – Active, 2 – Suspended, 3 – Terminated, 4 – Finished.
dateFrom
string
optional
Start date of the search period. Date format "yyyy-MM-ddTHH:mm:ss.fff".
dateTo
string
optional
End date of the search period. Date format "yyyy-MM-ddTHH:mm:ss.fff".
sortByDate
string
Sort the subscriptions by the creation date. Possible values:
"asc" - ascending order. Default.
"desc" - descending order.
dateFormat
string
optional
The date format in which you want to get the order details.
Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
includeOrders
boolean
optional
Possible values are true or false. False by default.
If true, it includes order ID values associated with the subscription ID.
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
  "skip": 0,
  "take": 50,
  "search": {
    "subscriptionIds": [
      1111111,
      1111111
    ],
    "statusIds": [
      1111111
    ],
    "customerEmail": "[email protected]",
    "dateFrom": "2023-10-02T08:00:34",
    "dateTo": "2024-10-02T09:30:34"
  },
  "sortByDate": "asc",
  "dateFormat": "a", 
  "includeOrders": true,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "response": {
    "id": 12345678,
    "name": "Test_list",
    "status": "Active",
    "createdAt": "2023-09-09T11:44:10.417", 
    "nextPayment": "2024-03-29T11:29:59.837",
    "lastPayment": "2024-02-29T11:29:59.837",
    "currentChargeCounter": 1, 
    "subscriptionPrice": 58.83, 
    "subscriptionCurrency": "USD",
    "subscriptionPeriod": "Days",
    "subscriptionPeriodValue": 1,
    "isTrial": false, 
    "renewalType": "Auto", 
    "orders": [
      1111
    ]
  },
  "request": {
    "skip": 0,
    "take": 50,
    "search": {
      "subscriptionIds": [
        1111111,
        1111111
      ],
      "statusIds": [
        1111111
      ],
      "customerEmail": "[email protected]",
      "dateFrom": "2023-10-02T08:00:34",
      "dateTo": "2024-10-02T09:30:34"
    },
    "sortByDate": "asc",
    "dateFormat": "a", 
    "includeOrders": true,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}