{"_id":"5bedd214812951004a2ad9b8","category":{"_id":"5bedd214812951004a2ad94a","version":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-27T10:22:06.636Z","from_sync":false,"order":7,"slug":"subscriptions","title":"Subscriptions"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf36ac4eaaa605217d94b8","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5bedd214812951004a2ad943","5bedd214812951004a2ad944","5bedd214812951004a2ad945","5bedd214812951004a2ad946","5bedd214812951004a2ad947","5bedd214812951004a2ad948","5bedd214812951004a2ad949","5bedd214812951004a2ad94a","5bedd214812951004a2ad94b","5bedd214812951004a2ad94c","5bedd214812951004a2ad94d","5bedd214812951004a2ad94e","5bedd214812951004a2ad94f","5bedd214812951004a2ad950","5bedd214812951004a2ad951"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T19:20:45.628Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"text","code":""}]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"get","auth":"optional","params":[{"_id":"56953ff3fe18811700c9bfcc","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the subscription.","default":"","type":"int","name":"subscriptionId"}],"url":"/recurring/subscriptions/:subscriptionId"},"isReference":false,"order":10,"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 Subscription request enables you to retrieve details about one existing subscription.\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 `subscriptionId` into the web service URL, in the format:\n`services/2/recurring/subscriptions/{subscriptionId}`\n\nFor example:\n`services/2/recurring/subscriptions/2111111`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved **[subscription](doc:recurring-subscription)** 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/subscriptions/8491535 \\\\\\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 Subscription Request\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"nextChargeDate\\\": \\\"2016-08-15\\\",\\n \\\"quantity\\\": 1,\\n \\\"trialPeriodDays\\\": 14,\\n \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2019,\\n \\\"cardLastFourDigits\\\": 1111,\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\t\\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"expirationMonth\\\": \\\"07\\\"\\n }\\n }},\\n \\\"softDescriptor\\\": \\\"Example descriptor\\\",\\n \\\"recurringChargeAmount\\\": 29.99,\\n \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n \\\"vaultedShopperId\\\": 21188039,\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"John\\\",\\n \\\"lastName\\\": \\\"Doe\\\"\\n },\\n \\\"initialChargeAmount\\\": 100,\\n \\\"autoRenew\\\": true,\\n \\\"planId\\\": 2283845,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"subscriptionId\\\": 8491535,\\n \\\"status\\\": \\\"ACTIVE\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve Specific Subscription 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 subscription ID in the request URL. The subscription ID is the unique ID sent in the `subscriptionId` property in the [Create Subscription](doc:create-subscription) 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 subscription ID (e.g *8491535*) in the `subscriptionId` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"retrieve-specific-subscription","type":"endpoint","title":"Retrieve Specific Subscription"}getRetrieve Specific Subscription
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
subscriptionId:
required
integer
BlueSnap identifier for the subscription.
Documentation
The Retrieve Specific Subscription request enables you to retrieve details about one existing subscription.
Request Content
Enter the subscriptionId into the web service URL, in the format:services/2/recurring/subscriptions/{subscriptionId}
For example:services/2/recurring/subscriptions/2111111
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the retrieved subscription object.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/subscriptions/8491535 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '{
"nextChargeDate": "2016-08-15",
"quantity": 1,
"trialPeriodDays": 14,
"paymentSource": {"creditCardInfo": {
"billingContactInfo": {
"firstName": "John",
"lastName": "Doe"
},
"creditCard": {
"expirationYear": 2019,
"cardLastFourDigits": 1111,
"cardSubType": "CREDIT",
"cardCategory": "CLASSIC",
"cardType": "VISA",
"expirationMonth": "07"
}
}},
"softDescriptor": "Example descriptor",
"recurringChargeAmount": 29.99,
"chargeFrequency": "MONTHLY",
"vaultedShopperId": 21188039,
"payerInfo": {
"firstName": "John",
"lastName": "Doe"
},
"initialChargeAmount": 100,
"autoRenew": true,
"planId": 2283845,
"currency": "USD",
"subscriptionId": 8491535,
"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 subscription ID in the request URL. The subscription ID is the unique ID sent in the subscriptionId property in the Create Subscription response.
API Explorer
To test out a call, enter an existing subscription ID (e.g 8491535) in the subscriptionId field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.