> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetCreditData

# Package: machineTranslation

# Namespace: TranslationCredits

# Method link: https://dev.wix.com/docs/api-reference/business-management/multilingual/machine-translation/credit-data/get-credit-data.md

## Permission Scopes:
Wix Multilingual: SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS

## Introduction

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.

---

## REST API

### Schema

```
 Method: getCreditData
 Description: 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.
 URL: https://www.wixapis.com/translation-credits/v1/credit
 Method: GET
 Return type: GetCreditDataResponse
  - name: creditData | type: CreditData | description: Credit data. 
     - name: creditsUsed | type: integer | description: Total number of word credits consumed by a site. For sites with an unlimited word credit quota, this property still reflects the number of credits used, even though no usage limit applies. 
     - name: quotaType | type: Quota | description: Quota type. 
         - enum:
         -     LIMITED: Limited word credit quota.


```

### Examples

### Get Credit Data
```curl
curl -X GET \
'https://www.wixapis.com/translation-credits/v1/credit' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.machineTranslation.TranslationCredits.getCreditData()
 Description: 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.
 Return type: PROMISE<GetCreditDataResponse>
  - name: creditData | type: CreditData | description: Credit data. 
     - name: creditsUsed | type: integer | description: Total number of word credits consumed by a site. For sites with an unlimited word credit quota, this property still reflects the number of credits used, even though no usage limit applies. 
     - name: quotaType | type: Quota | description: Quota type. 
         - enum:
         -     LIMITED: Limited word credit quota.


```

### Examples

### getCreditData
```javascript
import { translationCredits } from '@wix/multilingual';

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

### getCreditData (with elevated permissions)
```javascript
import { translationCredits } from '@wix/multilingual';
import { auth } from '@wix/essentials';

async function myGetCreditDataMethod() {
  const elevatedGetCreditData = auth.elevate(translationCredits.getCreditData);
  const response = await elevatedGetCreditData();
}
```

### getCreditData (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { translationCredits } from '@wix/multilingual';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { translationCredits },
  // Include the auth strategy and host as relevant
});


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

---