サンプルJSONデータ（Apps API）

Apps APIおよびWebhookで使用される代表的なJSONサンプルを掲載しています。
実際の実装時の参考にしてください。

顧客新規作成イベント（customer）

{
  "id": "58886defd811bdbadec04bafd19d9f58",
  "event": "customer",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "customer": {
    "customer_id": "3a7f0e8f97955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  }
}

申し込み完了イベント（application）

{
  "id": "fdda24b899e5b42c571f6b435259b037",
  "event": "application",
  "mode": "live",
  "create_at": "2025-01-28T11:26:16Z",
  "contract_id": "310ede6b6c34c1365868e1f18099baf6",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  }
}

決済成功イベント（payment）

{
  "id": "a66fb8867f80ef7b9097fae64bcdd512",
  "event": "payment",
  "mode": "live",
  "create_at": "2025-01-23T10:34:19Z",
  "contract_id": "81a2b289a7744e8e5ff830a935e15af5",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  },
  "payment": {
    "platform_id": 4,
    "price": 6680.0,
    "card": {
      "brand": "visa",
      "exp_month": 12,
      "exp_year": 2034,
      "last4": "0000"
    }
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  }
}

返金成功イベント（refund）

{
  "id": "fdda24b899e5b42c571f6b435259b037",
  "event": "refund",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "contract_id": "310ede6b6c34c1365868e1f18099baf6",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  },
  "payment": {
    "platform_id": 4,
    "price": 6680.0,
    "refund_id": "refund_xxxxxxxx"
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  }
}

決済エラーイベント（payment_error）

{
  "id": "fdda24b899e5b42c571f6b435259b037",
  "event": "payment_error",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "contract_id": "310ede6b6c34c1365868e1f18099baf6",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com"
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  },
  "card": {
    "brand": "visa",
    "exp_month": 12,
    "exp_year": 2034,
    "last4": "0000"
  },
  "message": "カードの利用限度額を超えています"
}

かご落ちイベント（abandoned）

{
  "id": "f6e39de29dbb60fae58877817eda84c9",
  "event": "abandoned",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "cart_abandoned_list": [
    {
      "email": "a01@theapps.com",
      "name": "アップス太郎",
      "company": "テスト会社",
      "phone_number": "+818011112222",
      "plan": {
        "payment_type": 1,
        "name": "ドリップ口座"
      }
    }
  ]
}

解約完了イベント（canceled）

{
  "id": "fdda24b899e5b42c571f6b435259b037",
  "event": "canceled",
  "mode": "live",
  "create_at": "2025-02-01T10:07:31Z",
  "contract_id": "310ede6b6c34c1365868e1f18099baf6",
  "customer": {
    "customer_id": "3a7f0e8197955aa4178902e17371f1b5",
    "email": "taro@apps.com",
    "name": "アップス太郎",
    "company": "テスト会社",
    "phone_number": "+818018821111"
  },
  "plan": {
    "payment_type": 4,
    "name": "アップス月額プラン"
  }
}

関連情報

• 各イベントの詳細なデータ構造については Webhookデータ構造 をご覧ください。
• APIの基本的な使い方は API設定方法 を参照してください。