進行帳單調整

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

簡介

你可以透過營利功能調整帳單詳細資料。舉例來說,由於您的記錄有差異,您可能需要增加或減少特定帳單月份的收益分潤或費用。

探索「帳單調整項」頁面

按照下文說明前往「帳單調整項」頁面。

Edge

如何使用 Edge UI 存取「帳單調整項」頁面:

  1. 登入 apigee.com/edge
  2. 在左側導覽列中,依序選取「發布」>「營利」>「帳單調整項」

畫面上會顯示「帳單調整」頁面。

如圖中所示,您可以透過「帳單調整項」頁面進行下列操作:

傳統邊緣 (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 刪除帳單調整

如要刪除帳單調整,請向 /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

帳單調整的帳單月份,以整數表示。例如 11 代表 12 月。

不適用
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

帳單調整項適用的開發人員。如果未指定這項屬性,帳單調整項會套用至所有開發人員。

不適用

後續步驟

營利設定可讓您彈性地核發抵免額給開發人員。如果開發人員對某項服務不滿意,並且針對某段期間的用量要求部分或全額退款,您可能就必須執行這項操作。請參閱「核發抵免額」一文,瞭解如何核發抵免額。