管理预付费账号余额

<ph type="x-smartling-placeholder"></ph> 您正在查看 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

此响应与上面显示的响应类似,也就是查看 的预付账户余额 开发者。