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.
curl --location --request \GET 'https://api.receptiviti.com/v1/usage' \-u <YOUR_API_KEY>:<YOUR_API_SECRET>
Response
Field | Type | Details |
---|---|---|
word_limit | Integer | The number of words available in a subscription's billing cycle. |
words_used | Integer | The number of words used for the current billing cycle. |
words_remaining | Integer | The number of words remaining for the current billing cycle. |
percent_used | Float | The percentage of words used based on the amount of words available in a subscription's billing cycle. |
start_date | Datetime | The first day of the current billing cycle in UTC. |
end_date | Datetime | The last day of the current billing cycle in UTC. |