Read credit usage by month and platform, and the remaining monthly and purchased balance.
curl -s "https://api.betterpost.dev/v1/usage?from=2026-09&to=2026-10" \
-H "x-access-key: $BETTERPOST_API_KEY"{
"success": true,
"totalUsage": 13,
"usage": [
{ "year": 2026, "month": 9, "count": 7, "purchasedCount": 0, "platform": { "twitter": 5, "linkedin": 1, "instagram": 1 } },
{ "year": 2026, "month": 10, "count": 6, "purchasedCount": 0, "platform": { "twitter": 5, "linkedin": 1 } }
],
"balance": {
"monthly": {
"limit": 20,
"used": 6,
"remaining": 14,
"cycleStart": "2026-10-05T09:12:44.000Z",
"cycleEnd": "2026-11-05T09:12:44.000Z"
},
"purchased": { "total": 0, "used": 0, "remaining": 0 }
}
}usage[]: one entry per UTC calendar month with usage, oldest first.
count is the net credits used that month: charges minus refunds. A refund is counted in the month of the
charge it reverses, so a post scheduled in September and cancelled in October lowers September.purchasedCount is the part of count paid from purchased credits.platform breaks count down by platform (platforms with zero net usage are omitted).totalUsage: net credits used across all time. from and to only slice usage; totalUsage is never
sliced.balance (only without profileId or integrationId):
monthly: your plan's allowance for the current cycle, which runs from your sign-up day to the same day next
month.purchased: credits bought or granted outside the plan. They never expire and are used after the monthly
allowance.Usage counts this project's posts; the balance belongs to your account and is shared by all its projects.
| Query | Description |
|---|---|
from, to | YYYY-MM, inclusive. |
profileId | Only usage of accounts in this profile. |
integrationId | Only usage of this account. |
profileId and integrationId cannot be combined (400 conflicting_filters). An unknown profile or account
is 404.
Reference: GET /v1/usage. Costs per platform: Credits.