Skip to main content
POST
/
api
/
mitigation
/
subscriptions
User Subscription Search with Pagination
curl --request POST \
  --url https://test.paysight.io/api/mitigation/subscriptions \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "pageNumber": 123,
  "limit": 123,
  "emails": [
    "<string>"
  ],
  "orderIds": [
    123
  ],
  "dateFrom": "2023-12-25",
  "dateTo": "2023-12-25"
}'
{
  "success": true,
  "message": "<string>",
  "count": 123,
  "pageNumber": 123,
  "moreResults": true,
  "subscriptions": [
    {
      "parentCompanyId": 123,
      "companyId": 123,
      "mid": "<string>",
      "descriptor": "<string>",
      "id": 123,
      "customerId": 123,
      "subDate": "2023-11-07T05:31:56Z",
      "unsubDate": "2023-11-07T05:31:56Z",
      "orderId": 123,
      "active": true,
      "unsubscribeOrderId": 123,
      "email": "<string>",
      "subId": 123,
      "frozen": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Paysight API key

Headers

​
ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

​
UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Request to fetch subscriptions with filters like email and date range

​
pageNumber
integer
required

Page number for pagination

​
limit
integer

The maxium number of results to return per page. Default is 100. Maxiumum is 1000.

​
emails
string[]

List of customer emails

​
orderIds
integer[]

List of order IDs

​
dateFrom
string<date>

Start date filter for subscription or unsubscription

​
dateTo
string<date>

End date filter for subscription or unsubscription

Response

200 - application/json

List of subscriptions

​
success
boolean
​
message
string
​
count
integer
​
pageNumber
integer
​
moreResults
boolean
​
subscriptions
object[]
⌘I