GET
/v2/organizations/{organizationId}/usageGet current organization usage
Retrieves current usage and plan-limit details for an organization. Use the organizationId to select the organization whose usage you need to inspect. The response includes usage counts, credit balances and refill timestamps, and included plan allowances.
organizationIdintegerrequired
The integer identifier of the organization whose usage to retrieve.
200Returns organization usage values, including current keys, seats, translations, words, and machine translation credit usage; credit balances and refill timestamps; and included plan allowances. The legacy `extraCreditBalance` field is retained for compatibility and is always 0.
availablePayAsYouGoMtCreditsintegerrequired
The maximum amount organization can spend on MT credit usage before they reach the spending limit
creditBalanceintegerrequired
Current balance of standard credits. Standard credits are refilled every month
creditBalanceNextRefillAtintegerrequired
Date when credits will be refilled. (In epoch format)
creditBalanceRefilledAtintegerrequired
Date when credits were refilled. (In epoch format)
currentKeysintegerrequired
How many keys are currently stored by organization
currentPayAsYouGoMtCreditsintegerrequired
Currently used credits over credits included in plan and extra credits
currentSeatsintegerrequired
How seats are currently used by organization
currentTranslationsintegerrequired
How many non-empty translations are currently stored by organization
currentWordsintegerrequired
How many hosted words are currently stored by organization
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.
includedKeysintegerrequired
How many keys are included in current subscription plan. How many keys can organization use without additional costs.
includedMtCreditsintegerrequired
How many credits are included in your current plan
includedSeatsintegerrequired
How many seats are included in current subscription plan. How many seats can organization use without additional costs.
includedTranslationsintegerrequired
How many translations are included in current subscription plan. How many translations can organization use without additional costs
includedWordsintegerrequired
How many hosted words are included in current subscription plan (for word-based plans). How many words the organization can host without additional costs.
isPayAsYouGobooleanrequired
Whether the current plan is pay-as-you-go of fixed. For pay-as-you-go plans, the spending limit is the top limit.
keysLimitintegerrequired
How many keys can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit)
organizationIdintegerrequired
seatsLimitintegerrequired
How many seats can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit)
translationsLimitintegerrequired
How many translations can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit)
usedMtCreditsintegerrequired
Currently used credits including credits used over the limit
wordsLimitintegerrequired
Total number of hosted words the organization can store (-1 for unlimited). For pay-as-you-go, the top limit is the spending limit.
400Returned when a request parameter or value is invalid.
codestringrequired
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
paramsarray<object>optional
403Returned when the authenticated user does not have access to the requested organization.
codestringrequired
paramsarray<object>optional
404Returned when the organization cannot be found.
codestringrequired
paramsarray<object>optional
Error handling
A 400 is returned for an invalid request, a 401 when authentication is missing or invalid, and a 403 when the authenticated user lacks access. A 404 is returned when the organizationId path parameter does not identify an available organization.