> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/get-started/ja/purattofmu/billing-and-plans/billing-folders.md).

# 請求フォルダー

## 概要

{% hint style="info" %}
Billing Folders は **有料** 機能で、Enterprise プランで利用できます。ワークスペースで Billing Folders を有効にするには、 [Roboflow の営業チーム](https://roboflow.com/sales) またはアカウント担当者にお問い合わせください。利用可能なプランの詳細は、 [料金ページをご覧ください](https://roboflow.com/pricing).
{% endhint %}

有効にすると、すべての使用量（例: 学習、推論、画像保存、ラベリングなど）は、使用中のプロジェクトを含むフォルダに自動的に割り当てられます。これにより、組織はチーム、部門、または顧客ごとに、きめ細かなコストの可視化と支出管理を行えます。

### 使用量の割り当ての仕組み

Billing Folders が有効な場合、ワークスペース内の各フォルダには独自の API キーが付与されます。フォルダ内のプロジェクトで発生した課金対象の使用量は、そのフォルダの API キーに対して追跡されます。つまり、各フォルダがどれだけ使用しているかを、使用量レポートとダッシュボードで正確に確認できます。

{% hint style="info" %}
使用量の割り当ては自動です。使用量を手動でフォルダに割り当てる必要はありません。プロジェクトから親フォルダへ自動的に引き継がれます。
{% endhint %}

#### API またはデプロイメントの使用量

API キーを使って Roboflow のサービスを利用する場合（Serverless Cloud API、Batch Processing などを含むがこれらに限定されない）、課金の割り当てはプロジェクトのフォルダではなく、リクエスト内の API キーに従います。

ワークスペースレベルの API キーで行ったリクエストは、使用したモデルがフォルダ内のプロジェクトに属していても、ワークスペースに割り当てられます。直接 API またはバッチの使用量をフォルダに割り当てるには、そのフォルダの API キーでリクエストしてください。

#### 画像保存の割り当て

画像保存は、その画像を参照するプロジェクトを含むフォルダに割り当てられます。

同じフォルダ内の複数のプロジェクト（または同じ親を持つサブフォルダ内）で画像が共有されている場合、保存はその画像を使用するすべてのプロジェクトを含む最も深いフォルダに割り当てられます:

```
ワークスペース
├── フォルダ A
│   ├── プロジェクト 1  ← image.jpg
│   └── プロジェクト 2  ← image.jpg（共有）
└── フォルダ B
    └── プロジェクト 3

image.jpg の保存はフォルダ A に割り当てられます（これを参照するすべてのプロジェクトを含む最も深いフォルダ）
```

親フォルダを共有しない別々のルートフォルダ内のプロジェクト間で画像が共有されている場合、保存はワークスペースレベルで割り当てられます:

```
ワークスペース
├── フォルダ A
│   └── プロジェクト 1  ← image.jpg
└── フォルダ B
    └── プロジェクト 2  ← image.jpg（共有）

image.jpg の保存はワークスペースに割り当てられます（1 つのフォルダに両方のプロジェクトが含まれていないため）
```

### フォルダ操作メニュー

フォルダの操作は、そのフォルダの操作メニュー（3 つの点のアイコン）にあります。フォルダ一覧またはフォルダ名の横にあるフォルダのプロジェクトページのヘッダーから開けます。ここには「フォルダの使用量」「フォルダ API キー」「権限の設定」があります。

### 使用量の確認

ワークスペースのクレジット使用量ページで、フォルダ別の内訳を含む使用量を確認でき、割り当てフィルターを **フォルダ**に切り替えられます。 [請求フォルダに使用量を絞り込む方法](/get-started/ja/purattofmu/billing-and-plans/credits/view-credit-usage.md#usage-chart) または [使用量を一般的に確認する方法を参照してください。](/get-started/ja/purattofmu/billing-and-plans/credits/view-credit-usage.md)

1 つのフォルダの使用量に直接移動するには、そのフォルダの操作メニューから「フォルダの使用量」を選択します。

### フォルダ使用量の一時停止と再開

ワークスペース管理者は、フォルダ内のすべての課金対象使用量を一時的に停止できます。これは、コスト管理や誤使用の防止に役立ちます。

#### フォルダの一時停止

フォルダを一時停止するには、フォルダの操作メニューから「フォルダ API キー」を選択し、「フォルダの使用量を一時停止」を切り替えてから、表示されるメッセージで確定します。

<figure><img src="/files/1222c61db5c2e9baf181d088726f3d0f325cd109" alt=""><figcaption></figcaption></figure>

<div><figure><img src="/files/dc4f2d6104749c35467f5f9846c6f439e96c756c" alt=""><figcaption></figcaption></figure> <figure><img src="/files/05e94d5eb57d182a953f9d981887884fef62479e" alt=""><figcaption></figcaption></figure></div>

フォルダが一時停止されると:

* そのフォルダに属するすべての API キーが無効になります
* そのフォルダに対して使用量が発生する API リクエストは、 `423 Locked` ステータスコード
* そのフォルダには新しい課金対象の使用量は記録されません

「すべての子孫フォルダの使用量を一時停止」を切り替えることで、フォルダとそのすべての子孫フォルダをまとめて一時停止することもできます。これにより、選択したフォルダと、その下にネストされたすべてのフォルダの API キーが無効になります。

#### フォルダの再開

一時停止したフォルダを再開するには、「フォルダ API キー」モーダルを再度開き、一時停止の切り替えをオフにしてから確定します。これにより、そのフォルダの API キーが再有効化され、通常の動作に戻ります。同様に、フォルダとそのすべての子孫をまとめて再開することもできます。

再開の影響を受けるのは、フォルダの一時停止機能によって停止されたキーのみです。別の理由で無効化されたキーには影響しません。

### フォルダ API キー

Billing Folders が有効な場合、各フォルダには自動的に独自の API キーが付与されます。これらのキーは、課金対象の使用量がどのフォルダに属するかを内部的に追跡するために使用されます。

* **キーの表示**: フォルダの操作メニューから「フォルダ API キー」を選択すると、そのフォルダに関連付けられた API キーを確認できます。
* **自動作成**: フォルダ作成時、またはワークスペースで Billing Folders を初めて有効にしたときに API キーは自動的に作成されます。手動で作成する必要はありません。

### よくあるシナリオ

| シナリオ                       | 発生すること                                                                       |
| -------------------------- | ---------------------------------------------------------------------------- |
| **プロジェクトを別のフォルダに移動する**     | そのプロジェクトの今後の使用量は新しいフォルダに割り当てられます。過去の使用量は元のフォルダに割り当てられたままです。                  |
| **フォルダを削除する**              | フォルダはワークスペースから削除されます。子プロジェクトとサブフォルダは親フォルダに再割り当てされます。過去の使用量データは請求レポートに保持されます。 |
| **新しいフォルダを作成する**           | 新しいフォルダには、請求の割り当て用 API キーが自動的に付与されます。追加の設定は不要です。                             |
| **Billing Folders を無効にする** | フォルダレベルの割り当ては停止します。新しい使用量はワークスペースレベルのみに記録されます。フォルダの請求期間中の過去の使用量データは保持されます。   |

### 使用量レポート API

次の [請求使用量レポート REST API](#http-api).

## HTTP API

**エンドポイント**

<mark style="color:緑;">`POST`</mark> `https://api.roboflow.com/{workspace_url}/billing-usage-report`

**認証**

次のスコープを持つ API キー `workspaceStats.read` をクエリパラメータとして渡します（`?api_key=YOUR_API_KEY`).

**レート制限**

API キーごとに 1 分あたり 10 リクエスト。

#### リクエストパラメータ <a href="#request-parameters" id="request-parameters"></a>

すべてのパラメータはリクエスト本文に JSON として渡します。すべて任意です。

| パラメータ              | 型                    | 既定値    | 説明                                                                                                         |
| ------------------ | -------------------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| `startAt`          | string (ISO 8601)    | 7 日前   | 集計期間の開始（含む）                                                                                                |
| `endAt`            | string (ISO 8601)    | 現在     | 集計期間の終了（含まない）                                                                                              |
| `api_key_prefixes` | string または string\[] | すべてのキー | 特定の API キープレフィックスに絞り込みます。各プレフィックスは完全な API キーの最初の 5 文字です（例: `rf_ab` キー `rf_abCdEfGhIjK...`）。完全一致である必要があります。 |
| `features`         | string または string\[] | すべての機能 | 特定の請求機能に絞り込む                                                                                               |

#### 例 <a href="#examples" id="examples"></a>

{% tabs %}
{% tab title="基本" %}
既定値は直近 7 日間、すべての機能、すべての API キーです。

```shellscript
curl -X POST "https://api.roboflow.com/my-workspace/billing-usage-report?api_key=$ROBOFLOW_API_KEY"
```

{% endtab %}

{% tab title="カスタム日付範囲" %}

```shellscript
curl -X POST "https://api.roboflow.com/my-workspace/billing-usage-report?api_key=$ROBOFLOW_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "startAt": "2025-01-01T00:00:00.000Z",
    "endAt": "2025-02-01T00:00:00.000Z"
  }'
```

{% endtab %}

{% tab title="機能で絞り込む" %}

```shellscript
curl -X POST "https://api.roboflow.com/my-workspace/billing-usage-report?api_key=$ROBOFLOW_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "features": ["train", "serverless-inference-run"]
  }'
```

{% endtab %}

{% tab title="すべてのパラメータ" %}

```shellscript
curl -X POST "https://api.roboflow.com/my-workspace/billing-usage-report?api_key=$ROBOFLOW_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "startAt": "2025-01-01T00:00:00.000Z",
    "endAt": "2025-02-01T00:00:00.000Z",
    "api_key_prefixes": ["rf_ab", "rf_de"],
    "features": ["train", "serverless-inference-run"]
  }'
```

{% endtab %}
{% endtabs %}

#### レスポンススキーマ <a href="#response-schema" id="response-schema"></a>

API は使用量レコードの JSON 配列を返します:

```json
[
    {
        "api_key_prefix": "rf_ab",
        "feature": "train",
        "total_credits_used": 150.5,
        "usage_events": 12,
        "earliest_usage": "2025-01-02T10:30:00.000Z",
        "latest_usage": "2025-01-28T14:15:00.000Z",
        "billing_entity_id": "folder-id-123",
        "billing_entity_name": "My Project Folder",
        "billing_entity_type": "folder"
    }
]
```

| フィールド                 | 型      | 説明                                                   |
| --------------------- | ------ | ---------------------------------------------------- |
| `api_key_prefix`      | string | 使用量に関連付けられた API キーの最初の 5 文字                          |
| `feature`             | string | 請求機能の識別子（例: `"train"`, `"serverless-inference-run"`) |
| `total_credits_used`  | number | このキー/機能の組み合わせで消費されたクレジット総数                           |
| `usage_events`        | number | 個々の使用イベントの件数                                         |
| `earliest_usage`      | string | 範囲内の最初の使用イベントの ISO タイムスタンプ                           |
| `latest_usage`        | string | 範囲内の最後の使用イベントの ISO タイムスタンプ                           |
| `billing_entity_id`   | string | この使用量を所有するフォルダ ID またはワークスペース ID                      |
| `billing_entity_name` | string | 請求対象エンティティの人間可読名                                     |
| `billing_entity_type` | string | いずれか `"folder"` または `"workspace"`                    |

#### エラーコード <a href="#error-codes" id="error-codes"></a>

| ステータス | 説明                                                        |
| ----- | --------------------------------------------------------- |
| `400` | このワークスペースでは Billing Folders が有効になっていない、またはリクエストパラメータが無効です |
| `401` | API キーが無効または不足しています、または権限が不十分です                           |
| `423` | フォルダの使用量が一時停止されています                                       |
| `429` | レート制限を超えました（1 分あたり 10 リクエスト）                              |
