【2026.7月度】Appsアップデート情報

APIエンドポイント一覧(Apps API)

Apps APIで提供している各種APIのエンドポイントをまとめています。各エンドポイントにアクセスするには、事前にアクセストークンを取得してください。

API呼び出しに利用するアクセストークンは認証情報です。公開リポジトリ、チャット、問い合わせ本文などに貼り付けないでください。

共通:認証ヘッダー

Authorization: Bearer {access_token}

ベースURL

環境 ベースURL
本番 https://api.theapps.jp

顧客情報・決済情報を取得する

用途 メソッド エンドポイント
顧客情報を取得する GET /v1/customer/{customer_id}
決済情報を取得する(1回払い) GET /v1/charge/{payment_id}
決済情報を取得する(定期払い) GET /v1/paid/{payment_id}
決済情報を取得する(毎月払い・回数制限付き) GET /v1/installments/{payment_id}

payment_id は管理画面上の表示IDではありません。Webhookの「Webhook⑥-決済成功イベント」に含まれる payment_id を使用します。管理画面の取引明細などに表示される数字IDを指定しても、API用の payment_id として利用できない場合があります。

登録ページAPI

登録ページのプラン登録、一覧取得、更新、削除、契約者一覧の取得を行います。詳細は 登録ページAPI を確認してください。

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

決済ページ作成API

1回払い、定期払い、毎月払い(回数制限付き)の決済ページプランをAPIで登録、一覧取得、更新、削除できます。購入者または契約者一覧の取得にも対応しています。

1回払い

用途 メソッド エンドポイント リクエスト 主なレスポンス
プラン登録 POST /v1/client/product Productオブジェクト product_id / url_application / product
プラン一覧 GET /v1/client/product なし products
プラン取得 GET /v1/client/product/{product_id} なし product_id / url_application / product
プラン更新 PUT /v1/client/product/{product_id} Productオブジェクト product_id / url_application / product
プラン削除 DELETE /v1/client/product/{product_id} なし product_id
購入者一覧 GET /v1/client/product/{product_id}/purchaser なし purchasers

定期払い

用途 メソッド エンドポイント リクエスト 主なレスポンス
プラン登録 POST /v1/client/paid Paidオブジェクト paid_id / url_application / plan
プラン一覧 GET /v1/client/paid なし plans
プラン取得 GET /v1/client/paid/{paid_id} なし paid_id / url_application / plan
プラン更新 PUT /v1/client/paid/{paid_id} Paidオブジェクト paid_id / url_application / plan
プラン削除 DELETE /v1/client/paid/{paid_id} なし paid_id
契約者一覧 GET /v1/client/paid/{paid_id}/subscriber なし subscribers

毎月払い(回数制限付き)

用途 メソッド エンドポイント リクエスト 主なレスポンス
プラン登録 POST /v1/client/installments InstallmentPaidオブジェクト paid_id / url_application / plan
プラン一覧 GET /v1/client/installments なし plans
プラン取得 GET /v1/client/installments/{paid_id} なし paid_id / url_application / plan
プラン更新 PUT /v1/client/installments/{paid_id} InstallmentPaidオブジェクト paid_id / url_application / plan
プラン削除 DELETE /v1/client/installments/{paid_id} なし paid_id
契約者一覧 GET /v1/client/installments/{paid_id}/subscriber なし subscribers

決済ページ作成APIのリクエストオブジェクト

以下は、プラン登録・更新で使用する主なリクエストオブジェクトです。更新時に変更できない項目や、条件付きで必須になる項目があります。

Productオブジェクト(1回払い)

waiting_list は、成立条件付き申込に対応する設定です。詳細は WaitingList オブジェクトを確認してください。

