您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
簡介
在費率表方案中,開發人員須為每筆交易付費。這類方案需要提供額外詳細資料,例如充電模式和充電模式的價格。
你也可以選擇為個別產品 (而非 API 套件) 指定免費增值方案,但只能為產品專屬方案指定。
系統何時會收取定期費用,以及重設套裝組合方案?
費率方案可包含週期性費用和 API 套裝組合 (量級和套裝組合方案),兩者都涉及特定時間,屆時會收取費用,且套裝組合方案會重設為零。下表說明系統何時會收取週期性費用,以及何時會重設套裝組合數量。如果開發人員應用程式達到特定交易限制,而無法再發出 API 呼叫,系統會在這些時間將 API 呼叫計數重設為零,應用程式就能再次發出呼叫。
| 如果方案有... | ...this happens |
|---|---|
|
週期性費用和套裝方案會在每月 1 號重設 (預設)。 如要設定在特定日期每月重複收費,請使用管理 API 建立費率方案,並以 |
|
週期性費用和套裝組合方案會在開發人員的費率方案開始日期後,每 7 天重設一次。 |
|
週期性費用和套裝組合方案會在開發人員的費率方案開始日期後,每 X 天重設。 |
|
系統會根據費率表上定義的匯總依據,重設組合方案。舉例來說,如果開發人員在當月 19 日開始使用費率方案,且「匯總依據」為每 1 個月,則系統會在每個月的 19 日重設套裝組合用量。 請注意,每月結算日可能不盡相同。舉例來說,如果費率方案的開始日期是 12 月 31 日,由於 2 月只有 28 天,因此在平年 2 月,重設日期會變成 28 日。之後的重設日就會固定在 28 號。 |
使用 UI 設定價目表方案
設定費率表方案,詳情請見下文。
邊緣
如要設定價目表方案,請在建立或編輯價目表方案時,選取「價目表」或「價目表和收益分享」價目表方案類型,然後在「價目表」部分選取下列任一收費模式:
| 充電模式 | 說明 |
| 固定費率 | 系統會針對每筆交易向開發人員收取固定費率。 |
| Volume Banded | 開發人員的費率會因交易量而異。 |
| 套裝組合 | 系統會預先向開發人員收取每筆交易組合的固定金額。無論開發人員是否用完所有額度,都必須支付設定的金額。
注意:選取費率表和收益分享時,無法使用這個選項。 |
接著,根據所選的充電模式設定下列資訊。
| 收費模式 | 欄位 | 說明 |
| 全部 | 計算頻率 | 計算交易量 (或自訂屬性相關量) 的時間範圍。選取月數 (1 到 24 個月)。 |
| 固定費率 | 固定費率 | 每筆交易的收費率。輸入小數 (最多可到小數點後四位)。
注意:您可以使用 API (而非 UI) 設定費率可指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。 舉例來說,如果輸入 0.10,且幣別為美元,則開發人員每筆交易需支付 $0.10 美元 (或如果根據自訂屬性 (例如交易中傳輸的位元組數) 計費,則開發人員每傳輸指定位元組數需支付 $0.10 美元)。 |
| Volume Banded | 音量頻段 | 交易量 (或以顧客屬性為準) 的一或多個範圍 (每個範圍都是「量帶」),適用於量帶式收費模式。每個量帶都可以指派費率。適用費率會套用至適用量級範圍內的所有交易。指定第一個頻帶的上限,例如最多 1000 (下限預設為大於 0)。
按一下「+ 新增」即可新增其他樂團。 將最終範圍的上限留空,表示所有高於這個等級的交易。 注意:您可以使用 API (而非 UI) 設定費率可指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。 舉例來說,如果您在「音量範圍」部分指定兩個音量範圍 (0 到 1000 以上),則 0 到 1000 的音量範圍可輸入 0.15,1000 以上的音量範圍可輸入 0.10。如果選取的幣別是美元,前 1,000 筆交易的費率為每筆 $0.15 美元,超過 1,000 筆交易的費率則為每筆 $0.10 美元。 |
| 套裝組合 | API 套裝組合價格 | 套件中的交易數 (或與自訂屬性相關的數字,例如套件中傳輸的位元組總數)。每個套裝組合都可以指派價格。價格適用於整個套裝組合。指定第一個組合的上限,例如最多 1000 個 (下限預設為大於 0)。
按一下「+ 新增」即可新增其他組合。除非您想對最後一組的無限次交易向開發人員收取固定金額,否則必須為最後一組指定上限。 注意:您可以使用 API (而非 UI) 設定費率可指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。 舉例來說,如果您在「組合大小」部分指定兩個組合 (大於 0 到 1000,以及大於 1000 到 2000),則大於 0 到 1000 的組合可輸入 50,大於 1000 到 2000 的組合可輸入 40。如果選取的貨幣是美元,第一個套裝組合的價格為 $50 美元,第二個套裝組合的價格為 $40 美元。無論開發人員在套裝組合內使用多少筆交易,都須支付適用的套裝組合價格 (也就是說,只要套裝組合內的第一筆交易完成,開發人員就須支付套裝組合價格)。 |
如果您為 API 產品定義了自訂屬性,可以設定自訂評分參數,根據每筆交易中的自訂屬性向應用程式開發人員收費。舉例來說,如果您設定的方案是針對每筆交易向開發人員收費,可以根據自訂屬性 (例如後端傳輸的位元組數,每筆交易可能不同) 設定方案費率。
在本例中,請選取「使用自訂評分參數」,然後從下拉式清單中選取自訂屬性。詳情請參閱「設定含自訂屬性的費率方案」。
Classic Edge (Private Cloud)
如要使用傳統 Edge UI 設定價目表方案,請按照下列步驟操作:
- 按照步驟建立費率方案。
- 在「費率方案類型」下拉式選單中選取「費率表」,即可設定收益模式。
- 如果所選 API 套件包含多個 API 產品,請選取下列其中一個選項:
注意:如果 API 套件只包含單一 API 產品,可以略過這個步驟。
- 特定產品方案:個別設定每項 API 產品的費率方案詳細資料。
- 所有產品的通用方案:設定所有 API 產品的費率方案詳細資料。
- 按一下一般費率方案或各個 API 產品專屬費率方案的「費率表」。
注意:設定 API 產品專屬方案時,您必須為每個 API 產品個別設定費率表方案。

