管理房價方案

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

如要使用 UI 和 API 管理費率方案，請參閱下列各節。

瀏覽費率方案頁面

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

邊緣

如要在 Edge UI 中查看費率方案，請前往「費率方案」頁面：

  1. 登入 apigee.com/edge。
  2. 在左側導覽列中，依序選取「發布」>「營利」>「費率方案」。

系統隨即會顯示「費率方案」頁面。

如圖所示，「費率方案」頁面可讓您：

Classic Edge (Private Cloud)

如要使用 Classic Edge UI 查看費率方案，請前往「API Packages」頁面：

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端導覽列中，依序選取「發布」>「套件」。

「API 套裝組合」頁面會顯示為每個套裝組合定義的費率方案。

您可以在「費率方案」頁面執行下列操作：

建立費率方案

如要建立費率方案，請按照下列步驟操作：

  1. 存取「費率方案」頁面。
  2. 按一下「+ 費率方案」。
  3. 在頂端面板中設定下列欄位：
    欄位 說明 預設 必填
    房價方案名稱 房價方案名稱。

    NOTE：名稱在 API 產品套裝組合中不得重複。同一產品組合中的兩個方案不得使用相同名稱。

    		N/A 是
    房價方案類型 房價方案類型。從下拉式清單中選取值。如需有效費率方案類型清單，請參閱「支援的費率方案類型」。 N/A 是
    產品組合 API 產品組合。從下拉式清單中選取值。如要進一步瞭解 API 產品套裝組合，請參閱「管理 API 產品套裝組合」。

    如果選取的產品組合包含多個 API 產品，您必須選擇為每個 API 產品設定個別費率方案，還是設定適用於所有 API 產品的通用費率方案。

    		N/A 是
    目標對象 可存取費率方案的目標對象。從下拉式清單中選取下列其中一個值：
    • 所有人 - 所有開發人員。
    • 開發人員 - 開發人員或公司。輸入開發人員名稱或公司名稱。輸入時，下拉式選單會顯示包含該字串的開發人員/公司清單。從下拉式清單中點選開發人員或公司的名稱。
    • 開發人員類別 - 開發人員類別。從下拉式清單中選取開發人員類別。

      視需要設定開發人員類別，詳情請參閱「管理開發人員類別」。

    		 所有人 否
    開始日期 費率方案生效日期。輸入開始日期，或使用日曆選取日期。 今天 否
    結束日期 費率方案的結束日期。如要指定結束日期，請啟用「Has End Date」(有結束日期) 切換開關，然後輸入結束日期，或使用日曆選取日期。

    注意：費率方案將在指定日期的當天結束前生效。舉例來說，如要讓費率方案在 2018 年 12 月 1 日到期，endDate 值應設為 2018-11-30。在此情況下，費率方案將於 2018 年 11 月 30 日當天結束，2018 年 12 月 1 日的所有要求都會遭到封鎖。

    		無 否
    入口網站可見 設定房價方案為公開或不公開。請參閱「公開與不公開費率方案」。 已啟用 否
  4. 為費率方案設定費用。請參閱「為費率方案設定費用」。
    NOTE：不適用於可調整的通知方案。
  5. 如果選取的產品組合包含多個 API 產品，請在「特定或一般費率方案」部分設定下列偏好設定：
    注意：這個步驟不適用於可調整的通知方案。
    欄位 說明 預設
    個別設定每項產品 這個旗標會指定是否要為每個 API 產品設定個別費率方案。 已停用
    個別設定每項產品的買一送一優惠 這個標記會指定是否要為每個 API 產品設定免費增值方案。 已停用
    選取產品 如果啟用一或多個標記，請從下拉式選單中個別選取每個產品，並設定費率方案詳細資料。

    NOTE：請務必設定產品組合中的所有產品。

    		N/A
  6. 根據所選房價方案類型，設定房價方案詳細資料：
  7. 點選下列其中一個選項：
    按鈕 說明
    儲存為草稿 將費率方案儲存為草稿。

    費率方案發布後，應用程式開發人員才會看到。您可以編輯費率方案草稿中的任何欄位。

    發布新計畫 發布計畫。

    NOTE：發布費率方案後，如果尚未設定結束日期，您只能修改結束日期。費率方案發布後就無法刪除，但可以讓費率方案過期，並以未來的費率方案取代，詳情請參閱「讓已發布的費率方案過期」。

  8. 將「營利限制檢查」政策附加至與費率方案中 API 產品相關聯的 API Proxy。 營利限制檢查政策會對 API Proxy 強制執行營利限制，並確保分析和營利報表能準確擷取任何錯誤。詳情請參閱「在 API Proxy 中強制實行營利限制」。

