> ## Documentation Index
> Fetch the complete documentation index at: https://docs.utage-system.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 決済ツール

> 商品・商品グループ・商品詳細・売上の操作ツール

## 概要

決済系ツールでは、商品（管理画面「商品管理」）・商品グループ・商品詳細（価格や決済方法などの販売設定。実際の決済は商品詳細ごとに行われます）と、売上（売上一覧・売上詳細・領収書・請求書設定・銀行振込の入金反映・月別/日別の売上集計）を管理できます。商品詳細のツールで指定する `product_id` は `payment_product_list` で取得します。

## 商品

管理画面「商品管理」の商品を操作します。商品は配信アカウントに紐づかないユーザー単位のリソースで、実際の決済は商品配下の商品詳細ごとに行われます（商品詳細のツールは後述）。

### payment\_product\_list

商品の一覧を取得します（全件、表示順）。`is_archived` で通常の商品とアーカイブ済みの商品を切り替えます（画面の「商品管理」「アーカイブ済」タブに相当）。ファネルページの「決済」「オーダーバンプ」要素などで指定する商品詳細ID（`product_detail_id`）は `payment_product_detail_list` で取得します。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `is_archived` | boolean | - | `true` でアーカイブ済みの商品のみ。省略時・`false` はアーカイブ済みでない商品のみ |

**指示例:**

* 「商品の一覧を見せて」
* 「アーカイブ済みの商品を一覧にして」

***

### payment\_product\_create

商品を新規作成します。商品一覧の末尾に追加されます。作成後に `payment_product_detail_create` で商品詳細を追加すると決済フォームで販売できます。API経由の商品作成には作成上限（月間・累計）があり、超過するとエラー（`monthly_limit_exceeded` / `total_limit_exceeded`）になります。契約内容による商品の件数上限（アーカイブ済みを含む）に達している場合はエラー（`bad_request`）になります。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `name` | string | 必須 | 商品名（最大255文字） |
| `memo` | string | - | メモ（管理画面の商品基本設定でのみ表示される内部メモ。最大65,535バイト） |
| `product_group_id` | string | - | 所属する商品グループのID（`payment_product_group_list` で取得）。`null`・省略は未分類 |
| `business_id` | string | - | 領収書の発行事業者とする事業者設定のID。`null`・省略はデフォルト。事業者設定の一覧取得ツールは無いため、既存の商品の `business_id` を再利用する |
| `deny_multiple_purchases` | boolean | - | 重複購入を禁止するか（`true`=禁止する / `false`=許可する。デフォルト: `false`） |
| `has_sales_limit` | boolean | - | 販売上限を指定するか（`true`=指定する / `false`=指定しない。デフォルト: `false`） |
| `max_sales_quantity` | integer | - | 販売上限数（0以上の整数）。`has_sales_limit` が `true` の場合は必須 |

**指示例:**

* 「"オンライン講座"という商品を作成して」
* 「商品グループ"セミナー"に、重複購入を禁止した商品"個別相談"を追加して」

***

### payment\_product\_get

商品の内容（商品名・メモ・所属する商品グループ・事業者設定・重複購入・販売上限・アーカイブ状態）を取得します。配下の商品詳細は `payment_product_detail_list` で取得します。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID（`payment_product_list` で取得） |

**指示例:**

* 「この商品の設定を見せて」
* 「商品"オンライン講座"の販売上限を確認して」

***

### payment\_product\_update

商品を更新します（部分更新）。送信したフィールドのみ更新され、未送信のフィールドは既存の値を維持します。アーカイブ・アーカイブ解除は `is_archived` で行います（アーカイブ済みでも取得・更新・削除はでき、一覧の表示分けと商品並び替えの対象外になるだけです）。表示順は変更できません（`payment_product_reorder` で変更）。存在しない商品グループ・事業者設定を指定した場合や、`max_sales_quantity` に `null` を送った場合はエラー（`validation_error`）になります。`max_sales_quantity` を省略すると既存の値（未設定なら 0）を維持します。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `name` | string | - | 商品名（最大255文字）。`null` は既存の値が `null` の場合のみ可 |
| `memo` | string | - | メモ（最大65,535バイト）。`null` でクリア |
| `product_group_id` | string | - | 所属する商品グループのID（`payment_product_group_list` で取得）。`null` で未分類へ移動 |
| `business_id` | string | - | 事業者設定のID。`null` でデフォルトへ変更 |
| `deny_multiple_purchases` | boolean | - | 重複購入を禁止するか（`true`=禁止する / `false`=許可する） |
| `has_sales_limit` | boolean | - | 販売上限を指定するか（`true`=指定する / `false`=指定しない） |
| `max_sales_quantity` | integer | - | 販売上限数（0以上の整数）。省略時は既存の値を維持。`null` は不可 |
| `is_archived` | boolean | - | アーカイブ状態（`true`=アーカイブ / `false`=アーカイブ解除。画面の「アーカイブ(非表示化)」「アーカイブを解除」に相当） |

**指示例:**

* 「商品"オンライン講座"の販売上限を100個にして」
* 「この商品をアーカイブして」
* 「商品"個別相談"を未分類に移して」

***

### payment\_product\_delete

商品を削除します（物理削除。画面の「削除」と同じで、元に戻せません）。配下の商品詳細や売上のデータは削除されませんが、商品詳細はツールから取得できなくなります。購入実績がある商品でも削除は拒否されないため、削除前に利用者に確認してください。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |

**指示例:**

