Tolgee Octri Demo
PUT/v2/ee-license/refresh

Refresh EE subscription information

Refreshes EE subscription information from the license server and updates the subscription information for the instance. Use this operation when you need to synchronize the instance's subscription details with the license server. The response includes the subscription status and enabled features.

5 status codes
200Returns the refreshed subscription details, including the license key, subscription name and status, enabled features, and current user count.
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 unauthenticated.
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 access to the requested operation is forbidden.
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 requested resource is not 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 indicates the refresh request is invalid; a 401 indicates authentication is missing or invalid; a 403 indicates access is forbidden; and a 404 indicates the requested resource was not found. Use this operation to refresh the instance's EE subscription information from the license server.