編輯費率方案

除了產品組合、類型和目標對象，草擬費率方案中的所有欄位都可以編輯。發布費率方案後，您只能編輯結束日期，且前提是未指定結束日期。

如要編輯費率方案，請按照下列步驟操作：

  1. 存取「費率方案」頁面。
  2. 按一下要編輯的費率方案列。
    系統會顯示費率方案面板。
  3. 視需要編輯費率方案欄位。
    NOTE：發布費率方案後，如果尚未設定結束日期，就只能修改結束日期。
  4. 點選下列其中一個選項：
    按鈕 說明
    更新草稿 (草稿費率方案) 將費率方案儲存為草稿。

    您必須發布費率方案，應用程式開發人員才會看到。您可以編輯費率方案草稿中的任何欄位。
    發布草稿 (草稿費率方案) 發布費率方案。

    NOTE：發布費率方案後，如果尚未設定結束日期，就只能修改結束日期。費率方案發布後就無法刪除，但可以讓費率方案過期，並以未來的費率方案取代，詳情請參閱「讓已發布的費率方案過期」。
    更新後的結束日期 (已發布的費率方案) 設定已發布計畫的結束日期。

    NOTE：發布的費率方案設定結束日期後，就無法再修改。

刪除費率方案草稿

如果不再需要草稿費率方案，請刪除。

注意：你無法刪除已發布的費率方案。

如要刪除草稿費率方案，請按照下列步驟操作：

  1. 存取「費率方案」頁面。
  2. 將游標懸停在要刪除的費率方案上，系統就會顯示動作選單。
  3. 按一下「」。
  4. 按一下「刪除」確認操作。

使用 API 管理費率方案

以下各節說明如何使用 API 管理費率方案。

使用 API 建立費率方案

如要建立費率方案，請對 /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans 發出 POST 要求，其中 {monetizationpackage_id} 是您要建立費率方案的 API 產品組合 ID (建立 API 產品組合時，系統會在回應中傳回這個 ID)。

建立費率方案時，您必須在要求主體中指定下列項目：

  • 組織 ID
  • API 軟體包 ID
  • 房價方案名稱
  • 費率方案說明
  • 費率方案的適用範圍 (是否適用於所有開發人員，或僅適用於特定開發人員、公司或開發人員類別)
  • 費率方案生效日期
  • 房價方案的幣別
  • 是否發布費率方案
  • 費率方案是公開還是私人

您也可以視需要指定其他設定，例如應付款的期限 (例如 30 天)。請參閱「費率方案的設定屬性」。

如果您為 API 產品組合建立費率方案 (僅收取費用的方案除外)，且該組合包含多項產品，您可以將方案套用至產品組合中的特定產品。方法是在要求中識別產品。如未指定產品，方案會套用至 API 產品組合中的所有產品。

下列各節說明如何建立費率方案：

使用 API 建立標準費率方案

如要建立標準費率方案，請將 type 屬性設為 STANDARD，如以下範例所示。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

使用 API 建立開發人員或公司費率方案

如要將費率方案套用至特定開發人員或公司，請將 type 值設為 Developer。您也需要在要求中識別開發人員或公司，包括 ID、法定名稱和開發人員/公司名稱。

