{"_id":"5c6c23e4735b81006177d077","category":{"_id":"5c6c23e4735b81006177d00d","version":"5c6c23e4735b81006177d0a4","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":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T18:21:03.379Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"auth":"optional","params":[],"url":""},"isReference":false,"order":9,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/recurring/subscriptions?{parameters}</span>\n\n##Documentation\nThe Retrieve All Subscriptions request enables you to retrieve details about all existing subscriptions in your account, or else for a specific shopper or plan ID.\nYou can filter by status, shopper, or plan.\n\n###Request Content\nEnter any of the query parameters below into the request URL. For example:\n`services/2/recurring/subscriptions?pagesize=20&after=34567&gettotal=true`\n\n**Query Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"`pagesize`\",\n    \"1-0\": \"`after`\",\n    \"2-0\": \"`before`\",\n    \"3-0\": \"`gettotal`\",\n    \"5-0\": \"`status`\",\n    \"3-1\": \"**true** = Include the number of total results in the response\",\n    \"4-0\": \"`fulldescription`\",\n    \"4-1\": \"**true** (default) = Return complete details for each subscription in the response\\n\\n**false** = Return limited information about each subscription\",\n    \"1-1\": \"Subscription ID. The response will get the page of results after the specified ID (exclusive).\",\n    \"2-1\": \"Subscription ID. The response will get the page of results before the specified ID (exclusive).\",\n    \"0-1\": \"Positive integer. Sets the maximum number of results to return (i.e. page size).\\nDefault is **10** if not set.\",\n    \"5-1\": \"Enter **ACTIVE** , **CANCELED**, **SUSPENDED** or **DELETED** to filter for subscriptions with that status.\",\n    \"0-2\": \"`pagesize=20`\",\n    \"1-2\": \"`after=1000`\",\n    \"2-2\": \"`before=5000`\",\n    \"3-2\": \"`gettotal=true`\",\n    \"4-2\": \"`fulldescription=true`\",\n    \"5-2\": \"`status=ACTIVE`\",\n    \"6-0\": \"`shopperid`\",\n    \"7-0\": \"`planid`\",\n    \"6-2\": \"`shopperid=16985478`\",\n    \"7-2\": \"`planid=2345`\",\n    \"6-1\": \"Retrieve the subscriptions for a specific shopper.\",\n    \"7-1\": \"Retrieve the subscriptions associated to a specific plan.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the **[subscriptionList](doc:recurring-subscriptions)** 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?pagesize=5&after=34567&gettotal=true&fulldescription=false \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Subscriptions Request\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/recurring/subscriptions?pagesize=2&after=343435&fulldescription=true \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"with full description\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"totalResults\\\": 42,\\n    \\\"lastPage\\\": false,\\n    \\\"subscriptions\\\": [\\n        {\\n            \\\"vaultedShopperId\\\": 19550180,\\n            \\\"planId\\\": 2186200,\\n            \\\"subscriptionId\\\": 34566\\n        },\\n        {\\n            \\\"vaultedShopperId\\\": 1976543,\\n            \\\"planId\\\": 2186208,\\n            \\\"subscriptionId\\\": 34565\\n        },\\n        {\\n            \\\"vaultedShopperId\\\": 1923456,\\n            \\\"planId\\\": 2195008,\\n            \\\"subscriptionId\\\": 34564\\n        },\\n        {\\n            \\\"vaultedShopperId\\\": 1975746,\\n            \\\"planId\\\": 6208208,\\n            \\\"subscriptionId\\\": 34563\\n        },\\n        {\\n            \\\"vaultedShopperId\\\": 1922334,\\n            \\\"planId\\\": 408567,\\n            \\\"subscriptionId\\\": 34562\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Retrieve Subscriptions Response: 200 OK\"\n    },\n    {\n      \"code\": \"{\\n    \\\"lastPage\\\": true,\\n    \\\"subscriptions\\\": [\\n        {\\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                    \\\"cardCategory\\\": \\\"CLASSIC\\\", \\n                    \\\"cardType\\\": \\\"VISA\\\",\\n                    \\\"expirationMonth\\\": \\\"07\\\"\\n                }\\n            }},\\n            \\\"softDescriptor\\\": \\\"BLS&#x2a;default_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\\\": 343434,\\n            \\\"status\\\": \\\"ACTIVE\\\"\\n        },\\n        {\\n            \\\"nextChargeDate\\\": \\\"2016-08-30\\\",\\n            \\\"quantity\\\": 1,\\n            \\\"trialPeriodDays\\\": 14,\\n            \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\n                \\\"billingContactInfo\\\": {\\n                    \\\"firstName\\\": \\\"Bob\\\",\\n                    \\\"lastName\\\": \\\"Shopper\\\"\\n                },\\n                \\\"creditCard\\\": {\\n                    \\\"expirationYear\\\": 2019,\\n                    \\\"cardLastFourDigits\\\": 1234,\\n                    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n                    \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n                    \\\"cardType\\\": \\\"VISA\\\",\\n                    \\\"expirationMonth\\\": 10\\n                }\\n            }},\\n            \\\"softDescriptor\\\": \\\"BLS&#x2a;default_descriptor\\\",\\n            \\\"recurringChargeAmount\\\": 29.99,\\n            \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n            \\\"vaultedShopperId\\\": 2134539,\\n            \\\"payerInfo\\\": {\\n                \\\"firstName\\\": \\\"Bob\\\",\\n                \\\"lastName\\\": \\\"Shopper\\\"\\n            },\\n            \\\"initialChargeAmount\\\": 100,\\n            \\\"autoRenew\\\": true,\\n            \\\"planId\\\": 2283845,\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"subscriptionId\\\": 343433,\\n            \\\"status\\\": \\\"ACTIVE\\\"\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - with full description\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\n\n###Retrieve Subscriptions\nThe example above shows how to retrieve all subscriptions in your account. Results are limited to subscriptions after subscription ID 34567, and a maximum of 5 subscriptions per page. Because `gettotal=true`, the response includes the total number of results. Because `fulldescription=false`, the response includes limited information and you can use the subscription IDs to retrieve more details about each subscription.\n\n###Retrieve Subscriptions with full description\nThe example above shows how to retrieve plans with their complete details, using the `fulldescription=true` parameter (alternatively, you can just leave this parameter off, since the default is **true**).\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-all-subscriptions","type":"endpoint","title":"Retrieve All Subscriptions"}