プランクレジット一覧
QUERY
https://api.youvico.com/api/workspace/plan-credits- レート制限
- Default
- スコープ
- credits:read
ワークスペースのプランクレジットの付与履歴を新しい順に取得します。終了した付与は残高をそのまま返しますが、その残高はもう使用できません。
例
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
}
}
リクエスト
curl -X QUERY 'https://api.youvico.com/api/workspace/plan-credits' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'
レスポンス200 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
}
}
リクエスト
ボディ
nextstringMaximum 2048 characters
page.next のカーソル
prevstringMaximum 2048 characters
page.prev のカーソル
レスポンス
200 OK を返します。
dataarrayプランクレジットの付与履歴
data[].idstring付与ID
例: 8c4e2f1a-6b3d-4a5e-9f7c-2d1e0b9a8c7f
data[].reasonstring付与理由。付与理由を参照
指定できる値: MONTHLY_GRANTBILLING_CYCLESEAT_INCREASEPLAN_CHANGEMIGRATIONOFFERADMIN_GRANT
例: MONTHLY_GRANT
data[].remainCreditsnumber予約量を除いた残高
例: 900
data[].reservedCreditsnumber実行中のAIジョブが予約したクレジット
例: 50
data[].usedCreditsnumber使用したクレジット
例: 550
data[].expiredAtstring?終了日時
例: null
data[].createdAtstring付与日時
例: 2026-04-01 00:00:00.120456
pageobjectページネーションカーソル
page.nextstring?次のページのカーソル
例: null
page.prevstring?前のページのカーソル
例: null
付与理由
| 理由 | 意味 |
|---|---|
MONTHLY_GRANT | 請求期間の開始時と毎月の定期付与 |
BILLING_CYCLE | 以前の方式の定期付与 |
SEAT_INCREASE | 請求期間中のシート数の増加 |
PLAN_CHANGE | 請求期間中のプランまたは請求間隔の変更 |
MIGRATION | 既存残高の移行 |
OFFER | プランの特典 |
ADMIN_GRANT | YouViCoによる付与 |