json_key json_type required default description remarks
product_name string 必須 null 商品名
provider_name string 任意 null サービス提供者名
label string 任意 null ラベル
language string 任意 null 申し込みページの言語 ja, en, pt のいずれか
stripe_env_id string 必須 1 Stripe環境ID 新規作成時のみ必須。更新時は変更不可
platform object(PaymentPlatform) 任意 null 決済プラットフォーム 更新時は変更不可
price integer 必須 -1 価格
stock integer 任意 -1 在庫数 -1は無制限
refund_policy integer 任意 0 返金ポリシー
tax_rate integer 任意 null 税率
receipt_exclusion_tax boolean 任意 false 領収書の税抜き表示
allow_duplicate boolean 任意 false 重複申し込みの許可
limit_per_person integer 任意 -1 1人あたりの購入上限 -1は無制限
honorific_title string 任意 null 敬称
proviso string 任意 null 但し書き
agreement_terms object(AgreementTerms) 任意 null 同意チェックボックス
discord_rule object(DiscordRule) 任意 null Discord自動化ルール
line object(Line) 任意 null LINE設定
show_discord_account_change boolean 任意 false DiscordアカウントID変更許可フラグ
mail_application object(Mail) 任意 申し込み完了メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice object(Mail) 任意 請求書メール 指定しない場合はデフォルトのテンプレートが適用される
bank_invoice object(BankInvoice) 任意 null 銀行振込(請求書払い)設定
waiting_list object(WaitingList) 任意 null キャンセル待ち設定
univapay_installment object(UnivapayInstallment) 任意 null UnivaPay分割払い設定
card_attribute object(CardAttribute) 任意 カード入力項目設定 未指定時は card_name のみ有効
company_info object(CompanyInfo) 任意 事業者情報 source_from_client未指定時はクライアント情報を使用
provider_information object(ProviderInformation) 任意 null 提供者情報
use_shipping_address boolean 任意 false 配送先住所の使用
shipping_address_name string 任意 配送先住所の表示名 未指定時は既定表示名
use_phone_number boolean 任意 false 電話番号入力フラグ
receipt_email boolean 任意 null 領収書メール送信
alert_inventory object(InventoryAlert) 任意 null 在庫アラート
custom_item_names object(CustomItemNames) 任意 null 項目名のカスタマイズ
notes array<object(Note)> 任意 null 備考欄
additional_address array<object(AdditionalAddress)> 任意 null 受信用メールアドレス追加
free_space string 任意 null フリースペース
display_free_space integer 任意 3 フリースペースの表示 3:申し込み/支払い両方(既定) 1:支払いのみ
background_color string 任意 #f8f8f8 背景色
url_redirect_1 string 任意 null 受付完了時リダイレクトURL
url_redirect_2 string 任意 null 申し込み完了時リダイレクトURL
lp_header string 任意 null LPヘッダー
lp_footer string 任意 null LPフッター
sales_start object(ReceptionHours) 任意 null 販売開始日時
sales_end object(ReceptionHours) 任意 null 販売終了日時
meta_information string 任意 null メタ情報
meta_conversion_api object(MetaConversionApi) 任意 {} Meta Conversion API設定
enable_save_utm boolean 任意 false UTMパラメータ保存フラグ
show_sales_quantity boolean 任意 true 販売数量の表示
contract_flow integer 任意 1 メールアドレス認証設定 1:分けない(既定) 2:分ける
disable_company_name boolean 任意 false 会社名入力欄の非表示

WaitingListオブジェクト(成立条件付き申込)

json_key json_type required default constraints description remarks
type integer 任意 null キャンセル待ちの種別
interval integer 任意 -1 通知間隔
min_participants integer 任意 null 最小人数
max_participants integer 任意 null 最大人数
application_deadline integer 任意 null 申し込み期限(Linux時間)
mail_application object(Mail) 任意 申し込みメール 指定しない場合はデフォルトのテンプレートが適用される
mail_cancel object(Mail) 任意 キャンセルメール 指定しない場合はデフォルトのテンプレートが適用される

Paidオブジェクト(定期払い)

