您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
簡介
透過營利功能,您可以調整帳單詳細資料。舉例來說,如果記錄有差異,您可能需要提高或降低特定帳單月份的收益分享比例或費用。
探索「帳單調整項」頁面
按照下方說明前往「帳單調整項」頁面。
邊緣
如要使用 Edge UI 存取「帳單調整」頁面,請按照下列步驟操作:
- 登入 apigee.com/edge。
- 在左側導覽列中,依序選取「發布」>「營利」>「帳單調整項」。
系統會顯示「帳單調整」頁面。

如圖所示,「帳單調整項」頁面可讓您:
Classic Edge (Private Cloud)
如要使用傳統 Edge UI 存取「帳單調整項」頁面,請按照下列步驟操作:
- 登入
http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。 - 在頂端導覽列中,依序選取「營利」>「調整」。
您可以在「帳單調整」頁面執行下列操作:
- 查看目前的帳單調整項清單
- 新增帳單調整項
- 編輯帳單調整項
- 搜尋帳單調整項清單
新增帳單調整項
如要新增帳單調整項,請按照下列步驟操作:
- 存取「帳單調整項」頁面。
- 按一下「+ 調整項」。
- 輸入下列資訊:
欄位 說明 名稱 帳單文件上顯示的描述性名稱。
調整百分比 調整金額,以正數或負數百分比表示。正百分比會將交易的收益分潤或費用調高該百分比。負值調整項會將交易中的收益分潤或費用調降該百分比。輸入正數或負數 (最多可到小數點後第二位)。
帳單月份 調整項的帳單月份。從下拉式清單中選取月份。
交易類型 要套用調整項的交易類型。從下拉式選單中選取值:
- 所有交易
- 費用 (充電模式交易)
- 購買 (收益分潤模式交易)
- 退款 (收益分潤模式交易)
產品 要套用調整項目的 API 產品。你無法對多個 API 產品套用單一調整項。如要對多項 API 產品套用調整項,請為每項產品建立調整項。從下拉式選單中選取 API 產品。
開發人員 要套用調整項目的開發人員。您可以將調整項目套用至所有開發人員 (預設),或特定開發人員。從下拉式選單中選取「所有開發人員」或特定開發人員。
- 按一下「建立調整項」。
編輯帳單調整
如要編輯帳單調整項,請按照下列步驟操作:
- 存取「帳單調整項」頁面。
- 將游標懸停在要編輯的帳單調整項上,然後按一下動作選單中的
。 - 視需要更新帳單調整項。
- 按一下「更新調整項」。
使用 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 (建立帳單調整項時,系統會在回應中傳回該 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} 是特定帳單調整項的 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 |
帳單調整項的描述性名稱。 |
N/A | 是 |
adjustmentPercentageFactor |
調整金額,以正數或負數百分比表示。正百分比會將交易中的收益分潤或費用調高該百分比。負百分比會將交易的收益分潤或費用調降該百分比。值的範圍為 -100 到 999.9999。 |
N/A | 是 |
billingMonth |
帳單調整項的帳單月份,以整數表示。例如 11 代表 12 月。 |
N/A | 是 |
billingYear |
帳單調整項的帳單年度,格式如下: YYYY。例如 2017 年。 |
N/A | 是 |
organization |
套用帳單調整項的機構。 |
N/A | 是 |
isPublished |
指定是否應發布調整項的旗標。值可以是下列其中一個:
|
N/A | 否 |
transactionType |
帳單調整項適用的交易類型。類型可以是下列任一值:
|
N/A | 否 |
developerBillingType |
適用帳單調整項目的開發人員帳單類型。這個值可以是下列其中一個值:
|
N/A | 否 |
product |
適用帳單調整項的 API 產品。如未指定這項屬性,帳單調整項目會套用至所有 API 產品。 |
N/A | 否 |
monetizationPackage |
適用帳單調整的 API 套件。如未指定這項屬性,系統會將帳單調整項套用至所有 API 套件。 |
N/A | 否 |
developer |
要套用帳單調整項的開發人員。如未指定這項屬性,帳單調整項會套用至所有開發人員。 |
N/A | 否 |
後續步驟
營利功能可讓您彈性發放抵免額給開發人員。如果開發人員對服務不滿意,並要求部分或全額退款某段時間的使用費用,您可能需要這麼做。請參閱「核發抵免額」一文,瞭解如何核發抵免額。