API リファレンス

Xsolla 確認

POST/v1/xsolla/verify

この API キーに設定したマーチャント ID、プロジェクト ID、Xsolla API キー(コンソール → API キー → 編集 → Xsolla サブスクリプション確認)を使い、Xsolla のユーザーまたはサブスクリプションが購読中かを確認します。結果は Xsolla から直接取得し、ゲートウェイは課金しません。何を解放するかはアプリが決めます。見つかったサブスクリプションは 1 分間キャッシュされます。

#リクエストパラメーター

  • user_idstring任意

    アプリが Xsolla の決済トークンに入れた user.id。subscription_id を送らない場合は必須です。

  • subscription_idinteger任意

    Xsolla のサブスクリプション ID(アプリが持っている場合)。user_id と一緒に送ると、そのユーザーのサブスクリプションである必要があります。

subscribed は、このプロジェクトでそのユーザーに実際のサブスクリプションがあれば(解約済みも含む)true です。active は今使える間だけ true です。自動更新をオフにした場合(state が non_renewing)、expiry_time までは有効のままです。in_trial はまだ課金されていない間 true です。サブスクリプションのないユーザーは subscribed false、state not_found をステータス 200 で返します。複数ある場合は、最も長く続く有効なものを返します。

キャッシュされた結果や失敗を含むすべての呼び出しは、コンソール → リクエストログに、呼び出したキーの無料の xsolla-verify 行として表示されます。これらの行はリクエスト数に含まれません。 アプリで Xsolla サブスクリプションを使う →

#関連するエラー

  • 400 invalid_request本文が JSON でないか、user_id と subscription_id の両方がありません。
  • 400 xsolla_not_configuredこの API キーにはまだ Xsolla のマーチャント ID、プロジェクト ID、API キーが設定されていません。
  • 401Bearer トークンが無効か、ありません。
  • 429キーごとの確認回数の上限:既定は 1 分あたり 120 回で、サポートがキー単位で引き上げられます。Retry-After を待ち、前回の結果を使い続けてください。
  • 502 xsolla_credentials_invalidXsolla が保存済みの API キーを拒否しました。キーに新しいものを入力してください。
  • 503 xsolla_unavailableXsolla が時間内に応答しませんでした。数秒後に再試行してください。

エラーコード一覧 →

#リクエスト例

curl https://www.aisplice.store/v1/xsolla/verify \
  -H "Authorization: Bearer sk-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id": "USER_ID_IN_THE_PAYMENT_TOKEN"}'

#レスポンス

response.json
{
  "project_id": 273204,
  "subscribed": true,
  "active": true,
  "in_trial": false,
  "state": "active",
  "subscription_id": 249579,
  "user_id": "user-8f2c",
  "plan_id": 601,
  "plan_external_id": "weekly",
  "expiry_time": 1793000000,
  "auto_renewing": true,
  "checked_at": 1790400000
}

まだ解決しませんか?

リクエスト ID かエラーメッセージを送っていただければ、こちらで調査します。