Entitlements

Check entitlements for network actions.

Get all plans and entitlements

Get all company plans and entitlements

Request
path Parameters
username
required
string

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

Example: Acme
Responses
200

OK

get/api/company/{username}/ports/entitlement
Response samples
application/json
[
  • {
    },
  • {
    }
]

Get plan and entitlement details

Get specific plan and entitlement details.

Request
path Parameters
username
required
string

The username of the company.

Example: company_co
portId
required
string

The port ID.

Example: 55767b5652a693344a015744
Responses
200

OK

get/api/company/{username}/ports/{portId}/entitlement
Response samples
application/json
{
  • "subscriptions": [ ],
  • "entitlement": {
    }
}