本頁面由 Cloud Translation API 翻譯而成。

管理 API 產品的計價方案

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

透過費率方案，API 產品擁有者可以設定下列項目，藉此利用 API 產品營利：

帳單帳戶模式
用於帳單的貨幣
向客戶收費的頻率 (僅限按月)
使用 API 產品的初始設定費
使用 API 產品時，以用量計費
任何非以使用量為依據的週期性費用，例如 API 產品的月費
API 產品的費率方案生效期間 (費率方案啟用和到期時間)
與開發合作夥伴分享收益

請按照下列各節所述管理 API 產品的費率方案。

查看房價方案

請按照下列各節所述，查看貴機構的費率方案。

Cloud 控制台中的 Apigee

如要查看費率方案，請使用 Cloud 控制台中的 Apigee UI，如以下各節所述：

查看貴機構定義的觀看費率方案
查看與 API 產品相關聯的費率方案

查看為貴機構定義的費率方案

在「費率方案」頁面查看機構定義的費率方案。

如要存取「費率方案」頁面，請按照下列步驟操作：

登入 Cloud 控制台中的 Apigee UI。
在側邊導覽列中，依序選取「發布」>「營利」。

「房價方案」頁面會隨即開啟，並列出目前的房價方案。

費率方案清單，顯示每個費率方案的名稱、API 產品、啟用和到期時間，以及可用於管理費率方案的選單

你可以在「房價方案」頁面中執行下列操作：

按一下「建立」，即可建立新的費率方案。
按一下房價方案名稱，更新房價方案。
透過 more_vert 選單管理費率方案：
- 設定費率方案的啟用和到期時間
- 發布房價方案 (僅適用於草稿房價方案)
- 將已發布的費率方案設為草稿狀態 (僅適用於已發布的費率方案)
- 複製費率方案
- 刪除費率方案
查看各個費率方案的詳細資料，包括相關 API 產品、狀態 (Published 或 Draft)、是否為有效方案，以及啟用和到期時間

查看與 API 產品相關聯的費率方案

管理 API 產品時，您可以查看及管理與 API 產品相關聯的費率方案。向下捲動至「費率方案」部分，即可查看費率方案。

傳統版 Apigee UI

請按照下列各節所述，使用 UI 查看費率方案：

查看貴機構定義的觀看費率方案
查看與 API 產品相關聯的費率方案

查看為貴機構定義的費率方案

在「費率方案」頁面查看機構定義的費率方案。

如要存取「費率方案」頁面，請按照下列步驟操作：

登入傳統版 Apigee UI。
在側邊導覽列中，依序選取「發布」>「營利」>「費率方案」。

「費率方案」頁面會列出目前的費率方案。

費率方案清單，顯示每個費率方案的名稱、API 產品、啟用和到期時間，以及可用於管理費率方案的下拉式選單

在「費率方案」頁面中，你可以：

查看各個費率方案的詳細資料，包括相關 API 產品、狀態 (Published 或 Draft)、是否為有效方案，以及啟用和到期時間
按一下「建立」，即可建立新的費率方案。
按一下房價方案名稱，更新房價方案。
透過「動作」選單管理計價方案：
- 設定費率方案的啟用和到期時間
- 發布房價方案 (僅適用於草稿房價方案)
- 將已發布的費率方案設為草稿狀態 (僅適用於已發布的費率方案)
- 複製費率方案
- 刪除費率方案

查看與 API 產品相關聯的費率方案

管理 API 產品時，您可以查看及管理與 API 產品相關聯的費率方案。編輯 API 產品，然後向下捲動至「費率方案」部分。

Apigee API

以下各節說明如何使用 API 查看機構的費率方案：

列出 API 產品的費率方案
查看費率方案詳細資料

使用 API 列出 API 產品的費率方案

如要列出機構的費率方案，請向下列 API 發出 GET 要求： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

例如使用 curl：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

其中 $TOKEN 會設為您的 OAuth 2.0 存取權憑證，如取得 OAuth 2.0 存取權憑證一節所述。如要瞭解本範例中使用的 curl 選項，請參閱「使用 curl」。如要瞭解所使用的環境變數，請參閱「為 Apigee API 要求設定環境變數」。

以下提供回應輸出的範例，包括與 HelloworldProduct API 產品相關聯的兩個費率方案 myrateplan1 和 myrateplan2：

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

如要進一步瞭解 API 及其回應酬載，請參閱 List rate plans API

使用 API 查看費率方案詳細資料

