View product subscription
- Print
- PDF
View product subscription
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View product information that meet the user-defined conditions.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /products/{product-id}/subscription-detail |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID whose subscription information you want to view
|
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
offset | Long | Optional | Starting point of the response data
|
limit | Long | Optional | Maximum number of response data
|
apiId | String | Optional | API ID
|
stageId | String | Optional | Stage ID
|
apiKeyId | String | Required | API key ID
|
Request example
The following is a sample request.
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}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"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"
} ]
}
}
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Response example
The following is a sample response.
{
"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
}
}
Was this article helpful?