getDiscountList

Available in Classic and VPC

View the list of discounts that an account has.

Request

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

Method	URI
GET, POST	/discount/getDiscountList

Request headers

For headers common to NAVER Cloud Platform, see Common Ncloud API 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 service 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
`discountTypeCode`	String	Optional	Discount type `PRODUCT` \| `CREDIT` \| `COIN` `PRODUCT`: service fee discount `CREDIT`: credit `COIN`: coin
`startMonth`	String	Optional	Query start month (yyyyMM) Up to 3 months viewable <E.g.> 202401
`endMonth`	String	Optional	Query end month (yyyyMM) Up to 3 months viewable <E.g.> 202403
`isValidDiscount`	Boolean	Optional	Whether to view only valid discounts `true` \| `false` `true`: View only valid discounts `false`: View all discounts
`responseFormatType`	String	Optional	Response result format `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location  --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/discount/getDiscountList?startMonth=202401&endMonth=202403&isValidDiscount=true&responseFormatType=xml' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {signature}' \

Response

The following describes the response format.

Response body

See DiscountList 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"?>
<getDiscountListResponse>
  <requestId>b797****-****-****-****-****6fab4b70</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <discountList>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>54</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>Bank transer (Nonghyup)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>100000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>158</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>Credit card (TEST)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>10000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
  </discountList>
</getDiscountListResponse>