{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/recurring/plans/:planId","auth":"optional","method":"get","results":{"codes":[{"code":"","language":"text"}]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"params":[{"name":"planId","type":"int","default":"","desc":"BlueSnap identifier for the plan.","required":true,"in":"path","ref":"","_id":"56953ff3fe18811700c9bfcc"}]},"next":{"description":"","pages":[]},"title":"Retrieve Specific Plan","type":"endpoint","slug":"retrieve-specific-plan","excerpt":"","body":"[block:html]\n{\n \"html\": \"<script>\\n // hide body textbox of API Explorer\\n $(document).ready(function() {\\n $(\\\"textarea[placeholder='Body Content']\\\").hide(); \\n }); \\n</script>\"\n}\n[/block]\nThe Retrieve Specific Plan request enables you to retrieve details about one existing subscription billing plan.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nEnter the `planId` into the web service URL, in the format:\n`services/2/recurring/plans/{planId}`\n\nFor example:\n`services/2/recurring/plans/2111111`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved **[plan](doc:plan)** object.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/plans/2283845 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Specific Plan Request\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n \\\"gracePeriodDays\\\": 10,\\n \\\"trialPeriodDays\\\": 14,\\n \\\"initialChargeAmount\\\": 100,\\n \\\"name\\\": \\\"Gold Plan\\\",\\n \\\"planId\\\": 2283845,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"maxNumberOfCharges\\\": 12,\\n \\\"recurringChargeAmount\\\": 29.99,\\n \\\"chargeOnPlanSwitch\\\": true,\\n \\\"status\\\": \\\"ACTIVE\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve Specifc Plan Response: 200 OK\"\n }\n ]\n}\n[/block]\n<hr>\n\n##Example Descriptions\nAbove is an example request. Note that no content is required in the request body. You simply need to include the plan ID in the request URL.\n\nThe plan ID is the unique ID sent in the `planId` property in the [Create Plan](doc:create-plan) response.\n\nThe response contains the retrieved **[plan](doc:plan)** object.\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter an existing plan ID (e.g *2283845*) in the `planId` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff39c12e2e8fa00503ad593","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Subscriptions","slug":"subscriptions","order":10,"from_sync":false,"reference":false,"_id":"5ff39c12e2e8fa00503ad534","version":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-07-27T10:22:06.636Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff39c12e2e8fa00503ad52d","5ff39c12e2e8fa00503ad52e","5ff39c12e2e8fa00503ad52f","5ff39c12e2e8fa00503ad530","5ff39c12e2e8fa00503ad531","5ff39c12e2e8fa00503ad532","5ff39c12e2e8fa00503ad533","5ff39c12e2e8fa00503ad534","5ff39c12e2e8fa00503ad535","5ff39c12e2e8fa00503ad536","5ff39c12e2e8fa00503ad537","5ff39c12e2e8fa00503ad538","5ff39c12e2e8fa00503ad539","5ff39c12e2e8fa00503ad53a","5ff39c12e2e8fa00503ad53b","5ff39c12e2e8fa00503ad53c","5ff39c12e2e8fa00503ad53d","5ff39c12e2e8fa00503ad53e","5ff39c12e2e8fa00503ad53f"],"_id":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fc6c6094cb8fa066b0d2ea3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-07-29T15:17:29.885Z","githubsync":"","__v":0}getRetrieve Specific Plan
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
planId:
required
integer
BlueSnap identifier for the plan.
Documentation
The Retrieve Specific Plan request enables you to retrieve details about one existing subscription billing plan.
Request Content
Enter the planId into the web service URL, in the format:services/2/recurring/plans/{planId}
For example:services/2/recurring/plans/2111111
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the retrieved plan object.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/plans/2283845 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '{
"chargeFrequency": "MONTHLY",
"gracePeriodDays": 10,
"trialPeriodDays": 14,
"initialChargeAmount": 100,
"name": "Gold Plan",
"planId": 2283845,
"currency": "USD",
"maxNumberOfCharges": 12,
"recurringChargeAmount": 29.99,
"chargeOnPlanSwitch": true,
"status": "ACTIVE"
}Example Descriptions
Above is an example request. Note that no content is required in the request body. You simply need to include the plan ID in the request URL.
The plan ID is the unique ID sent in the planId property in the Create Plan response.
The response contains the retrieved plan object.
API Explorer
To test out a call, enter an existing plan ID (e.g 2283845) in the planId field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.
