결제 조정하기

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

소개

수익 창출을 통해 결제 세부정보를 조정할 수 있습니다. 예를 들어 기록의 불일치로 인해 특정 결제 월의 수익 배분 또는 수수료를 늘리거나 줄여야 할 수 있습니다.

결제 조정 페이지 살펴보기

아래에 설명된 대로 '결제 조정' 페이지에 액세스합니다.

에지

Edge UI를 사용하여 '결제 조정' 페이지에 액세스하는 방법은 다음과 같습니다.

  1. apigee.com/edge에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 게시 > 수익 창출 > 결제 조정을 선택합니다.

'결제 조정' 페이지가 표시됩니다.

그림에 강조표시된 것처럼 '결제 조정' 페이지를 통해 다음을 수행할 수 있습니다.

Classic Edge (Private Cloud)

기본 에지 UI를 사용하여 '결제 조정' 페이지에 액세스하는 방법은 다음과 같습니다.

  1. http://ms-ip:9000에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.
  2. 상단 탐색 메뉴에서 수익 창출 > 조정을 선택합니다.

'결제 조정' 페이지에서 할 수 있는 작업은 다음과 같습니다.

  • 현재 결제 조정 목록 보기
  • 결제 조정 추가
  • 결제 조정 수정
  • 결제 조정 목록 검색

결제 조정 추가

결제 조정을 추가하는 방법은 다음과 같습니다.

  1. 결제 조정 페이지에 액세스합니다.
  2. + 조정을 클릭합니다.
  3. 다음 정보를 입력합니다.
    필드 설명
    이름

    청구 문서에 표시될 설명이 포함된 이름입니다.

    조정 %

    양수 또는 음수로 표시되는 조정 금액입니다. 백분율이 양수면 거래의 수익 배분율 또는 수수료가 해당 백분율로 조정됩니다. 음수 조정은 거래의 수익 배분율 또는 수수료를 해당 비율로 조정합니다. 양수 또는 음수의 십진수를 입력합니다 (소수점 이하 최대 2자리).

    청구 월

    조정의 청구 월입니다. 드롭다운 목록에서 월을 선택합니다.

    거래 유형

    조정을 적용할 거래 유형입니다. 드롭다운에서 값을 선택합니다.

    • 전체 거래
    • 청구 (청구 모델 거래)
    • 구매 (수익 공유 모델 거래)
    • 환불 (수익 공유 모델 거래)
    제품

    조정을 적용하려는 API 제품입니다. 하나의 조정을 여러 API 제품에 적용할 수는 없습니다. 여러 API 제품에 조정을 적용해야 하는 경우 제품별로 조정을 만드세요. 드롭다운 메뉴에서 API 제품을 선택합니다.

    개발자

    조정을 적용하려는 개발자입니다. 모든 개발자 (기본값) 또는 특정 개발자에게 조정을 적용할 수 있습니다. 드롭다운 메뉴에서 '모든 개발자' 또는 특정 개발자를 선택합니다.

  4. 조정 만들기를 클릭합니다.

결제 조정 수정

결제 조정을 수정하는 방법은 다음과 같습니다.

  1. 결제 조정 페이지에 액세스합니다.
  2. 수정하려는 결제 조정 위에 커서를 놓고 작업 메뉴에서 아이콘을 클릭합니다.
  3. 필요에 따라 결제 조정을 업데이트합니다.
  4. 조정 업데이트를 클릭합니다.

API를 사용하여 결제 조정하기

다음 섹션에서는 API를 사용하여 결제 조정을 수행하는 방법을 설명합니다.

API를 사용하여 결제 조정

/organizations/{org_name}/billing-adjustments에 POST 요청을 하여 결제 세부정보를 조정할 수 있습니다. 요청할 때 요청 본문에서 다음을 지정합니다.

  • 결제 조정의 이름입니다.
  • 조정율, 즉 청구 금액을 각각 늘리거나 줄이는 양수 또는 음수의 백분율 값입니다.
  • 청구 월입니다.
  • 청구 연도입니다.
  • 결제 조정이 적용되는 조직입니다.

다음과 같은 다른 속성도 지정할 수 있습니다.

  • 조정을 적용할 거래 유형입니다 (예: 구매 거래).
  • 조정을 적용하려는 개발자입니다.
  • 선불 개발자, 후불 개발자 또는 둘 다에 조정을 적용할지 여부입니다.
  • 조정을 적용하려는 API 패키지입니다.
  • 조정을 적용하려는 API 제품입니다.

조정 요청에 지정할 수 있는 결제 조정 속성의 전체 목록은 결제 조정 구성 설정을 참고하세요.

선택적 속성을 지정하지 않으면 결제 문서 조정에 해당 속성이 모두 포함됩니다. 예를 들어 거래 유형을 지정하지 않으면 결제 조정이 모든 거래 유형에 적용됩니다.

