Mengelola paket tarif untuk produk API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Dengan menggunakan paket tarif, pemilik produk API dapat memonetisasi produk API mereka dengan mengonfigurasi hal berikut:

  • Model akun penagihan
  • Mata uang yang digunakan untuk penagihan
  • Frekuensi penagihan pelanggan (khusus bulanan)
  • Biaya penyiapan awal untuk menggunakan produk API
  • Biaya berbasis konsumsi untuk menggunakan produk API
  • Biaya berulang apa pun yang tidak didasarkan pada penggunaan, seperti biaya bulanan untuk akses ke produk API Anda
  • Interval waktu selama paket tarif berlaku untuk produk API (waktu aktivasi dan habis masa berlaku paket tarif)
  • Pembagian keuntungan dengan partner developer

Kelola paket tarif untuk produk API Anda seperti yang dijelaskan di bagian berikut.

Melihat paket tarif

Lihat paket tarif di organisasi Anda seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Lihat paket tarif menggunakan UI Apigee di konsol Cloud seperti yang dijelaskan di bagian berikut:

Melihat paket tarif yang ditentukan untuk organisasi Anda

Lihat paket tarif yang ditentukan untuk organisasi Anda di halaman Paket tarif.

Untuk mengakses halaman Paket tarif:

  1. Login ke UI Apigee di konsol Cloud.
  2. Pilih Distribusi > Monetisasi di menu navigasi samping.

Halaman Tarif akan terbuka dan mencantumkan tarif saat ini.

Daftar paket tarif yang menampilkan nama paket tarif, produk API, serta waktu aktivasi dan habis masa berlaku untuk setiap paket, ditambah menu yang dapat digunakan untuk mengelola paket tarif

Halaman Paket Tarif memungkinkan Anda:

Melihat paket tarif yang terkait dengan produk API

Saat mengelola produk API, Anda dapat melihat dan mengelola paket tarif yang terkait dengan produk API. Scroll ke bawah ke bagian Paket tarif untuk melihat paket tarif.

UI Apigee Klasik

Lihat paket tarif menggunakan UI seperti yang dijelaskan di bagian berikut:

Melihat paket tarif yang ditentukan untuk organisasi Anda

Lihat paket tarif yang ditentukan untuk organisasi Anda di halaman Paket tarif.

Untuk mengakses halaman Paket tarif:

  1. Login ke UI Apigee Klasik.
  2. Pilih Publikasi > Monetisasi > Paket Tarif di menu navigasi samping.

Halaman Tarif mencantumkan tarif saat ini.

Daftar paket tarif yang menampilkan nama paket tarif, produk API, serta waktu aktivasi dan habis masa berlaku untuk setiap paket, ditambah drop-down yang dapat digunakan untuk mengelola paket tarif

Di halaman Paket Tarif, Anda dapat:

Melihat paket tarif yang terkait dengan produk API

Saat mengelola produk API, Anda dapat melihat dan mengelola paket tarif yang terkait dengan produk API. Edit produk API, lalu scroll ke bawah ke bagian Paket tarif.

Apigee API

Bagian berikut menjelaskan cara melihat paket tarif untuk organisasi menggunakan API:

Mencantumkan paket tarif untuk produk API menggunakan API

Untuk mencantumkan paket tarif untuk organisasi, buat permintaan GET ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Misalnya, menggunakan curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons, termasuk dua paket tarif, myrateplan1 dan myrateplan2 yang terkait dengan produk API HelloworldProduct:

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

Untuk informasi selengkapnya tentang API dan payload responsnya, lihat API Daftar paket tarif

Melihat detail untuk paket tarif menggunakan API

Untuk melihat detail paket tarif, buat permintaan GET ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Untuk menentukan nama paket tarif yang akan diteruskan di jalur resource, lihat Mencantumkan paket tarif di organisasi.

Misalnya, menggunakan curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons untuk paket tarif dengan nama 6b51b501-ac15-41b7-bb3e-621edb849e13 dan nama tampilan myrateplan2:

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

Untuk informasi selengkapnya tentang API dan payload responsnya, lihat API Get rate plan.

Membuat paket tarif

