> 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 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 の保存はワークスペースに割り当てられます（両方のプロジェクトを含む単一のフォルダがないため）
```

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

フォルダの管理機能は、フォルダの操作メニュー（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)

特定のフォルダの使用量に直接移動するには、そのフォルダの操作メニューから「フォルダの使用量」を選択してください。

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

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

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

フォルダを一時停止するには、フォルダの操作メニューから「フォルダ 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`      | 文字列 | 使用量に関連付けられた API キーの先頭 5 文字                           |
| `feature`             | 文字列 | 課金機能の識別子（例: `"train"`, `"serverless-inference-run"`) |
| `total_credits_used`  | 数値  | このキー／機能の組み合わせで消費された合計クレジット                           |
| `usage_events`        | 数値  | 個々の使用イベント数                                           |
| `earliest_usage`      | 文字列 | 範囲内の最初の使用イベントの ISO タイムスタンプ                           |
| `latest_usage`        | 文字列 | 範囲内の最後の使用イベントの ISO タイムスタンプ                           |
| `billing_entity_id`   | 文字列 | この使用量を所有するフォルダ ID またはワークスペース ID                      |
| `billing_entity_name` | 文字列 | 請求対象エンティティのわかりやすい名前                                  |
| `billing_entity_type` | 文字列 | いずれか `"folder"` または `"workspace"`                    |

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

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