getContractSummaryList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Search a list of user contract summaries.
The contract summary consists of a Region code, a contract type code, and the number of contracts.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/cost/getContractSummaryList

Request headers

For headers common to all Cost and usage APIs, see Cost and usage common headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number
`pageSize`	Integer	Optional	Page size 1000 or less (default: 1000)
`isOrganization`	Boolean	Optional	Whether to view consolidated usage for organization sub accounts Available to masters only An error is returned if both `isOrganization` and `isPartner` are `true`
`isPartner`	Boolean	Optional	Whether to view partner accounts Available to partner representatives only An error is returned if both `isOrganization` and `isPartner` are `true`
`memberNoList`	List<String>	Optional	Member ID list Only available to master or partner representatives
`contractMonth`	String	Required	Contract year and month to view (yyyyMM) <E.g.> 202404
`contractTypeCode`	String	Optional	Contract type code
`contractStatusCode`	String	Optional	Contract status code `ALL` (default) \| `NOML` \| `NLEND` `ALL`: all `NOML`: normal `NLEND`: ended
`regionCode`	String	Optional	Region code regionCode can be obtained through the getRegionList action
`responseFormatType`	String	Optional	Response result format `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getContractSummaryList?contractMonth=202404'
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See ContractSummaryList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<?xml version="1.0" encoding="UTF-8"?>
<getContractSummaryListResponse>
    <requestId>db96b2c0-****-****-****-939ab748350e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <contractSummaryList>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>1</contractCount>
            <contractType>
                <code>ARCST</code>
                <codeName>Archive Storage</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>2</contractCount>
            <contractType>
                <code>CTNRR</code>
                <codeName>Container Registry</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>1</contractCount>
            <contractType>
                <code>OBJST</code>
                <codeName>Object Storage</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
    </contractSummaryList>
</getContractSummaryListResponse>

Was this article helpful?

What's Next

getCostRelationCodeList

Table of contents

Request
Response