Entitlements

Check entitlements for network actions.

Get all plans and entitlements

Get all company plans and entitlements

Securityapi-key

Request

path Parameters

username

required

string

The username of the company to retrieve the ports and entitlement details of.

Example: Acme

Responses

200

get/api/company/{username}/ports/entitlement

Response samples

application/json

[{"subscriptions": null,
"subscriptionLength": 1,
"subscriptionLengthUnit": "y",
"itemCollectionType": "port",
"id": "5c07767990a74879f2cf8cf4",
"userId": "5c07766b3a4c3579f27a4553",
"bundleId": "5c07767990a74879f2cf8cf1",
"deletedAt": null,
"createdAt": "2018-12-05T06:55:53.797Z",
"updatedAt": "2018-12-05T06:55:53.797Z",
"itemIds": ["57e0aba00956ad107191328c"
]
},
{"entitlement": {"57e0aba00956ad107191328c": {"portSpeed": {"used": null,
"available": null
},
"maxControllerType": {"used": "REGIONAL",
"available": null
},
"maxControllers": {"used": 0,
"available": null
}
},
"57e0aba10956ad1071913290": {"portSpeed": {"used": null,
"available": null
},
"maxControllerType": {"used": null,
"available": null
},
"maxControllers": {"used": 0,
"available": null
},
"cdrGlobal": {"000000000000000000000000-111111111111111111111111": {"name": "US-London",
"srcRegionId": "000000000000000000000000",
"destRegionId": "111111111111111111111111",
"used": 0,
"available": null
}
}
}
}
}
]

Get plan and entitlement details

Get specific plan and entitlement details.