{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"planList","type":"basic","slug":"plans","excerpt":"Contains a list of subscription billing plans","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 billing plans.\",\n    \"0-1\": \"*integer*\",\n    \"2-0\": \"`plans`\",\n    \"2-1\": \"*array* \",\n    \"2-2\": \"Array containing one or more [plan](doc:plan) 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":32,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e5d3aa2dc4d35003d784d3f","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":13,"from_sync":false,"reference":false,"_id":"5e5d3aa2dc4d35003d784cfb","version":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-07-27T11:10:56.021Z","githubsync":"","__v":0}

planList

Contains a list of subscription billing plans

Request

N/A

Response

Property Name
Type
Description

totalResults

integer

Number of retrieved billing plans.

lastPage

boolean

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

plans

array

Array containing one or more plan objects.