Skip to content

Add /2/usage/credits endpoint to Usage docs #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vaulpannx merged 1 commit into from
Aug 24, 2026
Merged

Add /2/usage/credits endpoint to Usage docs #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,8 @@
"group": "Usage",
"pages": [
"x-api/usage/introduction",
"x-api/usage/get-usage"
"x-api/usage/get-usage",
"x-api/usage/get-usage-credits"
]
},
{
Expand Down
5 changes: 3 additions & 2 deletions x-api/usage/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Usage
sidebarTitle: Introduction
description: "The Usage endpoint lets you monitor your API usage, including the number of Posts consumed. Reference for the X API v2 standard tier covering usage."
description: "The Usage endpoints let you monitor your API usage and, for Pay-per-use (PPU) accounts, check your credit balance. Reference for the X API v2 standard tier covering usage."
keywords: ["usage API", "API usage", "usage tracking", "post usage", "consumption monitoring"]
---

Expand Down Expand Up @@ -29,11 +29,12 @@ Pay-per-usage plans are subject to a monthly cap of 3 million Post reads. If you

---

## Endpoint
## Endpoints

| Method | Endpoint | Description |
|:-------|:---------|:------------|
| GET | [`/2/usage/tweets`](/x-api/usage/get-usage) | Get Post usage data |
| GET | [`/2/usage/credits`](/x-api/usage/get-usage-credits) | Get your Pay-per-use (PPU) credit balance in USD |

---

Expand Down