결제 조정하기

Apigee Edge 문서입니다.
Go to the Apigee X 문서로 이동합니다. info

소개

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

결제 조정 페이지 탐색

아래 설명에 따라 결제 조정 페이지에 액세스합니다.

에지

Edge UI를 사용하여 결제 조정 페이지에 액세스하려면 다음 안내를 따르세요.

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

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

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

기본 Edge (Private Cloud)

기본 Edge UI를 사용하여 결제 조정 페이지에 액세스하려면 다음 단계를 따르세요.

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

결제 조정 페이지에서 다음을 작업을 수행할 수 있습니다.

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

결제 조정 추가

결제 조정을 추가하려면 다음 단계를 따르세요.

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

    결제 문서에 표시되는 설명 이름입니다.
    조정 비율

    조정 금액(양수 또는 음수 비율로 표시됨)입니다. 양수 비율은 거래의 수익 공유 또는 수수료를 해당 비율만큼 조정합니다. 음수 조정은 거래의 수익 공유 또는 수수료를 해당 비율만큼 조정합니다. 소수점 이하 두 자리까지의 양수 또는 음수 소수를 입력합니다.
    결제 월

    조정의 결제 월입니다. 드롭다운 목록에서 월을 선택합니다.
    거래 유형

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

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

    조정을 적용하려는 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}는 특정 결제 조정의 식별자입니다. 업데이트를 할 때 요청 본문에 업데이트된 속성과 업데이트할 결제 조정의 식별자를 지정해야 합니다. 또한 결제 조정의 필수 속성, 즉 이름, 조정 비율, 결제 월, 결제 연도, 조직의 속성을 지정해야 합니다.

예를 들어 다음 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를 사용하여 결제 조정 삭제

DELETE 요청을 실행하여 결제 조정을 삭제할 수 있습니다. /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, 여기서 {billing_adjustment_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

결제 조정의 설명 이름입니다.

 해당 사항 없음 예
adjustmentPercentageFactor

조정 금액(양수 또는 음수 숫자 비율로 표시됨)입니다. 양수 비율은 거래의 수익 공유 또는 수수료를 해당 비율만큼 조정합니다. 음수 비율은 거래의 수익 공유 또는 수수료를 해당 비율만큼 조정합니다. 값은 -100~999.9999 범위일 수 있습니다.

 해당 사항 없음 예
billingMonth

결제 조정의 결제 월(정수로 지정됨)입니다. 예를 들어 12월의 경우 11 입니다.

 해당 사항 없음 예
billingYear

결제 조정의 결제 연도( YYYY 형식으로 지정됨)입니다. 예를 들어 2017입니다.

 해당 사항 없음 예
organization

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

 해당 사항 없음 예
isPublished

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

  • true. 결제 조정을 게시해야 합니다.
  • false. 결제 조정을 게시해서는 안 됩니다.
 해당 사항 없음 아니요
transactionType

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

  • PURCHASE
  • CHARGE
  • REFUND
  • CREDIT
  • BALANCE
  • SETUPFEES
  • TERMINATIONFEES
  • RECURRINGFEES
  • TRUEUPS. 등급이 매겨진 거래를 재조정하는 데 사용되는 거래입니다. 이전 결제 월에 세금 변경이 이루어질 때 호출됩니다.
 해당 사항 없음 아니요
developerBillingType

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

  • PREPAID.. 선불 개발자
  • POSTPAID. 후불 개발자
  • BOTH. 선불 및 후불 개발자
 해당 사항 없음 아니요
product

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

 해당 사항 없음 아니요
monetizationPackage

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

 해당 사항 없음 아니요
developer

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

 해당 사항 없음 아니요

다음 단계

수익 창출을 사용하면 개발자에게 크레딧을 유연하게 발급할 수 있습니다. 개발자가 서비스에 만족하지 않고 일정 기간 동안 사용량에 대해 부분 또는 전액 환불을 요청하는 경우 이 작업을 해야 할 수 있습니다. 크레딧 발급에서 크레딧을 발급하는 방법을 알아보세요.