如要查看費率方案的詳細資料，請向下列 API 發出 GET 要求： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

如要判斷要傳入資源路徑的費率方案名稱，請參閱「列出機構中的費率方案」。

例如使用 curl：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

以下是名稱為 6b51b501-ac15-41b7-bb3e-621edb849e13 且顯示名稱為 myrateplan2 的費率方案回應輸出內容範例：

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

如要進一步瞭解 API 及其回應酬載，請參閱「取得費率方案 API」。

建立費率方案

按照下列各節所述，建立費率方案。

Cloud 控制台中的 Apigee

如要使用 Cloud 控制台中的 Apigee UI 建立費率方案，請按照下列步驟操作：

執行下列任一工作：
- 在側邊導覽列中依序選取「發行」>「營利」，然後按一下費率方案清單中的「建立」。
- 編輯 API 產品，然後點選「費率方案」部分中的「新增費率方案」。

輸入費率方案詳細資料，如下所示：

欄位	說明
房價方案名稱	輸入費率方案名稱。
API 產品	從下拉式選單中選取要關聯費率方案的 API 產品。

點選「下一步」。

輸入帳單詳細資料，如下所示：

欄位說明預設

帳單貨幣從下拉式選單中選取帳單幣別。美元

帳單週期

欄位	說明	預設
帳單貨幣	從下拉式選單中選取帳單幣別。	美元
帳單週期	在下拉式選單中，選取向客戶收費的頻率。注意： `Monthly` 是本版本中唯一有效的選項。	每月
初始化費用	在費率方案開始日期 (即開發人員購買 API 產品的日期)，向每位開發人員收取的一次性費用。如要收取設定費，請選取「收取啟用費」，然後在「啟用費」欄位輸入要收取的金額。	已停用

在下拉式選單中，選取向客戶收費的頻率。

注意： Monthly 是本版本中唯一有效的選項。

每月

初始化費用

在費率方案開始日期 (即開發人員購買 API 產品的日期)，向每位開發人員收取的一次性費用。

如要收取設定費，請選取「收取啟用費」，然後在「啟用費」欄位輸入要收取的金額。

已停用

點選「下一步」。

輸入價格詳細資料，如下所示。

欄位說明預設

固定週期性費用

欄位	說明	預設
固定週期性費用	啟用每個單位的固定週期性費用：選取「收取固定的週期性費用」。設定固定費用頻率和固定週期性費用金額。費用會按比例計算，並在第一個帳單週期收取。啟用後，您可以預覽固定週期性費用對明細和總費用的影響，詳情請參閱「預覽費率方案」。如要停用費用，請取消選取「收取固定週期性費用」。	已停用
以用量計費	啟用根據用量計費：選取「根據消費量收費」。選取下列任一選項：每單位固定費用 (每單位消耗量固定費用) 分級 (依用量範圍決定每單位用量變動費用) 單次單價：每筆營利交易都會收取固定費用。在「每單位固定費用」欄位中輸入值，系統會針對每筆交易收取這筆費用。分級：每筆營利交易都會收取浮動費。交易頻率和用量會決定交易費用。頻帶是指 API 用量範圍，每個頻帶的費用皆不同。在 `Ranges of unit consumption` 區段中，您可以指定頻帶範圍和相應的費用。您可以點選「+ 頻帶」，指定任意數量的頻帶。範例：假設您想為前 1000 次 API 呼叫收取每個呼叫 $2 美元的費用，而後續所有 API 呼叫則收取每個呼叫 $1 美元的費用。如要設定這項功能，請在 `Ranges of unit consumption` 區段中指定下列兩個頻帶：在第一列輸入下列值： Start：0 End：1000 費用：2 在第二列輸入下列值：起始：1001 End：無限制的單位費用：1 在這個範例中，如果開發人員使用 1500 個 API，總費用將是 $2500 美元 `((1000 * 2) + (500 * 1))`。啟用任何以消費量計費的費用類型後，您可以預覽所選費用類型對整體收益的影響，詳情請參閱「預覽費率方案」。如要停用這項費用，請取消選取「按照用量計費的定價模式」。如果您已在 DataCapture 政策中設定 `perUnitPriceMultiplier` 營利變數，則以任何類型 (每單位固定費或頻寬) 指定的以消耗量計費的費用，會乘以 `perUnitPriceMultiplier` 的值。注意：交易的營利方式取決於 `transactionSuccess` 營利變數的值。詳情請參閱「營利變數」一文。	已停用