「費率表」視窗隨即開啟。

- 為 API 產品設定免費加值方案。免費加值方案可讓開發人員在一段時間內或根據用量,免費使用 API 產品。
輸入下列資訊:
欄位 說明 免費增值產品? 免費使用期長度。選取下列其中一個圓形按鈕:
- 依數量。免費期會根據「數量」欄位中指定的數量計算。
- 依時間長度。費用週期是根據「Freemium Duration」(免費增值期限) 欄位中指定的時間間隔計算。
- 以先到期者為準。達到「數量」欄位中的數量或「免費期長度」欄位中的時間間隔時 (以先發生者為準),免費期就會結束。
- 否,這不是免費增值方案。此為預設值。
免費增值方案 開發人員免付費的交易量 (或交易記錄政策中記錄的自訂屬性相關交易量)。系統會針對 API 產品測量用量。輸入音量值,例如 5000。也就是說,開發人員開始使用方案時,前 5,000 筆交易 (或前 5,000 次使用自訂屬性相關項目) 不會產生費用。只有在「Freemium Product?」(免費增值產品?) 欄位中選取「By Quantity」(依數量) 或「Whichever comes first」(先到先得) 時,這個欄位才會啟用。
免費增值時間長度 開發人員免付費的時間間隔。輸入數字並選取時間範圍,例如 1 個月。也就是說,開發人員可免付 1 個月的費用。只有在「freemium 產品?」欄位中選取「依時間長度」或「以先到者為準」時,這個欄位才會啟用。
- 選取下列其中一種收費模式:
- 固定費率。採用這種模式時,開發人員須為每筆交易支付固定費率。
- 音量分級。在這個模式中,開發人員需支付的費率會因交易量而異。
- 套裝組合。在這個模式中,開發人員須為每筆交易組合支付固定金額 (預付)。無論是否完全使用套裝組合,開發人員都必須支付設定的金額。
固定費率模式:在「一般費率表」視窗的「定價」部分中,輸入下列資訊:
欄位 說明 營運商 (或機構) 貴機構的名稱。這個欄位會使用機構設定檔中的「營運商」(或「機構」) 欄位值預先設定。
國家/地區 貴機構的營運國家/地區。這個欄位會使用機構付款資料中的「國家/地區」欄位值預先填入。
固定費率 每筆交易的收費率。輸入小數 (最多四位小數)。
注意:您可以使用 API (而非使用者介面),設定費率可指定的小數位數。詳情請參閱設定費率方案費率的小數位數。
舉例來說,如果輸入 0.10,且幣別為美元,則系統會針對每筆交易向開發人員收取 $0.10 美元 (或如果根據自訂屬性 (例如交易中傳輸的位元組數) 收費,則系統會針對傳輸指定位元組數向開發人員收取 $0.10 美元)。
量級分級模式:「一般費率表」視窗會顯示額外欄位,供您指定匯總依據和「量級分級」,也就是可套用不同費率的交易量範圍。
這類方案通常會為較高的數量級提供折扣費率,鼓勵開發人員產生更多數量。

