{"_id":"59a45d447ee621000fc9d3cc","category":{"_id":"59a45d447ee621000fc9d3c0","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-27T10:22:06.636Z","from_sync":false,"order":8,"slug":"subscriptions","title":"Subscriptions"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T15:17:29.885Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"56953ff3fe18811700c9bfcc","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the plan.","default":"","type":"int","name":"plan-id"}],"url":"/recurring/plans/:plan-id"},"isReference":false,"order":22,"body":"The 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 `plan-id` into the web service URL, in the format:\n`services/2/recurring/plans/{plan-id}`\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) resource.\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/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\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\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<plan xmlns=\\\"http://ws.plimus.com\\\">\\n  <plan-id>2283845</plan-id>\\n  <name>Gold Plan</name>\\n  <recurring-charge-amount>29.99</recurring-charge-amount>\\n  <currency>USD</currency>\\n  <charge-frequency>MONTHLY</charge-frequency>\\n  <trial-period-days>14</trial-period-days>\\n  <initial-charge-amount>100.00</initial-charge-amount>\\n  <charge-on-plan-switch>true</charge-on-plan-switch>\\n  <max-number-of-charges>12</max-number-of-charges>\\n  <grace-period-days>10</grace-period-days>\\n  <status>ACTIVE</status>\\n</plan>\",\n      \"language\": \"xml\",\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 XML 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 `plan-id` property in the [Create Plan](doc:create-plan) response.\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 `plan-id` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"retrieve-specific-plan","type":"get","title":"Retrieve Specific Plan"}

getRetrieve Specific Plan


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

plan-id:
required
integer
BlueSnap identifier for the plan.

Documentation

The Retrieve Specific Plan request enables you to retrieve details about one existing subscription billing plan.

Try it in the API Explorer

Request Content

Enter the plan-id into the web service URL, in the format:
services/2/recurring/plans/{plan-id}

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 resource.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/plans/2283845 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<plan xmlns="http://ws.plimus.com">
  <plan-id>2283845</plan-id>
  <name>Gold Plan</name>
  <recurring-charge-amount>29.99</recurring-charge-amount>
  <currency>USD</currency>
  <charge-frequency>MONTHLY</charge-frequency>
  <trial-period-days>14</trial-period-days>
  <initial-charge-amount>100.00</initial-charge-amount>
  <charge-on-plan-switch>true</charge-on-plan-switch>
  <max-number-of-charges>12</max-number-of-charges>
  <grace-period-days>10</grace-period-days>
  <status>ACTIVE</status>
</plan>


Example Descriptions

Above is an example request. Note that no XML 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 plan-id property in the Create Plan response.



Back to Top


API Explorer

To test out a call, enter an existing plan ID (e.g 2283845) in the plan-id field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.


User Information

Try It Out


get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}