Skip to main content
Version: 1.0 (Legacy)

Usage Endpoint

Call to Score​

GET /v1/usage

Overview​

The usage endpoint allows you to obtain usage details of your account.

Request​

This is a simple GET request.

[Code example removed β€” see LEGACY_IMPORT_REPORT.md]

Response​

FieldTypeDetails
word_limitIntegerThe number of words available in a subscription's billing cycle.
words_usedIntegerThe number of words used for the current billing cycle.
words_remainingIntegerThe number of words remaining for the current billing cycle.
percent_usedFloatThe percentage of words used based on the amount of words available in a subscription's billing cycle.
start_dateDatetimeThe first day of the current billing cycle in UTC.
end_dateDatetimeThe last day of the current billing cycle in UTC.