The Credit Data API allows you to retrieve information about a site's word credits. When a Wix user installs the Wix Multilingual app on their site, the site receives a free word credit quota. These credits are consumed when the Machine Translation API translates text from one language to another, with each credit representing 1 word translated.
With the Credit Data API, you can:
- Retrieve a site's word credit data.
- Check whether a site has enough credits to translate a specific number of words.
It's important to note the following points before starting to code:
- You can only use this API on sites where the Wix user has installed the Wix Multilingual app.
- Wix users can receive additional word credits by purchasing a translation package in the Translation Manager at any time. These additional credits get added to the site's quota.
- For sites with a limited quota, you can calculate the current 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, the available word credits will be 0. If a Wix user purchases an additional 50 credits, the total quota will increase to 150, and the site will have 50 available word credits.
- Apps that use machine translation deduct credits from the site's word credit balance.
- Word credit: A unit of translation capacity, where 1 credit equals 1 word to translate. Each site has a word credit balance indicating the number of words available for translation.
- Quota: Total number of credits allocated to the site. Currently, sites have a quota limit, with the exception of Wix Studio enterprise sites, which have an unlimited quota.