Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

請求額の調整

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します。 info

はじめに

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

[請求の調整] ページを確認する

下記のように [請求の調整] ページにアクセスします。

エッジ

Edge UI を使用して [請求の調整] ページにアクセスするには:

apigee.com/edge にログインします。
左側のナビゲーションバーで、[公開] > [収益化] > [請求の調整] を選択します。

[請求の調整] ページが表示されます。

図でハイライト表示されているように、[請求の調整] ページでは以下を行うことができます。

請求の調整の現在のリストを表示する
請求額の調整を追加する
請求額の調整を編集する
請求の調整のリストを検索する

Classic Edge（Private Cloud）

Classic Edge UI を使用して [請求の調整] ページにアクセスするには:

http://ms-ip:9000 にログインします。ここで、ms-ip は Management Server ノードの IP アドレスまたは DNS 名です。
上部のナビゲーションバーで [収益化] > [調整] を選択します。

[請求の調整] ページでは、次の操作を行うことができます。

請求の調整の現在のリストを表示する
請求額の調整を追加する
請求額の調整を編集する
請求の調整のリストを検索する

請求額の調整を追加する

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

[請求の調整] ページにアクセスします。
[+ 調整] をクリックします。

次の情報を入力します。

フィールド	説明
名前	請求書に表示される説明的な名前。
調整率 %	調整額（正または負のパーセンテージ）。正のパーセンテージは、トランザクションの収益分配または料金をそのパーセンテージだけ引き上げます。負の調整は、トランザクションの収益分配または料金をそのパーセンテージだけ引き下げます。正または負の小数（小数点以下 2 桁まで）を入力します。
請求月	調整の請求月。プルダウンリストから月を選択します。
取引の種類	調整を適用する取引の種類。プルダウンから値を選択します。すべての料金の履歴課金（課金モデルのトランザクション）購入（収益分配モデルのトランザクション）払い戻し（収益分配モデルのトランザクション）
プロダクト	調整を適用する API プロダクト。複数の API プロダクトに 1 回の調整を適用することはできません。複数の API プロダクトに調整を適用する必要がある場合は、プロダクトごとに調整を作成します。プルダウンメニューから API プロダクトを選択します。
デベロッパー	調整を適用するデベロッパー。調整は、すべてのデベロッパー（デフォルト）または特定のデベロッパーに適用できます。プルダウンメニューから [すべてのデベロッパー] または特定のデベロッパーを選択します。注: 特定のデベロッパーに対して行う調整は、すべてのデベロッパーに対して行われた調整よりも優先されます。

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

請求額の調整を編集する

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

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

API を使用して請求の調整を行う

以降のセクションでは、API を使用して請求の調整を行う方法について説明します。

API を使用して請求額の調整を行う

/organizations/{org_name}/billing-adjustments に POST リクエストを送信して、請求の詳細を調整できます。リクエストを行う場合は、リクエスト本文で次のように指定します。

請求額の調整の名前。
調整率。つまり、請求額を増減する正または負のパーセンテージ値。
請求月。
請求年。
請求額の調整が適用される組織。

次のような他のプロパティも指定できます。

調整を適用する取引の種類（購入取引など）。
調整を適用するデベロッパー。
前払いデベロッパー、後払いデベロッパー、またはその両方に調整を適用するかどうか。
調整を適用する API パッケージ。
調整を適用する API プロダクト。

調整リクエストで指定できる請求額の調整プロパティの完全なリストについては、請求額の調整の構成設定をご覧ください。

省略可能なプロパティが指定されていない場合、請求書の調整はそのプロパティに対してすべて包括的になります。たとえば、取引の種類が指定されていない場合、請求の調整はすべての取引の種類に適用されます。

次の例では、2013 年 6 月の未確定の請求月に対して請求額の調整を行います。調整により 3% の削減が行われ、購入取引、支払いプロダクト、後払いデベロッパーに適用されます。特定のデベロッパーまたは API パッケージを識別するプロパティが指定されていないため、調整はすべてのデベロッパー（who は後払いデベロッパー）とすべての 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

組織のすべての請求の調整を表示するには、に 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} は特定の請求額の調整の識別子です。更新を行う場合は、リクエスト本文で、更新するプロパティと更新する請求額の調整の識別子を指定する必要があります。また、請求額の調整の必須プロパティ（名前、調整率、請求月、請求年、組織のプロパティ）も指定する必要があります。

たとえば、次の 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} は削除する請求額の調整の識別子です。次に例を示します。

$ 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 プロダクトに適用されます。注: 複数の API プロダクトに 1 回の調整を適用することはできません。複数の API プロダクトに調整を適用する必要がある場合は、プロダクトごとに調整を作成します。	なし	いいえ
`monetizationPackage`	請求額の調整が適用される API パッケージ。このプロパティを指定しない場合、請求額の調整はすべての API パッケージに適用されます。注: 複数の API パッケージに 1 回の調整を適用することはできません。複数の API パッケージに調整を適用する必要がある場合は、パッケージごとに調整を作成します。	なし	いいえ
`developer`	請求額の調整が適用されるデベロッパー。このプロパティを指定しない場合、請求額の調整はすべてのデベロッパーに適用されます。注: 特定のデベロッパーに対して行う調整は、常にすべてのデベロッパーに対して行われた調整よりも優先されます。	なし	いいえ

次のステップ

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