XM
Members
Retrieve Single Plan
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/data-subscription/plans/{planID}
Copied!
Retrieves a single plan based on the plan ID

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 : path
Name : The plan ID.
Required: true

Sample Path

1
https://{baseURL}/data-subscription/plans/60584b5fd54c3d6ddd934c8e
Copied!

Sample Response

Response Code: 200
Message: OK
1
{
2
"success": true,
3
"responseStatus": "OK",
4
"message": "Request processed successfully.",
5
"data": {
6
"_id": "60584b5fd54c3d6ddd934c8e",
7
"isDeleted": false,
8
"deletedAt": null,
9
"title": "Plan for testing",
10
"description": "Creating this plan for testing ",
11
"products": [
12
{
13
"_id": "60584b5fd54c3d6ddd934c8f",
14
"itemId": "1000019269",
15
"priceListId": "100272"
16
}
17
],
18
"frequency": 2,
19
"frequencyType": "weekly",
20
"status": "INACTIVE",
21
"discount": 1,
22
"shippingCost": 12,
23
"merchantAccountId": "8739392294",
24
"merchantAccount": "5f328bf0b7c15700071233b9",
25
"createdAt": "2021-03-22T07:46:39.675Z",
26
"updatedAt": "2021-03-22T07:46:39.675Z",
27
"__v": 0
28
}
29
}
Copied!
Response Code: 400
Message: Client Error
Response Code: 500
Message: Server Error

Changelog

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