啟用每個單位的固定週期性費用：

選取「收取固定的週期性費用」。
設定固定費用頻率和固定週期性費用金額。

費用會按比例計算，並在第一個帳單週期收取。

啟用後，您可以預覽固定週期性費用對明細和總費用的影響，詳情請參閱「預覽費率方案」。

如要停用費用，請取消選取「收取固定週期性費用」。

已停用

以用量計費

啟用根據用量計費：

選取「根據消費量收費」。
選取下列任一選項：
- 每單位固定費用 (每單位消耗量固定費用)
- 分級 (依用量範圍決定每單位用量變動費用)

單次單價：每筆營利交易都會收取固定費用。在「每單位固定費用」欄位中輸入值，系統會針對每筆交易收取這筆費用。
分級：每筆營利交易都會收取浮動費。交易頻率和用量會決定交易費用。頻帶是指 API 用量範圍，每個頻帶的費用皆不同。在 Ranges of unit consumption 區段中，您可以指定頻帶範圍和相應的費用。您可以點選「+ 頻帶」，指定任意數量的頻帶。

範例：假設您想為前 1000 次 API 呼叫收取每個呼叫 $2 美元的費用，而後續所有 API 呼叫則收取每個呼叫 $1 美元的費用。如要設定這項功能，請在 Ranges of unit consumption 區段中指定下列兩個頻帶：
- 在第一列輸入下列值：
  - Start：0
  - End：1000
  - 費用：2
- 在第二列輸入下列值：
  - 起始：1001
  - End：無限制的單位
  - 費用：1
在這個範例中，如果開發人員使用 1500 個 API，總費用將是 $2500 美元 ((1000 * 2) + (500 * 1))。

啟用任何以消費量計費的費用類型後，您可以預覽所選費用類型對整體收益的影響，詳情請參閱「預覽費率方案」。

如要停用這項費用，請取消選取「按照用量計費的定價模式」。

如果您已在 DataCapture 政策中設定 perUnitPriceMultiplier 營利變數，則以任何類型 (每單位固定費或頻寬) 指定的以消耗量計費的費用，會乘以 perUnitPriceMultiplier 的值。

注意：交易的營利方式取決於 transactionSuccess 營利變數的值。詳情請參閱「營利變數」一文。

已停用

點選「下一步」。

輸入收益分潤詳細資料，如下所示：

欄位說明預設

收益分成

欄位	說明	預設
收益分成	啟用收益分潤功能，與開發合作夥伴分享部分收益。選取「啟用收益分潤」。在「與開發人員分享的收益百分比 (%)」欄位中輸入收益分潤百分比。您可以在 DataCapture 政策中設定 `revShareGrossPrice` 營利變數，取得每筆營利交易的分潤。詳情請參閱「營利變數」。啟用收益分潤功能後，你可以預覽輸入的百分比 (%) 值對分項費用和總費用的影響，詳情請參閱「預覽房價方案」一文。如要停用這筆費用，請取消選取「啟用收益分潤」。	已停用

啟用收益分潤功能，與開發合作夥伴分享部分收益。

選取「啟用收益分潤」。
在「與開發人員分享的收益百分比 (%)」欄位中輸入收益分潤百分比。

您可以在 DataCapture 政策中設定 revShareGrossPrice 營利變數，取得每筆營利交易的分潤。詳情請參閱「營利變數」。

啟用收益分潤功能後，你可以預覽輸入的百分比 (%) 值對分項費用和總費用的影響，詳情請參閱「預覽房價方案」一文。

如要停用這筆費用，請取消選取「啟用收益分潤」。

已停用

點選「下一步」。
點選下列其中一個選項：
- 點選「儲存並發布」，即可儲存並發布費率方案。系統會提示你選擇啟用日期。詳情請參閱「設定費率方案的啟用日期」。
- 點選「儲存」，即可儲存費率方案草稿。
- 點選「取消」即可取消。

傳統版 Apigee UI

如何使用 UI 建立費率方案：

執行下列任一工作：
- 在側邊導覽列中依序選取「發布」>「營利」>「費率方案」，然後點選「建立費率方案」。
- 編輯 API 產品，然後點選「費率方案」專區中的。
輸入費率方案詳細資料，如下所示：

欄位說明

房價方案名稱輸入費率方案名稱。

API 產品從下拉式選單中選取要關聯費率方案的 API 產品。
點選「下一步」。

輸入帳單詳細資料，如下所示：

欄位說明預設