Buat paket tarif seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk membuat paket tarif menggunakan UI Apigee di konsol Cloud:

  1. Lakukan salah satu tugas berikut:
    • Pilih Distribusi > Monetisasi di menu navigasi samping, lalu klik Buat di daftar paket tarif.
    • Edit produk API, lalu klik Tambahkan paket tarif di bagian Paket tarif.
  2. Masukkan Detail paket tarif, sebagai berikut:
    Kolom Deskripsi
    Nama paket tarif Masukkan nama paket tarif.
    Produk API Pilih produk API yang ingin Anda kaitkan dengan paket tarif dari menu drop-down.
  3. Klik Berikutnya.
  4. Masukkan detail Penagihan, sebagai berikut:
    Kolom Deskripsi Default
    Mata uang penagihan Pilih mata uang yang akan digunakan untuk penagihan dari menu drop-down. USD
    Periode penagihan Pilih frekuensi penagihan pelanggan dari menu drop-down. Bulanan
    Biaya inisialisasi

    Biaya satu kali yang dikenakan kepada setiap developer pada tanggal mulai paket tarif (yaitu, tanggal developer membeli produk API).

    Jika Anda ingin mengenakan biaya penyiapan, pilih Kerjakan biaya inisialisasi dan masukkan jumlah yang akan ditagih di kolom Biaya inisialisasi.

    		Nonaktif
  5. Klik Berikutnya.
  6. Masukkan detail Harga sebagai berikut.
    Kolom Deskripsi Default
    Biaya berulang tetap Aktifkan biaya berulang tetap per unit:
    1. Pilih Tagih biaya berulang tetap.
    2. Konfigurasikan jumlah Frekuensi biaya tetap dan Biaya berulang tetap.

    Biaya akan dihitung secara prorata untuk periode penagihan pertama.

    Jika diaktifkan, Anda dapat melihat pratinjau efek yang akan ditimbulkan oleh biaya berulang tetap pada tagihan terperinci dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagih biaya berulang tetap.

    		Nonaktif
    Biaya berbasis konsumsi Aktifkan harga berbasis pemakaian:
    1. Pilih Tagih biaya berbasis konsumsi.
    2. Pilih salah satu opsi berikut:
      • Biaya tetap per unit (biaya tetap per unit yang digunakan)
      • Berjenjang (biaya variabel per unit yang digunakan, ditentukan oleh rentang penggunaan)

    • Biaya tetap per unit: Biaya tetap dikenakan untuk setiap transaksi yang dimonetisasi. Masukkan nilai di kolom Biaya tetap per unit yang akan ditagih untuk setiap transaksi.

    • Berjenjang: Biaya variabel dikenakan untuk setiap transaksi yang dimonetisasi. Rentang transaksi dan konsumsi menentukan biaya transaksi. Band mengacu pada rentang penggunaan API, dan setiap band memiliki biaya yang berbeda. Di bagian Ranges of unit consumption, Anda dapat menentukan rentang band dan biaya yang sesuai untuk band tersebut. Anda dapat menentukan sebanyak mungkin band yang diinginkan dengan mengklik + BAND.

      Contoh: Misalnya, Anda ingin menagih 1.000 panggilan API pertama sebesar USD 2 per panggilan dan semua panggilan API berikutnya sebesar USD 1 per panggilan. Untuk mengonfigurasinya, tentukan dua band berikut di bagian Ranges of unit consumption:

      • Di baris pertama, masukkan nilai berikut:
        • Mulai: 0
        • Akhir: 1.000
        • Biaya: 2
      • Di baris kedua, masukkan nilai berikut:
        • Mulai: 1001
        • Akhir: unit tidak terbatas
        • Biaya: 1

      Dalam contoh ini, jika developer menggunakan 1.500 API, total biayanya akan menjadi USD 2.500 ((1000 * 2) + (500 * 1)).

    Jika mengaktifkan biaya berbasis penggunaan, Anda dapat melihat pratinjau efek jenis biaya yang dipilih terhadap keseluruhan pendapatan seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagih model harga berbasis konsumsi.

    Jika Anda telah mengonfigurasi variabel monetisasi perUnitPriceMultiplier dalam kebijakan DataCapture, biaya per transaksi yang ditentukan dalam jenis biaya berbasis konsumsi apa pun (Biaya tetap per unit atau Banded) dikalikan dengan nilai perUnitPriceMultiplier.

    		Nonaktif
  7. Klik Berikutnya.
  8. Masukkan detail Pembagian keuntungan, sebagai berikut:
    Kolom Deskripsi Default
    Pembagian keuntungan Aktifkan pembagian keuntungan untuk berbagi persentase pendapatan dengan partner developer.
    1. Pilih Aktifkan pembagian keuntungan.
    2. Masukkan persentase pendapatan yang akan dibagikan di kolom Persentase (%) pendapatan yang akan dibagikan kepada developer.

    Anda bisa mendapatkan pembagian keuntungan untuk setiap transaksi yang dimonetisasi dengan mengonfigurasi variabel monetisasi revShareGrossPrice di kebijakan DataCapture. Untuk mengetahui informasi selengkapnya, lihat Variabel monetisasi.

    Jika mengaktifkan pembagian keuntungan, Anda dapat melihat pratinjau efek nilai Persentase (%) yang dimasukkan pada tagihan per item dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Aktifkan pembagian keuntungan.

    		Nonaktif
  9. Klik Berikutnya.
  10. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk informasi selengkapnya, lihat Menetapkan tanggal aktivasi untuk paket tarif.
    • Simpan untuk menyimpan draf paket tarif.
    • Cancel untuk membatalkan.

