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

核發抵免額

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。資訊

簡介

營利計畫讓你靈活發送開發人員抵免額，

如果是預付開發人員，抵免額的用量減少，表示未來開發人員預付餘額有所增加或減少。非常喜歡付款時，系統會從開發人員的預付餘額中扣除開發人員購買 API 產品套裝組合。開發人員必須維持足夠的餘額購買。請參閱「如何計算剩餘的預付帳戶餘額？」一節。

如果是後付開發人員，抵免額會顯示為在月結單中逐行列出，藉此減少月結單中的費用。

瀏覽「抵免額」頁面

存取及探索「抵免額」頁面，詳情請見下方說明。

Edge

如何使用 Edge UI 存取「Credits」(抵免額) 頁面：

登入 apigee.com/edge。
選取「發布」>「發布」營利 >抵免額。

隨即顯示「抵免額」頁面。

如圖中所示，「抵免額」頁面可讓您執行下列操作：

查看所有抵免額的摘要資訊，包括收款人名稱、抵免額金額、抵免額生效日期和時間，適用抵免額的 API 產品套裝組合和 API 產品，以及任何附加的附註
核發抵免額
搜尋抵免額清單

傳統版 Edge (Private Cloud)

如何使用傳統版 Edge UI 存取「Credits」頁面：

登入「http://ms-ip:9000」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。
選取「營利」>上方導覽列中的營利報表。

「抵免額」頁面可讓您：

查看所有抵免額的摘要資訊，包括收款人名稱、抵免額金額、抵免額生效日期和時間，適用抵免額的 API 產品套裝組合和 API 產品，以及任何附加的附註
核發抵免額
搜尋抵免額清單

核發抵免額

前往「抵免額」頁面。
按一下「+ 抵免額」。

輸入下列資訊：

欄位	說明
帳單月份	套用抵免額的帳單月份。從清單中選取月份。
開發人員	抵免額適用的開發人員或公司名稱。在文字方塊中輸入名稱。輸入文字時，含有字串的開發人員/公司清單會顯示在下拉式選單中。在下拉式清單中按一下開發人員或公司名稱。注意：選取開發人員或公司後，系統會顯示其餘欄位。如果所選公司或開發人員尚未接受費率方案，你就無法提供抵免額。
產品組合	要套用抵免額的 API 產品套裝組合。從可用的 API 產品套裝組合清單中選取。
產品	所選 API 產品套裝組合中要套用抵免額的 API 產品。選取所有產品或清單中的單一 API 產品。
幣別	抵免額使用的貨幣。在 API 產品套件中，費率方案設定的幣別開發人員購買，無法變更。如果費率方案中定義了多種貨幣，您可以選取其中一種貨幣。
金額	抵免額金額 (以指定幣別顯示)。請指定正值或負值。此值不得為零。
注意事項	(選填) 說明抵免額原因。

按一下「儲存抵免額」。

使用 API 核發抵免額

使用 API 將整個 API 產品套裝組合的抵免額核發給開發人員，或在 API 產品組合中使用特定 API 產品的情形。

如要使用 API 核發抵免額，請發出 POST 要求至 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, 其中 {package_id} 和 {rate-plan_id} 會定義抵免額適用的 API 產品套裝組合和費率方案詳細資訊。

發出要求時，必須指定為查詢參數：

抵免額適用的開發人員 ID (電子郵件地址)。
抵免額金額。
抵免額使用的貨幣。
說明抵免額原因的附註。

您也可以選擇指定下列額外的查詢參數：

套用抵免額的帳單月份。這個值預設為目前的每月。
套用抵免額的帳單年度。這個值預設為目前年份。
適用抵免額的 API 產品。未指定 API 產品 ID，抵免額適用於 API 產品組合中的所有 API 產品。

舉例來說，下列要求會核發 2018 年 4 月帳單月份 $100 美元的抵免額「dev1@myorg.com」的開發人員。抵免額適用於 payment API 產品套裝組合和 payment_standard_plan 費率方案：

如需查詢參數的完整清單，請參閱 Credit API 查詢參數當中可以指定目標

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

以下列舉一些回應內容範例：

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

抵免額 API 的查詢參數

以下查詢參數可與抵免額 API 搭配使用：

名稱	說明	預設	必填與否
`billingMonth`	抵免額的計費月份，例如 APRIL。	不適用	否
`billingYear`	適用抵免額的帳單年度，例如 2018。	不適用	否
`currencyId`	抵免額使用的貨幣。在 API 產品套件中，費率方案設定的幣別開發人員購買，無法變更。	不適用	是
`developerId`	抵免額適用的開發人員或公司名稱。	不適用	是
`productId`	適用抵免額的 API 產品。如果未指定產品 ID，則抵免額適用於 API 產品組合中的所有 API 產品。	不適用	否
`transactionAmount`	抵免額金額 (以指定幣別顯示)。請指定正值或負值。此值不得為零。	不適用	是
`transactionNote`	請注意，請註明領取抵免額的原因。	不適用	是