json_key json_type required default description remarks
plan_name string 必須 null プラン名
provider_name string 任意 null サービス提供者名
label string 任意 null ラベル
language string 任意 null 申し込みページの言語 ja, en, pt のいずれか
stripe_env_id string 必須 1 Stripe環境ID 新規作成時のみ必須。更新時は変更不可
platform object(PaymentPlatform) 任意 null 決済プラットフォーム 更新時は変更不可
price integer 必須 0 価格
billing_cycle object(BillingCycle) 必須 null 支払いサイクル
sales_count integer 任意 -1 販売数上限 -1は無制限
tax_rate integer 任意 null 税率
receipt_exclusion_tax boolean 任意 false 領収書の税抜き表示
honorific_title string 任意 null 敬称
proviso string 任意 null 但し書き
agreement_terms object(AgreementTerms) 任意 null 同意チェックボックス
discord_rule object(DiscordRule) 任意 null Discord自動化ルール
line object(Line) 任意 null LINE設定
show_discord_account_change boolean 任意 false DiscordアカウントID変更許可フラグ
mail_application object(Mail) 任意 申し込み完了メール 指定しない場合はデフォルトのテンプレートが適用される
mail_recept object(Mail) 任意 受付メール 指定しない場合はデフォルトのテンプレートが適用される
mail_contract object(Mail) 任意 契約完了メール 指定しない場合はデフォルトのテンプレートが適用される
mail_cancel object(Mail) 任意 解約メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice_notice object(Mail) 任意 請求予告メール 指定しない場合はデフォルトのテンプレートが適用される
notice_days_before integer 任意 3 請求予告メールの送信日数 mail_invoice_notice指定時は必須
mail_invoice object(Mail) 任意 請求書メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice_error object(Mail) 任意 決済失敗メール 指定しない場合はデフォルトのテンプレートが適用される
mail_return_recess object(Mail) 任意 返金/休会メール 指定しない場合はデフォルトのテンプレートが適用される
initial_cost object(InitialCost) 任意 null 初期費用設定
bank_invoice object(BankInvoice) 任意 null 銀行振込(請求書払い)設定
auto_retry object(AutoRetry) 任意 決済自動リトライ設定 未指定時は有効
auto_cancel object(AutoCancel) 任意 自動解約設定 未指定時は有効
execute_role_first_payment boolean 任意 false 初回決済時にロール付与
permit_user_payment_cancel boolean 任意 false ユーザーによる決済キャンセル許可
contracted_units object(ContractedUnits) 任意 null 契約口数設定
use_change_plan boolean 任意 true プラン変更の許可
univapay_installment object(UnivapayInstallment) 任意 null UnivaPay分割払い設定
card_attribute object(CardAttribute) 任意 カード入力項目設定 未指定時は card_name のみ有効
company_info object(CompanyInfo) 任意 事業者情報 source_from_client未指定時はクライアント情報を使用
provider_information object(ProviderInformation) 任意 null 提供者情報
use_phone_number boolean 任意 false 電話番号入力フラグ
receipt_email boolean 任意 null 領収書メール送信
alert_inventory object(InventoryAlert) 任意 null 在庫アラート
custom_item_names object(CustomItemNames) 任意 null 項目名のカスタマイズ
notes array<object(Note)> 任意 null 備考欄
additional_address array<object(AdditionalAddress)> 任意 null 受信用メールアドレス追加
free_space string 任意 null フリースペース
display_free_space integer 任意 3 フリースペースの表示 3:申し込み/支払い両方 1:支払いのみ
background_color string 任意 #f8f8f8 背景色
url_redirect_1 string 任意 null 受付完了時リダイレクトURL
url_redirect_2 string 任意 null 申し込み完了時リダイレクトURL
sales_start object(ReceptionHours) 任意 null 販売開始日時
sales_end object(ReceptionHours) 任意 null 販売終了日時
meta_information string 任意 null メタ情報
meta_conversion_api object(MetaConversionApi) 任意 {} Meta Conversion API設定
enable_save_utm boolean 任意 false UTMパラメータ保存フラグ
contract_flow integer 任意 1 メールアドレス認証設定 1:分けない 2:分ける
disable_company_name boolean 任意 false 会社名入力欄の非表示

