設定價目表方案

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

簡介

在價目表方案中,開發人員的每筆交易都會被收取。您必須為這類方案提供其他詳細資料,例如充電模式和充電模式價格。

或者,您也可以為個別產品 (而非 API 套件) 指定免費增值方案,具體做法僅適用於產品專屬方案。

系統何時會收取週期性費用並重設套裝組合方案?

費率方案可包含週期性費用和 API 套裝組合 (磁碟區頻帶和套裝組合方案),這兩種方案會在特定時間內收費,並將套裝組合方案重設為零。下表說明週期性費用及重設組合數的計費時機。如果開發人員應用程式達到特定交易限制,導致無法進行其他 API 呼叫,這些情況下 API 呼叫的計數就會重設為 0,應用程式將可再次發出呼叫。

如果方案有... ...如有以下情況
  • 非零的週期性費用設為「月」
  • 混合磁碟區或套裝組合方案

週期性費用和套裝組合方案重設會在每月第一天 (預設) 進行。

如要在特定日期定期執行週期性方案,請使用 Management API 建立費率方案,並使用 RecurringStartUnit 屬性標示這一天,如使用 API 建立費率方案一節所述。

  • 非零的週期性費用設為「週」
  • 混合磁碟區或套裝組合方案
在開發人員的費率方案開始日期後,系統每 7 天會重設一次週期性費用和套裝組合方案。
  • 非零的週期性費用已設為「天數」
  • 混合磁碟區或套裝組合方案
週期性費用和套裝組合方案會在開發人員費率方案開始日期後每 X 天重設一次。
  • 無 (或零元) 週期性費用
  • 混合磁碟區或套裝組合方案

系統會根據價目表定義的匯總基礎來重設套裝組合方案。舉例來說,如果開發人員於該月 19 日開始建構費率方案,且匯總基準是每 1 個月一次,則該套裝組合的使用會在每月 19 日重設。

請注意,當月的第幾天不一定是相同日期。舉例來說,如果費率方案的開始日期為 12 月 31 日,則重設日期會成為 2 月非短期的 28 日,因為 2 月只有 28 天。28 日之後,重設一天仍然存在。

透過 UI 設定價目表方案

按照下方說明設定價目表方案。

Edge

如要設定價目表方案,請在建立編輯費率方案時,選取「價目表」或「價目表和收益分潤」費率方案類型,然後在「價目表」部分中選取下列其中一種計費模式:

充電模式 說明
固定費率 開發人員將依固定費率收取每筆交易的費用。
頻帶音量 系統會根據交易量向開發人員收取變動費率。
套裝組合 系統會向開發人員收取每筆交易的預付金額。無論套裝組合是否完整使用,開發人員都必須收取設定金額。

注意:選取「價目表」和「收益分潤」時無法使用這個選項。

然後根據所選充電模式設定下列資訊。

充電模式 欄位 說明
全部 計算頻率 計算交易量 (或自訂屬性相關量) 的時間範圍。選取月數 (1 至 24 個月)。
固定費率 固定費率 每筆交易的費率。輸入十進位數字 (最多小數點後四位數)。

注意:您可以使用 API (而非 UI) 設定可指定的小數位數。詳情請參閱設定費率方案費率的小數位數

舉例來說,假設您輸入 0.10,而貨幣為美元,則開發人員會針對每筆交易支付 $0.10 美元的費用 (或根據自訂屬性 (如交易中傳輸的位元組數),開發人員會針對傳輸的指定位元組數收取 $0.10 美元)。

頻帶音量 音量錶帶 適用於體積錶帶充電模式的一或多個交易範圍 (或客戶屬性型) 數量 (每個範圍都是「體積區間」)。每個音量錶帶都能指定速率。該費率將套用至適用體積區間的所有交易。指定第一個頻帶的上限,例如最多 1000 (下限預設大於 0)。

按一下「+ 新增」新增其他錶帶。

將最後一個頻帶的上限留空,表示此等級以上的所有交易。

注意:您可以使用 API (而非 UI) 設定可指定的小數位數。詳情請參閱設定費率方案費率的小數位數