* 「商品"テスト商品"を削除して」

***

### payment\_product\_reorder

商品を並び替えます（画面の「表示順変更」に相当）。商品グループの並び順・各商品の所属する商品グループ・グループ内の商品の並び順を一括で更新します。`groups` には未分類（`product_group_id` が `null`）の要素を先頭に1つ置き、全ての商品グループと、アーカイブ済みを除く全ての商品を網羅します（過不足・未分類が先頭以外・アーカイブ済み商品の指定はエラー `validation_error`）。商品の所属グループだけを変えたい場合は `payment_product_update` の `product_group_id` でも変更できます。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `groups` | array | 必須 | グループごとの商品の並び。各要素は `{product_group_id: 商品グループID（未分類は null。先頭の要素に置く）, product_ids: そのグループに所属させる商品IDの配列（並べたい順。空配列可）}`。配列の順序がグループの表示順になる |

**指示例:**

* 「商品"オンライン講座"をグループ"講座"の先頭に移動して」
* 「商品グループ"セミナー"を一番上に並べ替えて」

***

## 商品グループ

管理画面「商品管理」の「グループ管理」で扱う商品グループを操作します。商品グループは商品を分類するためのもので、グループ名と表示順だけを持ちます。

### payment\_product\_group\_list

商品グループの一覧を取得します（全件、表示順）。「未分類」は商品グループではないため含まれません（未分類の商品は `product_group_id` が `null` で表されます）。

**パラメータ:** なし

**指示例:**

* 「商品グループの一覧を見せて」

***

### payment\_product\_group\_create

商品グループを新規作成します。グループ一覧の末尾に追加されます。商品の所属は `payment_product_create` / `payment_product_update` の `product_group_id`、または `payment_product_reorder` で指定します。商品グループの作成はAPI経由の作成上限の対象外です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `name` | string | 必須 | グループ名（最大255文字） |

**指示例:**

* 「"講座"という商品グループを作成して」

***

### payment\_product\_group\_get

商品グループの内容（グループ名・表示順）を取得します。所属する商品は `payment_product_list` の `product_group_id` で確認します。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_group_id` | string | 必須 | 商品グループID（`payment_product_group_list` で取得） |

**指示例:**

* 「この商品グループの情報を見せて」

***

### payment\_product\_group\_update

商品グループを更新します（部分更新）。更新できるのはグループ名（`name`）だけです（画面と同じ）。表示順は `payment_product_reorder` で変更します。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_group_id` | string | 必須 | 商品グループID |
| `name` | string | - | グループ名（最大255文字）。`null`・空文字は不可 |

**指示例:**

* 「商品グループ"講座"の名前を"オンライン講座"に変更して」

***

### payment\_product\_group\_delete

