核發抵免額

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info

簡介

您可以透過營利功能，靈活發放開發人員抵免額。

如果是預付開發人員， 抵免額的用量會下降，也就是開發人員日後的預付餘額增加或減少。就像使用簽帳金融卡一樣，開發人員購買 API 產品組合時，系統會從開發人員的預付餘額中扣款。開發人員必須維持足夠的購買餘額。請參閱「如何計算預付帳戶的剩餘餘額？」

對於後付款開發人員，抵免額會顯示在月結單的獨立明細項目中，用於抵銷月結單中的費用。

探索「抵免額」頁面

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

核發抵免額

1. 前往「抵免額」頁面。
2. 按一下「+ 信用卡」。
3. 輸入下列資訊：

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

4. 按一下「儲存信用額」。

使用 API 核發抵免額

使用 API，針對 API 產品組合整體或 API 產品組合中的特定 API 產品使用情形，向開發人員核發積分。

如要使用 API 核發抵免額，請向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions 發出 POST 要求，其中 {package_id} 和 {rate-plan_id} 分別定義適用於抵免額的 API 產品組合和費率方案。

發出要求時，您需要指定以下查詢參數：

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

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

• 套用抵免額的帳單月份。此值預設為當月。
• 套用抵免額的帳單年度。這個值的預設值為目前的年份。
• 抵免額適用的 API 產品。如果您未指定 API 產品 ID，抵免額就會套用至 API 產品套裝組合中的所有 API 產品。

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

如要查看可在抵免額要求中指定的查詢參數完整清單，請參閱「抵免額 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 的查詢參數

下列查詢參數可與 Credits API 搭配使用：

名稱	說明	預設	必填與否
billingMonth	抵免額適用的帳單月份，例如 4 月。	不適用	否
billingYear	適用抵免額的帳單年度，例如 2018。	不適用	否
currencyId	抵免額使用的貨幣。開發人員購買的 API 產品套裝組合中，費率方案的貨幣已設定完成，無法變更。	不適用	是
developerId	適用於這筆抵免額的開發人員或公司名稱。	不適用	是
productId	抵免額適用的 API 產品。如未指定產品 ID，這項抵免額會套用至 API 產品組合中的所有 API 產品。	不適用	否
transactionAmount	抵免金額 (以指定幣別計算)。指定正值或負值。值不得為零。	不適用	是
transactionNote	說明退款原因的備註。	不適用	是