Get current Enterprise Edition subscription usage

5 status codes

200Returns current, included, and limit usage values for credits, keys, seats, and strings, along with the pay-as-you-go indicator and word usage when available.

creditsobjectrequired

isPayAsYouGobooleanrequired

keysobjectrequired

seatsobjectrequired

stringsobjectrequired

wordsobjectoptional

400Returned when the request is invalid.

codestringrequired

Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted

paramsarray<object>optional

401Returned when the request is not authenticated.

codestringrequired

paramsarray<object>optional

403Returned when the authenticated user is not permitted to access subscription usage.

codestringrequired

paramsarray<object>optional

404Returned when current subscription usage cannot be found.

codestringrequired

paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when authentication is missing or invalid, a 403 when the authenticated user lacks permission, and a 404 when the current subscription usage cannot be found. Use valid authentication credentials with access to the subscription usage.

import { Client } from "tolgee-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://app.tolgee.io",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.eeCurrentSubscriptionUsage.list();

{
  "credits": {
    "current": 1,
    "included": 1,
    "limit": 20
  },
  "isPayAsYouGo": true,
  "keys": {
    "current": 1,
    "included": 1,
    "limit": 20
  },
  "seats": {
    "current": 1,
    "included": 1,
    "limit": 20
  },
  "strings": {
    "current": 1,
    "included": 1,
    "limit": 20
  },
  "words": {
    "current": 1,
    "included": 1,
    "limit": 20
  }
}

Response

Errors