List Subscribers
Retrieve a paginated list of subscribers with optional filtering by email, mobile number, or subscriber ID.
List Subscribers
Version: 3.0.0
Generate an API Key for the Subscription channel before making requests.
Use this endpoint to retrieve a paginated list of all subscribers associated with your merchant account. You can filter subscribers by email/mobile number or subscriber ID, and paginate through results.
Endpoint
| Method | URL |
|---|---|
| GET | https://api.payorc.com/subscriptions/v1/subscriber/list |
Please use the test credentials for sandbox testing.
Authentication
Include the following headers in every request:
| Header | Type | Description |
|---|---|---|
merchant-key | String | Your merchant key |
merchant-secret | String | Your merchant secret |
All API requests must be made over HTTPS. Requests made over plain HTTP will be rejected.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
perpage | Integer | Yes | Number of records per page |
page | Integer | Yes | Page number (starting from 1) |
subscriber_email_mobile | String | No | Filter by subscriber email or mobile number |
subscriber_id | String | No | Filter by plain display subscriber ID |
Pagination is required for accounts with many subscribers. Use perpage and page to navigate through results.
Response (200 OK)
| Field | Type | Description |
|---|---|---|
data | Array | List of subscriber objects |
data[].data_id | String | Encrypted subscriber identifier — use for Subscriber Details |
data[].subscriber_id | String | Plain display subscriber number |
data[].name | String | Subscriber name |
data[].email | String | Subscriber email address |
data[].mobile_no | String | Subscriber mobile number |
data[].country_code | String | Country code |
data[].created_date | String | Date created (DD-MM-YYYY HH:mm:ss) |
data[].first_txn_date | String | First transaction date (DD-MM-YYYY HH:mm:ss) |
data[].last_txn_date | String | Last transaction date (DD-MM-YYYY HH:mm:ss) |
data[].country | String | Country associated with the subscriber |
message | String | Human-readable status message |
status | String | success or error |
code | String | Status code (00 for success) |
total_records | Integer | Total number of matching records |
Code Examples
curl -X GET "https://api.payorc.com/subscriptions/v1/subscriber/list?perpage=10&page=1" \
-H "merchant-key: YOUR_MERCHANT_KEY" \
-H "merchant-secret: YOUR_MERCHANT_SECRET"Example Response
{
"data": [
{
"data_id": "Q0hkcGRSb0publgv",
"subscriber_id": "0000000167",
"name": "Krushnakant Moundekar",
"mobile_no": "9876543210",
"country_code": "91",
"email": "[email protected]",
"created_date": "23-01-2024 09:35:59",
"first_txn_date": "23-01-2024 09:35:59",
"last_txn_date": "23-01-2024 09:35:59",
"country": ""
},
{
"data_id": "QU9IdGRnM1VyZ2",
"subscriber_id": "0000000248",
"name": "Rahul S",
"mobile_no": "9238328673",
"country_code": "91",
"email": "[email protected]",
"created_date": "23-01-2024 10:34:07",
"first_txn_date": "23-01-2024 10:34:07",
"last_txn_date": "23-01-2024 10:34:07",
"country": "IND"
}
],
"message": "Subscriber list fetched successfully.",
"status": "success",
"code": "00",
"total_records": 4
}Use data[].data_id (encrypted) for Subscriber Details. Use data[].subscriber_id (plain number) only for display or the optional subscriber_id filter on this endpoint.