InstallmentPaidオブジェクト(毎月払い・回数制限付き)

json_key json_type required default description remarks
plan_name string 必須 null プラン名
provider_name string 任意 null サービス提供者名
label string 任意 null ラベル
language string 任意 null 申し込みページの言語 ja, en, pt のいずれか
stripe_env_id string 必須 1 Stripe環境ID 新規作成時のみ必須。更新時は変更不可
platform object(PaymentPlatform) 任意 null 決済プラットフォーム 更新時は変更不可
price integer 必須 0 総額(価格)
billing_cycle object(InstallmentBillingCycle) 必須 null 支払いサイクル(分割) installments_countは2以上
tax_rate integer 任意 null 税率
receipt_exclusion_tax boolean 任意 false 領収書の税抜き表示
honorific_title string 任意 null 敬称
proviso string 任意 null 但し書き
agreement_terms object(AgreementTerms) 任意 null 同意チェックボックス
discord_rule object(DiscordRule) 任意 null Discord自動化ルール
line object(Line) 任意 null LINE設定
show_discord_account_change boolean 任意 false DiscordアカウントID変更許可フラグ
mail_application object(Mail) 任意 申し込み完了メール 指定しない場合はデフォルトのテンプレートが適用される
mail_contract object(Mail) 任意 契約完了メール 指定しない場合はデフォルトのテンプレートが適用される
mail_cancel object(Mail) 任意 解約メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice_notice object(Mail) 任意 請求予告メール 指定しない場合はデフォルトのテンプレートが適用される
notice_days_before integer 任意 3 請求予告メールの送信日数 mail_invoice_notice指定時は必須
mail_invoice object(Mail) 任意 請求書メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice_error object(Mail) 任意 決済失敗メール 指定しない場合はデフォルトのテンプレートが適用される
auto_retry object(AutoRetry) 任意 決済自動リトライ設定 未指定時は有効
auto_cancel object(AutoCancel) 任意 自動解約設定 未指定時は有効
card_attribute object(CardAttribute) 任意 カード入力項目設定 未指定時は card_name のみ有効
company_info object(CompanyInfo) 任意 事業者情報 source_from_client未指定時はクライアント情報を使用
provider_information object(ProviderInformation) 任意 null 提供者情報
use_phone_number boolean 任意 false 電話番号入力フラグ
receipt_email boolean 任意 null 領収書メール送信
alert_inventory object(InventoryAlert) 任意 null 在庫アラート
custom_item_names object(CustomItemNames) 任意 null 項目名のカスタマイズ total_amount項目あり
notes array<object(Note)> 任意 null 備考欄
additional_address array<object(AdditionalAddress)> 任意 null 受信用メールアドレス追加
free_space string 任意 null フリースペース
display_free_space integer 任意 3 フリースペースの表示 3:申し込み/支払い両方 1:支払いのみ
background_color string 任意 #f8f8f8 背景色
url_redirect_1 string 任意 null 受付完了時リダイレクトURL
url_redirect_2 string 任意 null 申し込み完了時リダイレクトURL
sales_start object(ReceptionHours) 任意 null 販売開始日時
sales_end object(ReceptionHours) 任意 null 販売終了日時
meta_information string 任意 null メタ情報
meta_conversion_api object(MetaConversionApi) 任意 {} Meta Conversion API設定
enable_save_utm boolean 任意 false UTMパラメータ保存フラグ
contract_flow integer 任意 1 メールアドレス認証設定 1:分けない 2:分ける
disable_company_name boolean 任意 false 会社名入力欄の非表示

PaymentPlatformオブジェクト

