請求額の調整

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

はじめに

収益化では、請求の詳細を調整できます。たとえば、記録の不一致が原因で、特定の請求月の収益分配や料金を増減する必要が生じる場合があります。

[請求調整] ページの詳細

次の手順で [請求調整] ページにアクセスします。

請求調整を追加

請求調整を追加するには:

1. [請求調整] ページにアクセスします。
2. [+ 調整] をクリックします。
3. 次の情報を入力します。

   項目	説明
   名前	請求ドキュメントに表示されるわかりやすい名前です。
   調整率（%）	調整金額。正または負のパーセンテージで表します。正の割合の場合は、トランザクションの収益分配率または手数料がその割合で調整されます。マイナスの調整は、トランザクションの収益分配率または手数料をその割合分引き下げることを意味します。正または負の 10 進数（小数第 2 位まで）を入力します。
   請求月	調整の請求月。プルダウン リストから月を選択します。
   取引の種類	調整を適用する取引の種類。プルダウンから値を選択します。 すべての料金の履歴 請求（請求モデルの取引） 購入（収益分配モデルのトランザクション） 払い戻し（収益分配モデルのトランザクション）
   商品	調整を適用する API プロダクト。複数の API プロダクトに 1 つの調整を適用することはできません。複数の API プロダクトに調整を適用する必要がある場合は、プロダクトごとに調整を作成します。プルダウン メニューから API プロダクトを選択します。
   デベロッパー	調整を適用するデベロッパー。この調整は、すべてのデベロッパー（デフォルト）または特定のデベロッパーに適用できます。プルダウン メニューから [All Developers] または特定のデベロッパーを選択します。

4. [調整を作成] をクリックします。

請求調整を編集する

請求調整を編集するには:

1. [請求調整] ページにアクセスします。
2. 編集する請求調整にカーソルを合わせて、操作メニューで をクリックします。
3. 必要に応じて、請求額の調整を更新します。
4. [Update Adjust（調整を更新）] をクリックします。

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 を使用した請求額の調整の表示

組織に対する特定の請求調整またはすべての請求調整を表示できます。 特定の請求調整を表示するには、GET リクエストを /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} に送信します。ここで、{billing_adjustment_id} は特定の請求調整の 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

組織のすべての請求額の調整を表示するには、GET リクエストを /organizations/{org_name}/billing-adjustments に送信します。例:

$ 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 を使用した請求額調整の更新

請求調整を更新するには、PUT リクエストを /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} に発行します。ここで、{billing_adjustment_id} は特定の請求調整を示す 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	請求額調整のわかりやすい名前。	なし	○
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	請求額調整が適用されるデベロッパー。このプロパティを指定しなかった場合、請求調整はすべてのデベロッパーに適用されます。	なし	×

次のステップ

収益化により、デベロッパーにクレジットを柔軟に発行できます。デベロッパーがサービスに満足せず、一定期間の使用に対して一部または全額払い戻しをリクエストする場合は、この処理が必要になることがあります。クレジットの発行方法については、クレジットの発行をご覧ください。