商品グループを削除します（物理削除）。商品（アーカイブ済みを含む）が1件でも所属しているグループは削除できず、エラー（`conflict`）になります。先に `payment_product_update` の `product_group_id` または `payment_product_reorder` で、所属する商品を未分類か他のグループへ移してください。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_group_id` | string | 必須 | 商品グループID |

**指示例:**

* 「商品グループ"旧講座"を削除して」

***

## 商品詳細

商品配下の商品詳細（管理画面「商品詳細管理」の各行。価格・支払方法・決済代行会社・支払回数の組み合わせ）を操作します。商品IDは `payment_product_list` で取得します。

### payment\_product\_detail\_list

商品配下の商品詳細の一覧を取得します（通常商品 → オーダーバンプ商品の順、表示順）。名称・支払方法・決済代行会社・支払回数・金額などの概要だけを返し、全項目は `payment_product_detail_get` で取得します。ファネルページの要素（「決済」「オーダーバンプ」の `product_detail_id`、決済の動作を設定した「ボタン」の `payment_product_detail_id`）や、売上一覧の絞り込みに使う商品詳細IDの取得元です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |

**指示例:**

* 「この商品の商品詳細を一覧で見せて」
* 「継続課金の商品詳細を持つ商品を確認して」

***

### payment\_product\_detail\_create

商品に商品詳細を作成します。`payment_type`（支払方法）・`payment_provider`（決済代行会社）・`charge_type`（支払回数）の組み合わせで必須になる項目と指定できる値が変わり、違反はエラー（`validation_error`）になります。主な制約: 銀行振込（`bank_transfer`）は `payment_provider` が `none` / `univapay`、`charge_type` が `one_time` のみで、支払い期限（`deadline_days`）とリマインドメールの送信のタイミング（`deadline_mail_sent_before_days`）が必須。クレジットカード払いは `none` 不可。`multiple` は `installment_count` 必須、`subscription` は `trial_days` 必須。`stripe` + `one_time` は金額 50 以上、`stripe` + `multiple` / `subscription` は Stripe プランIDが必須（実在を検証）、`stripe` + 初回別金額は `recurring_amount` 必須で、`amount` は `recurring_amount` 以下（差額が Stripe クーポンになる）。送信が有効なメールの送信者情報（送信者名・送信元に応じた送信者メールアドレスまたはお問い合わせ先・カスタム時の件名と本文）も検証されます。省略した項目は管理画面の作成フォームの初期値（`payment_type=credit_card`、`billing_cycle=month`、`deadline_days=7`、`deadline_mail_sent_before_days=3`、申込受付メール・リマインドメールは送信する、通知先メールアドレスはアカウントのメールアドレスなど）になります。Stripe のシークレットキー未登録でプラン検証・クーポン作成ができない場合はエラー（`stripe_not_configured`）、API 経由の作成上限（月間・累計）を超えた場合はエラー（`monthly_limit_exceeded` / `total_limit_exceeded`）です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `name` | string | 必須 | 名称（最大255文字） |
| `payment_type` | string | - | 支払方法。`credit_card`（クレジットカード払い）/ `bank_transfer`（銀行振込）。省略時は `credit_card` |
| `payment_provider` | string | 必須 | 決済代行会社。`none`（なし。銀行振込のみ）/ `stripe` / `univapay` / `aquagates`（有効な環境のみ）/ `telecom`（テレコムクレジット）/ `firstpayment` / `robotpayment` |
| `charge_type` | string | 必須 | 支払回数。`one_time`（一回払い）/ `multiple`（複数回払い・分割払い）/ `subscription`（継続課金）。銀行振込は `one_time` のみ |
| `payment_setting_id` | string | - | 決済連携設定ID（null・省略はデフォルトの決済連携設定） |
| `is_bump` | boolean | - | オーダーバンプ商品か（省略時は false＝通常商品） |
| `is_hidden` | boolean | - | 連携フォームに表示しないか（省略時は false）。true にすると商品名表記・価格表記は null、販売期間は指定しないになる |
| `amount` | integer | 必須 | 金額（円・税込。0〜99,999,999）。一回払いは決済金額、初回別金額のときは初回決済時の金額、`multiple` + `aquagates` は決済総額、その他の `multiple` は1回当たりの金額 |
| `use_different_first_amount` | boolean | - | 初回決済時の金額と2回目以降の金額を分けるか（省略時は false） |
| `recurring_amount` | integer | - | 2回目以降の金額（円）。`stripe` + 初回別金額のとき必須で、`amount` 以上にする |
| `installment_count` | integer | - | 支払回数・分割回数（0〜999）。`charge_type=multiple` のとき必須（それ以外は null で保存） |
| `trial_days` | integer | - | 無料お試し日数（0以上。省略時は 0）。`charge_type=subscription` のとき必須。`aquagates` は 24 以下（それ以外の支払回数では 0 で保存） |
| `billing_cycle` | string | - | 課金サイクル。`month`（毎月）/ `year`（毎年）。省略時は `month` |
| `show_payment_count` | boolean | - | 分割払いオプション（購入フォームに分割払い回数の選択肢を表示するか。省略時は false） |
| `stripe_plan_id` | string | - | StripeプランのプランID（画面の「Stripeプラン」。最大255文字。決済連携設定の本番用 Stripe アカウントに実在すること）。`stripe` + `multiple` / `subscription` で `stripe_test_plan_id` とどちらか一方が必須 |
| `stripe_test_plan_id` | string | - | Stripeプラン(テストモード)のプランID（最大255文字） |
| `telecom_rebill_param_id` | string | - | テレコムクレジットの rebill\_param\_id（最大255文字） |
| `has_sales_limit` | boolean | - | 販売上限を指定するか（省略時は false） |
| `max_sales_quantity` | integer | - | 販売上限数（0以上）。`has_sales_limit=true` のとき必須 |
| `display_name` | string | - | 連携フォームでの商品名表記（最大1024文字。null は商品名をそのまま表示） |
| `display_price` | string | - | 連携フォームでの価格表記（最大1024文字。null は金額をそのまま表示） |
| `use_sales_period` | boolean | - | 販売期間を指定するか（省略時は false） |
| `sales_period_from` | string | - | 販売期間の開始日時（YYYY-MM-DD HH:mm:ss。秒は 00 に正規化） |
| `sales_period_to` | string | - | 販売期間の終了日時（YYYY-MM-DD HH:mm:ss。秒は 59 に正規化） |
| `receipt_name` | string | - | 領収書の品名（最大1024文字） |
| `receipt_description` | string | - | 領収書の但し書き（最大255文字） |
| `purchase_register_type` | string | - | 購入後（銀行振込は入金反映後）の登録先。`none`（登録しない）/ `scenario`（シナリオに登録）/ `external_form`（外部連携フォームを利用）。省略時は `none` |
| `purchase_scenario_id` | string | - | 購入後に登録するシナリオID。`purchase_register_type=scenario` のとき必須 |
| `purchase_form_id` | string | - | 購入後に利用する外部連携フォームID |
| `purchase_bundle_id` | string | - | 購入後に開放するバンドルID（null は開放しない） |
| `purchase_action_id` | string | - | 購入後に実行するアクションID（null は実行しない） |
| `registration_register_type` | string | - | 申込後の登録先（銀行振込で有効）。`none` / `scenario` / `external_form`。省略時は `none` |
| `registration_scenario_id` | string | - | 申込後に登録するシナリオID。`registration_register_type=scenario` のとき必須 |
| `registration_form_id` | string | - | 申込後に利用する外部連携フォームID（`external_form` 以外は null で保存） |
| `registration_action_id` | string | - | 申込後に実行するアクションID |
| `has_registration_mail` | boolean | - | 申込受付メールを送信するか（銀行振込で有効。省略時は true、`bank_transfer` + `univapay` は false） |
| `registration_from_name` | string | - | 申込受付メールの送信者名（最大255文字）。送信が有効なとき必須 |
| `registration_from_mail` | string | - | 申込受付メールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信が有効で送信元が `own_domain` のとき必須 |
| `registration_from_address_type` | string | - | 申込受付メールの送信元。`own_domain`（独自ドメインのアドレスを利用）/ `system`（システム標準のアドレスを利用。設定された環境のみ）。省略時は `own_domain` |
| `registration_reply_to_mail` | string | - | 申込受付メールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_registration_custom_mail` | boolean | - | 申込受付メールの送信内容をカスタムするか（省略時は false） |
| `registration_subject` | string | - | 申込受付メールの件名（最大255文字）。カスタム時必須 |
| `registration_body` | string | - | 申込受付メールの本文。カスタム時必須 |
| `deadline_days` | integer | - | 支払い期限（申し込みから何日後か。0〜32767。省略時は 7）。銀行振込のとき必須 |
| `has_deadline_mail` | boolean | - | リマインドメールを送信するか（銀行振込で有効。省略時は true、`bank_transfer` + `univapay` は false） |
| `deadline_from_name` | string | - | リマインドメールの送信者名（最大255文字）。送信が有効なとき必須 |
| `deadline_from_mail` | string | - | リマインドメールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信が有効で送信元が `own_domain` のとき必須 |
| `deadline_from_address_type` | string | - | リマインドメールの送信元。`own_domain` / `system`。省略時は `own_domain` |
| `deadline_reply_to_mail` | string | - | リマインドメールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_deadline_custom_mail` | boolean | - | リマインドメールの送信内容をカスタムするか（省略時は false） |
| `deadline_subject` | string | - | リマインドメールの件名（最大255文字）。カスタム時必須 |
| `deadline_body` | string | - | リマインドメールの本文。カスタム時必須 |
| `deadline_mail_sent_before_days` | integer | - | リマインドメールの送信のタイミング（支払い締切の何日前か。0〜32767。省略時は 3）。銀行振込のとき必須 |
| `cancel_unregister_scenario_id` | string | - | 解除時に解除するシナリオID（複数回払い・分割払い・継続課金で有効。null は解除しない） |
| `cancel_register_type` | string | - | 解除時の登録先。`none` / `scenario` / `external_form`。省略時は `none` |
| `cancel_register_scenario_id` | string | - | 解除時に登録するシナリオID。`cancel_register_type=scenario` のとき必須 |
| `cancel_form_id` | string | - | 解除時に利用する外部連携フォームID |
| `cancel_bundle_id` | string | - | 解除時に停止するバンドルID（null は停止しない） |
| `cancel_action_id` | string | - | 解除時に実行するアクションID（null は実行しない） |
| `has_failed_mail` | boolean | - | 課金失敗時に顧客へメールを送信するか（複数回払い・分割払い・継続課金で有効。省略時は false） |
| `failed_from_name` | string | - | 課金失敗メールの送信者名（最大255文字。省略時はアカウント名） |
| `failed_from_mail` | string | - | 課金失敗メールの送信者メールアドレス（最大255文字・メールアドレス形式。省略時はアカウントのメールアドレス、システム標準の送信元が設定された環境では null）。送信が有効で送信元が `own_domain` のとき必須 |
| `failed_from_address_type` | string | - | 課金失敗メールの送信元。`own_domain` / `system`。省略時は `own_domain` |
| `failed_reply_to_mail` | string | - | 課金失敗メールのお問い合わせ先メールアドレス（最大255文字・メールアドレス形式）。送信が有効で送信元が `system` のとき必須 |
| `failed_subject` | string | - | 課金失敗メールの件名（最大255文字。省略時は既定の件名） |
| `failed_body` | string | - | 課金失敗メールの本文（省略時は既定の本文） |
| `has_purchase_mail` | boolean | - | 購入後（入金反映後）に顧客へメールを送信するか（省略時は false）。管理者向けの通知設定とは別 |
| `purchase_from_name` | string | - | 購入後メールの送信者名（最大255文字）。送信が有効なとき必須 |
| `purchase_from_address_type` | string | - | 購入後メールの送信元。`own_domain` / `system`。省略時は `own_domain` |
| `purchase_from_mail` | string | - | 購入後メールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信が有効で送信元が `own_domain` のとき必須 |
| `purchase_reply_to_mail` | string | - | 購入後メールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_purchase_custom_mail` | boolean | - | 購入後メールの送信内容をカスタムするか（省略時は false） |
| `purchase_subject` | string | - | 購入後メールの件名（最大255文字）。カスタム時必須 |
| `purchase_body` | string | - | 購入後メールの本文。カスタム時必須 |
| `notify_mail` | string | - | 通知設定の通知先メールアドレス（最大2048文字。カンマ区切りで複数可。省略時はアカウントのメールアドレス。null は通知しない） |
| `is_purchase_custom_notify` | boolean | - | 購入通知の通知内容をカスタムするか（省略時は false） |
| `purchase_custom_notify_subject` | string | - | 購入通知の件名（最大1024文字） |
| `purchase_custom_notify_body` | string | - | 購入通知の本文（置き換え文字を利用可） |
| `chat_notify_type` | string | - | チャット通知の通知先。`none`（通知しない）/ `chatwork` / `slack` / `discord`。省略時は `none` |
| `chat_notify_token` | string | - | Chatwork の APIトークン、または Slack の Bot User OAuth Token（最大255文字）。設定専用で取得はできない |
| `chat_notify_webhook_url` | string | - | Discord のウェブフックURL（最大255文字・URL形式）。設定専用で取得はできない |
| `chat_notify_to` | string | - | チャット通知の通知先（Slack はチャンネル名、Chatwork はルームID。最大255文字） |
| `is_chat_custom_notify` | boolean | - | チャット通知の通知内容をカスタムするか（省略時は false） |
| `chat_notify_text` | string | - | チャット通知の内容（カスタム時） |