json_key json_type required default constraints description remarks
stripe boolean 任意 null Stripe(カード決済) 1回払い/定期/毎月払い共通
univapay boolean 任意 null UnivaPay(カード決済)
stripe_bank boolean 任意 null Stripe(銀行振込) 定期払いで利用
univapay_bank boolean 任意 null UnivaPay(銀行振込) 定期払いで利用
stripe_billing boolean 任意 null Stripe Billing 定期払いで利用
paypal boolean 任意 null PayPal 1回払いで利用

BillingCycleオブジェクト(定期払い)

json_key json_type required default constraints description remarks
interval string 必須 null 課金間隔
count integer 任意 1 課金間隔の倍数
billing_cycle_anchor integer 任意 -1 課金基準日 -1は基準日指定なし
immediate_payment boolean 任意 false 即時決済フラグ
proration_behavior integer 任意 0 日割り計算の挙動
trial_end integer 任意 null トライアル終了(Linux時間)
force_authorization boolean 任意 null 強制オーソリ

InstallmentBillingCycleオブジェクト(毎月払い・回数制限付き)

json_key json_type required default constraints description remarks
interval string 必須 null 課金間隔
installments_count integer 必須 null 2以上 分割回数 2以上を指定
manual_payments boolean 任意 null 手動決済フラグ
sales_count integer 任意 -1 販売数上限 -1は無制限

InitialCostオブジェクト

json_key json_type required default constraints description remarks
name string 任意 null 初期費用名
amount integer 任意 0 初期費用額
installments_count integer 任意 1 分割回数
billing_cycle_anchor integer 任意 1 課金基準日
skip_on_plan_change boolean 任意 true プラン変更時にスキップ
mail object(Mail) 任意 初期費用メール 指定しない場合はデフォルトのテンプレートが適用される

BankInvoiceオブジェクト

json_key json_type required default constraints description remarks
billing_deadline_days integer 任意 7 支払い期限(日数) 1回払いではキー名 billing_deadline
remainder_days_before integer 任意 2 リマインド送信日数
mail_invoice object(Mail) 任意 請求書メール 指定しない場合はデフォルトのテンプレートが適用される
mail_invoice_notice object(Mail) 任意 請求予告メール 指定しない場合はデフォルトのテンプレートが適用される

AutoRetryオブジェクト

json_key json_type required default constraints description remarks
enabled boolean 任意 true 決済自動リトライの有効化
interval_days integer 任意 5 リトライ間隔(日)

AutoCancelオブジェクト

json_key json_type required default constraints description remarks
enabled boolean 任意 true 自動解約の有効化
limit integer 任意 45 自動解約までの日数

ContractedUnitsオブジェクト

json_key json_type required default constraints description remarks
accept boolean 任意 false 口数指定の受付
max integer 任意 -1 最大口数 -1は無制限
allow_repeat_contract boolean 任意 false 重複契約の許可

UnivapayInstallmentオブジェクト

json_key json_type required default constraints description remarks
allow boolean 任意 false 分割払いの許可
visa boolean 任意 false VISA対応
master_card boolean 任意 false Mastercard対応
american_express boolean 任意 false American Express対応
jcb boolean 任意 false JCB対応
diners_club boolean 任意 false Diners Club対応
terms array<integer> 任意 [] 分割回数の選択肢 allowがtrueの場合は必須

CardAttributeオブジェクト

json_key json_type required default constraints description remarks
card_name integer 任意 1 カード名義の入力(0:非表示 1:任意 2:必須)
card_address_country integer 任意 0 国の入力
card_address_zip integer 任意 0 郵便番号の入力
card_address_line integer 任意 0 住所の入力

CompanyInfoオブジェクト

json_key json_type required default constraints description remarks
source_from_client boolean 任意 true クライアント情報を使用するか trueの場合は以下を無視しクライアント設定を使用
name string 任意 null 事業者名
postal_code string 任意 null 郵便番号
state string 任意 null 都道府県
city string 任意 null 市区町村
line string 任意 null 番地・建物名
phone_number string 任意 null 電話番号

