ELelicit
Usage

Get usage status

Changed on

Report the authenticated account's current usage against its plan.

Returns whether the account still has usage available (hasUsageRemaining), the percentage of plan usage consumed this billing period, the billing-period bounds, and — only when extra usage is enabled — the extra-usage spend and limit in USD cents.

Example

curl https://elicit.com/api/v2/usage \
  -H "Authorization: Bearer elk_live_your_key_here"
get/usage

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/usage
  • Auth
    HTTP bearer

Response

Current usage status.

hasUsageRemainingboolean required

Whether the account can run billable work right now. False once both the plan limit and (if enabled) the extra-usage limit are exhausted, or once an organization member reaches their own weekly usage limit.

percentUsednumber required

Percentage of plan usage consumed this billing period.

periodStartstring required

ISO 8601 start of the current billing period.

periodEndstring required

ISO 8601 end of the current billing period. Monthly usage limits reset at this time.

Changes

  • 27c80b9a3470Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 9b5b75b828abRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status