Skip to main content

Usage Credits

Usage credits measure how much Custodian Labs processing your account can use during a plan cycle.

In different parts of the product, you may see usage described as words, tokens, or credits. The dashboard is the source of truth for the current limit and remaining amount on your account.

What Credits Measure​

Credits represent the amount of text or file content processed by Custodian Labs.

They are used to help answer:

  • How much usage is included in my plan?
  • How much have I used?
  • How much do I have left in the current cycle?

Words, Tokens, and Credits​

Product-facing plan cards may describe allowance in words, while dashboard and API usage may show token-style counters.

For documentation clarity:

  • Use "usage credits" as the general concept.
  • Use "tokens" when referring to dashboard counters or API usage fields.
  • Use "words" when describing plan marketing limits shown on pricing cards.

If there is a mismatch between wording, follow the value displayed in your dashboard.

Text Requests​

For text requests, usage is deducted based on the amount of text processed.

A request may consume credits when Custodian Labs analyzes or transforms text, such as:

  • Detecting sensitive entities.
  • Transforming sensitive values.
  • Redacting or masking text.
  • Returning de-identified output.

File Uploads​

For file uploads, usage depends on the content processed from the file.

Supported files may include:

  • CSV
  • DOC / DOCX
  • PDF
  • TXT

Large files generally consume more credits than small files because more content has to be processed.

Where to View Remaining Credits​

You can view remaining usage in:

Depending on the page, you may see remaining usage at the plan level or API key level.

When Credits Run Out​

When credits run out, requests may fail until more usage becomes available.

To regain access, you can:

  • Wait for the next renewal cycle if your plan renews.
  • Change or upgrade your plan.
  • Contact support for custom usage needs.