舉例來說，下列摘錄內容會為開發人員建立費率方案：Dev Five

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

使用 API 建立開發人員類別費率方案

如要將費率方案套用至開發人員類別，請將 type 值設為 Developer_Category。您也需要在要求中指明開發人員類別。 例如：

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

使用 API 建立 API 產品專屬費率方案

為包含多個 API 產品的 API 產品組合建立費率方案時，您可以個別指定 API 產品的費率方案詳細資料。

舉例來說，下列指令會建立收益分享方案，其中包含兩項 API 產品：

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

如要將 API 產品新增至 my-package API 產品組合，您需要在要求主體中新增 API 產品的費率方案詳細資料，詳情請參閱「使用 API 產品專屬費率方案將 API 產品新增至 API 產品組合」。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

使用 API 將費率方案設為公開或私人

建立費率方案時，您可以使用要求主體中的 isPrivate 屬性，指定方案為公開或私密。如果設為 true，費率方案就會設為私人。詳情請參閱「公開與不公開費率方案」。

舉例來說，下列程式碼會建立不公開費率方案：

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

使用 API 發布費率方案

如要發布費率方案，請在建立費率方案時，將 published 屬性值設為 true。開發人員可查看方案的 startDate 屬性中指定的日期，瞭解費率方案的生效日期。

舉例來說，下列程式碼會建立費率表方案並發布 (僅顯示部分要求)：

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

使用 API 儲存費率方案草稿

如要儲存費率方案但不發布，請在建立費率方案時，將 published 屬性值設為 false。

舉例來說，下列程式碼會建立費率表方案並儲存為草稿 (僅顯示部分要求)：

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

使用 API 編輯費率方案草稿

如要更新費率方案草稿，請向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} 發出 PUT 要求，其中 {package_id} 是 API 套件的 ID，{plan_Id} 則是費率方案的 ID。更新時，您需要在要求主體中指定更新的設定和費率方案 ID。如要更新房價方案費率，也必須指定房價方案費率的 ID。舉例來說，下列要求會更新 ID 為 location_flat_rate_card_plan 的費率方案中的費率方案費率 (更新部分已醒目顯示)：

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "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": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "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/location_flat_rate_card_plan" \
-u email:password

回應包含更新後的費率方案費率 (僅顯示部分回應)：

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

使用 API 查看費率方案

如以下章節所述，您可以使用營利 API 查看費率方案。

使用 API 查看機構的所有費率方案

如要查看機構的所有費率方案，請向 /mint/organizations/{org_name}/rate-plans 發出 GET 要求，其中 {org_name} 是機構名稱。

您可以傳遞下列查詢參數來篩選結果：

查詢參數 說明
all 指定是否要傳回所有費率方案的旗標。如設為 false，每頁傳回的費率方案數量會由 size 查詢參數定義。預設值為 true。
size 每個頁面傳回的 API 套件數量。如果 all 查詢參數設為 true，系統會忽略這個參數。
page 要傳回的頁碼 (如果內容已分頁)。如果 all 查詢參數設為 true，系統會忽略這個參數。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

使用 API 查看 API 產品組合的所有費率方案

如要查看 API 套件的所有費率方案，請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans 發出 GET 要求，其中 {package_id} 是 API 套件的 ID (建立營利套件時會傳回套件 ID)。

根據預設，結果只會傳回有效、公開和標準費率方案。如要加入：

  • 草稿或過期費率方案，請將 current 查詢參數設為 false (例如 ?current=false)。
  • 不公開費率方案：將 showPrivate 查詢參數設為 true (例如 ?showPrivate=true)。
  • 所有標準費率方案，將 standard 查詢參數設為 true (例如 ?standard=true)。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

使用 API 查看 API 套裝組合的費率方案

如要查看 API 套件的費率方案，請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} 發出 GET 要求，其中 {package_id} 是 API 套件的 ID，{plan_id} 則是費率方案的 ID (建立營利套件時會傳回套件 ID，建立費率方案時則會傳回費率方案 ID)。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

