Check Access

GET /organizations/{organizationId}/entitlements/{service}/access

Check service access entitlement

cURL

curl --request GET \
  --url https://api.hixbe.com/account/organizations/{organizationId}/entitlements/{service}/access \
  --header 'Authorization: Bearer <token>'

200

{
  "hasAccess": true,
  "tier": "FREE",
  "usage": {
    "current": 123,
    "limit": 123,
    "percentage": 123
  },
  "features": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId · string · required

service · enum<string> · required

Available options: PAYMENT_GATEWAY, SMS_GATEWAY, LINK_SHORTENER, PBX_CALL_CENTER, HOSTING, NATIONAL_ISP, CERTIFICATION_BADGE

Response

200 - application/json

Access check result

hasAccess · boolean · required

Whether the organization has access to the service

tier · enum<string>

Current subscription tier

Available options: FREE, PRO, BUSINESS, CUSTOM

usage · object

Current usage information

Show child attributes

features · string[]

Available features for this tier