Skip to main content

概要

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

商品

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

payment_product_list

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

payment_product_create

商品を新規作成します。商品一覧の末尾に追加されます。作成後に payment_product_detail_create で商品詳細を追加すると決済フォームで販売できます。API経由の商品作成には作成上限(月間・累計)があり、超過するとエラー(monthly_limit_exceeded / total_limit_exceeded)になります。契約内容による商品の件数上限(アーカイブ済みを含む)に達している場合はエラー(bad_request)になります。 パラメータ: 指示例:
  • 「“オンライン講座”という商品を作成して」
  • 「商品グループ”セミナー”に、重複購入を禁止した商品”個別相談”を追加して」

payment_product_get

商品の内容(商品名・メモ・所属する商品グループ・事業者設定・重複購入・販売上限・アーカイブ状態)を取得します。配下の商品詳細は payment_product_detail_list で取得します。 パラメータ: 指示例:
  • 「この商品の設定を見せて」
  • 「商品”オンライン講座”の販売上限を確認して」

payment_product_update

商品を更新します(部分更新)。送信したフィールドのみ更新され、未送信のフィールドは既存の値を維持します。アーカイブ・アーカイブ解除は is_archived で行います(アーカイブ済みでも取得・更新・削除はでき、一覧の表示分けと商品並び替えの対象外になるだけです)。表示順は変更できません(payment_product_reorder で変更)。存在しない商品グループ・事業者設定を指定した場合や、max_sales_quantity に null を送った場合はエラー(validation_error)になります。max_sales_quantity を省略すると既存の値(未設定なら 0)を維持します。 パラメータ: 指示例:
  • 「商品”オンライン講座”の販売上限を100個にして」
  • 「この商品をアーカイブして」
  • 「商品”個別相談”を未分類に移して」

payment_product_delete

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

payment_product_reorder

商品を並び替えます(画面の「表示順変更」に相当)。商品グループの並び順・各商品の所属する商品グループ・グループ内の商品の並び順を一括で更新します。groups には未分類(product_group_id が null)の要素を先頭に1つ置き、全ての商品グループと、アーカイブ済みを除く全ての商品を網羅します(過不足・未分類が先頭以外・アーカイブ済み商品の指定はエラー validation_error)。商品の所属グループだけを変えたい場合は payment_product_update の product_group_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経由の作成上限の対象外です。 パラメータ: 指示例:
  • 「“講座”という商品グループを作成して」

payment_product_group_get

商品グループの内容(グループ名・表示順)を取得します。所属する商品は payment_product_list の product_group_id で確認します。 パラメータ: 指示例:
  • 「この商品グループの情報を見せて」

payment_product_group_update

商品グループを更新します(部分更新)。更新できるのはグループ名(name)だけです(画面と同じ)。表示順は payment_product_reorder で変更します。 パラメータ: 指示例:
  • 「商品グループ”講座”の名前を”オンライン講座”に変更して」

payment_product_group_delete

商品グループを削除します(物理削除)。商品(アーカイブ済みを含む)が1件でも所属しているグループは削除できず、エラー(conflict)になります。先に payment_product_update の product_group_id または payment_product_reorder で、所属する商品を未分類か他のグループへ移してください。 パラメータ: 指示例:
  • 「商品グループ”旧講座”を削除して」

商品詳細

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

payment_product_detail_list

商品配下の商品詳細の一覧を取得します(通常商品 → オーダーバンプ商品の順、表示順)。名称・支払方法・決済代行会社・支払回数・金額などの概要だけを返し、全項目は payment_product_detail_get で取得します。ファネルページの要素(「決済」「オーダーバンプ」の product_detail_id、決済の動作を設定した「ボタン」の payment_product_detail_id)や、売上一覧の絞り込みに使う商品詳細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)です。 パラメータ: 指示例:
  • 「この商品に一回払い 10,000 円の Stripe の商品詳細を追加して」
  • 「銀行振込の商品詳細を作って。支払い期限は申し込みから 7 日後にして」

payment_product_detail_get

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

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)。 パラメータ: 指示例:
  • 「この商品詳細の金額を 12,000 円に変更して」
  • 「この商品詳細の購入後に登録するシナリオを変更して」

payment_product_detail_delete

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

payment_product_detail_reorder

商品詳細の表示順を変更します。通常商品(is_bump=false)の全商品詳細IDを並べたい順に指定します(過不足があるとエラー validation_error)。オーダーバンプ商品(is_bump=true)は並び替えの対象外で、含めるとエラーになります。 パラメータ: 指示例:
  • 「この商品の商品詳細を、月額プランを先頭にして並び替えて」

売上

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

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 で絞ると商品の売上は含まれません。商品や商品詳細が削除された売上は一覧に出ません。 パラメータ: 指示例:
  • 「今月の売上一覧を見せて」
  • 「振込待ちの銀行振込の売上を一覧にして」
  • 「この商品の売上を購入者のメールアドレスで検索して」

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)です。 パラメータ: 指示例:
  • 「この売上の詳細を見せて」
  • 「この売上の振込先口座と入金日を確認して」

payment_purchase_update

売上の領収書・請求書設定(管理画面の操作メニュー「領収書・請求書設定」: 事業者・宛名・領収書の但し書き)を更新します(部分更新)。送信したフィールドのみ更新され、未送信のフィールドは既存値を維持します。business_id に null を送るとデフォルトの事業者に戻し、receipt_name / receipt_description に null を送ると未設定に戻します。決済失敗の売上・金額 0 円の売上・事業者設定が登録されていないアカウントではエラー(bad_request)、存在しない事業者設定IDはエラー(validation_error)、イベントの入金行のIDはエラー(not_found)です。 パラメータ: 指示例:
  • 「この売上の領収書の宛名を『株式会社〇〇』にして」
  • 「この売上の但し書きを『セミナー受講料として』に変更して」

payment_purchase_bank_transfer_reflect

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

payment_purchase_delete

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

payment_purchase_stats_monthly

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

payment_purchase_stats_daily

日別売上集計(管理画面「日別売上集計」)を取得します。指定した年月の各日の件数と売上(daily)と月間の合計(totals)を返します。集計対象は payment_purchase_stats_monthly と同じです。売上の無い日は 0 です。 パラメータ: 指示例:
  • 「今月の日別売上集計を見せて」
  • 「先月の売上を日ごとに集計して」