Tolgee Octri Demo
POST/v2/ee-license/prepare-set-license-key

Preview an EE subscription for a license key

Previews the EE subscription details and usage that would apply if you set a license key. Supply licenseKey to see the plan and usage information, including the subscription cost. Use this preview before applying the key with PUT /v2/ee-license/set-license-key.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Request to preview the subscription associated with a license key.

licenseKeystringrequired
The license key to preview. Must contain at least one character.

5 status codes
200Returns the plan and usage information that would apply to the license key, including subscription pricing and usage totals.
planobjectrequired
usageobjectrequired
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 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. licenseKey is required and must contain at least one character.