Skip to content

Commit 1384a46

Browse files
jancurnclaude
andauthored
docs: Clarify monthly usage API documentation (#2425)
## Summary Updated the OpenAPI documentation for the monthly usage endpoint to provide clearer and more accurate descriptions of the API functionality. ## Key Changes - Clarified that the usage cycle is specifically a "monthly usage cycle" (not just "usage cycle") - Updated the Billing page reference to point to the more specific "Billing > Historical usage page" with the correct URL (`/billing/historical-usage`) - Improved consistency in terminology throughout the endpoint description ## Details These documentation improvements help users better understand: - The monthly nature of the usage cycle being reported - Where to find the equivalent information in the Apify console UI - How the `date` parameter affects which monthly cycle's data is returned https://claude.ai/code/session_016zLNhC5XUAQcqLci4e5ABS --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 9b2a7e5 commit 1384a46

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

apify-api/openapi/paths/users/users@me@usage@monthly.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ get:
33
- Users
44
summary: Get monthly usage
55
description: |
6-
Returns a complete summary of your usage for the current usage cycle,
6+
Returns a complete summary of your usage for the current monthly usage cycle,
77
an overall sum, as well as a daily breakdown of usage. It is the same
8-
information you will see on your account's [Billing page](https://console.apify.com/billing#/usage). The information
9-
includes your use of storage, data transfer, and request queue usage.
8+
information you will see on your account's [Billing > Historical usage page](https://console.apify.com/billing/historical-usage). The information
9+
includes your use of Actors, compute, data transfer, and storage.
1010
11-
Using the `date` parameter will show your usage in the usage cycle that
11+
Using the `date` parameter will show your usage in the monthly usage cycle that
1212
includes that date.
1313
operationId: users_me_usage_monthly_get
1414
parameters:

0 commit comments

Comments
 (0)