メインコンテンツへスキップ
テスト環境から本番環境にサブスクリプション商品を公開します。これは一方向の初回公開のみの操作です。
POST /v1/actions/subscription-product/publish-product
認証: API Key
このエンドポイントには X-Environment ヘッダーを含めないでください。公開は常にテストから本番環境への一方向です。

リクエストボディ

フィールド必須説明
idstringYes商品 ID(PROD_xxx フォーマット)

リクエスト例

await client.subscriptionProducts.publish({
  id: "PROD_3F7H2J5L8N1Q4S6U",
});

成功レスポンス (200)

{
  "data": {
    "product": {
      "id": "PROD_3F7H2J5L8N1Q4S6U",
      "storeId": "STO_2D5F8G3H1K4M6N9P",
      "name": "Pro Plan",
      "description": "Full access to all Pro features.",
      "billingPeriod": "monthly",
      "prices": {
        "USD": { "amount": "29.00", "taxCategory": "saas" },
        "EUR": { "amount": "27.00", "taxCategory": "saas" }
      },
      "media": [],
      "successUrl": "https://example.com/welcome",
      "metadata": { "trialDays": 14 },
      "status": "active",
      "createdAt": "2026-03-30T10:30:00.000Z",
      "updatedAt": "2026-03-30T12:00:00.000Z"
    }
  }
}

レスポンスフィールド

サブスクリプション商品の作成レスポンスと同じです。
初回公開のみサポートされています。商品に本番バージョンが存在する場合、このエンドポイントはエラーを返します。公開済みの商品を更新するには、本番環境で商品の更新エンドポイントを使用してください。

エラー

リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
ステータスerrors[0].message意味推奨処理
400Missing header: x-context-merchant-idマーチャントコンテキスト header が転送されていないSDK 設定を修正
400Missing required field: idリクエストボディに id が含まれないid を追加して再送信
400Expected format: PROD_xxx, got "X"id が正しい Short ID ではないPROD_ 接頭辞付きの Short ID を使用
400No test version foundこの商品は test 環境に公開可能なバージョンが存在しない先に Update Product / Update Status で test バージョンを作成・アクティブ化
400Test version is not activetest バージョンは存在するが状態が inactive先に Update Status で test バージョンをアクティブ化してから公開
400Already published to production商品に既に prod バージョンが存在(publish は初回公開のみ)prod 環境で Update Product を呼び出す
401Unauthorized認証失敗API Key、タイムスタンプ、署名を確認
404Product not found / Source version not foundproduct ID が存在しない(またはソースバージョン欠落)product ID を確認
500Internal server error一時的な下流障害指数バックオフでリトライ(5s 開始、最大 3 回)