在「一般費率表」視窗中輸入下列資訊:
欄位 說明 匯總依據 匯總交易量 (或自訂屬性相關量) 的時間範圍。系統會根據匯總量判斷交易量級距,並套用適當的費率。選取月數 (1 到 12 個月)。
如要瞭解系統何時會重設套餐,請參閱「系統何時會收取週期性費用並重設套餐方案?」一文。
音量帶 一或多個交易量 (或以顧客屬性為準) 範圍 (每個範圍都是「交易量帶」)。每個量帶都可以指派費率 (您可以在「價格」部分的「量帶」欄位中設定費率)。這個費率會套用至適用量級範圍內的所有交易。指定第一個頻帶的上限,例如最多 1000 (下限預設為大於 0)。按一下「+」 即可新增第二個範圍,例如大於 1000 但小於等於 2000。按一下「+」即可新增更多頻段。您可以將最終級距的上限留空,表示所有高於這個層級的交易。

定價 營運商 (或機構) 貴機構的名稱。這個欄位會使用機構單位設定檔中的「營運商」(或「機構」) 欄位值預先設定。
國家/地區 貴機構的營運國家/地區。這個欄位會預先填入機構設定檔中的「國家/地區」欄位值。
幣別 貴機構使用的「基本」或會計貨幣。這個欄位會預先填入機構設定檔中的「幣別」欄位值,但您可以在這裡變更。
音量帶 用量級距的費率。你為每個量帶指定費率。為每個頻帶輸入十進位數字 (最多可到小數點後四位)。
注意:您可以使用 API (而非 UI) 設定可為量帶費率指定的十進位位數。詳情請參閱設定費率方案費率的小數位數。
舉例來說,如果您在「音量範圍」部分指定兩個音量範圍 (0 到 1000 以上),則可以為 0 到 1000 的音量範圍輸入 0.15,為 1000 以上的音量範圍輸入 0.10。如果選取的幣別是美元,前 1000 筆交易的費率為每筆 $0.15 美元,超過 1000 筆交易的費率則為每筆 $0.10 美元。

套裝組合模型:「一般費率表」視窗會顯示額外欄位,您可指定匯總依據 (開發人員可使用交易套裝組合的時間範圍),並指定套裝組合相關資訊,例如套裝組合大小。

在「一般費率表」視窗中輸入下列資訊:
欄位 說明 匯總依據 開發人員可使用交易組合 (或使用以自訂屬性為準的組合) 的時間範圍。選取月數 (1 到 12 個月)。這段期間過後,方案就會過期,開發人員必須再次購買方案 (和套裝組合)。
如要瞭解系統何時會重設套餐,請參閱「系統何時會收取週期性費用並重設套餐方案?」一文。
套裝組合大小 套裝組合中的交易數 (或與自訂屬性相關的數字,例如套裝組合中傳輸的位元組總數)。每個組合都可以指派價格 (您可以在「價格」部分的「組合大小」欄位中設定價格)。價格適用於整個套裝組合。指定第一個組合的上限,例如最多 1000 個 (下限預設為大於 0)。按一下「+」新增第二個組合,例如大於 1000 但小於或等於 2000。按一下「+」即可新增更多套裝組合。您必須為最後一個套裝組合指定上限,除非您想針對最後一個套裝組合中的無限次交易,向開發人員收取固定金額。

定價 營運商 (或機構) 貴機構的名稱。這個欄位會使用機構單位設定檔中的「營運商」(或「機構」) 欄位值預先設定。
國家/地區 貴機構的營運國家/地區。這個欄位會預先填入機構設定檔中的「國家/地區」欄位值。
幣別 貴機構使用的「基本」或會計貨幣。這個欄位會預先填入機構設定檔中的「幣別」欄位值,但您可以在這裡變更。
套裝組合大小 (價格) 組合包的價格。並為每個套裝組合指定價格。輸入小數 (最多可到小數點後四位)。
注意:您可以使用 API (而非使用者介面),設定可為套裝組合費率指定的十進位位數。詳情請參閱設定費率方案費率的小數位數。
舉例來說,如果您在「組合大小」部分指定兩個組合 (大於 0 到 1000,以及大於 1000 到 2000),則大於 0 到 1000 的組合可輸入 50,大於 1000 到 2000 的組合可輸入 40。舉例來說,如果選取的貨幣是美元,第一個套裝組合的價格為 $50 美元,第二個套裝組合的價格則為 $40 美元。無論開發人員在套裝組合內使用多少交易,都須支付適用的套裝組合價格 (也就是說,只要完成套裝組合內的第一筆交易,開發人員就須支付套裝組合價格)。