UI Apigee Klasik

Untuk membuat paket tarif menggunakan UI:

  1. Lakukan salah satu tugas berikut:
    • Pilih Publikasikan > Monetisasi > Tarif di menu navigasi samping, lalu klik Buat tarif.
    • Edit produk API, lalu klik Tombol Tambahkan di bagian Paket tarif.
  2. Masukkan Detail paket tarif, sebagai berikut:
    Kolom Deskripsi
    Nama paket tarif Masukkan nama paket tarif.
    Produk API Pilih produk API yang ingin Anda kaitkan dengan paket tarif dari menu drop-down.
  3. Klik Berikutnya.
  4. Masukkan detail Penagihan, sebagai berikut:
    Kolom Deskripsi Default
    Mata uang penagihan Pilih mata uang yang akan digunakan untuk penagihan dari menu drop-down. USD
    Periode penagihan Pilih frekuensi penagihan pelanggan dari menu drop-down. Bulanan
    Biaya inisialisasi

    Biaya satu kali yang dikenakan kepada setiap developer pada tanggal mulai paket tarif (yaitu, tanggal developer membeli produk API).

    Jika Anda ingin mengenakan biaya penyiapan, pilih Tagih biaya penyiapan dan masukkan jumlah yang akan ditagih di kolom Biaya inisialisasi.

    		Nonaktif
  5. Klik Berikutnya.
  6. Masukkan detail Harga sebagai berikut.
    Kolom Deskripsi Default
    Biaya berulang tetap Aktifkan biaya berulang tetap per unit:
    1. Pilih Tagih biaya berulang tetap.
    2. Konfigurasikan jumlah Biaya berulang tetap dan Frekuensi biaya.

    Biaya akan dihitung secara prorata untuk periode penagihan pertama.

    Jika diaktifkan, Anda dapat melihat pratinjau efek yang akan ditimbulkan oleh biaya berulang tetap pada tagihan terperinci dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagih biaya berulang tetap.

    		Nonaktif
    Biaya berbasis konsumsi Aktifkan harga berbasis pemakaian:
    1. Pilih Tagih biaya berbasis konsumsi.
    2. Pilih salah satu opsi berikut:
      • Biaya tetap per unit (biaya tetap per unit yang digunakan)
      • Berjenjang (biaya variabel per unit yang digunakan, ditentukan oleh rentang penggunaan)

    • Biaya tetap per unit: Biaya tetap dikenakan untuk setiap transaksi yang dimonetisasi. Masukkan nilai di kolom Biaya tetap per unit yang akan ditagih untuk setiap transaksi.

    • Berjenjang: Biaya variabel dikenakan untuk setiap transaksi yang dimonetisasi. Rentang transaksi dan konsumsi menentukan biaya transaksi. Band mengacu pada rentang penggunaan API, dan setiap band memiliki biaya yang berbeda. Di bagian Ranges of unit consumption, Anda dapat menentukan rentang band dan biaya yang sesuai untuk band tersebut. Anda dapat menentukan sebanyak mungkin band yang diinginkan dengan mengklik + BAND.

      Contoh: Misalnya, Anda ingin menagih 1.000 panggilan API pertama sebesar USD 2 per panggilan dan semua panggilan API berikutnya sebesar USD 1 per panggilan. Untuk mengonfigurasinya, tentukan dua band berikut di bagian Ranges of unit consumption:

      • Di baris pertama, masukkan nilai berikut:
        • Mulai: 0
        • Akhir: 1.000
        • Biaya: 2
      • Di baris kedua, masukkan nilai berikut:
        • Mulai: 1001
        • Akhir: unit tidak terbatas
        • Biaya: 1

      Dalam contoh ini, jika developer menggunakan 1.500 API, total biayanya akan menjadi USD 2.500 ((1000 * 2) + (500 * 1)).

    Jika mengaktifkan biaya berbasis penggunaan, Anda dapat melihat pratinjau efek jenis biaya yang dipilih terhadap keseluruhan pendapatan seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagih model harga berbasis konsumsi.

    Jika Anda telah mengonfigurasi variabel monetisasi perUnitPriceMultiplier dalam kebijakan DataCapture, biaya per transaksi yang ditentukan dalam jenis biaya berbasis konsumsi apa pun (Biaya tetap per unit atau Banded) dikalikan dengan nilai perUnitPriceMultiplier.

    		Nonaktif
  7. Klik Berikutnya.
  8. Masukkan detail Pembagian keuntungan, sebagai berikut:
    Kolom Deskripsi Default
    Pembagian keuntungan Aktifkan pembagian keuntungan untuk berbagi persentase pendapatan dengan partner developer.
    1. Pilih Aktifkan pembagian keuntungan.
    2. Masukkan persentase pendapatan yang akan dibagikan di kolom Persentase (%) pendapatan yang akan dibagikan kepada developer.

    Anda bisa mendapatkan pembagian keuntungan untuk setiap transaksi yang dimonetisasi dengan mengonfigurasi variabel monetisasi revShareGrossPrice di kebijakan DataCapture. Untuk mengetahui informasi selengkapnya, lihat Variabel monetisasi.

    Jika mengaktifkan pembagian keuntungan, Anda dapat melihat pratinjau efek nilai Persentase (%) yang dimasukkan pada tagihan per item dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Aktifkan pembagian keuntungan.

    		Nonaktif
  9. Klik Berikutnya.
  10. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk informasi selengkapnya, lihat Menetapkan tanggal aktivasi untuk paket tarif.
    • Simpan untuk menyimpan draf paket tarif.
    • Cancel untuk membatalkan.