**指示例:**

* 「この商品に一回払い 10,000 円の Stripe の商品詳細を追加して」
* 「銀行振込の商品詳細を作って。支払い期限は申し込みから 7 日後にして」

***

### payment\_product\_detail\_get

商品詳細の全項目（基本情報・金額・販売設定・申込後 / 購入後 / 解除時の動作設定・支払い期限の設定・課金失敗時の動作設定・通知設定・チャット通知）を取得します。チャット通知の APIトークン・ウェブフックURL は設定専用のため含まれません。取得した内容はそのまま `payment_product_detail_update` に送り返せます（`trial_days` が負の値の既存データだけは、0 以上の範囲で検証されるため 0 以上に直してから送ります）。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `detail_id` | string | 必須 | 商品詳細ID |

**指示例:**

* 「この商品詳細の設定を全部見せて」
* 「この商品詳細の購入後の動作設定を確認して」

***

### payment\_product\_detail\_update

商品詳細を更新します（部分更新）。送信したフィールドのみ更新され、未送信のフィールドは既存値を維持します（`chat_notify_token` / `chat_notify_webhook_url` も省略時は既存値を維持、null でクリア）。項目の意味と組み合わせの制約は `payment_product_detail_create` と同じで、制約はリクエストで値が変わるフィールドに関わるものだけを検証します（取得した値をそのまま送り返せます。ただし `trial_days` が負の値の既存データは 0 以上に直してから送ります）。購入実績のある商品詳細は `payment_type` / `payment_provider` を変更できません（`validation_error`）。`payment_setting_id` に null を送るとデフォルトの決済連携設定に差し替えます。決済代行会社・決済連携設定・Stripe プランIDの変更時や、支払回数を `multiple` / `subscription` に変更したときは Stripe プランの実在を検証し、`stripe` + 初回別金額で金額に差がある場合は Stripe クーポンを作り直します（シークレットキー未登録はエラー `stripe_not_configured`）。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `detail_id` | string | 必須 | 商品詳細ID |
| `name` | string | - | 名称（最大255文字）。null は既存値が null のときのみ可 |
| `payment_type` | string | - | 支払方法。`credit_card` / `bank_transfer`。購入実績がある場合は変更不可 |
| `payment_provider` | string | - | 決済代行会社。`none` / `stripe` / `univapay` / `aquagates` / `telecom` / `firstpayment` / `robotpayment`。購入実績がある場合は変更不可 |
| `charge_type` | string | - | 支払回数。`one_time` / `multiple` / `subscription` |
| `payment_setting_id` | string | - | 決済連携設定ID。null でデフォルトの決済連携設定に差し替え |
| `is_bump` | boolean | - | オーダーバンプ商品か |
| `is_hidden` | boolean | - | 連携フォームに表示しないか。true にすると商品名表記・価格表記は null、販売期間は指定しないになる |
| `amount` | integer | - | 金額（円・税込。0〜99,999,999） |
| `use_different_first_amount` | boolean | - | 初回決済時の金額と2回目以降の金額を分けるか |
| `recurring_amount` | integer | - | 2回目以降の金額（円）。null でクリア |
| `installment_count` | integer | - | 支払回数・分割回数（0〜999）。`charge_type=multiple` のとき必須 |
| `trial_days` | integer | - | 無料お試し日数（0以上）。`subscription` 以外では 0 で保存 |
| `billing_cycle` | string | - | 課金サイクル。`month` / `year` |
| `show_payment_count` | boolean | - | 分割払いオプション（購入フォームに分割払い回数の選択肢を表示するか） |
| `stripe_plan_id` | string | - | StripeプランのプランID（画面の「Stripeプラン」。変更時に本番用の Stripe アカウントで実在を検証）。null でクリア |
| `stripe_test_plan_id` | string | - | Stripeプラン(テストモード)のプランID（変更時に実在を検証）。null でクリア |
| `telecom_rebill_param_id` | string | - | テレコムクレジットの rebill\_param\_id。null でクリア |
| `has_sales_limit` | boolean | - | 販売上限を指定するか |
| `max_sales_quantity` | integer | - | 販売上限数（0以上）。省略時は既存の値を維持。null は不可 |
| `display_name` | string | - | 連携フォームでの商品名表記（最大1024文字）。null で商品名をそのまま表示 |
| `display_price` | string | - | 連携フォームでの価格表記（最大1024文字）。null で金額をそのまま表示 |
| `use_sales_period` | boolean | - | 販売期間を指定するか |
| `sales_period_from` | string | - | 販売期間の開始日時（YYYY-MM-DD HH:mm:ss。秒は 00 に正規化）。null でクリア |
| `sales_period_to` | string | - | 販売期間の終了日時（YYYY-MM-DD HH:mm:ss。秒は 59 に正規化）。null でクリア |
| `receipt_name` | string | - | 領収書の品名（最大1024文字）。null でクリア |
| `receipt_description` | string | - | 領収書の但し書き（最大255文字）。null でクリア |
| `purchase_register_type` | string | - | 購入後の登録先。`none` / `scenario` / `external_form` |
| `purchase_scenario_id` | string | - | 購入後に登録するシナリオID。`purchase_register_type=scenario` のとき必須 |
| `purchase_form_id` | string | - | 購入後に利用する外部連携フォームID。null でクリア |
| `purchase_bundle_id` | string | - | 購入後に開放するバンドルID。null で開放しない |
| `purchase_action_id` | string | - | 購入後に実行するアクションID。null で実行しない |
| `registration_register_type` | string | - | 申込後の登録先（銀行振込で有効）。`none` / `scenario` / `external_form` |
| `registration_scenario_id` | string | - | 申込後に登録するシナリオID。`registration_register_type=scenario` のとき必須 |
| `registration_form_id` | string | - | 申込後に利用する外部連携フォームID（`external_form` 以外は null で保存） |
| `registration_action_id` | string | - | 申込後に実行するアクションID。null で実行しない |
| `has_registration_mail` | boolean | - | 申込受付メールを送信するか（銀行振込で有効） |
| `registration_from_name` | string | - | 申込受付メールの送信者名（最大255文字） |
| `registration_from_mail` | string | - | 申込受付メールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信元が `own_domain` のとき使用 |
| `registration_from_address_type` | string | - | 申込受付メールの送信元。`own_domain` / `system`。省略時は保存されている送信者メールアドレスの有無から復元 |
| `registration_reply_to_mail` | string | - | 申込受付メールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_registration_custom_mail` | boolean | - | 申込受付メールの送信内容をカスタムするか |
| `registration_subject` | string | - | 申込受付メールの件名（最大255文字） |
| `registration_body` | string | - | 申込受付メールの本文 |
| `deadline_days` | integer | - | 支払い期限（申し込みから何日後か。0〜32767）。銀行振込のとき必須 |
| `has_deadline_mail` | boolean | - | リマインドメールを送信するか（銀行振込で有効） |
| `deadline_from_name` | string | - | リマインドメールの送信者名（最大255文字） |
| `deadline_from_mail` | string | - | リマインドメールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信元が `own_domain` のとき使用 |
| `deadline_from_address_type` | string | - | リマインドメールの送信元。`own_domain` / `system` |
| `deadline_reply_to_mail` | string | - | リマインドメールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_deadline_custom_mail` | boolean | - | リマインドメールの送信内容をカスタムするか |
| `deadline_subject` | string | - | リマインドメールの件名（最大255文字） |
| `deadline_body` | string | - | リマインドメールの本文 |
| `deadline_mail_sent_before_days` | integer | - | リマインドメールの送信のタイミング（支払い締切の何日前か。0〜32767）。銀行振込のとき必須 |
| `cancel_unregister_scenario_id` | string | - | 解除時に解除するシナリオID。null で解除しない |
| `cancel_register_type` | string | - | 解除時の登録先。`none` / `scenario` / `external_form` |
| `cancel_register_scenario_id` | string | - | 解除時に登録するシナリオID。`cancel_register_type=scenario` のとき必須 |
| `cancel_form_id` | string | - | 解除時に利用する外部連携フォームID。null でクリア |
| `cancel_bundle_id` | string | - | 解除時に停止するバンドルID。null で停止しない |
| `cancel_action_id` | string | - | 解除時に実行するアクションID。null で実行しない |
| `has_failed_mail` | boolean | - | 課金失敗時に顧客へメールを送信するか（複数回払い・分割払い・継続課金で有効） |
| `failed_from_name` | string | - | 課金失敗メールの送信者名（最大255文字） |
| `failed_from_mail` | string | - | 課金失敗メールの送信者メールアドレス（最大255文字・メールアドレス形式）。送信元が `own_domain` のとき使用 |
| `failed_from_address_type` | string | - | 課金失敗メールの送信元。`own_domain` / `system` |
| `failed_reply_to_mail` | string | - | 課金失敗メールのお問い合わせ先メールアドレス（最大255文字・メールアドレス形式）。送信が有効で送信元が `system` のとき必須 |
| `failed_subject` | string | - | 課金失敗メールの件名（最大255文字） |
| `failed_body` | string | - | 課金失敗メールの本文 |
| `has_purchase_mail` | boolean | - | 購入後（入金反映後）に顧客へメールを送信するか。管理者向けの通知設定とは別 |
| `purchase_from_name` | string | - | 購入後メールの送信者名（最大255文字）。送信が有効なとき必須。null でクリア |
| `purchase_from_address_type` | string | - | 購入後メールの送信元。`own_domain` / `system` |
| `purchase_from_mail` | string | - | 購入後メールの送信者メールアドレス（最大255文字。フリーメール・携帯キャリアメール不可）。送信元が `own_domain` のとき使用 |
| `purchase_reply_to_mail` | string | - | 購入後メールのお問い合わせ先メールアドレス（最大255文字）。送信が有効で送信元が `system` のとき必須 |
| `is_purchase_custom_mail` | boolean | - | 購入後メールの送信内容をカスタムするか |
| `purchase_subject` | string | - | 購入後メールの件名（最大255文字）。カスタム時必須。null でクリア |
| `purchase_body` | string | - | 購入後メールの本文。カスタム時必須。null でクリア |
| `notify_mail` | string | - | 通知設定の通知先メールアドレス（最大2048文字。カンマ区切りで複数可）。null で通知しない |
| `is_purchase_custom_notify` | boolean | - | 購入通知の通知内容をカスタムするか |
| `purchase_custom_notify_subject` | string | - | 購入通知の件名（最大1024文字） |
| `purchase_custom_notify_body` | string | - | 購入通知の本文 |
| `chat_notify_type` | string | - | チャット通知の通知先。`none` / `chatwork` / `slack` / `discord` |
| `chat_notify_token` | string | - | Chatwork の APIトークン、または Slack の Bot User OAuth Token（最大255文字）。設定専用で取得はできない。省略時は既存値を維持、null でクリア |
| `chat_notify_webhook_url` | string | - | Discord のウェブフックURL（最大255文字・URL形式）。設定専用で取得はできない。省略時は既存値を維持、null でクリア |
| `chat_notify_to` | string | - | チャット通知の通知先（Slack はチャンネル名、Chatwork はルームID。最大255文字） |
| `is_chat_custom_notify` | boolean | - | チャット通知の通知内容をカスタムするか |
| `chat_notify_text` | string | - | チャット通知の内容（カスタム時） |

