About the Credit Data API

The Credit Data API allows you to retrieve information about a site's word credits to help you monitor credit usage and availability. Multilingual sites receive a free word credit quota (1 credit per word) that gets consumed when the Machine Translation API is used.

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.

Before you begin

It's important to note the following points before starting to code:

  • A Wix user must install the Wix Multilingual app on their site.
  • Wix users can receive additional word credits by purchasing a translation package in the Translation Manager at any time.
  • Credits are deducted from a site's word credit balance in real-time when machine translation requests succeed.

Use cases

Terminology

  • Word credit: A unit of translation capacity. 1 credit equals 1 word. Every site has a word credit balance indicating the number of words available for translation.
  • Quota: The total number of word credits allocated to a site, including initial allocation and any additional credits purchased through the Translation Manager. Currently, sites have a quota limit, with the exception of Wix Studio enterprise sites, which have an unlimited quota.
  • Machine translation: The process of using an external service to automatically translate text to other languages. Alternatively, a Wix user can manually translate their content with the Translation Manager.
Did this help?