Apigee API

Untuk membuat paket tarif, buat permintaan POST ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Konfigurasikan paket tarif dengan meneruskan kolom yang diperlukan dalam isi permintaan, seperti yang dijelaskan dalam Referensi: RatePlans.

Tabel berikut merangkum kolom yang diperlukan saat membuat draf dan paket tarif yang dipublikasikan.

Kolom wajib diisi untuk draf paket tarif Kolom wajib diisi untuk paket tarif yang dipublikasikan
  • apiproduct
  • displayName
  • state
  • apiproduct
  • billingPeriod
  • currencyCode
  • displayName
  • startTime
  • state

Misalnya, panggilan API berikut membuat draf paket tarif bernama myrateplan5 yang terkait dengan produk API HelloworldProduct: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

Untuk informasi selengkapnya, lihat Membuat API paket tarif

Melihat pratinjau paket tarif di UI

Berdasarkan konfigurasi harga dan pangsa keuntungan, Anda dapat melihat pratinjau tagihan terperinci dan total yang ditagih di bagian Pratinjau paket tarif di halaman Paket tarif, seperti yang ditunjukkan pada gambar berikut.

Masukkan contoh nilai, lihat hasil di pratinjau paket tarif

Perbarui kolom Penggunaan unit API di bagian Contoh data konsumen untuk mengubah estimasi dalam pratinjau. Tagihan terperinci dan total akan diperbarui berdasarkan input Anda.

Perbarui kolom berikut di bagian Contoh data konsumen:

  • Konsumsi unit API
    Jika Tagih biaya berbasis konsumsi dipilih di bagian Harga.
  • Pendapatan
    Jika Aktifkan pembagian keuntungan dipilih di bagian Pembagian keuntungan.

