XM
Members
Retrieve All Subscribers
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/data-subscription/customers?pageSize=12&pageNumber=1
Copied!
This API enables you to retrieve all of your subscribers based on the specified query parameters

Headers

Content-Type : application/json
Authorization: The JWT Authorization toke from the Login API.
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox"

Parameters

Type : query
Name : The page size and the page number.
Required: true

Sample Path

1
https://{baseURL}/data-subscription/subscriptions/customers?pageSize=12&pageNumber=1
Copied!

Sample Response

Response Code: 200
Message: OK
1
{
2
"success": true,
3
"responseStatus": "OK",
4
"message": "Request processed successfully.",
5
"data": {
6
"customers": [
7
{
8
"_id": "6068efcdb89ba600081ea618",
9
"isDeleted": false,
10
"deletedAt": null,
11
"stripeId": "cus_JElkvWLG5Lu1cb",
12
"customerEmail": "[email protected]",
13
"customerReferenceId": "[email protected]",
14
"customerFullName": "Joe M Demo",
15
"paymentMethodId": [
16
{
17
"isDeleted": false,
18
"_id": "6068efcdb89ba600081ea619",
19
"paymentMethodId": "pm_1ISekkETggmgrCy2b7osIpl8",
20
"isDefault": "true"
21
}
22
],
23
"createdAt": "2021-04-03T22:44:29.656Z",
24
"updatedAt": "2021-04-11T09:25:11.654Z",
25
"__v": 0,
26
"merchantAccount": "5fc78dfc6135050007191290",
27
"subscriptions": [
28
{
29
"_id": "6068efcdb89ba600081ea618",
30
"status_with_count": [
31
{
32
"status": "ACTIVE",
33
"count": 3
34
},
35
{
36
"status": "PAUSE",
37
"count": 1
38
}
39
],
40
"count": 4
41
}
42
]
43
},
44
{
45
"_id": "606c90c746eb7a0008ae4c4b",
46
"isDeleted": false,
47
"deletedAt": null,
48
"stripeId": "cus_JFnfL6dEFDGvKB",
49
"customerEmail": "[email protected]",
50
"customerReferenceId": "606c8f222b0ed4000838d631",
51
"customerFullName": "Smith Demo",
52
"paymentMethodId": [
53
{
54
"isDeleted": false,
55
"_id": "606c90c746eb7a0008ae4c4c",
56
"paymentMethodId": "pm_1ISekkETggmgrCy2b7osIpl8",
57
"isDefault": "true"
58
}
59
],
60
"createdAt": "2021-04-06T16:48:07.714Z",
61
"updatedAt": "2021-04-06T17:01:24.246Z",
62
"__v": 0,
63
"merchantAccount": "5fc78dfc6135050007191290",
64
"subscriptions": [
65
{
66
"_id": "606c90c746eb7a0008ae4c4b",
67
"status_with_count": [
68
{
69
"status": "CANCEL",
70
"count": 1
71
},
72
{
73
"status": "PAUSE",
74
"count": 1
75
}
76
],
77
"count": 2
78
}
79
]
80
},
81
{
82
"_id": "606de2193b02c1000989679e",
83
"isDeleted": false,
84
"deletedAt": null,
85
"stripeId": "cus_JGAtcCVomlYRxq",
86
"customerEmail": "[email protected]",
87
"merchantAccount": "5fc78dfc6135050007191290",
88
"customerReferenceId": "[email protected]",
89
"customerFullName": "Kathy Demo",
90
"paymentMethodId": [],
91
"createdAt": "2021-04-07T16:47:21.173Z",
92
"updatedAt": "2021-04-08T21:03:11.843Z",
93
"__v": 0,
94
"subscriptions": [
95
{
96
"_id": "606de2193b02c1000989679e",
97
"status_with_count": [
98
{
99
"status": "ACTIVE",
100
"count": 1
101
}
102
],
103
"count": 1
104
}
105
]
106
},
107
{
108
"_id": "606e2498b1f58a000875d63b",
109
"isDeleted": false,
110
"deletedAt": null,
111
"stripeId": "cus_JGFS38AJQtWJh3",
112
"customerEmail": "[email protected]",
113
"merchantAccount": "5fc78dfc6135050007191290",
114
"customerReferenceId": "",
115
"customerFullName": "Sara Demo",
116
"paymentMethodId": [],
117
"createdAt": "2021-04-07T21:31:04.125Z",
118
"updatedAt": "2021-04-07T21:31:04.125Z",
119
"__v": 0,
120
"subscriptions": []
121
},
122
{
123
"_id": "606efdc83bf07b0009bb92e7",
124
"isDeleted": false,
125
"deletedAt": null,
126
"stripeId": "cus_JGUP58B8bOiQNn",
127
"customerEmail": "[email protected]",
128
"merchantAccount": "5fc78dfc6135050007191290",
129
"customerReferenceId": "606efb7ec042330007b48447",
130
"customerFullName": "Mike Demo",
131
"paymentMethodId": [],
132
"createdAt": "2021-04-08T12:57:44.079Z",
133
"updatedAt": "2021-04-08T12:57:44.079Z",
134
"__v": 0,
135
"subscriptions": [
136
{
137
"_id": "606efdc83bf07b0009bb92e7",
138
"status_with_count": [
139
{
140
"status": "ACTIVE",
141
"count": 3
142
}
143
],
144
"count": 3
145
}
146
]
147
},
148
{
149
"_id": "606f024132f89200086753bc",
150
"isDeleted": false,
151
"deletedAt": null,
152
"stripeId": "cus_JGUiIgFqh76cGM",
153
"customerEmail": "[email protected]",
154
"merchantAccount": "5fc78dfc6135050007191290",
155
"customerReferenceId": "606f01f441b8fc0008529916",
156
"customerFullName": "Lyn Demo",
157
"paymentMethodId": [],
158
"createdAt": "2021-04-08T13:16:49.214Z",
159
"updatedAt": "2021-04-08T13:16:49.214Z",
160
"__v": 0,
161
"subscriptions": []
162
},
163
{
164
"_id": "606f1cfe8bb36a000944ea08",
165
"isDeleted": false,
166
"deletedAt": null,
167
"stripeId": "cus_JGWY1d5javq8Ub",
168
"customerEmail": "[email protected]",
169
"merchantAccount": "5fc78dfc6135050007191290",
170
"customerReferenceId": "",
171
"customerFullName": "Erin Test",
172
"paymentMethodId": [],
173
"createdAt": "2021-04-08T15:10:54.313Z",
174
"updatedAt": "2021-04-08T15:10:54.313Z",
175
"__v": 0,
176
"subscriptions": []
177
},
178
{
179
"_id": "606f226dd0c32b0008bf0472",
180
"isDeleted": false,
181
"deletedAt": null,
182
"stripeId": "cus_JGWvrW64HRYjXY",
183
"customerEmail": "[email protected]",
184
"merchantAccount": "5fc78dfc6135050007191290",
185
"customerReferenceId": "",
186
"customerFullName": "taha Test",
187
"paymentMethodId": [],
188
"createdAt": "2021-04-08T15:34:05.628Z",
189
"updatedAt": "2021-04-08T15:34:05.628Z",
190
"__v": 0,
191
"subscriptions": []
192
},
193
{
194
"_id": "606f235dd0c32b0008bf0473",
195
"isDeleted": false,
196
"deletedAt": null,
197
"stripeId": "cus_JGWzgpZeCba3iY",
198
"customerEmail": "[email protected]",
199
"merchantAccount": "5fc78dfc6135050007191290",
200
"customerReferenceId": "601bd05137d7fc00081c3259",
201
"customerFullName": "Ahmed Test",
202
"paymentMethodId": [],
203
"createdAt": "2021-04-08T15:38:05.315Z",
204
"updatedAt": "2021-04-08T15:38:05.315Z",
205
"__v": 0,
206
"subscriptions": []
207
},
208
{
209
"_id": "606f2c241c731e0008059528",
210
"isDeleted": false,
211
"deletedAt": null,
212
"stripeId": "cus_JGXbtZUZaqRbmX",
213
"customerEmail": "[email protected]",
214
"merchantAccount": "5fc78dfc6135050007191290",
215
"customerReferenceId": "",
216
"customerFullName": "Sam Demo",
217
"paymentMethodId": [],
218
"createdAt": "2021-04-08T16:15:32.988Z",
219
"updatedAt": "2021-04-08T16:15:32.988Z",
220
"__v": 0,
221
"subscriptions": []
222
},
223
{
224
"_id": "606f7102d52ad200094c818c",
225
"isDeleted": false,
226
"deletedAt": null,
227
"stripeId": "cus_JGcLvmdeaFeMAY",
228
"customerEmail": "[email protected]",
229
"merchantAccount": "5fc78dfc6135050007191290",
230
"customerReferenceId": "606f7098d19ec5000830027a",
231
"customerFullName": "Ruth Test",
232
"paymentMethodId": [],
233
"createdAt": "2021-04-08T21:09:22.644Z",
234
"updatedAt": "2021-04-08T21:32:35.109Z",
235
"__v": 0,
236
"subscriptions": [
237
{
238
"_id": "606f7102d52ad200094c818c",
239
"status_with_count": [
240
{
241
"status": "ACTIVE",
242
"count": 5
243
}
244
],
245
"count": 5
246
}
247
]
248
},
249
{
250
"_id": "606f81f8feef6c0008971e60",
251
"isDeleted": false,
252
"deletedAt": null,
253
"stripeId": "cus_JGdVfXEUZu18En",
254
"customerEmail": "[email protected]",
255
"merchantAccount": "5fc78dfc6135050007191290",
256
"customerReferenceId": "6037b2dc6c845c00085d40f7",
257
"customerFullName": "Liz Tets",
258
"paymentMethodId": [
259
{
260
"isDeleted": false,
261
"_id": "606f81f8feef6c0008971e61",
262
"paymentMethodId": "pm_1ISekkETggmgrCy2b7osIpl8",
263
"isDefault": "true"
264
}
265
],
266
"createdAt": "2021-04-08T22:21:44.597Z",
267
"updatedAt": "2021-04-08T22:21:44.616Z",
268
"__v": 0,
269
"subscriptions": [
270
{
271
"_id": "606f81f8feef6c0008971e60",
272
"status_with_count": [
273
{
274
"status": "ACTIVE",
275
"count": 1
276
}
277
],
278
"count": 1
279
}
280
]
281
}
282
],
283
"count": 1404
284
}
285
}
Copied!
Response Code: 400
Message: Client Error
Response Code: 500
Message: Server Error

Changelog

  • April-2021
Last modified 1mo ago
Copy link
Contents
Changelog