Kelola saldo akun prabayar

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X.
info

Untuk mengelola saldo di akun prabayar, Anda dapat:

Bagaimana cara menghitung sisa saldo akun prabayar?

Saat melihat saldo akun prabayar untuk developer atau perusahaan, seperti yang dijelaskan di bagian berikut, Anda harus dapatkan nilai berikut dari respons:

  • amount: Jumlah total uang yang tersedia untuk periode penagihan saat ini. Nilai ini diperbarui saat Anda memuat ulang akun prabayar menggunakan metode yang dijelaskan di bagian ini.
  • usage: Jumlah total uang yang digunakan selama periode penagihan saat ini. Nilai ini diperbarui dengan setiap nilai yang memenuhi syarat transaksi atau dengan mengeluarkan kredit (positif atau negatif).

Anda dapat menghitung sisa saldo akun prabayar untuk periode penagihan saat ini dengan mengurangi nilai usage dari Nilai amount. Misalnya, jika nilai amount adalah 335,50 dan nilai usage adalah 34, sisa saldo akan dihitung sebagai berikut:

amount(335.50) - usage(34) = 229.50

Melihat saldo rekening prabayar menggunakan API

Bagian berikut menjelaskan cara melihat saldo rekening prabayar untuk developer atau perusahaan Anda menggunakan API.

Melihat saldo rekening prabayar untuk developer

Untuk melihat saldo akun prabayar bagi developer, kirimkan permintaan GET ke salah satu API berikut, dengan {developer_id} adalah alamat email developer:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: Menampilkan informasi penyiapan berulang dan saldo akun prabayar untuk developer.
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: Menampilkan informasi saldo akun prabayar termasuk saldo saat ini dan total, penggunaan, penambahan saldo, dan pajak penggunaan.

Anda dapat meneruskan parameter kueri berikut untuk memfilter hasil:

Parameter Kueri Deskripsi
all Tanda yang menentukan apakah akan menampilkan semua paket API. Jika ditetapkan ke false, jumlah paket API yang ditampilkan per halaman adalah yang ditentukan oleh parameter kueri size. Nilai defaultnya adalah false.
size Jumlah paket API yang ditampilkan per halaman. Defaultnya adalah 20. Jika kueri all disetel ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten diberi nomor halaman). Jika parameter kueri all disetel ke true, diabaikan.
currencyId ID mata uang yang saldo rekening prabayarnya ingin Anda lihat.

Contoh:

$ 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

Berikut ini contoh responsnya:

{
    "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
}

Melihat saldo akun prabayar untuk perusahaan

Untuk melihat saldo rekening prabayar perusahaan, kirim permintaan GET ke /mint/organizations/{org_name}/companies/{company_id}/developer-balances, dengan {company_id} adalah ID perusahaan. Jika perusahaan menggunakan prabayar, permintaan mengambil saldo akun prabayar saat ini. Jika perusahaan melakukan pascabayar, permintaan akan mengambil batas kredit saat ini.

Anda dapat meneruskan parameter kueri berikut untuk memfilter hasil:

Parameter Kueri Deskripsi
all Tanda yang menentukan apakah akan menampilkan semua paket API. Jika ditetapkan ke false, jumlah paket API yang ditampilkan per halaman adalah yang ditentukan oleh parameter kueri size. Nilai defaultnya adalah false.
size Jumlah paket API yang ditampilkan per halaman. Defaultnya adalah 20. Jika kueri all disetel ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten diberi nomor halaman). Jika parameter kueri all disetel ke true, diabaikan.
currencyId ID mata uang yang saldo rekening prabayarnya ingin Anda lihat.

Contoh:

$ 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

Responsnya serupa dengan respons yang ditunjukkan di atas, saat melihat saldo akun prabayar untuk seorang pengembang.