Menetapkan waktu aktivasi dan masa berlaku untuk paket tarif

Tetapkan waktu aktivasi dan habis masa berlaku untuk paket tarif guna menunjukkan kapan paket tarif yang dipublikasikan aktif dan produk API terkait tersedia untuk digunakan developer di aplikasi mereka.

Pertimbangkan hal berikut saat menetapkan waktu aktivasi dan habis masa berlaku:

  • Hanya satu paket tarif yang dapat aktif untuk produk API pada waktu tertentu.
  • Anda dapat memublikasikan beberapa paket tarif untuk produk API yang sama dengan waktu aktivasi dan habis masa berlaku yang tidak tumpang-tindih.
  • Anda harus menetapkan waktu aktivasi untuk paket tarif sebelum dapat dipublikasikan.
    Saat memublikasikan paket tarif menggunakan UI, Anda akan diminta untuk menetapkan waktu aktivasi jika belum ditetapkan.
  • Waktu aktivasi harus terjadi sebelum waktu habis masa berlaku (jika ditetapkan), dan waktu habis masa berlaku harus terjadi setelah waktu aktivasi.
  • Waktu habis masa berlaku tidak wajib diisi. Jika tidak ditentukan, masa berlaku akan ditetapkan secara default ke Never (paket tarif tidak pernah berakhir masa berlakunya).
  • Saat menetapkan waktu aktivasi dan habis masa berlaku menggunakan UI, Anda hanya dapat menentukan tanggal, bukan waktu (hh:mm:ss:mmm). Waktu untuk nilai aktivasi dan habis masa berlaku secara default adalah 12:00:00:000 AM dan 11:59:59:999 PM.

Tetapkan waktu aktivasi dan habis masa berlaku untuk paket tarif seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk menetapkan waktu aktivasi untuk paket tarif menggunakan UI Apigee di konsol Cloud:

  1. Buka halaman Tarif.
  2. Klik , lalu Tetapkan aktivasi untuk paket tarif yang waktu aktivasinya ingin Anda tetapkan.
  3. Pilih salah satu opsi berikut:
    • Tidak ditentukan untuk menghapus setelan waktu aktivasi paket tarif (hanya tersedia untuk paket tarif draf).
    • Segera untuk segera menetapkan paket tarif sebagai aktif.
    • Pada tanggal mendatang untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan aktivasi.
  5. Publikasikan paket tarif jika belum dipublikasikan agar tersedia bagi developer untuk digunakan di aplikasi mereka.

Untuk menetapkan waktu habis masa berlaku untuk paket tarif menggunakan UI Apigee di Cloud Console:

  1. Buka halaman Tarif.
  2. Klik , lalu Tetapkan masa berlaku untuk paket tarif yang waktu habis masa berlakunya ingin Anda tetapkan.
  3. Pilih salah satu opsi berikut:
    • Never (default) agar masa berlaku paket tarif tidak pernah berakhir.
    • Segera untuk segera menetapkan paket tarif sebagai aktif.
    • Pada tanggal mendatang untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan tanggal habis masa berlaku.

UI Apigee Klasik

Untuk menetapkan waktu aktivasi untuk paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Klik > Tetapkan aktivasi untuk paket tarif yang waktu aktivasinya ingin Anda tetapkan.
  3. Pilih salah satu opsi berikut:
    • Tidak ditentukan untuk menghapus setelan waktu aktivasi paket tarif (hanya tersedia untuk paket tarif draf).
    • Segera untuk segera menetapkan paket tarif sebagai aktif.
    • Pada tanggal mendatang untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan aktivasi.
  5. Publikasikan paket tarif jika belum dipublikasikan agar tersedia bagi developer untuk digunakan di aplikasi mereka.

Untuk menetapkan waktu habis masa berlaku untuk paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Klik > Tetapkan masa berlaku untuk paket tarif yang waktu habis masa berlakunya ingin Anda tetapkan.
  3. Pilih salah satu opsi berikut:
    • Never agar masa berlaku paket tarif tidak pernah berakhir.
    • Segera untuk segera menetapkan paket tarif sebagai aktif.
    • Pada tanggal mendatang untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan tanggal habis masa berlaku.

