管理預付帳戶餘額

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

如要管理預付帳戶的餘額,您可以:

如何計算剩餘的預付帳戶餘額?

按照下列各節所述,查看開發人員或公司的預付帳戶餘額時,你必須 從回應中取得下列值:

  • amount:目前帳單週期的可用金額。當您重新載入時,這個值就會更新 預付帳戶。
  • usage:目前帳單週期內的使用費用總額。每個符合資格的營利資格都會更新這個值 交易或發放抵免額 (正面或負面)。

您可以計算 減去 usage 值,也就是目前帳單週期的預付帳戶餘額。 amount 的值。舉例來說,如果 amount 值為 335.50,usage 值為 34,則 剩餘餘額的計算方式如下:

amount(335.50) - usage(34) = 229.50
敬上

使用 API 查看預付帳戶餘額

以下各節將說明如何查看開發人員或服務的預付帳戶餘額 使用 API

查看開發人員的預付帳戶餘額

如要查看開發人員的預付帳戶餘額,請向下列任一 API 發出 GET 要求,其中 {developer_id} 是開發人員的電子郵件地址:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances:傳回開發人員的預付帳戶餘額和週期性設定資訊。
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances:傳回預付帳戶餘額資訊,包括 目前餘額和總餘額、用量、儲值金額和使用稅。

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

查詢參數 說明
all 此標記用於指定是否要傳回所有 API 套件。如果設為 false,每頁傳回的 API 套件數量就會是 由 size 查詢參數定義。預設值為 false
size 每頁傳回的 API 套件數量。預設值為 20。如果 all 查詢 參數已設為 true,系統會忽略這個參數。
page 您要傳回的頁面數量 (如果內容已分頁)。如果 all 查詢參數設為 true,這個 參數都會遭到忽略。
currencyId 要查看預付帳戶餘額的貨幣 ID。

例如:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

以下提供回應範例:

{
    "developerBalance": [
        {
            "amount": 2005,
            "chargePerUsage": false,
            "id": "your-provider-id",
            "isRecurring": false,
            "supportedCurrency": {
                "description": "United States Dollars",
                "displayName": "United States Dollars",
                "id": "usd",
                "name": "USD",
                "organization": {
                    "address": [
                        {
                            "address1": "10 Almaden Blvd.",
                            "city": "San Jose",
                            "country": "US",
                            "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61",
                            "isPrimary": true,
                            "state": "CA",
                            "zip": "95113"
                        }
                    ],
                    "approveTrusted": false,
                    "approveUntrusted": false,
                    "billingCycle": "CALENDAR_MONTH",
                    "country": "US",
                    "currency": "USD",
                    "description": "my-org",
                    "groupOrganization": false,
                    "hasBillingAdjustment": false,
                    "hasBroker": false,
                    "hasSelfBilling": false,
                    "hasSeparateInvoiceForProduct": false,
                    "id": "my-org",
                    "issueNettingStmt": false,
                    "name": "my-org",
                    "nettingStmtPerCurrency": false,
                    "selfBillingAsExchOrg": false,
                    "selfBillingForAllDev": false,
                    "separateInvoiceForFees": false,
                    "status": "ACTIVE",
                    "supportedBillingType": "BOTH",
                    "taxModel": "HYBRID",
                    "timezone": "UTC"
                },
                "status": "ACTIVE",
                "virtualCurrency": false
            },
            "usage": 2.1572
        }
    ],
    "totalRecords": 1
}

查看公司的預付帳戶餘額

如要查看公司的預付帳戶餘額,請向以下公司提出 GET 要求: /mint/organizations/{org_name}/companies/{company_id}/developer-balances,其中 {company_id} 是公司 ID。如果公司已預付郵資, 擷取目前的預付帳戶餘額。如果公司為後付,則要求會擷取 目前的信用額度

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

查詢參數 說明
all 此標記用於指定是否要傳回所有 API 套件。如果設為 false,每頁傳回的 API 套件數量就會是 由 size 查詢參數定義。預設值為 false
size 每頁傳回的 API 套件數量。預設值為 20。如果 all 查詢 參數已設為 true,系統會忽略這個參數。
page 您要傳回的頁面數量 (如果內容已分頁)。如果 all 查詢參數設為 true,這個 參數都會遭到忽略。
currencyId 要查看預付帳戶餘額的貨幣 ID。

例如:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

回應與上述回應類似,當您查看預付帳戶餘額的 開發人員