Beta

List Plan Credits

QUERYhttps://api.youvico.com/api/workspace/plan-credits
Rate Limit
Default
Workspace Role
OwnerManager

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

nextstring

Maximum 2048 characters

Cursor from page.next
prevstring

Maximum 2048 characters

Cursor from page.prev

Response

Returns 200 OK.

dataarray
Plan credit grants
data[].idstring
Grant ID

Example: 8c4e2f1a-6b3d-4a5e-9f7c-2d1e0b9a8c7f

data[].reasonstring
Grant reason. See Grant Reasons

Possible values: MONTHLY_GRANTBILLING_CYCLESEAT_INCREASEPLAN_CHANGEMIGRATIONOFFERADMIN_GRANT

Example: MONTHLY_GRANT

data[].remainCreditsnumber
Remaining credits, excluding reserved credits

Example: 900

data[].reservedCreditsnumber
Credits reserved by running AI jobs

Example: 50

data[].usedCreditsnumber
Used credits

Example: 550

data[].expiredAtstring?
End time

Example: null

data[].createdAtstring
Grant time

Example: 2026-04-01 00:00:00.120456

pageobject
Pagination cursors
page.nextstring?
Next page cursor

Example: null

page.prevstring?
Previous page cursor

Example: null

Grant Reasons

ReasonMeaning
MONTHLY_GRANTGrant at the start of a billing period and every month
BILLING_CYCLEEarlier recurring grant
SEAT_INCREASESeat increase during a billing period
PLAN_CHANGEPlan or billing interval change during a billing period
MIGRATIONExisting balance migration
OFFERPlan offer
ADMIN_GRANTGrant by YouViCo