Apigee API

Untuk menetapkan waktu aktivasi atau habis masa berlaku untuk paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin Anda perbarui.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui kolom berikut:
    • startTime untuk menetapkan waktu aktivasi
    • endTime untuk menetapkan waktu habis masa berlaku

  3. Untuk memperbarui paket tarif dengan konfigurasi baru, buat permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, kode berikut menetapkan waktu aktivasi ke 1 April 2021 (waktu epoch 1617302588000): 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Untuk mengetahui informasi selengkapnya tentang kolom yang dapat Anda tentukan dalam isi permintaan, lihat Resource: RatePlans.

Berikut adalah contoh output respons:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Untuk informasi selengkapnya, lihat Update rate plan API

Memublikasikan paket tarif

Publikasikan paket tarif seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk memublikasikan paket tarif menggunakan UI, gunakan salah satu metode berikut:

  • Saat membuat atau memperbarui paket tarif, Anda dapat mengklik Simpan dan Publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk menetapkan tanggal aktivasi.
  • Akses halaman Tarif Paket, lalu klik , lalu Publikasikan untuk draf tarif paket yang ingin Anda publikasikan.

    Opsi ini hanya muncul jika Anda telah menetapkan tanggal aktivasi untuk draf paket tarif.

UI Apigee Klasik

Untuk memublikasikan paket tarif menggunakan UI, gunakan salah satu metode berikut:

  • Saat membuat atau memperbarui paket tarif, Anda dapat mengklik Simpan dan Publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk menetapkan tanggal aktivasi.
  • Akses halaman Paket Tarif, lalu klik > Publikasikan untuk draf paket tarif yang ingin Anda publikasikan.

    Opsi ini hanya muncul jika Anda telah menetapkan tanggal aktivasi untuk draf paket tarif.

Apigee API

Untuk memublikasikan paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin Anda publikasikan.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui kolom berikut:
    • Setel status ke PUBLISHED.
    • Tetapkan startTime ke waktu aktivasi dalam milidetik sejak epoch.
    • Atau, tetapkan endTime ke waktu habis masa berlaku dalam milidetik sejak epoch atau ke Never. Jika dihilangkan, waktu habis masa berlakunya akan ditetapkan secara default ke Never.
    • Tetapkan kolom lain yang ingin Anda pertahankan.

  3. Untuk memublikasikan paket tarif, buat permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, kode berikut mengubah status paket tarif rateplan1 menjadi PUBLISHED dan menetapkan waktu aktivasi ke 1 April 2021, yang ditentukan sebagai milidetik sejak epoch: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"PUBLISHED",
    "startTime": 1617302588000
    }'

Untuk mengetahui informasi selengkapnya tentang kolom yang dapat Anda tentukan dalam isi permintaan, lihat Resource: RatePlans.

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "PUBLISHED",
    "startTime": "1617302588000"
}

Untuk informasi selengkapnya, lihat Update rate plan API

Memindahkan paket tarif yang dipublikasikan ke status draf

Pindahkan paket tarif yang dipublikasikan ke status draf seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk memindahkan paket tarif yang dipublikasikan ke status draf menggunakan UI Apigee di konsol Cloud:

  1. Buka halaman Tarif.
  2. Pilih , lalu Pindahkan ke draf.

Paket tarif diperbarui dan kolom Status diubah menjadi Draf.

UI Apigee Klasik

Untuk memindahkan paket tarif yang dipublikasikan ke status draf menggunakan UI:

  1. Buka halaman Tarif.
  2. Pilih > Pindahkan ke draf.

Paket tarif diperbarui dan kolom Status diubah menjadi Draf.

Apigee API

Untuk memindahkan paket tarif yang dipublikasikan ke status draf menggunakan API:

  1. Lihat detail untuk paket tarif yang dipublikasikan yang ingin Anda pindahkan ke status draf.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui kolom berikut:
    • Tetapkan status ke DRAFT.
    • Tetapkan kolom lain yang ingin Anda pertahankan.

  3. Untuk memindahkan paket tarif yang dipublikasikan ke status draf, buat permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, kode berikut akan mengubah status paket tarif rateplan1 menjadi DRAFT: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Untuk mengetahui informasi selengkapnya tentang kolom yang dapat Anda tentukan dalam isi permintaan, lihat Resource: RatePlans.

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Untuk informasi selengkapnya, lihat Update rate plan API

