このページは Cloud Translation API によって翻訳されました。

前払い残高を管理する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。詳細

前払いアカウントの残高を管理する手順は、次のとおりです。

現在の前払い残高を確認します。前払い料金の表示 API を使用したアカウント残高の管理をご覧ください。
必要に応じて、サードパーティの決済機関を使用してアカウント残高を再読み込みする（入金）します。たとえば Worldpay ではサードパーティを利用したプリペイド残高の管理決済機関。
別の方法として、手動またはその後、Monetization API を呼び出してアカウントを再読み込みします。詳しくは、前払い残高の手動管理をご覧ください。
前払い残高が一定の基準額を下回った場合に自動再読み込みを設定する Monetization API と第三者の決済機関（Worldpay など）を使用して購入代金を支払います。このオプションは料金プランの定期的な支払いを管理するのに便利です詳しくは、 API を使用した前払いアカウント残高の自動再読み込み。

前払い残高の算出方法

以下の各セクションで説明するように、デベロッパーや会社の前払い残高を表示する場合は、次の操作を行う必要があります。レスポンスから次の値を取得します。

amount: 現在の請求対象期間で利用可能な合計金額。この値は再読み込みすると更新されますこのセクションで説明する方法で、前払いアカウントをリクエストします。
usage: 現在の請求対象期間中に使用された合計金額。この値は、収益化の対象となる資格があるたびに更新されます。またはクレジットの発行（正または負）によって識別されます。

注: 収益化では、デベロッパー残高を監査する事前スケジュールジョブとして、デベロッパー残高の監査が提供されます。使用残高をゼロにリセットします。収益化ジョブのスケジュールを設定するをご覧ください。

計算できる現在の請求対象期間の未払い残高（アカウント残高から usage を差し引いた金額） amount 値。たとえば、amount 値が 335.50、usage 値が 34 の場合、の残高は次のように計算されます。

amount(335.50) - usage(34) = 229.50

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

次のレスポンスは、開発者です。