다음 예에서는 공개 결제 월(2013년 6월)에 대한 결제 조정을 수행합니다. 이 조정은 3%씩 감소하며 구매 거래, 결제 제품, 후불 개발자에게 적용됩니다. 특정 개발자 또는 API 패키지를 식별하는 속성이 지정되지 않았으므로 모든 개발자 (후불 개발자)와 모든 API 패키지의 결제 제품에 조정이 적용됩니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

응답은 다음과 같아야 합니다(응답의 일부만 표시됨).

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

API를 사용하여 결제 조정 보기

조직의 특정 결제 조정 또는 모든 결제 조정을 볼 수 있습니다. 특정 결제 조정을 보려면 /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}에 GET 요청을 실행합니다. 여기서 {billing_adjustment_id}는 특정 결제 조정을 나타냅니다(결제 조정을 만들면 응답에서 ID가 반환됨). 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

조직의 모든 결제 조정을 보려면 /organizations/{org_name}/billing-adjustments에 GET 요청을 실행하세요. 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

응답은 다음과 같아야 합니다(응답의 일부만 표시됨).

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

API를 사용하여 결제 조정 업데이트

/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}에 PUT 요청을 실행하여 결제 조정을 업데이트할 수 있습니다. 여기서 {billing_adjustment_id}는 특정 결제 조정을 식별합니다. 업데이트할 때 업데이트된 속성과 업데이트할 결제 조정의 ID를 요청 본문에 지정해야 합니다. 결제 조정의 필수 속성, 즉 이름, 조정 비율, 청구 월, 청구 연도, 조직의 속성도 지정해야 합니다.

예를 들어 다음 API 호출은 조정 비율 계수와 이름을 업데이트합니다 (업데이트된 속성이 예에서는 강조 표시됨).

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

API를 사용한 결제 조정 삭제

/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}에 DELETE 요청을 실행하여 결제 조정을 삭제할 수 있습니다. 여기서 {billing_adjustment_id}는 삭제할 결제 조정의 ID입니다. 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

API에 대한 결제 조정 구성 설정

결제 조정에 사용할 수 있는 구성 옵션은 다음과 같습니다.

이름 설명 기본 계정 필수 여부
name

결제 조정을 설명하는 이름입니다.

N/A 지원됨
adjustmentPercentageFactor

양수 또는 음수의 백분율로 표시되는 조정 금액입니다. 백분율이 양수면 거래의 수익 배분율 또는 수수료가 해당 비율로 조정됩니다. 음수 비율은 거래에서 수익 배분율 또는 수수료를 해당 비율로 조정합니다. 값의 범위는 -100에서 999.9999 사이입니다.

N/A 지원됨
billingMonth

결제 조정에 대한 청구 월로, 정수로 지정됩니다. 예를 들어 12월의 경우 11입니다.

N/A 지원됨
billingYear

결제 조정의 결제 연도로, YYYY 형식으로 지정됩니다. 예: 2017

N/A 지원됨
organization

결제 조정이 적용되는 조직입니다.

N/A 지원됨
isPublished

조정을 게시해야 하는지 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true. 결제 조정이 게시되어야 합니다.
  • false. 결제 조정을 게시하면 안 됩니다.
N/A No
transactionType

결제 조정이 적용되는 거래 유형입니다. 유형은 다음 중 하나일 수 있습니다.

  • PURCHASE
  • CHARGE
  • REFUND
  • CREDIT
  • BALANCE
  • SETUPFEES
  • TERMINATIONFEES
  • RECURRINGFEES
  • TRUEUPS. 평가된 거래를 재조정하는 데 사용되는 거래입니다. 이전 결제 월에 세금이 변경되면 호출됩니다.
N/A No
developerBillingType

결제 조정이 적용되는 개발자 결제 유형입니다. 값은 다음 중 하나일 수 있습니다.

  • PREPAID.. 선불 개발자.
  • POSTPAID. 후불 개발자입니다.
  • BOTH. 선불 및 후불 개발자.
N/A No
product

결제 조정이 적용되는 API 제품입니다. 이 속성을 지정하지 않으면 결제 조정이 모든 API 제품에 적용됩니다.

N/A No
monetizationPackage

결제 조정이 적용되는 API 패키지입니다. 이 속성을 지정하지 않으면 결제 조정이 모든 API 패키지에 적용됩니다.

N/A No
developer

결제 조정이 적용되는 개발자입니다. 이 속성을 지정하지 않으면 모든 개발자에게 결제 조정이 적용됩니다.

N/A No

다음 단계

수익 창출은 개발자에게 크레딧을 발급할 수 있는 유연성을 제공합니다. 개발자가 서비스에 만족하지 못하고 일정 기간 사용량에 대한 부분 또는 전체 환불을 요청하는 경우 이 방법을 사용해야 할 수 있습니다. 크레딧 발급에서 크레딧을 발급하는 방법을 알아보세요.