getCreditData( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a site's word credit data.

For sites with a limited quota, you can calculate the available word credits by subtracting the credits used from the quota. For example, if a site has a quota of 100 credits and all credits have been used ("creditsUsed": 100), the available word credits will be 0. If a Wix user purchases an additional 50 credits, the quota will increase to 150, and the site will have 50 available word credits.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Wix Multilingual - Translation API
Learn more about app permissions.
Method Declaration
Copy
function getCreditData(): Promise<GetCreditDataResponse>;
Request
This method does not take any parameters
Returns
Return Type:Promise<GetCreditDataResponse>
JavaScript
import { translationCredits } from "@wix/multilingual";

async function getCreditData() {
  const response = await translationCredits.getCreditData();
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?