設定價目表方案

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

簡介

在費率表方案中，開發人員必須為每筆交易付費。針對這類方案，您需要提供其他詳細資料，例如收費模式和收費模式的價格。

您可以選擇為個別產品 (而非 API 套件) 指定免費增值方案，但只能為特定產品方案執行此操作。

系統何時會向你收取週期性費用和套裝組合方案？

費率方案可包含週期性費用與 API 套裝組合 (磁碟區頻帶和套裝組合方案)，兩者皆包含收費的特定時間，以及套裝組合方案重設為零。下表說明收取週期性費用和重設套裝組合計數的時間。如果開發人員的應用程式已達到特定交易限制，因此無法再發出 API 呼叫，則 API 呼叫計數會重設為零，應用程式才能再次發出呼叫。

如果計畫：	...發生這個情況
非零值的週期性費用設為「月」 大量使用者頻寬或套裝方案	週期性費用和套裝組合方案會在每月第一天重設 (預設值)。 如果是每月在特定日期重複發生的事件，請使用管理 API 建立費率方案，並使用 RecurringStartUnit 屬性指出該日，如「使用 API 建立費率方案」一文所述。
週期性費用設為 Week 且不為零 音量頻帶或套裝組合方案	週期性費用和套裝組合方案會在開發人員的費率方案開始日期後 7 天重設。
已將非零的週期性費用設為「Day」 大量使用者頻寬或套裝方案	定期費用和套裝組合方案會在開發人員的費率方案開始日期 X 天後重設。
沒有 (或收取零美元) 的週期性費用 音量頻帶或套裝組合方案	套裝方案會根據費率表中定義的匯總依據重設。舉例來說，假設開發人員於每個月的 19 日開始費率方案，且匯總依據為每 1 個月，那麼系統會在每月 19 日重設套裝組合。 注意：每個月的日子不一定相同。舉例來說，如果費率方案的開始日期為 12 月 31 日，則 2 月以外的非閏年，因此重設日期會變為 28 日，因為 2 月只有 28 天。之後的 28 天仍將保留至重設日。

使用 UI 設定價目表方案

按照下方說明設定費率表方案。

使用 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 個月，前 1, 000 筆交易的費率為 0.15，則開發人員在當月最多收取 1, 000 筆交易，因此向開發人員收取每筆交易 $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。如果開發人員購買第一個套裝方案的費率表方案，每月可為 1000 筆交易支付 $50 美元 (預付)。無論使用者是否完全使用套裝組合，開發人員都會被收取設定的金額。匯總期間結束後，方案就會到期。如果開發人員想再次使用套裝組合，就必須再次購買方案 (和套裝組合)。

您在費率方案詳細資料中指定的內容，基本上與為量值區間收費模式指定的費率方案詳細資料相同。差異如下：

• 您指定的每個費率方案都適用於套裝組合 (而非銷量區間)。
• 您必須為最後一個套裝組合指定上限，除非您想對開發人員收取無限交易的固定金額。

如需費率方案詳細資料選項的完整清單，請參閱「費率方案詳細資料設定」。

例如，以下會建立使用套裝收費模式的價目表方案。第一個套裝組合 (最多 1,000 筆交易) 的費率會設為 $50 美元，第二個組合 (超過 1,000 筆且最多 2,000 筆交易) 的費率設為 $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