帳單貨幣從下拉式選單中選取帳單幣別。美元

帳單週期

欄位	說明	預設
帳單貨幣	從下拉式選單中選取帳單幣別。	美元
帳單週期	在下拉式選單中，選取向客戶收費的頻率。注意： `Monthly` 是本版本中唯一有效的選項。	每月
初始化費用	在費率方案開始日期 (即開發人員購買 API 產品的日期)，向每位開發人員收取的一次性費用。如要收取設定費，請選取「Charge setup fee」(收取設定費)，然後在「Initialization fee」(啟用費) 欄位輸入要收取的金額。	已停用

在下拉式選單中，選取向客戶收費的頻率。

注意： Monthly 是本版本中唯一有效的選項。

每月

初始化費用

在費率方案開始日期 (即開發人員購買 API 產品的日期)，向每位開發人員收取的一次性費用。

如要收取設定費，請選取「Charge setup fee」(收取設定費)，然後在「Initialization fee」(啟用費) 欄位輸入要收取的金額。

已停用

點選「下一步」。

輸入價格詳細資料，如下所示。

欄位說明預設

固定週期性費用

欄位	說明	預設
固定週期性費用	啟用每個單位的固定週期性費用：選取「收取固定的週期性費用」。設定固定週期性費用金額和費用頻率。費用會按比例計算，並在第一個帳單週期收取。啟用後，您可以預覽固定週期性費用對明細和總費用的影響，詳情請參閱「預覽費率方案」。如要停用費用，請取消選取「收取固定週期性費用」。	已停用
以用量計費	啟用根據用量計費：選取「根據消費量收費」。選取下列任一選項：每單位固定費用 (每單位消耗量固定費用) 分級 (依用量範圍決定每單位用量變動費用) 單次單價：每筆營利交易都會收取固定費用。在「每單位固定費用」欄位中輸入值，系統會針對每筆交易收取這筆費用。分級：每筆營利交易都會收取浮動費。交易頻率和使用量會決定交易費用。頻帶是指 API 用量範圍，每個頻帶的費用皆不同。在 `Ranges of unit consumption` 區段中，您可以指定頻帶範圍和相應的費用。您可以點選「+ 頻帶」，指定任意數量的頻帶。範例：假設您想為前 1000 次 API 呼叫收取每個呼叫 $2 美元的費用，並為後續所有 API 呼叫收取每個呼叫 $1 美元的費用。如要設定這項功能，請在 `Ranges of unit consumption` 區段中指定下列兩個頻帶：在第一列輸入下列值： Start：0 End：1000 費用：2 在第二列輸入下列值：起始：1001 End：無限制的單位費用：1 在這個範例中，如果開發人員使用 1500 個 API，總費用將是 $2500 美元 `((1000 * 2) + (500 * 1))`。注意：無論訂閱行為為何，開發人員的 API 呼叫計數器都會持續存在。舉例來說，如果開發人員訂閱浮動費率方案，並發出五次 API 呼叫、取消訂閱，然後重新訂閱，系統會將下一次的呼叫視為第六次呼叫，而非第一次呼叫。API 呼叫計數器會在每個帳單週期結束時重設。啟用任何以使用量計費的費用類型後，您可以預覽所選費用類型對整體收益的影響，詳情請參閱「預覽費率方案」。如要停用這項費用，請取消選取「按用量計費的定價模式」。如果您已在 DataCapture 政策中設定 `perUnitPriceMultiplier` 營利變數，則以任何類型 (每單位固定費或頻寬) 指定的以消耗量計費的費用，會乘以 `perUnitPriceMultiplier` 的值。注意：交易的營利方式取決於 `transactionSuccess` 營利變數的值。詳情請參閱「營利變數」一文。	已停用

啟用每個單位的固定週期性費用：

選取「收取固定的週期性費用」。
設定固定週期性費用金額和費用頻率。

費用會按比例計算，並在第一個帳單週期收取。

啟用後，您可以預覽固定週期性費用對明細和總費用的影響，詳情請參閱「預覽費率方案」。

如要停用費用，請取消選取「收取固定週期性費用」。

已停用

以用量計費

啟用根據用量計費：

選取「根據消費量收費」。
選取下列任一選項：
- 每單位固定費用 (每單位消耗量固定費用)
- 分級 (依用量範圍決定每單位用量變動費用)

