APIレスポンスデータ構造（Apps API）

Apps APIで取得できるレスポンスデータの共通的な構造を説明します。
各APIは以下のようなデータ形式でレスポンスを返します。

レスポンス共通構造

APIレスポンスは次のような共通の形式でJSONデータを返します。

{
  "contract_id": "契約の一意なID（UUID）",
  "customer": { 顧客情報オブジェクト },
  "payment": { 決済情報オブジェクト（カード情報は含まれません） },
  "plan": { プラン情報オブジェクト },
  "discord": { Discord連携情報（任意） },
  "line": { LINE連携情報（任意） },
  "shipping": { お届け先情報（任意） },
  "remarks": [ 備考欄情報（任意） ],
  "utm": [ UTMパラメータ情報（任意） ]
}

顧客情報オブジェクト（customer）

{
  "customer_id": "顧客の一意なID（UUID）",
  "email": "顧客のメールアドレス",
  "name": "顧客名（任意）",
  "company": "会社名（任意）",
  "phone_number": "電話番号（任意・E.164形式）"
}

決済情報オブジェクト（payment）

{
  "platform_id": "決済プラットフォームID",
  "original_price": "割引前の金額または割引前の総支払金額（1回払い・定期払いのみ）",
  "total_price": "割引後の総支払金額（定期払いのみ）",
  "price": "決済金額",
  "charge_id": "プラットフォーム決済ID（任意）",
  "refund_id": "返金ID（任意）"
}

※「original_price」と「total_price」は2025年6月7日より追加されました。

• 1回払いの場合：「original_price」＝割引前の金額
• 定期払いの場合：「original_price」＝割引前の総支払金額、「total_price」＝割引後の総支払金額

プラン情報オブジェクト（plan）

{
  "payment_type": "決済タイプ（1: 1回払い, 4: 定期払い, 5: 毎月払い[回数制限付き]）",
  "name": "プラン名"
}

Discord連携オブジェクト（discord）

{
  "discord_id": "DiscordユーザーID",
  "discord_name": "Discordユーザー名（任意）"
}

LINE連携オブジェクト（line）

{
  "line_id": "LINEユーザーID",
  "line_name": "LINEユーザー名（任意）"
}

お届け先オブジェクト（shipping）

{
  "name": "お届け先名（任意）",
  "address_country": "国（任意）",
  "address_zip": "郵便番号（任意）",
  "address_state": "都道府県（任意）",
  "address_city": "市町村（任意）",
  "address_line1": "住所1（任意）",
  "address_line2": "住所2（任意）"
}

備考欄情報オブジェクト（remarks）

[
  {
    "name": "備考欄項目名（任意）",
    "value": "顧客の入力値（任意）"
  }
]

UTMパラメータ情報オブジェクト（utm）

[
  {
    "name": "UTMパラメータ名（任意）",
    "value": "UTMパラメータ値（任意）"
  }
]

関連情報

• 各エンドポイントの詳細については APIエンドポイント一覧 を参照してください。
• Webhookで通知されるデータ形式については Webhookデータ構造 をご覧ください。