**指示例:**

* 「この商品詳細の金額を 12,000 円に変更して」
* 「この商品詳細の購入後に登録するシナリオを変更して」

***

### payment\_product\_detail\_delete

商品詳細を削除します（管理画面の削除と同じ物理削除。取り消せません）。購入実績や進行中の継続課金があっても拒否されません。売上・継続課金・ファネルページの要素からの参照は削除されませんが、商品詳細が無くなった売上は売上一覧・売上詳細に表示されなくなります。継続課金が参照する商品詳細を削除すると、会員サイトから受講生による解約・カード情報の変更ができなくなります（決済代行会社側の課金は停止しません）。実行前に利用者に確認してください。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `detail_id` | string | 必須 | 商品詳細ID |

**指示例:**

* 「この商品詳細を削除して」

***

### payment\_product\_detail\_reorder

商品詳細の表示順を変更します。通常商品（`is_bump=false`）の全商品詳細IDを並べたい順に指定します（過不足があるとエラー `validation_error`）。オーダーバンプ商品（`is_bump=true`）は並び替えの対象外で、含めるとエラーになります。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `product_id` | string | 必須 | 商品ID |
| `detail_ids` | array | 必須 | 並び替え後の順序で通常商品の全商品詳細IDを指定（JSON文字列でも可） |

