Sign in
Admin Usage

Get credit usage for the current month

Returns the monthly credit budget, credits consumed this month, and credits remaining. Fields are null if the organization does not have a usage-based subscription.

get/usage/credits

Request

  • The document declares no server URL.
  • Auth: none declared

Response

Credit usage retrieved successfully.

monthlyCreditsnumber nullable required

Monthly credit budget from the usage-based subscription. Null if the org does not have a usage-based subscription.

creditsUsednumber required

Total credits consumed in the current calendar month.

creditsRemainingnumber nullable required

Credits remaining this month (monthlyCredits - creditsUsed). Null if the org does not have a usage-based subscription.

Example response

{
  "monthlyCredits": 10000,
  "creditsUsed": 4250.5,
  "creditsRemaining": 5749.5
}

Changes

No recorded changes to this operation across all 50 revisions of this API.