舉例來說,如果在「音量錶帶」部分 (>0-1000 和 1000 及以上) 指定兩個音量錶帶,則可在 >0-1000 的音量錶帶中輸入 0.15,將 1000 和以上音量錶帶輸入 0.10。如果所選貨幣為美元,前 1,000 筆交易的費率為 $0.15 美元,如果交易金額超過 1,000 筆,則每筆交易的匯率為 $0.10 美元。

套裝組合 API 套裝組合價格 組合中的交易次數 (或是與自訂屬性相關的數字,例如套裝組合中傳輸的位元組總數)。每個套裝組合都可以指定價格。價格會套用到整個套裝組合。指定第一個套裝組合的上限,例如最多 1000 (下限大於 0)。

按一下「+ 新增」即可新增其他組合。你必須為開發人員的最後一個套裝組合指定上限,除非你想向開發人員收取最後一個套裝組合中 (無限制交易) 的固定金額。

注意:您可以使用 API (而非 UI) 設定可指定的小數位數。詳情請參閱設定費率方案費率的小數位數

舉例來說,如果您在「 Bundle Size」部分中指定兩個套裝組合 (介於 0 至 1000 之間,大於 1000 到 2000 之間),可以輸入 50 代表大於 0 的組合 (最多 1000 組),並在 1000 到 2000 之間輸入 40。如果所選貨幣為美元,第一個組合的價格為 $50 美元,第二個組合的價格為 $40 美元。無論套裝組合中的交易次數為何,開發人員都必須支付適用的套裝組合價格 (也就是說,開發人員在套裝組合中的第一筆交易完成後,系統會立即向開發人員收取套裝組合價格)。

如果您為 API 產品定義了自訂屬性,可以設定自訂評分參數,讓應用程式開發人員根據每筆交易中的自訂屬性收費。舉例來說,如果您設定的方案會針對每筆交易向開發人員收費,您可以根據自訂屬性設定方案費率,例如後端傳輸的位元組數 (可能因交易而異)。

在此情況下,請選取「使用自訂評分參數」,然後從下拉式清單中選取自訂屬性。詳情請參閱使用自訂屬性設定費率方案

傳統邊緣 (Private Cloud)

