GET/v2/ee-license/info

Get Enterprise Edition subscription information

Retrieves information about the current Enterprise Edition subscription and license. Use the response to inspect its status, enabled features, user count, period end, and cancellation state.

5 status codes
200Returns subscription and license details, including status, license key, enabled features, user count, pay-as-you-go state, cancellation state, and available period or validation timestamps.
cancelAtPeriodEndbooleanrequired
currentPeriodEndintegeroptional
currentUserCountintegerrequired
enabledFeaturesarray<string>required
isPayAsYouGobooleanrequired
lastValidCheckstringoptional
licenseKeystringrequired
namestringrequired
nonCommericalbooleanrequired
statusstringrequired
Allowed:ACTIVECANCELEDPAST_DUEUNPAIDERRORTRIALINGKEY_USED_BY_ANOTHER_INSTANCEUNKNOWN
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access the subscription information.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the current subscription information cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when authentication is missing or invalid, a 403 when the authenticated user lacks permission, and a 404 when the current subscription information cannot be found. Use valid authentication credentials with access to the subscription details.