**指示例:**

* 「この商品の商品詳細を、月額プランを先頭にして並び替えて」

***

## 売上

売上（管理画面「売上」の「売上一覧」「月別売上集計」「日別売上集計」）を操作します。売上一覧は商品の売上とイベントの入金をまとめて返し、売上詳細・領収書・請求書設定・入金反映・削除は商品の売上が対象です。

### payment\_purchase\_list

売上（管理画面「売上一覧」）の一覧を取得します。商品の売上とイベントの入金を1つの一覧で返し、`sales_type`（`product`＝商品の売上 / `event`＝イベントの入金）で区別します。`sales_type=event` の行の `id` はイベントの申込者IDで、詳細は `event_applicant_get`（`project_id` に `event.id`、`applicant_id` に `id`）で取得します。各行は売上日時・商品（`product` / `product_detail`）またはイベント（`event`）・金額・支払方法・ステータス（`paid`＝決済成功 / `pending`＝振込待ち / `failed`＝決済失敗 / `refunded`＝返金済み / `cancelled`＝キャンセル）・決済モード・購入者・登録経路名・パートナー名を含み、売上日時の降順です。`product_id` と `event_id` は同時に指定できません（`validation_error`）。銀行振込・商品・商品詳細・`paid` 以外のステータスで絞るとイベントの入金行は含まれず、`event_id` で絞ると商品の売上は含まれません。商品や商品詳細が削除された売上は一覧に出ません。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `date_from` | string | - | 期間の開始日（YYYY-MM-DD）。売上日時がこの日以降の売上 |
| `date_to` | string | - | 期間の終了日（YYYY-MM-DD）。売上日時がこの日までの売上 |
| `payment_type` | string | - | 支払方法で絞り込み。`credit_card`（クレジットカード払い）/ `bank_transfer`（銀行振込。イベントの入金行は含まれない） |
| `product_id` | string | - | 商品IDで絞り込み（イベントの入金行は含まれない）。`event_id` とは同時に指定できない |
| `event_id` | string | - | イベントIDで絞り込み（そのイベントの入金行だけになり、商品の売上は含まれない）。`product_id` とは同時に指定できない |
| `product_detail_id` | string | - | 商品詳細IDで絞り込み（イベントの入金行は含まれない） |
| `amount_from` | integer | - | 金額の下限（この金額以上の売上） |
| `amount_to` | integer | - | 金額の上限（この金額以下の売上） |
| `name` | string | - | 購入者の名前で部分一致検索 |
| `mail` | string | - | 購入者のメールアドレスで部分一致検索 |
| `phone` | string | - | 購入者の電話番号で部分一致検索（ハイフンを含めて指定するとハイフンと空白を除いて比較） |
| `tracking_name` | string | - | 登録経路名で部分一致検索（登録経路名と最初のステップの登録経路名のどちらかに一致） |
| `status` | string | - | ステータスで絞り込み。`paid`（決済成功）/ `pending`（振込待ち）/ `failed`（決済失敗）。`paid` 以外を指定するとイベントの入金行は含まれない |
| `is_test_mode` | boolean | - | 決済モードで絞り込み（true はテストモード、false は本番モード。未指定は両方） |
| `page` | integer | - | ページ番号（デフォルト 1） |
| `per_page` | integer | - | 1ページあたりの件数（デフォルト 20、最大 100） |