單次單價：每筆營利交易都會收取固定費用。在「每單位固定費用」欄位中輸入值，系統會針對每筆交易收取這筆費用。
分級：每筆營利交易都會收取浮動費。交易頻率和使用量會決定交易費用。頻帶是指 API 用量範圍，每個頻帶的費用皆不同。在 Ranges of unit consumption 區段中，您可以指定頻帶範圍和相應的費用。您可以點選「+ 頻帶」，指定任意數量的頻帶。

範例：假設您想為前 1000 次 API 呼叫收取每個呼叫 $2 美元的費用，並為後續所有 API 呼叫收取每個呼叫 $1 美元的費用。如要設定這項功能，請在 Ranges of unit consumption 區段中指定下列兩個頻帶：
- 在第一列輸入下列值：
  - Start：0
  - End：1000
  - 費用：2
- 在第二列輸入下列值：
  - 起始：1001
  - End：無限制的單位
  - 費用：1
在這個範例中，如果開發人員使用 1500 個 API，總費用將是 $2500 美元 ((1000 * 2) + (500 * 1))。

啟用任何以使用量計費的費用類型後，您可以預覽所選費用類型對整體收益的影響，詳情請參閱「預覽費率方案」。

如要停用這項費用，請取消選取「按用量計費的定價模式」。

注意：交易的營利方式取決於 transactionSuccess 營利變數的值。詳情請參閱「營利變數」一文。

已停用

點選「下一步」。

輸入收益分潤詳細資料，如下所示：

欄位說明預設

收益分成

欄位	說明	預設
收益分成	啟用收益分潤功能，與開發合作夥伴分享部分收益。選取「啟用收益分潤」。在「與開發人員分享的收益百分比 (%)」欄位中輸入收益分潤百分比。您可以在 DataCapture 政策中設定 `revShareGrossPrice` 營利變數，取得每筆營利交易的分潤。詳情請參閱「營利變數」。啟用收益分潤功能後，你可以預覽輸入的百分比 (%) 值對分項費用和總費用的影響，詳情請參閱「預覽房價方案」一文。如要停用這筆費用，請取消選取「啟用收益分潤」。	已停用

啟用收益分潤功能，與開發合作夥伴分享部分收益。

選取「啟用收益分潤」。
在「與開發人員分享的收益百分比 (%)」欄位中輸入收益分潤百分比。

您可以在 DataCapture 政策中設定 revShareGrossPrice 營利變數，取得每筆營利交易的分潤。詳情請參閱「營利變數」。

啟用收益分潤功能後，你可以預覽輸入的百分比 (%) 值對分項費用和總費用的影響，詳情請參閱「預覽房價方案」一文。

如要停用這筆費用，請取消選取「啟用收益分潤」。

已停用

點選「下一步」。
點選以下其中一個選項：
- 點選「儲存並發布」，即可儲存並發布費率方案。系統會提示你選擇啟用日期。詳情請參閱「設定費率方案的啟用日期」。
- 點選「儲存」，即可儲存費率方案草稿。
- 點選「取消」即可取消。

Apigee API

如要建立費率方案，請向下列 API 發出 POST 要求： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

如「資源：費率方案」一文所述，在要求主體中傳遞必要欄位，即可設定費率方案。

下表列出建立草稿和已發布的費率方案時，必須填寫的欄位。

草稿費率方案的必填欄位	已發布的費率方案必填欄位
`apiproduct` `displayName` `state`	`apiproduct` `billingPeriod` `currencyCode` `displayName` `startTime` `state`

舉例來說，下列 API 呼叫會建立名為 myrateplan5 的費率方案草稿，並與 HelloworldProduct API 產品建立關聯：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

以下提供回應輸出的範例：

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

詳情請參閱「Create rate plan API」

在 UI 中預覽費率方案

根據價格和收益分潤設定，您可以在「費率方案」頁面的「費率方案預覽」部分，預覽明細費用和帳單總額，如下圖所示。

輸入範例值，在費率方案預覽畫面中查看結果

如要變更預覽中的預估值，請更新「消費端資料範例」部分的「API 單元消費量」欄位。系統會根據您輸入的資訊更新明細費用和總金額。

在「Example consumer data」(消費者資料範例) 部分更新下列欄位：

API 單元用量
如果在「定價」下方選取「依用量收費」。
收益
如果在「收益分潤」下方選取「啟用收益分潤」。

設定費率方案的啟用和到期時間

設定費率方案的啟用和到期時間，以指出發布的費率方案何時生效，以及開發人員何時可在應用程式中使用相關的 API 產品。

設定啟用和到期時間時，請考量以下事項：

