{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"subscriptionList","type":"basic","slug":"recurring-subscriptions","excerpt":"Contains a list of subscriptions","body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`totalResults`\",\n    \"0-2\": \"Number of retrieved subscriptions.\",\n    \"0-1\": \"*integer*\",\n    \"2-0\": \"`subscriptions`\",\n    \"2-1\": \"*array*\",\n    \"2-2\": \"Contains one or more [subscription](doc:recurring-subscription) objects.\",\n    \"1-0\": \"`lastPage`\",\n    \"1-2\": \"Indicates whether this is the last page of results. Appears only if the `gettotal=true` parameter was included in the request.\",\n    \"1-1\": \"*boolean*\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":47,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a51e4adca83b015f8acb38","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"61a51e4adca83b015f8acaf1","version":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a51e4adca83b015f8acae6","61a51e4adca83b015f8acae7","61a51e4adca83b015f8acae8","61a51e4adca83b015f8acae9","61a51e4adca83b015f8acaea","61a51e4adca83b015f8acaeb","61a51e4adca83b015f8acaec","61a51e4adca83b015f8acaed","61a51e4adca83b015f8acaee","61a51e4adca83b015f8acaef","61a51e4adca83b015f8acaf0","61a51e4adca83b015f8acaf1","61a51e4adca83b015f8acaf2","61a51e4adca83b015f8acaf3","61a51e4adca83b015f8acaf4","61a51e4adca83b015f8acaf5","61a51e4adca83b015f8acaf6","61a51e4adca83b015f8acaf7","61a51e4adca83b015f8acaf8","61a51e4adca83b015f8acaf9"],"_id":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed21a76106200102eaec3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-07-29T18:25:17.311Z","githubsync":"","__v":0}

subscriptionList

Contains a list of subscriptions

Request

N/A

Response

Property Name
Type
Description

totalResults

integer

Number of retrieved subscriptions.

lastPage

boolean

Indicates whether this is the last page of results. Appears only if the gettotal=true parameter was included in the request.

subscriptions

array

Contains one or more subscription objects.