**指示例:**

* 「今月の売上一覧を見せて」
* 「振込待ちの銀行振込の売上を一覧にして」
* 「この商品の売上を購入者のメールアドレスで検索して」

***

### payment\_purchase\_get

売上の詳細（管理画面「売上詳細」と「領収書・請求書設定」の内容）を取得します。一覧の項目に加えて、決済代行会社（`payment_provider`）・入金日（`payment_date`）と入金反映日時（`payment_processed_at`）・振込先口座（`bank_account`。銀行名・支店名・口座種別・口座番号・口座名義が全て登録されているときのみ）・クーポン（`coupon`）・登録元ページURL（`referer`）・IP・端末（`device`: `mobile`＝スマホ/タブレット / `pc`＝PC）・端末詳細（`user_agent`）・パートナー（`partner`: パートナー名・案件名・報酬）・領収書・請求書設定（`business_id` / `receipt_name` / `receipt_description`）を含みます。イベントの入金行のIDを指定するとエラー（`not_found`）です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `purchase_id` | string | 必須 | 売上ID |

**指示例:**

* 「この売上の詳細を見せて」
* 「この売上の振込先口座と入金日を確認して」

***

### payment\_purchase\_update

売上の領収書・請求書設定（管理画面の操作メニュー「領収書・請求書設定」: 事業者・宛名・領収書の但し書き）を更新します（部分更新）。送信したフィールドのみ更新され、未送信のフィールドは既存値を維持します。`business_id` に null を送るとデフォルトの事業者に戻し、`receipt_name` / `receipt_description` に null を送ると未設定に戻します。決済失敗の売上・金額 0 円の売上・事業者設定が登録されていないアカウントではエラー（`bad_request`）、存在しない事業者設定IDはエラー（`validation_error`）、イベントの入金行のIDはエラー（`not_found`）です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `purchase_id` | string | 必須 | 売上ID |
| `business_id` | string | - | 領収書・請求書の発行事業者となる事業者設定ID（null でデフォルトの事業者。事業者設定の一覧取得ツールは無いため、商品や売上の取得結果の `business_id` を再利用する） |
| `receipt_name` | string | - | 宛名（最大255文字）。null で未設定に戻す |
| `receipt_description` | string | - | 領収書の但し書き（最大255文字）。null で未設定に戻す |