API 產品只能同時啟用一個費率方案。
您可以為同一個 API 產品發布多個費率方案，且啟用和到期時間不重疊。
您必須先設定費率方案的啟用時間，才能發布。
使用 UI 發布費率方案時，如果未設定啟用時間，系統會提示您設定。
啟用時間必須早於到期時間 (如有)，到期時間則必須晚於啟用時間。
到期時間並非必要項目。如未指定，到期時間預設為 Never (費率方案永遠不會過期)。
使用 UI 設定啟用和到期時間時，您只能指定日期，而無法指定時間 (hh:mm:ss:mmm)。啟用和到期時間的時間值預設為分別為 12:00:00:000 AM 和 11:59:59:999 PM。

按照下列各節的說明，設定費率方案的啟用和到期時間。

Cloud 控制台中的 Apigee

如要使用 Cloud 主控台中的 Apigee UI設定費率方案的啟用時間，請按照下列步驟操作：

前往「費率方案」頁面。
找到要設定啟用時間的費率方案，然後依序點選和「設定啟用時間」。
請選取下列其中一個選項：
- 未定：不設定費率方案啟用時間 (僅適用於草稿費率方案)。
- 立即：立即將費率方案設為有效。
- 在未來某個日期：選取費率方案生效的日期。
按一下「設定啟用」。
如果尚未發布費率方案，請發布，讓開發人員在應用程式中使用。

如要使用 Cloud 主控台中的 Apigee UI設定費率方案的到期時間：

前往「費率方案」頁面。
按一下，然後點選「設定到期時間」，為要設定到期時間的費率方案設定到期時間。
請選取下列其中一個選項：
- 永不 (預設值)，表示費率方案永遠不會失效。
- 立即：立即將費率方案設為有效。
- 在未來某個日期：選取費率方案生效的日期。
按一下「設定到期日」。

傳統版 Apigee UI

如何使用 UI 設定費率方案的啟用時間：

前往「費率方案」頁面。
找出要設定啟用時間的費率方案，然後依序點選 >「設定啟用時間」。
請選取下列其中一個選項：
- 未定：不設定費率方案啟用時間 (僅適用於草稿費率方案)。
- 立即：立即將費率方案設為有效。
- 在未來某個日期：選取費率方案生效的日期。
按一下「設定啟用」。
如果尚未發布費率方案，請發布，讓開發人員在應用程式中使用。

如何使用 UI 設定費率方案的到期時間：

前往「費率方案」頁面。
針對要設定到期時間的費率方案，依序點選 >「設定到期時間」。
請選取下列其中一個選項：
- 選擇「永不」，即可讓費率方案永不過期。
- 立即：立即將費率方案設為有效。
- 在未來某個日期：選取費率方案生效的日期。
按一下「設定到期日」。

Apigee API

如要使用 API 設定費率方案的啟用或到期時間，請按照下列步驟操作：

查看要更新的費率方案詳細資料。
使用回應建立要求內容，並更新下列欄位：
- startTime：設定啟用時間
- endTime：設定到期時間
注意： 使用 API 更新費率方案時，您在要求中指定的設定會取代所有現有設定。請務必為所有要保留的設定指定值，即使這些設定沒有變更也一樣，否則系統會移除這些設定。
如要使用新設定更新費率方案，請向下列 API 發出 PUT 要求，並在要求中傳遞經過修改的請求主體： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

舉例來說，以下設定會將啟用時間設為 2021 年 4 月 1 日 (1617302588000 紀元時間)：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

如要進一步瞭解可在要求主體中指定的欄位，請參閱「資源：RatePlans」。

以下提供回應輸出的範例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

詳情請參閱 Update rate plan API

發布房價方案

按照下列各節所述，發布費率方案。

Cloud 控制台中的 Apigee

如要使用 UI 發布費率方案，請使用下列任一方法：

建立或更新費率方案時，您可以按一下「儲存並發布」，儲存並發布費率方案。系統會提示你設定啟用日期。
前往「費率方案」頁面，然後按一下和「發布」，即可發布費率方案草稿。
只有在您為草稿費率方案設定啟用日期時，系統才會顯示這個選項。

傳統版 Apigee UI

如要使用 UI 發布費率方案，請使用下列任一方法：

建立或更新費率方案時，您可以按一下「儲存並發布」，儲存並發布費率方案。系統會提示你設定啟用日期。
前往「費率方案」頁面，然後按一下 >「發布」，即可發布費率方案草稿。
只有在您為草稿費率方案設定啟用日期時，系統才會顯示這個選項。