如何使用傳統版 Edge UI 設定價目表方案:

  1. 請按照這些步驟建立費率方案。
  2. 在「費率方案類型」下拉式選單中,選取「價目表」設定收益模式
  3. 如果選取的 API 套件包含多個 API 產品,請選取下列其中一個選項:

    注意:如果 API 套件包含單一 API 產品,您可以略過這個步驟。

    • 產品專屬方案:分別設定各項 API 產品的費率方案詳細資料。
    • 所有產品的一般方案:設定所有 API 產品的費率方案詳細資料。
  4. 按一下一般費率方案或每個 API 產品專屬費率方案的「價目表」

    注意事項:設定 API 產品專屬方案時,您必須為每個 API 產品個別設定價目表方案。

    「價目表」視窗會隨即開啟。

  5. 為 API 產品設定免費增值方案。免費增值方案可讓開發人員在一段時間或依據用量內免費使用 API 產品。

    輸入下列資訊:

    欄位 說明
    是免費增值產品?

    免費期間的範圍。選取下列其中一個圓形按鈕:

    • 依數量。免費期間是根據「磁碟區」欄位中指定的數量而定。
    • 依據時間長度。費用期間以「Freemium Duration」欄位中指定的時間間隔為準。
    • 先從何者開始。只要「磁碟區」欄位中的數量或達到 Freemium Duration 欄位的時間間隔 (兩者取其先),就會結束免費週期。
    • 不可以,這不是免費增值方案。此為預設值。
    免費增值量

    開發人員無須支付費用的交易量 (或涉及交易記錄政策中的自訂屬性數量)。系統會測量 API 產品的數量。輸入音量,例如 5000。也就是說,當開發人員開始製定方案時,系統不會針對前 5000 筆交易 (或前 5, 000 次使用自訂屬性相關項目使用) 收費。只有在「免費增值產品」欄位中選取「依數量」或「先發生者」,才能啟用這個欄位。

    免費增值時間

    開發人員不收費的時間間隔。輸入數字並選取時間範圍,例如 1 個月。也就是說,開發人員無須支付 1 個月的費用。您必須在「免費增值產品」欄位中選取「依時間長度」或「先發生者」,才能啟用這個欄位。

  6. 選擇下列其中一種充電模式:
    • 固定費率。在這個模式中,開發人員會針對每筆交易收取固定費率。
    • 團結音量。在這個模式中,開發人員必須根據交易量收取變動的費率。
    • 套裝組合。在這個模式中,開發人員會為每個交易組合收取固定金額 (預付費用)。無論套裝組合是否完全使用,開發人員都會收取設定金額。

    固定費率模式:在「一般價目表」視窗的「定價」部分輸入下列資訊:

    欄位 說明
    業者 (或機構)

    貴機構的名稱。系統會使用機構設定檔中的「運算子」(或機構) 欄位值來預設這個欄位。

    國家/地區

    貴機構的營運國家/地區。系統會使用機構資料中的「國家/地區」欄位值來預設這個欄位。

    固定費率

    每筆交易的費率。輸入十進位數字 (最多小數點後四位數)。

    注意:您可以設定可使用 API (而非 UI) 收取費率指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。

    舉例來說,假設您輸入 0.10,而貨幣為美元,則開發人員會針對每筆交易收取 $0.10 美元的費用 (或根據自訂屬性 (如交易中傳輸的位元組數),開發人員會針對傳輸的指定位元組數收取 $0.10 美元)。

    對於磁碟區搭配模型:「Generic Rate Card」視窗會顯示其他欄位,您可以使用這些欄位來指定匯總的基準,並指定「體積區間」,即可套用不同費率的交易量範圍。

    這類方案通常是為了鼓勵開發人員為更高頻段提供折扣費率,藉此增加磁碟區。

    在「一般價目表」視窗中輸入下列資訊:

    欄位 說明
    匯總基礎

    匯總交易量 (或自訂屬性相關量) 的時間範圍。使用匯總磁碟區來識別體積區間和適用於每筆交易的費率。選取月數 (1 至 12 個月)。

    如要進一步瞭解套裝組合的重設時間,請參閱「系統何時會收取週期性費用並重設套裝組合方案?」一節。

    音量頻帶

    一或多個交易範圍 (或以客戶屬性為準) 磁碟區 (每個範圍都是「體積區間」)。你可為各個音量頻帶指定費率 (可在「定價」部分的「音量頻帶」欄位中設定費率)。該費率會套用至適用磁碟區頻段中的所有交易。指定第一個頻帶的上限,例如最多 1000 (下限預設大於 0)。按一下 + 即可新增第二個錶帶,例如大於 1000 到 2000。按一下 + 即可新增更多錶帶。您可以將最終頻帶的最大值留空,表示所有高於該等級的交易。

    定價方式
    業者 (或機構)

    貴機構的名稱。系統會使用機構資料中的「運算子」(或機構) 欄位值來預設這個欄位。

    國家/地區

    貴機構的營運國家/地區。這個欄位使用機構個人資料中「國家/地區」欄位值來預設。

    幣別

    貴機構使用的「基準」或會計貨幣。這個欄位預設使用機構設定檔中的「貨幣」欄位值,但您可以在此變更。

    音量錶帶

    音量錶帶的速率。為每個音量錶帶指定速率。請為每個頻帶輸入十進位數字 (最多小數點後四位)。

    注意:您可以使用 API (而非 UI) 設定可以為音量頻帶速率指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。

    舉例來說,如果在「音量錶帶」部分 (>0-1000 和 1000 以上) 指定兩個音量錶帶,則可在 >0-1000 的音量錶帶中輸入 0.15,將 1000 以上音量錶帶輸入 0.10。如果所選貨幣為美元,前 1,000 筆交易的費率為 $0.15 美元,超過 1,000 筆交易,則每筆交易的費率為 $0.10 美元。

    套裝組合模型:「一般費率卡」視窗會顯示其他欄位,可用於指定匯總基準 (開發人員可使用交易組合的時間範圍),以及指定套裝組合相關資訊,例如組合大小。

    在「一般價目表」視窗中輸入下列資訊:

    欄位 說明
    匯總基礎

    開發人員可使用交易套裝組合 (或使用以屬性為基礎的自訂套裝組合) 的時間範圍。選取月數 (1 至 12 個月)。試用期過後,方案就會過期,而且開發人員必須重新購買方案和套裝組合。

    如要進一步瞭解套裝組合的重設時間,請參閱「系統何時會收取週期性費用並重設套裝組合方案?」一節。

    套裝組合大小

    套裝組合中的交易數 (或與自訂屬性相關的數字,例如組合中傳輸的位元組總數)。你可以為每個套裝組合指定價格 (您可以在「定價」部分的「套裝組合大小」欄位中設定這個價格)。價格會套用至整個套裝組合。指定第一個套裝組合的上限,例如最多 1000 (下限大於 0)。按一下「+」即可新增第二個套裝組合,例如大於 1000 至 2000。按一下「+」即可新增更多套裝組合。除非您想向開發人員收取最後一個套裝組合中無限制交易的固定金額,否則您必須指定最後一個套裝組合的上限。

    定價方式
    業者 (或機構)

    貴機構的名稱。系統會使用機構資料中的「運算子」(或機構) 欄位值來預設這個欄位。

    國家/地區

    貴機構的營運國家/地區。這個欄位使用機構個人資料中「國家/地區」欄位值來預設。

    幣別

    貴機構使用的「基準」或會計貨幣。這個欄位預設使用機構設定檔中的「貨幣」欄位值,但您可以在此變更。

    套組大小 (價格)

    套裝組合價格。並指定每個套裝組合的價格。請輸入十進位數字 (最多小數點後四位數)。

    注意:您可以使用 API (而非 UI) 設定可以為套裝組合費率指定的小數位數。詳情請參閱「設定費率方案費率的小數位數」。

    舉例來說,如果您在「Bundle Size」區段中指定兩個套裝組合 (介於 0 至 1000 之間,大於 1000 至 2000 之間),可以將大於 0 的組合輸入 50,最多 1000 個組合 (最多 2000 個)。如果所選貨幣為美元,第一個組合的價格為 $50 美元,第二個套裝組合的價格為 $40 美元。無論套裝組合中的交易次數為何,開發人員都必須支付適用的套裝組合價格 (也就是說,開發人員在套裝組合中的第一筆交易完成後,系統會立即向開發人員收取套裝組合價格)。

  7. 按一下「Apply and Close」儲存價目表詳細資料,然後返回標準費率方案視窗。
  8. 如果是 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,開發人員在當月針對最多 1,000 筆交易支付 $0.15 美元。

    如要進一步瞭解組合重設時間,請參閱「何時須支付週期性費用並重設套裝組合方案?」一文。

    如果您沒有為最終音量頻帶指定結束單位,則在交易次數超過該頻帶的起始單位後,該錶帶的費率將套用至所有交易。舉例來說,如果最後一個頻帶的起始單位為 1000,且您未指定該頻帶的結束單位,則在匯總期間進行 1000 筆交易後,該錶帶的費率就會套用至所有交易。