MetaConversionApiオブジェクト

json_key json_type required default constraints description remarks
dataset_id string 任意 null データセットID
access_token string 任意 null アクセストークン

共通オブジェクト

AgreementTermsオブジェクト

json_key json_type required default description remarks
show_agreement_terms boolean 必須 null 利用規約に同意利用フラグ
agreement_checkbox_text string 必須 null 利用規約に同意のチェックボックス表記
agreement_title string 必須 null 利用規約名
agreement_content string 必須 null 利用規約

Mailオブジェクト

json_key json_type required default description remarks
bcc boolean 必須 null BCC送信フラグ
subject string 必須 null メール件名
body string 必須 null メール本文

DiscordRuleオブジェクト

json_key json_type required default description remarks
trigger string 必須 トリガー(いつ) auto: 申し込み時(自動/登録と同時)
manual: 申し込み時(手動/登録後)
cancel:解約
action string 必須 アクション(どうする) grant:ロール付与
remove:ロール剥奪
kick:サーバーキック
guild_id string 必須 ギルドID(どのサーバーの)
target_type string 必須 channel or role
role_ids string[] ロールID(なにを) target_type=roleの場合は必須
channel_ids string[] チャンネルID(なにを) target_type=channel の場合は必須
related_role boolean 任意 関連ロール確認

Lineオブジェクト

json_key json_type required default constraints description remarks
channel_id string 必須 null チャンネルID
channel_secret string 必須 null チャンネルシークレット
add_friend_option integer 任意 null 友達追加オプション(null:未使用, 1:通常, 2:強制, それ以外:未使用)

ReceptionHoursオブジェクト

json_key json_type required default constraints description remarks
time integer 必須 null Linux時間
message string 任意 null メッセージ

CustomItemNamesオブジェクト

json_key json_type required default constraints description remarks
seller_name string 必須 null 販売者
purchaser string 必須 null 購入者
plan_name string 必須 null サービス名
name string 必須 null お名前
company string 必須 null 会社名
form_name_1 string 必須 null 無料登録フォーム
form_name_2 string 必須 null こちらの内容でよろしいですか?
form_name_3 string 必須 null お申し込みが完了しました
button_1 string 必須 null 申し込み

InventoryAlertオブジェクト

json_key json_type required default constraints description remarks
threshold string 必須 null 在庫アラート閾値
message string 必須 null 在庫アラートメッセージ

ProviderInformationオブジェクト

json_key json_type required default constraints description remarks
url_bussiness string 任意 null ビジネスの Web サイト
url_support string 任意 null サポートの Web サイト
url_service_terms string 任意 null プライバシーポリシー
url_privacy_policy string 任意 null 利用規約
url_special_commercial_law string 任意 null 特定商取引法に基づく表記

Noteオブジェクト

json_key json_type required default constraints description remarks
name string 必須 null 備考欄名
require boolean 必須 null 必須フラグ

AdditionalAddressオブジェクト

java_field json_key java_type json_type required default constraints description remarks
email email String string 任意 null メールアドレス
name name String string 任意 null 表示名

Discord連携API

Discordサーバー(Guild)に対して、ロールやチャンネルの作成・更新・取得・削除を行います。詳細は Discord連携API を確認してください。

POST   /v1/discord/guilds/{guild_id}/roles
PUT    /v1/discord/guilds/{guild_id}/roles/{role_id}
GET    /v1/discord/guilds/{guild_id}/roles/{role_id}
DELETE /v1/discord/guilds/{guild_id}/roles/{role_id}

POST   /v1/discord/guilds/{guild_id}/channels
PUT    /v1/discord/guilds/{guild_id}/channels/{channel_id}
GET    /v1/discord/guilds/{guild_id}/channels/{channel_id}
DELETE /v1/discord/guilds/{guild_id}/channels/{channel_id}

備考・注意事項