Memperbarui paket tarif

Perbarui paket tarif seperti yang dijelaskan di bagian berikut. Lihat juga:

Perbarui paket tarif seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk memperbarui paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Klik nama paket tarif yang ingin Anda perbarui dalam daftar.
  3. Perbarui paket tarif, sesuai kebutuhan.
  4. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk informasi selengkapnya, lihat Menetapkan tanggal aktivasi untuk paket tarif.
    • Simpan untuk menyimpan draf paket tarif.
    • Batal untuk membatalkan pembaruan.

UI Apigee Klasik

Untuk memperbarui paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Klik nama paket tarif yang ingin Anda perbarui dalam daftar.
  3. Perbarui paket tarif, sesuai kebutuhan.
  4. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk informasi selengkapnya, lihat Menetapkan tanggal aktivasi untuk paket tarif.
    • Simpan untuk menyimpan draf paket tarif.
    • Batal untuk membatalkan pembaruan.

Apigee API

Untuk memperbarui paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin Anda perbarui.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui setelan konfigurasi lainnya, sesuai kebutuhan.

  3. Untuk memperbarui paket tarif, buat permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, kode berikut mengubah biaya berbasis konsumsi menjadi 5; dan persentase pembagian keuntungan menjadi 6,5%.Semua setelan konfigurasi lainnya disertakan untuk memastikan setelan tersebut dipertahankan: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"5",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"6.5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Untuk mengetahui informasi selengkapnya tentang kolom yang dapat Anda tentukan dalam isi permintaan, lihat Resource: RatePlans.

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Untuk informasi selengkapnya, lihat Update rate plan API

Meng-clone paket tarif

Meng-clone paket tarif untuk membuat paket tarif duplikat berdasarkan paket tarif yang ada.

Apigee di konsol Cloud

Untuk meng-clone paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Pilih , lalu Clone.
  3. Perbarui kolom Nama paket tarif dan Produk API.
  4. Klik Clone.

Paket tarif ditambahkan ke daftar paket tarif.

UI Apigee Klasik

Untuk meng-clone paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Pilih > Clone.
  3. Perbarui kolom Nama paket tarif dan Produk API, sesuai kebutuhan.
  4. Klik Clone.

Paket tarif ditambahkan ke daftar paket tarif.

Apigee API

Untuk meng-clone paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin Anda clone.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui kolom berikut:
    • Hapus kolom name.
    • Perbarui setelan konfigurasi lainnya sesuai kebutuhan.
  3. Buat paket tarif dengan meneruskan isi permintaan yang diubah dalam permintaan Anda.

Menghapus paket tarif

Penghapusan paket tarif bersifat permanen. Paket tarif akan segera dihapus dan tidak dapat dipulihkan.

Hapus paket tarif seperti yang dijelaskan di bagian berikut.

Apigee di konsol Cloud

Untuk menghapus paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Pilih , lalu Hapus untuk paket tarif yang ingin Anda hapus.
  3. Pastikan ini adalah paket tarif yang benar untuk dihapus, lalu klik Hapus.

Paket tarif akan dihapus dan dihapus dari daftar.

UI Apigee Klasik

Untuk menghapus paket tarif menggunakan UI:

  1. Buka halaman Tarif.
  2. Pilih > Hapus untuk paket tarif yang ingin dihapus.
  3. Klik Hapus saat diminta untuk mengonfirmasi penghapusan.

Paket tarif akan dihapus dan dihapus dari daftar.

Apigee API

Untuk menghapus paket tarif, buat permintaan DELETE ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME.

Untuk menentukan nama paket tarif yang akan diteruskan di jalur resource, lihat Mencantumkan paket tarif di organisasi.

Misalnya, kode berikut menghapus paket tarif dengan nama cc6252c0-c5d0-4aaf-85f2-203ec8fa5707 dan nama tampilan myrateplan3: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN

Dengan $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan Apigee API.

Berikut adalah contoh output respons:

{
    "name": "93ca14aa-7a48-4384-ae09-c85a0e8a8df8",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Untuk informasi selengkapnya, lihat Menghapus API paket tarif.