如需費率方案詳細資料選項的完整清單,請參閱費率方案詳細資料配置設定

舉例來說,以下程式碼會建立價目表方案,搭配體積錶帶充電模式。前 1000 筆交易的費率設為 $0.15 美元,1, 000 筆交易的費率則為 $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 筆交易的費用。無論套裝組合是否完全使用,開發人員都必須向開發人員收取設定金額。 匯總期間結束後,方案就會過期。如果開發人員想再次使用套裝組合,必須重新購買方案和套裝組合。

您在費率方案詳細資料中指定的內容,基本上與您在體積頻帶充電模式的費率方案詳細資料中所指定的內容相同。兩者的差異如下:

  • 您指定的每個費率方案都適用於套裝組合 (而非音量錶帶)。
  • 除非您想向開發人員收取最後一個套裝組合中 (無限制交易) 的固定金額,否則請務必指定最後一個套裝組合的上限。

如需費率方案詳細資料選項的完整清單,請參閱費率方案詳細資料配置設定

舉例來說,下列指令會建立隨附充電模式的價目表方案。第一個組合的費率為 $50 美元 (最多 1,000 筆交易),第二個組合的費率為 $40 美元 (超過 1000 筆交易,最多 2000 筆交易)。匯總基準為 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 產品相關的交易次數,或是交易記錄政策中記錄的自訂屬性相關量。

如果免費增值期是以數量為準,請指定為免費增值單位的數量。舉例來說,下列程式碼會建立以 5, 000 個單位數量為基礎的免費增值方案 (會醒目顯示免費增值方案相關規格)。

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