X Credits
Inspect the workspace's included managed-X allowance, current weighted usage, remaining capacity, billing-period reset, and inbound safety limit.
GET
/v1/billing/x-creditsReturns the authenticated workspace's bounded monthly X Credits allowance.
Bearer tokenWorkspace scoped
Request
Response
| Parameter | Type | Required | Description |
|---|---|---|---|
| mode | string | ✓ | Always "monthly_allowance" in the bounded-usage phase. |
| plan_id | string | ✓ | Workspace plan used to select the included allowance. |
| monthly_allowance | integer | null | ✓ | Included X Credits for the billing period. Enterprise returns null for contract-defined capacity. |
| monthly_used | integer | ✓ | Finalized and provisional weighted usage in the current billing period. |
| monthly_remaining | integer | null | ✓ | Remaining included X Credits. Enterprise returns null. |
| billing_period_start | string | ✓ | ISO-8601 start of the current allowance period. |
| billing_period_end | string | ✓ | ISO-8601 reset boundary for the current allowance period. |
| catalog_version | string | ✓ | Operation catalog version. Current value: x-credits-2026-07-16-v1. |
| inbound_daily_usage | integer | ✓ | Weighted inbound X usage accepted today in UTC. |
| inbound_daily_limit | integer | null | ✓ | Daily inbound safety limit. Enterprise returns null for contract-defined capacity. |
| connection_mode_note | string | ✓ | Explains that managed X connections consume UniPost X Credits while BYO connections do not. |
Operation catalog
The public catalog is versioned. X Credits are weighted units, not dollars, and are separate from the workspace's posts/month allowance. Inbox operations become usable as their phased X Inbox support ships.
| Operation key | Description | Credits |
|---|---|---|
post.create | Create normal X post | 15 |
post.create_url | Create X post containing a URL | 200 |
post.reply_summoned | Create summoned X reply | 10 |
post.read | Read public X post | 5 |
post.read_owned | Read app-owner X post | 1 |
user.read | Read X user profile | 10 |
dm.read | Read legacy X DM event | 10 |
dm.send | Send legacy X DM | 15 |
post.mention.received | Receive X reply or mention | 5 |
dm.received | Receive legacy X DM | 10 |
Managed versus BYO X connections
Managed X connections use UniPost's X developer app and consume this allowance. Bring-your-own X API connections use the customer's developer credentials and do not consume UniPost X Credits. Platform-owned limits, abuse controls, and the independent 20-post daily X safety cap still apply to both modes.
Errors
| Code | HTTP | Description |
|---|---|---|
| unauthorized | 401 | The request is missing valid workspace authentication. |
| x_monthly_usage_limit_exceeded | 402 | The managed-X hard limit has been reached for this billing period. Wait for reset or upgrade/contact UniPost. |
| internal_error | 500 | The allowance snapshot could not be loaded. Retry and include request_id if contacting support. |
Next steps
Use the X Credits guide to estimate operations and handle exhaustion. Compare included plan capacity in Plans and limits.