Apigee API

如要使用 API 發布費率方案，請按照下列步驟操作：

查看詳細資料，瞭解要發布的費率方案。
使用回應建立要求內容，並更新下列欄位：
- 將「狀態」設為「已發布」。
- 將 startTime 設為啟用時間，以紀元時間為起算點，以毫秒為單位。
- 您可以視需要將 endTime 設為自紀元起算的到期時間 (以毫秒為單位)，或設為 Never。如果省略，到期時間預設為 Never。
- 設定您想保留的其他欄位。
  注意： 使用 API 更新費率方案時，您在要求中指定的設定會取代所有現有設定。請務必為所有要保留的設定指定值，即使這些設定沒有變更也一樣，否則系統會移除這些設定。
如要發布費率方案，請向下列 API 發出 PUT 要求，並在要求中傳遞修改過的請求主體： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

舉例來說，以下指令會將 rateplan1 費率方案的狀態變更為 PUBLISHED，並將啟用時間設為 2021 年 4 月 1 日，以自紀元起算的毫秒為單位指定：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"PUBLISHED",
    "startTime": 1617302588000
    }'

如要進一步瞭解可在要求主體中指定的欄位，請參閱「資源：RatePlans」。

以下提供回應輸出的範例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "PUBLISHED",
    "startTime": "1617302588000"
}

詳情請參閱「更新費率方案 API」

將已發布的費率方案設為草稿狀態

按照下文所述，將已發布的費率方案移至草稿狀態。

Cloud 控制台中的 Apigee

如要使用 Cloud 控制台中的 Apigee UI，將已發布的費率方案移至草稿狀態，請按照下列步驟操作：

前往「費率方案」頁面。
依序選取和「移至草稿」。

費率方案已更新，Status 欄位已變更為「草稿」。

傳統版 Apigee UI

如要使用 UI 將已發布的費率方案移至草稿狀態，請按照下列步驟操作：

前往「費率方案」頁面。
依序選取「」>「移動至草稿」。

費率方案已更新，Status 欄位已變更為「草稿」。

Apigee API

如要使用 API 將已發布的費率方案移至草稿狀態，請按照下列步驟操作：

查看詳細資料，瞭解要將已發布費率方案移至草稿狀態的相關資訊。
使用回應建立要求內容，並更新下列欄位：
- 將「狀態」設為「草稿」。
- 設定您想保留的其他欄位。
  注意： 使用 API 更新費率方案時，您在要求中指定的設定會取代所有現有設定。請務必為所有要保留的設定指定值，即使這些設定沒有變更也一樣，否則系統會移除這些設定。
如要將已發布的費率方案移至草稿狀態，請向下列 API 發出 PUT 要求，並在要求中傳遞修改過的請求主體： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

舉例來說，以下指令會將 rateplan1 費率方案的狀態變更為 DRAFT：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

如要進一步瞭解可在要求主體中指定的欄位，請參閱「資源：RatePlans」。

以下提供回應輸出的範例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

詳情請參閱 Update rate plan API

更新房價方案

請按照下列各節的說明更新費率方案。另請參閱：

發布費率方案
設定費率方案的啟用和到期時間

注意：更新有效的發布費率方案時，請選擇下列任一方法：

方法

注意事項

更新費率方案 (請見下文)

變更會立即套用至有效的發布費率方案。在這種情況下，您可能無法立即瞭解費率方案異動的原因。

發布新版費率方案

系統會根據新的有效發布費率方案追蹤費用，這可能有助於追蹤。

如要發布新版費率方案，請按照下列步驟操作：

複製現有費率方案。
視需要編輯複製的費率方案版本。
立即到期或移至草稿現有的費率方案。
立即發布新版費率方案。

請按照下列各節的說明更新費率方案。

Cloud 控制台中的 Apigee

如要使用 UI 更新費率方案，請按照下列步驟操作：

前往「費率方案」頁面。
在清單中按一下要更新的費率方案名稱。
視需要更新費率方案。
點選下列其中一個選項：
- 點選「儲存並發布」，即可儲存並發布費率方案。系統會提示你選擇啟用日期。詳情請參閱「設定費率方案的啟用日期」。
- 點選「儲存」，即可儲存費率方案草稿。
- 按一下「取消」即可取消更新。

傳統版 Apigee UI

如何使用 UI 更新費率方案：