- 按一下「套用並關閉」,儲存費率表詳細資料並返回「標準費率方案」視窗。
- 如要為特定 API 產品制定費率方案,請視需要為其他 API 產品設定費率方案詳細資料。
使用 API 設定費率表方案
如要使用 API 設定費率表方案詳細資料,請參閱下列章節。
使用 API 指定費率表方案詳細資料
建立費率方案時,您需指定費率表方案詳細資料。在呼叫 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 時,您可以在要求主體內的 ratePlanDetails 屬性中指定詳細資料。您在 ratePlanDetails 屬性中指定的內容,取決於您選擇的收費模式:固定費率、量級或套裝組合。
指定固定費率計費模式
如要實作固定費率計費模式,請在費率方案詳細資料中指定下列項目:
- 費率參數,指出費率方案是以交易 (
VOLUME) 或自訂屬性 (例如MINT_CUSTOM_ATTRIBUTE_1) 為依據。預設值為VOLUME。 - 計量類型 (
UNIT),表示費率是依單位固定計算 (也就是說,費率並非根據交易量計算,如交易量分級或套裝組合計費模式)。 - 付款期限 (例如 30 天)。
- 貴機構的 ID。
- 公司使用的「基本」或會計貨幣。
- 房價方案費率,提供費率計算方式的詳細資料。由於計費模式採用固定費率,因此您只需要指定一個房價方案費率。
在房價方案費率中,您可以指定:
- 房價方案費率的類型 (
RATECARD)。 - 方案費率。舉例來說,如果您指定 0.10,且幣別為美元,則系統會針對每筆交易向開發人員收取 $0.10 美元 (或根據自訂屬性,例如交易中傳輸的位元組數,向開發人員收取 $0.10 美元,以傳輸指定位元組數)。
- 費率適用的起始單位 (
0)。這表示費率會套用至每筆交易,從第一筆交易開始。
如需費率方案詳細資料選項的完整清單,請參閱費率方案詳細資料設定。
舉例來說,下列程式碼會建立採用固定計費模式的費率方案。每筆交易的費率為 $0.10 美元。付款期限為 30 天。(價目表相關詳細資料會以醒目方式顯示)。
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan",
"displayName" : "Flat rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
指定量帶式充電模式
在量級費率模型中,您會指定費率方案詳細資料,包括一或多個費率方案費率,每個費率適用於「量級」,也就是交易量範圍 (或根據自訂屬性 (例如傳輸的位元組數) 的範圍)。這類方案通常會為較高的數量級提供折扣費率,鼓勵開發人員產生較高的數量。
除了費率方案費率外,您還可以在費率方案詳細資料中指定下列項目:
- 費率參數,指出費率方案是以交易 (
VOLUME) 或自訂屬性 (例如CUSTOM_ATTRIBUTE_1) 為依據。預設值為VOLUME。 - 計量類型 (
VOLUME),表示費率是根據交易量計算 (也就是說,並非採用固定費率計費模式,每筆交易的費率都相同)。 - 付款期限 (例如 30 天)。
- 貴機構的 ID。
- 公司使用的「基本」或會計貨幣。
- 時間長度和時間長度類型,共同指定交易量 (或自訂屬性相關量) 的匯總時間範圍。這也稱為「匯總依據」。系統會根據匯總基準 (例如 1 個月) 匯總交易量,判斷適用的交易量級距。
- 用來判斷適用音量範圍的匯總計數器。
針對每個費率方案費率,您要指定:
- 房價方案費率的類型 (
RATECARD)。 - 方案費率。舉例來說,如果您指定 0.10,且幣別為美元,則開發人員每筆交易需支付 $0.15 美元 (或如果根據自訂屬性 (例如交易中傳輸的位元組數) 計費,則開發人員每傳輸指定位元組數需支付 $0.15 美元)。
- 音量範圍的起始和結束單位。開始單位會指定音量範圍的下限,結束單位則會指定音量範圍的上限。舉例來說,如果您指定起始單位為 0,結束單位為 1000,則交易量範圍涵蓋匯總期間內最多 1000 筆交易。如果幣別為美元,匯總期間為 1 個月,且前 1000 筆交易的費率為 0.15,則開發人員在該月最多 1000 筆交易的費用為每筆 $0.15 美元。
如要瞭解套餐何時會重設,請參閱「系統何時會收取週期性費用並重設套餐方案?」一文。
如果沒有為最終交易量級距指定結尾單位,系統會將該級距的費率套用至所有交易,前提是交易數量已超過該級距的起始單位。舉例來說,如果最後一個區間的起始單位是 1000,且您未指定該區間的結束單位,則在彙整期間內,交易次數超過 1000 後,所有交易都會套用該區間的費率。
如需費率方案詳細資料選項的完整清單,請參閱費率方案詳細資料設定。
舉例來說,下列指令會建立費率方案,並採用量級計費模式。前 1000 筆交易的費率為 $0.15 美元,超過 1000 筆的交易則為 $0.10 美元。匯總依據為 1 個月。付款期限為 30 天。(價目表詳細資料會醒目顯示)。
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Volume banded rate card plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Volume banded rate card plan",
"displayName" : "Volume banded rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.15",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "1000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
指定套裝組合充電模式
在套裝計費模式中,開發人員會預先支付「套裝」交易的費用 (或根據自訂屬性 (例如傳輸的位元組數) 支付套裝費用)。您要為每個套裝組合指定費率和匯總基準,也就是開發人員可使用套裝組合的時間長度。
舉例來說,假設您設定了兩個套裝組合,第一個套裝組合的大小為 1 到 1000 筆交易,第二個套裝組合的大小為 1001 到 2000 筆交易。第一個組合的費率為 $50 美元,第二個組合的費率為 $40 美元,而匯總依據為 1。如果開發人員為第一個套裝組合購買費率表方案,他們須先支付 $50 美元,才能在一個月內進行 1000 筆交易。無論是否完全使用套裝組合,開發人員都必須支付設定的金額。 彙整期結束後,方案就會到期。如果開發人員想再次使用套裝組合,必須重新購買方案 (和套裝組合)。
您在房價方案詳細資料中指定的內容,基本上與在量級收費模式的房價方案詳細資料中指定的內容相同。兩者差異如下:
- 您指定的每個費率方案都是針對套裝組合 (而非量帶)。
- 您必須為最後一個套裝組合指定上限,除非您想針對最後一個套裝組合的無限次交易向開發人員收取固定金額。
如需費率方案詳細資料選項的完整清單,請參閱費率方案詳細資料設定。
舉例來說,下列指令會建立採用套裝計費模式的費率方案。第一個套裝組合 (最多 1000 筆交易) 的費率為 $50 美元,第二個套裝組合 (超過 1000 筆交易,最多 2000 筆交易) 的費率為 $40 美元。匯總依據為 1 個月。付款期限為 30 天。
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Bundled rate plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Bundled rate plan",
"displayName" : "Bundled rate plan",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "true",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "STAIR_STEP",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "50",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "40",
"startUnit": "1000",
"endUnit": "2000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
使用 API 為個別產品指定免費增值方案
在費率表方案中,您可以為個別產品 (而非 API 套件) 設定免費增值方案。免費加值方案可讓開發人員在一段時間內或根據用量,免費使用 API 產品。
為 API 產品設定買免方案時,您可以在費率表方案詳細資料中,指定開發人員可免費使用 API 產品所提供資源的期間。期間可依下列其中一項設定:
- 時間長度,也就是生效日期和結束日期之間的時間。
- 數量,例如涉及 API 產品的交易數量,或交易記錄政策中記錄的自訂屬性相關量。
如果免費試用期是以數量為準,請指定免費試用單位的數量。舉例來說,下列程式碼會建立費率表方案,並根據 5000 個單位的數量提供免費增值方案 (免費增值相關規格會醒目顯示)。
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan with freemium period",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan with freemium period",
"displayName" : "Flat rate card plan with freemium period",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "myorg"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "false",
"ratePlanDetails": [
{
"currency": {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"id" : "usd"
},
"product" : {
"id" : "location",
"displayName":"Location"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "myorg"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"freemiumUnit": "5000",
"freemiumDuration": "0",
"freemiumDurationType": "DAY",
"ratingParameterUnit":"MB",
"customPaymentTerm": "false",
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password