Tolgee Octri Demo
GET/v2/organizations/{organizationId}/machine-translation-credit-balance

Get an organization's machine translation credit balance

Retrieves the machine translation credit balance for an organization. Use organizationId to select the organization; the response includes its bucket size and credit balance, while extraCreditBalance is retained for backward compatibility and is always 0.

1 parameter
organizationIdintegerrequired
The int64 identifier of the organization whose machine translation credit balance to retrieve.

5 status codes
200Returns the organization's `bucketSize`, `creditBalance`, and `extraCreditBalance`; `extraCreditBalance` is retained for backward compatibility and is always 0.
bucketSizeintegerrequired
creditBalanceintegerrequired
extraCreditBalanceintegerdeprecatedrequired
Customers were able to buy extra credits separately in the past. This option is not available anymore and this field is kept only for backward compatibility purposes and is always 0.
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 the authenticated user is not permitted to access the organization's credit balance.
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 specified organization 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 the request is unauthenticated, and a 403 when the authenticated user cannot access the organization. A 404 is returned when the organization cannot be found. The organizationId path parameter must identify an existing organization.