前往「費率方案」頁面。
在清單中按一下要更新的費率方案名稱。
視需要更新費率方案。
點選以下其中一個選項：
- 點選「儲存並發布」，即可儲存並發布費率方案。系統會提示你選擇啟用日期。詳情請參閱「設定費率方案的啟用日期」。
- 點選「儲存」，即可儲存費率方案草稿。
- 按一下「取消」即可取消更新。

Apigee API

如要使用 API 更新費率方案，請按照下列步驟操作：

查看要更新的費率方案詳細資料。
使用回應建立要求主體，並視需要更新任何其他設定。
注意： 使用 API 更新費率方案時，您在要求中指定的設定會取代所有現有設定。請務必為所有要保留的設定指定值，即使這些設定沒有變更也一樣，否則系統會移除這些設定。
如要更新費率方案，請向下列 API 發出 PUT 要求，並在要求中傳遞修改過的請求主體： https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

舉例來說，以下設定會將以用量為準的費用改為 5，並將收益分潤百分比改為 6.5%；所有其他設定都會納入其中，以確保維持現狀：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"5",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"6.5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

如要進一步瞭解可在要求主體中指定的欄位，請參閱「資源：RatePlans」。

以下提供回應輸出的範例：

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

詳情請參閱 Update rate plan API

複製房價方案

複製費率方案，根據現有費率方案建立複製的費率方案。

Cloud 控制台中的 Apigee

如何使用使用者介面複製費率方案：

前往「費率方案」頁面。
依序選取「」和「Clone」。
更新「費率方案名稱」和「API 產品」欄位。
按一下 [Clone] (複製)。

費率方案會加入費率方案清單。

傳統版 Apigee UI

如何使用 UI 複製費率方案：

前往「費率方案」頁面。
依序選取「」>「複製」。
視需要更新「計價方案名稱」和「API 產品」欄位。
按一下 [Clone] (複製)。

費率方案會加入費率方案清單。

Apigee API

如要使用 API 複製費率方案，請按照下列步驟操作：

查看詳細資料，瞭解要複製的費率方案。
使用回應建立要求內容，並更新下列欄位：
- 移除「name」欄位。
- 視需要更新任何其他設定。
  注意： 使用 API 更新費率方案時，您在要求中指定的設定會取代所有現有設定。請務必為所有要保留的設定指定值，即使這些設定沒有變更也一樣，否則系統會移除這些設定。
在要求中傳遞經修改的請求主體，建立費率方案。

刪除房價方案

費率方案一經刪除即無法復原。費率方案會立即刪除，無法復原。

按照下列各節所述刪除費率方案。

Cloud 控制台中的 Apigee

如要使用使用者介面刪除費率方案，請按照下列步驟操作：

前往「費率方案」頁面。
選取要刪除的費率方案，然後依序選取「」和「刪除」。
確認要刪除的費率方案是否正確，然後按一下「刪除」。

系統會刪除費率方案並從清單中移除。

傳統版 Apigee UI

如要使用使用者介面刪除費率方案，請按照下列步驟操作：

前往「費率方案」頁面。
針對要刪除的費率方案，依序選取「」>「刪除」。
系統提示時，按一下「刪除」即可確認刪除。

系統會刪除費率方案並從清單中移除。

Apigee API

如要刪除費率方案，請向下列 API 發出 DELETE 要求：https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME。

如要判斷要傳入資源路徑的費率方案名稱，請參閱「列出機構中的費率方案」。

例如，以下指令會刪除名稱為 cc6252c0-c5d0-4aaf-85f2-203ec8fa5707 且顯示名稱為 myrateplan3 的費率方案：

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN

以下提供回應輸出的範例：

{
    "name": "93ca14aa-7a48-4384-ae09-c85a0e8a8df8",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

詳情請參閱Delete rate plans API。

管理 API 產品的計價方案 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

查看房價方案

Cloud 控制台中的 Apigee

查看為貴機構定義的費率方案

查看與 API 產品相關聯的費率方案

傳統版 Apigee UI

查看為貴機構定義的費率方案

查看與 API 產品相關聯的費率方案

Apigee API

使用 API 列出 API 產品的費率方案

使用 API 查看費率方案詳細資料

建立費率方案

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

在 UI 中預覽費率方案

設定費率方案的啟用和到期時間

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

發布房價方案

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

將已發布的費率方案設為草稿狀態

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

更新房價方案

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

複製房價方案

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

刪除房價方案

Cloud 控制台中的 Apigee

傳統版 Apigee UI

Apigee API

管理 API 產品的計價方案