{"__v":1,"_id":"563e1ed31347cf0d004182c3","category":{"__v":2,"_id":"563e184077681a0d00d96a02","pages":["563e201c1347cf0d004182c5","563e20601347cf0d004182c6"],"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-07T15:26:56.680Z","from_sync":false,"order":5,"slug":"subscriptions","title":"Subscriptions"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","version":{"__v":7,"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-07T15:54:59.024Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\" \"https://sandbox.synapsepay.com/api/3/subscriptions\"","name":""},{"language":"python","code":"#ToDo"},{"name":"Node.js","language":"javascript","code":"//ToDo"},{"language":"ruby","code":"#ToDo"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"page\": 1,\n    \"page_count\": 1,\n    \"subscriptions\": [\n        {\n            \"_id\": \"589b6adec83e17002122196c\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/subscriptions/589b6adec83e17002122196c\"\n                }\n            },\n            \"_v\": 2,\n            \"client_id\": \"589acd9ecb3cd400fa75ac06\",\n            \"is_active\": true,\n            \"scope\": [\n                \"USER|PATCH\",\n                \"NODES|POST\",\n                \"TRANS|POST\"\n            ],\n            \"url\": \"http://requestb.in/15k15qr1\"\n        }\n    ],\n    \"subscriptions_count\": 1,\n    \"success\": true\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55728c20e42c040d00d68a9f","ref":"","in":"query","required":false,"desc":"Page number","default":"","type":"int","name":"page"},{"_id":"560c79eee0ec340d00899586","ref":"","in":"query","required":false,"desc":"Number of Subscriptions per page","default":"20","type":"int","name":"per_page"}],"url":"/subscriptions"},"isReference":true,"order":2,"body":"[block:embed]\n{}\n[/block]\n## Pagination\n\nResponses are paginated, so to move through pages, add page as a GET parameter. Here is an example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET -H \\\"Content-Type: application/json\\\" -H \\\"X-SP-GATEWAY: e3f19e4bd4022c86e7f2|11c94ba6bad74d24a0158bc707f0fc19a86dc08f\\\" -H \\\"X-SP-PROD: NO\\\" -H \\\"X-SP-LANG: EN\\\" 'https://sandbox.synapsepay.com/api/3/subscriptions?page=2'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"subscriptions-1","type":"endpoint","title":"Subscriptions"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer
Page number
per_page:
integer20
Number of Subscriptions per page

Examples


Result Format


Documentation

[block:embed] {} [/block] ## Pagination Responses are paginated, so to move through pages, add page as a GET parameter. Here is an example [block:code] { "codes": [ { "code": "curl -X GET -H \"Content-Type: application/json\" -H \"X-SP-GATEWAY: e3f19e4bd4022c86e7f2|11c94ba6bad74d24a0158bc707f0fc19a86dc08f\" -H \"X-SP-PROD: NO\" -H \"X-SP-LANG: EN\" 'https://sandbox.synapsepay.com/api/3/subscriptions?page=2'", "language": "curl" } ] } [/block]