Get list of subscriptions
GET https://api.zylo.com/v1/subscriptions?pageSize=number&pageToken=string
Returns collection of Subscription objects
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | string | (optional) The size of the page to return. Defaults to 50. | |
pageToken | string | A page token, received from a previous call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to the call must match the call that provided the page token. |
Example: pageToken=1b6792d8-1aaf-4f00-9b53-5fe1fb32eca1 |
RESPONSES
status: OK
{"nextPageToken":"1b6792d8-1aaf-4f00-9b53-5fe1fb32eca1","subscriptions":[{"appId":"application/8f42b1f6-06a4-465a-aff2-83be8fcf0886","appDescription":"string","id":"string","name":"subscription/8f42b1f6-06a4-465a-aff2-83be8fcf0886","createTime":"2020-01-01T12:00:00+00:00","updateTime":"2020-01-01T12:00:00+00:00","category":"Collaboration \u0026 Productivity","subcategory":"Team Collaboration","status":"active","businessUnit":"string","ssoEnforced":true,"launchUrl":"example.com","sources":["string"],"itSupported":true,"type":"string","businessGoals":"string","tags":["string"],"supplierName":"string","holdsPii":true,"notes":[{"text":"string","createTime":"2020-01-01T12:00:00+00:00","createdBy":"user@example.com","updateTime":"2020-01-01T12:00:00+00:00"}],"functionalities":["string"],"cloud":true,"primaryCostCenter":{"name":"string","annualSpend":{"currencyCode":"USD","amount":"199.99"},"numberOfCostCenters":0},"nextAction":"string","trueUp":true,"primaryContract":{"startDate":"2020-01-01T12:00:00+00:00","endDate":"2019-08-24T14:15:22Z","contractEndDate":"2020-01-01T12:00:00+00:00","totalContractValue":{"currencyCode":"USD","amount":"199.99"},"billFrequency":0,"cancellationNotificationLength":0,"licensesPurchased":"string"},"usageStats":{"uniqueActiveUsers":0,"uniqueProvisionedUsers":0,"activityThreshold":"string","provisionedUsers":0,"activeUsers":0,"percentActiveUsers":"string","percentLicensesProvisioned":"string"},"payment":{"yearToDateSpend":{"currencyCode":"USD","amount":"199.99"},"annualSpend":{"currencyCode":"USD","amount":"199.99"},"apSpend":{"currencyCode":"USD","amount":"199.99"},"expenseSpend":{"currencyCode":"USD","amount":"199.99"},"lastTransactionDate":"2020-01-01T12:00:00+00:00","lastApTransactionDate":"2020-01-01T12:00:00+00:00","lastExpenseTransactionDate":"2020-01-01T12:00:00+00:00","numberOfTransactions":0,"numberOfUsersExpensing":0,"numberOfCostCenters":0,"primaryCostCenter":{"name":"string","annualSpend":{"currencyCode":"USD","amount":"199.99"},"numberOfCostCenters":0}},"owners":{"app":"user@example.com","business":"user@example.com","it":"user@example.com"},"customFields":[{"key":"myCustomField","value":"200"}]}]}