登録ページAPI

登録ページAPIでは、登録ページに表示する「プラン」をAPIで登録・一覧・更新・削除できます。
また、プランごとの契約者一覧（contractor）を取得できます。

エンドポイント一覧

POST   /v1/advance
GET    /v1/advance
GET    /v1/advance/{plan_id}
PUT    /v1/advance/{plan_id}
DELETE /v1/advance/{plan_id}
GET    /v1/advance/{plan_id}/contractor

プラン登録（新規作成）

POST /v1/advance

リクエストは Plan オブジェクト（JSON）です。最低限「contract_type」「plan_name」「language」は必須です。

・レスポンス（例）

{
  "plan_id": "PLAN_ID",
  "url_application": "申込みURL",
  "plan": { "Planオブジェクト" }
}

プラン一覧

GET /v1/advance

・レスポンス（例）

{
  "plans": [
    {
      "plan_id": "PLAN_ID",
      "contract_type": "email",
      "plan_name": "プラン名",
      "url_application": "申込みURL"
    }
  ]
}

プラン取得 / 更新 / 削除

GET    /v1/advance/{plan_id}
PUT    /v1/advance/{plan_id}
DELETE /v1/advance/{plan_id}

更新（PUT）のリクエストは Plan オブジェクトです。

契約者一覧の取得

GET /v1/advance/{plan_id}/contractor

・レスポンス（例）

{
  "contractor": [
    {
      "status": 2,
      "email": "example@theapps.com",
      "name": "名前",
      "company": "会社名（任意）",
      "contract_date": "契約日",
      "cancel_date": "解約日（任意）",
      "discord_id": "Discord ID（任意）",
      "discord_user_name": "Discordユーザー名（任意）",
      "line_id": "LINE ID（任意）",
      "line_user_name": "LINEユーザー名（任意）"
    }
  ]
}

Planオブジェクト（リクエスト）

Planオブジェクトは項目が多いため、ここでは「よく使うもの」「条件付きで必須になるもの」を中心にまとめます。

必須項目

• contract_type（必須）：契約種別（email / discord / line）
• plan_name（必須）：プラン名
• language（必須）：申し込みページの言語（ja / en / pt）

条件付きで必須（contract_type によって変わる）

• contract_type = discord の場合：discord_rule が必須
• contract_type = line の場合：line が必須

主な任意項目（例）

• provider_name：サービス提供者名
• label：ラベル
• agreement_terms：同意チェックボックス（任意）
• url_redirect_1 / url_redirect_2：完了時リダイレクトURL（任意）
• mail_application / mail_contract：メールテンプレート（任意）
• contract_start / contract_end：販売開始/終了（任意）
• quantity：在庫数（任意）
• alert_inventory：在庫アラート（任意）
• notes：備考欄の定義（任意）

※Planの全項目（詳細版）を載せたい場合は、別ページ「登録ページAPI：Planオブジェクト詳細」を作って分離するのがおすすめです（ページが長くなりすぎるのを防ぐため）。

以上