List Plan Credits
QUERY
https://api.youvico.com/api/workspace/plan-credits- Rate Limit
- Default
- Scope
- credits:read
Lists the workspace's plan credit grants, newest first. A grant that has ended keeps its remaining balance, which can no longer be used.
Example
curl -X QUERY 'https://api.youvico.com/api/workspace/plan-credits' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'
{
"data": [
{
"id": "8c4e2f1a-6b3d-4a5e-9f7c-2d1e0b9a8c7f",
"reason": "MONTHLY_GRANT",
"remainCredits": 900,
"reservedCredits": 50,
"usedCredits": 550,
"expiredAt": null,
"createdAt": "2026-04-01 00:00:00.120456"
}
],
"page": {
"next": null,
"prev": null
}
}
Request
curl -X QUERY 'https://api.youvico.com/api/workspace/plan-credits' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'
Response200 OK
{
"data": [
{
"id": "8c4e2f1a-6b3d-4a5e-9f7c-2d1e0b9a8c7f",
"reason": "MONTHLY_GRANT",
"remainCredits": 900,
"reservedCredits": 50,
"usedCredits": 550,
"expiredAt": null,
"createdAt": "2026-04-01 00:00:00.120456"
}
],
"page": {
"next": null,
"prev": null
}
}
Request
Body
nextstringMaximum 2048 characters
Cursor from page.next
prevstringMaximum 2048 characters
Cursor from page.prev
Response
Returns 200 OK.
dataarrayPlan credit grants
data[].idstringGrant ID
Example: 8c4e2f1a-6b3d-4a5e-9f7c-2d1e0b9a8c7f
data[].reasonstringGrant reason. See Grant Reasons
Possible values: MONTHLY_GRANTBILLING_CYCLESEAT_INCREASEPLAN_CHANGEMIGRATIONOFFERADMIN_GRANT
Example: MONTHLY_GRANT
data[].remainCreditsnumberRemaining credits, excluding reserved credits
Example: 900
data[].reservedCreditsnumberCredits reserved by running AI jobs
Example: 50
data[].usedCreditsnumberUsed credits
Example: 550
data[].expiredAtstring?End time
Example: null
data[].createdAtstringGrant time
Example: 2026-04-01 00:00:00.120456
pageobjectPagination cursors
page.nextstring?Next page cursor
Example: null
page.prevstring?Previous page cursor
Example: null
Grant Reasons
| Reason | Meaning |
|---|---|
MONTHLY_GRANT | Grant at the start of a billing period and every month |
BILLING_CYCLE | Earlier recurring grant |
SEAT_INCREASE | Seat increase during a billing period |
PLAN_CHANGE | Plan or billing interval change during a billing period |
MIGRATION | Existing balance migration |
OFFER | Plan offer |
ADMIN_GRANT | Grant by YouViCo |