---
title: "Productサブスクリプションの照会"
slug: "apigateway-product-subscription"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/apigateway-product-subscription"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Productサブスクリプションの照会

Classic/VPC環境で利用できます。

ユーザーが指定した条件を満たす Productのサブスクリプション情報を照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/products/{product-id}/subscription-detail |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | サブスクリプション情報照会対象の Product ID - 0~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を通じて確認 |

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

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `offset` | Long | Optional | レスポンスデータの開始点 - 0~9,223,372,036,854,775,807 - `limit`と共にページネーションの実装に使用 |
| `limit` | Long | Optional | レスポンスデータの最大数 - 1~9,223,372,036,854,775,807 - `offset`と共にページネーションの実装に使用 |
| `apiId` | String | Optional | API ID - 0~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |
| `stageId` | String | Optional | Stage ID - 0~10文字 - [Stageリストの照会](/docs/ja/apigateway-stage-getstagelist)を参照 |
| `apiKeyId` | String | Required | API Key ID - 0~10文字 - [API Keyリストの照会](/docs/ja/apigateway-product-getapikeylist)を参照 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/subscription-detail?apiKeyId=***fmy2***&apiId=***51hs***&stageId=***5ei7***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンス構文

レスポンス構文は次の通りです。

```
{
    "apiKeyRelations" : {
        "total" : 5,
        "content" : [ {
            "apiName" : "apiName",
            "domainCode" : "domainCode",
            "monthlyUsage" : 5,
            "usagePlanId" : "usagePlanId",
            "monthCallCount" : 1,
            "apiKeyId" : "apiKeyId",
            "apiKeyName" : "apiKeyName",
            "usagePlanName" : "usagePlanName",
            "dailyUsage" : 0,
            "regTime" : "2000-01-23T04:56:07.000+00:00",
            "stageName" : "stageName",
            "modTime" : "2000-01-23T04:56:07.000+00:00",
            "dayCallCount" : 6,
            "apiId" : "apiId",
            "stageId" : "stageId"
    } ]
  }
}
```

### レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "apiKeyRelations": {
        "content": [
            {
                "apiId": "***51hs***",
                "apiName": "api000",
                "stageId": "***5ei7***",
                "stageName": "stage",
                "apiKeyId": "***fmy2***",
                "apiKeyName": "apikey000",
                "regTime": "2024-05-07T04:22:05Z",
                "modTime": "2024-05-07T04:22:05Z",
                "dayCallCount": 0,
                "monthCallCount": 0,
                "domainCode": "PUB"
            }
        ],
        "total": 1
    }
}
```