進行帳單調整

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

簡介

營利可讓您調整帳單詳情。例如,您可能需要 提高或降低特定帳單月份的收益分潤或費用, 。

查看「帳單調整項」頁面

存取「帳單調整項」頁面 (如下所述)。

Edge

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

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

系統隨即會顯示「帳單調整項」頁面。

如圖中所示,「帳單調整項」頁面可讓您執行下列操作:

傳統版 Edge (Private Cloud)

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

  1. 登入「http://ms-ip:9000」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。
  2. 選取「營利」>頂端導覽列中的調整項

「帳單調整項」頁面可讓您:

  • 查看目前的帳單調整項清單
  • 新增帳單調整項
  • 修改帳單調整項
  • 搜尋帳單調整項清單

新增帳單調整項

如要新增帳單調整項,請按照下列步驟操作:

  1. 存取「帳單調整項」頁面
  2. 按一下「+ 調整項」
  3. 輸入下列資訊:
    欄位 說明
    名稱

    可顯示在帳單文件上的描述性名稱,

    調整項百分比

    調整項金額,以正或負百分比表示。陽性 百分比會據此調整交易的收益分潤或手續費 百分比。負數調整項則會降低 以達成此百分比的交易量請輸入正數或負小數 (含) 至小數點後兩位)

    帳單月份

    調整項的帳單月份。從下拉式清單中選取月份。

    交易類型

    要套用調整項的交易類型。根據您的目標選取 ] 值:

    • 所有交易
    • 收費 (充電模式交易)
    • 購買 (收益分潤模式交易)
    • 退款 (收益分潤模式交易)
    產品

    要套用調整項的 API 產品。您無法套用 針對多項 API 產品套用一項調整如果您需要將調整項套用至 多項 API 產品,請為每個產品建立調整項。選取 API 產品 。

    開發人員

    您要套用調整項的開發人員。您可以將 為特定開發人員 (根據預設) 或特定開發人員進行調整。選取「全部」 開發人員」從下拉式選單選取特定開發人員

  4. 按一下「建立調整項」

編輯帳單調整項

若要修改帳單調整項,請按照下列步驟進行:

  1. 存取「帳單調整項」頁面
  2. 將滑鼠遊標移到要修改的帳單調整項上,然後按一下動作選單中的
  3. 視需要更新帳單調整項。
  4. 按一下「更新調整項」

使用 API 調整帳單

以下各節說明如何使用 API 調整帳單。

使用 API 進行帳單調整

您可以向以下位置發出 POST 要求,調整帳單詳細資料: /organizations/{org_name}/billing-adjustments.提出要求時,您應在 要求主體:

  • 帳單調整項的名稱。
  • 調整百分比,也就是正數或負數的百分比值 帳單金額分別會增加或減少。
  • 帳單月份。
  • 帳單年度。
  • 套用帳單調整項的機構。

您也可以指定其他屬性,例如:

  • 要套用調整項的交易類型 (例如購買交易) 交易)。
  • 您要套用調整項的開發人員。
  • 您要為預付開發人員、後付開發人員或 兩者。
  • 要套用調整項的 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)。例如:

$ 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 更新帳單調整項

您可以向 /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 刪除帳單調整項

您可以向以下使用者發出 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

調整項的金額,以正或負數值百分比表示。陽性 百分比並據此調整交易的收益分潤或手續費。A 罩杯 負百分比減少了交易的收益分潤或手續費 百分比。值的範圍為 -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

要套用帳單調整項的開發人員。如果未指定 帳單調整項,適用於所有開發人員。

不適用

後續步驟

營利功能可讓你靈活發送抵免額給開發人員,您可能需要完成 如果開發人員對服務不滿意,要求針對使用情況申請部分或全額退款 表示一個時期。請參閱這篇文章,瞭解如何核發抵免額。