以下是回應範例：

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

使用 API 查看開發人員的所有有效費率方案

如要查看開發人員的所有有效費率方案，請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans 發出 GET 要求，其中 {developer_id} 是開發人員的電子郵件地址。

您可以傳遞下列查詢參數來篩選結果：

查詢參數 說明
all 這個旗標會指定是否要傳回所有 API 套件。如果設為 false，則每個頁面傳回的 API 套件數量會由 size 查詢參數定義。預設值為 false。
size 每個頁面傳回的 API 套件數量。預設值為 20。如果 all 查詢參數設為 true，系統會忽略這個參數。
page 要傳回的頁碼 (如果內容已分頁)。如果 all 查詢參數設為 true，系統會忽略這個參數。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

以下是回應範例：

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

使用 API 檢視開發人員接受的費率方案

如要查看開發人員的有效費率方案，請對 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 發出 GET 要求，其中 {developer_id} 是開發人員的電子郵件地址，而 {developer_rateplan_id} 是您接受發布的費率方案時，回應中傳回的已接受費率方案 ID。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

以下是回應範例：

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

使用 API 查看開發人員接受的費率方案，其中包含 API 產品

如要查看含有 API 產品的開發人員已接受的費率方案，請向 /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product 發出 GET 要求，其中 {developer_id} 是開發人員的 ID，/{product_id} 則是產品的 ID。

根據預設，結果只會傳回公開費率方案。如要顯示不公開費率方案，請將 showPrivate 查詢參數設為 true (例如 ?showPrivate=true)。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

使用 API 查看開發人員接受的所有費率方案

如要查看開發人員接受的費率方案，請對 /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans 發出 GET 要求，其中 {developer_id} 是開發人員的 ID。

您可以傳遞下列查詢參數來篩選結果：

查詢參數 說明
all 這個旗標會指定是否要傳回所有 API 套件。如果設為 false，則每個頁面傳回的 API 套件數量會由 size 查詢參數定義。預設值為 false。
size 每個頁面傳回的 API 套件數量。預設值為 20。如果 all 查詢參數設為 true，系統會忽略這個參數。
page 要傳回的頁碼 (如果內容已分頁)。如果 all 查詢參數設為 true，系統會忽略這個參數。

例如：

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

以下是回應範例：

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

使用 API 刪除費率方案草稿

如要刪除費率方案草稿，請對 /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} 發出 DELETE 要求，其中 {plan_Id} 是要刪除的費率方案 ID，{package_id} 則是費率方案的 API 套件 ID。例如：

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

費率方案的設定屬性

使用 API 建立費率方案時，可以指定下列設定。

名稱 說明 預設 是否必要？
advance

僅適用於週期性費用。此標記用於指定是否預先收取週期性費用。有效值包括：

  • true - 系統會預先收取定期費用。舉例來說，如果週期為 1 個月，系統會在上一個帳單月份結束時產生月結單，並收取週期性費用。
  • false - 系統會在週期結束時收取週期性費用。舉例來說，如果週期為 1 個月，系統會在當月帳單週期結束時，在月結單中收取週期性費用。此為預設值。
 false 否
contractDuration

與「contractDurationType」共同規劃的方案合約期限。 舉例來說，如要指定 6 個月的合約效期，請將 contractDuration 設為 6，並將 contractDurationType 設為 MONTH。

 N/A 否
contractDurationType

與「contractDuration」共同規劃的方案合約期限。有效值包括：

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 N/A 否
currency

房價方案使用的幣別。指定貨幣的 ISO 4217 代碼，例如美元為 usd，瑞士法郎為 chf。

 N/A 是
description

費率方案說明。

 N/A 是
developer

開發人員 ID (電子郵件地址)。僅適用於開發人員費率方案。

 N/A 否
developerCategory

開發人員類別 ID。僅適用於開發人員類別費率方案。

 N/A 否
displayName

房價方案的易記顯示名稱。

 N/A 是