**指示例:**

* 「この売上の領収書の宛名を『株式会社〇〇』にして」
* 「この売上の但し書きを『セミナー受講料として』に変更して」

***

### payment\_purchase\_bank\_transfer\_reflect

銀行振込の入金を反映します（管理画面の操作メニュー「入金反映」）。振込待ち（`status=pending`）の銀行振込の売上を、入金日を指定して決済成功（`status=paid`）にします。管理画面の入金反映と同じく、商品詳細の購入後（入金反映後）の動作設定に従ったシナリオへの登録または外部連携フォームへの登録・バンドルの開放・アクションの実行・購入後メールの送信、パートナー成約の確定と通知、領収書の送信が行われます。振込待ちの銀行振込以外の売上（クレジットカード払い・反映済みなど）はエラー（`bad_request`）です。シナリオへの登録が拒否された場合（同一メールアドレスの連続登録の制限など）もエラー（`bad_request`）で、売上は振込待ちのままです。同じ売上への同時実行は先行する処理の完了を待ってから判定し、待ち時間内に完了しない場合もエラー（`bad_request`）になります（二重に反映されることはありません）。実行前に利用者に確認してください。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `purchase_id` | string | 必須 | 売上ID |
| `payment_date` | string | 必須 | 入金日（YYYY-MM-DD。管理画面の「入金日」） |

**指示例:**

* 「この売上の入金を今日の日付で反映して」
* 「振込待ちの売上を 2026-10-28 入金で反映して」

***

### payment\_purchase\_delete

売上を削除します（管理画面の操作メニュー「削除」と同じ。取り消せません。管理画面ではテストデータの削除のみに使うよう案内しています）。購入者・商品詳細・継続課金・パートナー成約は削除されません。ステータスに関係なく削除できます。イベントの入金行のIDを指定するとエラー（`not_found`）です。実行前に利用者に確認してください。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `purchase_id` | string | 必須 | 売上ID |

**指示例:**

* 「このテストモードの売上を削除して」

***

### payment\_purchase\_stats\_monthly

月別売上集計（管理画面「月別売上集計」）を取得します。指定した年の1〜12月それぞれの件数と売上（`monthly`）と年間の合計（`totals`）を返します。本番モードで決済失敗でない商品の売上（振込待ちを含む）と、本番モードのイベントの入金（日程変更で複製された旧申込者を除く）を売上日時で集計します。売上の無い月は 0 です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `year` | integer | - | 集計年（2021〜今年。省略時は今年） |

**指示例:**

* 「今年の月別売上集計を見せて」
* 「去年の売上を月ごとに集計して」

***

### payment\_purchase\_stats\_daily

日別売上集計（管理画面「日別売上集計」）を取得します。指定した年月の各日の件数と売上（`daily`）と月間の合計（`totals`）を返します。集計対象は `payment_purchase_stats_monthly` と同じです。売上の無い日は 0 です。

**パラメータ:**

| パラメータ | 型 | 必須 | 説明 |
| - | - | - | - |
| `year` | integer | - | 集計年（2021〜今年。省略時は今年） |
| `month` | integer | - | 集計月（1〜12。省略時は今月） |

**指示例:**

* 「今月の日別売上集計を見せて」
* 「先月の売上を日ごとに集計して」

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.