Apps API

Apps APIを利用すると、顧客情報や決済情報の取得、Webhookによるイベント通知の受信に加えて、登録ページ・決済ページのプラン管理、Discord連携の一部操作をAPIから実行できます。各APIの設定方法や仕様については、以下のリンクから確認してください。

Apps APIは管理画面から機能をインストールして使います。アプリID、アプリシークレット、アクセストークンは認証情報です。外部サイト、チャット、GitHub、問い合わせ本文などに貼り付けないでください。

2026年7月4日の訂正

• Apps APIドキュメントの一部に、現在提供していないSandbox環境と、決済ページ作成APIのエンドポイント表記に誤りがありました。
• 現在、Apps APIの接続先は本番環境 https://api.theapps.jp です。Sandbox環境は提供していません。
• 決済ページ作成APIのエンドポイントは apps 系ではなく client 系のパスを使用します。例として、定期払いプラン一覧は GET /v1/client/paid/、毎月払いプラン一覧は GET /v1/client/installments/ です。
• 決済情報取得APIで指定する payment_id は管理画面上の表示IDではなく、Webhookの「Webhook⑥-決済成功イベント」に含まれる payment_id を使用します。

2026年6月13日の更新

• 1回払い、定期払い、毎月払い（回数制限付き）の決済ページ作成APIを公開しました。
• 決済ページのプラン登録、一覧取得、更新、削除、購入者・契約者一覧の取得に対応しています。
• 決済プラットフォーム、課金サイクル、銀行振込、決済自動リトライ、自動解約、UnivaPay分割払い、カード入力項目、事業者情報、Meta Conversion APIなどのリクエスト項目を確認できます。
• 1回払いAPIでは、成立条件付き申込に対応する waiting_list / WaitingList オブジェクトを指定できます。
• 詳しいエンドポイントとリクエスト項目は APIエンドポイント一覧 を確認してください。

Apps APIメニュー