earlyTerminationFee

如果開發人員在續約期前終止方案，則需支付一次性費用。

 N/A 否
endDate

方案結束日期。開發人員將無法再查看費率方案。如果不想讓房價方案在特定日期結束，請為 endDate 指定空值。

費率方案將在指定日期的當天結束前生效。舉例來說，如要讓費率方案在 2016 年 12 月 1 日到期，請將 endDate 值設為 2016-11-30。在此情況下，費率方案將於 2016 年 11 月 30 日當天結束，2016 年 12 月 1 日的所有要求都會遭到封鎖。

NOTE：使用 API 查看費率方案時，endDate 時間戳記會指定為 YYYY-MM-DD 00:00:00，這可能會造成誤導。

 N/A 否
freemiumDuration

免費增值期時間長度，連同 freemiumDurationType。舉例來說，如要指定免付費期為 30 天，請將 freemiumDuration 設為 30，並將 freemiumDurationType 設為 DAY。

 N/A 否
freemiumDurationType

免費增值期時間長度，以及 freemiumDuration。 有效值包括：

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 N/A 否
freemiumUnit

免費精簡版數量。這個值可以是交易數量，也可以是交易記錄政策中記錄的自訂屬性相關單位數量。

 N/A 否
frequencyDuration

僅適用於週期性費用。定期收費的間隔時間，與 frequencyDurationType 一併收取。舉例來說，如要指定費用收取間隔為 30 天，請將 frequencyDuration 設為 30，並將 frequencyDurationType 設為 DAY。

 N/A 否
frequencyDurationType 僅適用於週期性費用。定期收費的間隔時間，與 frequencyDuration 一併收取。有效值包括：
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 N/A 否
isPrivate 指定房價方案為公開或不公開的旗標。預設值為 false (公開)。詳情請參閱「公開與不公開費率方案」。 N/A 否
monetizationPackage

費率方案的 API 產品組合 ID。

 N/A 否
name

房價方案名稱。

 N/A 是
organization

費率方案的組織 ID。

 N/A 是
paymentDueDays

僅適用於週期性費用。費用應付天數。舉例來說，將值設為 30，表示費用應在 30 天內繳納。

 N/A 否
proRate

僅適用於週期性費用。這個旗標會指定開發人員在當月開始或結束方案時，是否按比例計算週期性費用。有效值包括：

  • true - 初始費用會根據週期結束前的天數 (或週期內的使用天數) 按比例計算。
  • false - 無論開發人員何時開始 (或結束) 方案，都須支付全額初始費用。此為預設值。
 false 否
published

這個旗標會指定是否應發布費率方案，供開發人員查看。有效值包括：

  • true - 發布費率方案。
  • false - 不要發布費率方案。
 N/A 是
ratePlanDetails

費率方案詳細資料 (請參閱費率方案詳細資料的設定屬性)。

 N/A 是
recurringFee

這項費用會持續向開發人員收取，直到開發人員終止方案為止。

 N/A 否
recurringStartUnit

只有在 recurringType 設為 CALENDAR 時才有效。系統會在每月這一天收取定期費用。舉例來說，如果定期費用是按月收取，且 recurringStartUnit 設為 1，系統會在每個月的第一天收取定期費用。

 N/A 否
recurringType

週期性費用的排程。有效值包括：

  • CALENDAR - 根據日曆排定。
  • CUSTOM - 根據自訂日期設定排定。
 N/A 否
setUpFee

系統會在方案開始日期 (即開發人員購買方案的日期) 向每位開發人員收取一次性費用。

 N/A 否
startDate

方案的開始日期。開發人員可自該日期起查看費率方案。

 N/A 是
type

費率方案類型。指定下列其中一項：

  • STANDARD。適用於所有開發人員。
  • DEVELOPER_CATEGORY。適用於所選類別中的所有開發人員。
  • DEVELOPER。適用於特定開發人員或公司。
 N/A 是

費率方案詳細資料的設定屬性

建立費率方案時，您可以指定下列任一設定屬性做為 ratePlanDetails 陣列的一部分。

名稱 說明 預設 是否必要？
aggregateFreemiumCounters

這個旗標會指定是否啟用匯總計數器，以判斷 API 產品的使用量是否在免費範圍內。如要為產品設定免費增值方案，必須啟用匯總計數器。有效值包括：

  • true - 啟用匯總計數器。
  • false - 請勿啟用匯總計數器。
 N/A 否
aggregateStandardCounters

這個旗標會指定是否使用匯總計數器來判斷用量範圍 (例如費率表方案的用量範圍)。可能的值如下：

  • true - 使用匯總計數器。
  • false - 請勿使用匯總計數器。
 N/A 否
aggregateTransactions

NOTE：這項屬性目前不會用於營利，因此可以忽略。

 true 否
currency

Currency (貨幣)

 N/A 否
duration

計算頻率的時間週期，連同 durationType，允許的 duration 值為 1 到 24。

舉例來說，將 duration 設為 2，並將 durationType 設為 MONTH，即可指定 2 個月的計算頻率。

 N/A 否
durationType

計算頻率的時間範圍，以及duration。 唯一有效的值為 MONTH。

如需使用範例，請參閱 duration。

 N/A 否
freemiumDuration

個別 API 產品的免費試用期，以及freemiumDurationType。舉例來說，如要指定 API 產品的免費試用期為 30 天，請將 freemiumDuration 設為 30，並將 freemiumDurationType 設為 DAY。

 N/A 否
freemiumDurationType

個別 API 產品的免費試用期，以及freemiumDuration。有效值包括：

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

舉例來說，如要將 API 產品的免費試用期設為 30 天，請將 freemiumDuration 設為 30，並將 freemiumDurationType 設為 DAY。

 N/A 否
freemiumUnit

API 產品的免費增值數量。這個值可以是交易數量，也可以是交易記錄政策中記錄的自訂屬性相關單位數量。

 N/A 否
meteringType

價目表方案的收費模式。有效值包括：

  • UNIT - 固定費率充電模式。
  • VOLUME - 依用量分級的充電模式。
  • STAIR_STEP - 隨附充電器。
  • DEV_SPECIFIC - 可調整的通知充電模式。不適用於任何其他收益模式。
 N/A 是
organization

組織 ID。

 N/A 否
paymentDueDays

後付型開發人員的應付日期。舉例來說，將值設為 30，表示應在 30 天內付款。

 N/A 否
product

API 產品資訊，例如 ID。

 N/A 否
ratePlanRates

房價方案費率詳細資料，例如房價方案類型 (REVSHARE 或 RATECARD)、價目表方案的費率、收益分享方案的收益分享比例，以及範圍 (適用房價方案費率的起始和結束單位)。

 N/A 是
ratingParameter

房價方案的依據。費率方案的依據是交易或自訂屬性。有效值包括：

  • VOLUME - 費率方案依交易量而定。
  • custom_attribute - 自訂屬性的名稱， 在 API 產品的交易記錄政策中定義，且僅適用於費率表方案。自訂屬性名稱不得定義為 VOLUME。
 VOLUME 是
ratingParameterUnit

適用於 ratingParameter. Only required if ratingParameter 的單位設為自訂屬性 (即未設為 VOLUME)。

 N/A 是
revenueType

收益分潤方案的收益分潤依據。有效值包括：

  • GROSS - 收益分潤是根據交易總價的百分比計算。
  • NET - 收益分潤是根據交易淨價的百分比計算。
 N/A 否
type

房價方案類型。有效值包括：

  • REVSHARE - 收益分潤模式。
  • RATECARD - 價目表模型。
  • REVSHARE_RATECARD - 收益分潤和費率表模式。
  • USAGE_TARGET - 可調整的通知模式。

如要進一步瞭解費率方案類型，請參閱「支援的費率方案類型」。

 N/A 是