Mengelola paket tarif untuk produk API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Dengan 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 pemakaian untuk menggunakan produk API
  • Biaya berulang yang tidak didasarkan pada konsumsi, seperti biaya bulanan untuk akses ke produk API Anda
  • Interval waktu saat paket tarif berlaku untuk produk API (aktivasi paket tarif dan waktu habis masa berlaku)
  • 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 Cloud Console.
  2. Pilih Distribusi > Monetisasi di menu navigasi samping.

Halaman Paket Tarif akan terbuka dan mencantumkan paket tarif saat ini.

Daftar paket tarif yang menampilkan nama paket tarif, produk API, serta aktivasi dan waktu habis masa berlaku untuk setiap paket, serta 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 Publikasikan > Monetisasi > Paket Tarif di menu navigasi samping.

Halaman Paket Tarif mencantumkan paket tarif saat ini.

Daftar paket tarif yang menampilkan nama paket tarif, produk API, serta aktivasi dan waktu habis masa berlaku untuk setiap paket, serta 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 dan scroll ke bawah ke bagian Paket tarif.

API Apigee

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

Mencantumkan paket tarif untuk produk API menggunakan API

Untuk menampilkan daftar paket tarif bagi organisasi, kirimkan 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"

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

Berikut ini contoh output respons, yang mencakup 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 mengetahui informasi selengkapnya tentang API dan payload responsnya, lihat Daftar API paket tarif

Melihat detail untuk paket tarif menggunakan API

Untuk melihat detail paket tarif, kirimkan 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"

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

Berikut ini 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 bagian Dapatkan API paket tarif.

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 dari tugas berikut:
    • Pilih Distribusi > Monetisasi di menu navigasi samping, lalu klik Buat pada 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 tempat Anda ingin mengaitkan paket tarif dari drop-down.
  3. Klik Next.
  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 kepada pelanggan dari menu drop-down. Bulanan
    Biaya inisialisasi

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

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

    Nonaktif
  5. Klik Next.
  6. Masukkan detail Harga sebagai berikut.
    Kolom Deskripsi Default
    Biaya berulang tetap Mengaktifkan biaya berulang tetap per unit:
    1. Pilih Tagihan biaya berulang tetap.
    2. Konfigurasi jumlah Frekuensi biaya tetap dan Biaya berulang tetap.

    Biaya ini akan dihitung secara prorata untuk periode penagihan pertama.

    Jika diaktifkan, Anda dapat melihat pratinjau dampak biaya berulang tetap pada tagihan per item dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagihan biaya berulang tetap.

    Nonaktif
    Biaya berbasis pemakaian Aktifkan harga berbasis konsumsi:
    1. Pilih Biaya berbasis pemakaian tagihan.
    2. Pilih salah satu opsi berikut:
      • Biaya tetap per unit (biaya tetap per unit yang digunakan)
      • Banded (biaya variabel per unit yang digunakan, ditentukan oleh rentang konsumsi)
    • Biaya tetap per unit: Biaya tetap dikenakan untuk setiap transaksi yang dimonetisasi. Masukkan nilai di kolom Biaya tetap per unit yang harus ditagih untuk setiap transaksi.

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

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

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

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

    Jika mengaktifkan biaya berbasis konsumsi, Anda dapat melihat pratinjau dampak biaya yang dipilih jenis pendapatan keseluruhan seperti yang dijelaskan di Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Model penetapan harga berbasis pemakaian tagihan.

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

    Nonaktif
  7. Klik Next.
  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 dibagi di kolom Persentase (%) pendapatan yang akan dibagi dengan developer.

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

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

    Untuk menonaktifkan biaya, batalkan pilihan Aktifkan pembagian keuntungan.

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

UI Apigee Klasik

Untuk membuat paket tarif menggunakan UI:

  1. Lakukan salah satu dari tugas berikut:
    • Pilih Publikasikan > Monetisasi > Paket Tarif di menu navigasi samping, lalu klik Buat rencana tarif.
    • Edit produk API dan klik Tambahkan tombol 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 tempat Anda ingin mengaitkan paket tarif dari drop-down.
  3. Klik Next.
  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 kepada pelanggan dari menu drop-down. Bulanan
    Biaya inisialisasi

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

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

    Nonaktif
  5. Klik Next.
  6. Masukkan detail Harga sebagai berikut.
    Kolom Deskripsi Default
    Biaya berulang tetap Mengaktifkan biaya berulang tetap per unit:
    1. Pilih Tagihan biaya berulang tetap.
    2. Konfigurasi jumlah Biaya berulang tetap dan Frekuensi biaya.

    Biaya ini akan dihitung secara prorata untuk periode penagihan pertama.

    Jika diaktifkan, Anda dapat melihat pratinjau dampak biaya berulang tetap pada tagihan per item dan total, seperti yang dijelaskan dalam Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Tagihan biaya berulang tetap.

    Nonaktif
    Biaya berbasis pemakaian Aktifkan harga berbasis konsumsi:
    1. Pilih Biaya berbasis pemakaian tagihan.
    2. Pilih salah satu opsi berikut:
      • Biaya tetap per unit (biaya tetap per unit yang digunakan)
      • Banded (biaya variabel per unit yang digunakan, ditentukan oleh rentang konsumsi)
    • Biaya tetap per unit: Biaya tetap dikenakan untuk setiap transaksi yang dimonetisasi. Masukkan nilai di kolom Biaya tetap per unit yang harus ditagih untuk setiap transaksi.

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

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

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

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

    Jika mengaktifkan biaya berbasis konsumsi, Anda dapat melihat pratinjau dampak biaya yang dipilih jenis pendapatan keseluruhan seperti yang dijelaskan di Melihat pratinjau paket tarif.

    Untuk menonaktifkan biaya, batalkan pilihan Model penetapan harga berbasis pemakaian tagihan.

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

    Nonaktif
  7. Klik Next.
  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 dibagi di kolom Persentase (%) pendapatan yang akan dibagi dengan developer.

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

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

    Untuk menonaktifkan biaya, batalkan pilihan Aktifkan pembagian keuntungan.

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

API Apigee

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

Konfigurasi paket tarif dengan meneruskan kolom wajib diisi di isi permintaan, seperti yang dijelaskan di Resource: RatePlans.

Tabel berikut meringkas kolom wajib diisi saat membuat draf dan rencana tarif yang dipublikasikan.

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

Misalnya, panggilan API berikut akan 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"
    }'

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Membuat API paket tarif

Melihat pratinjau paket tarif di UI

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

Masukkan nilai contoh, lihat hasil di pratinjau paket tarif

Perbarui kolom Konsumsi unit API di bagian Contoh data konsumen untuk mengubah estimasi dalam pratinjau. Tagihan dan total biaya per item akan diperbarui berdasarkan input Anda.

Perbarui kolom berikut di bagian Contoh data konsumen:

  • Konsumsi unit API
    Jika Biaya berbasis pemakaian tagihan dipilih di bagian Harga.
  • Pendapatan
    Jika Aktifkan pembagian keuntungan dipilih di bagian Pembagian keuntungan.

Menetapkan waktu aktivasi dan habis masa berlaku untuk paket tarif

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

Pertimbangkan hal berikut saat menyetel 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 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 disetel), 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 memiliki tanggal habis masa berlaku).
  • Saat menyetel waktu aktivasi dan waktu habis masa berlaku menggunakan UI, Anda hanya dapat menentukan tanggal, bukan waktu (hh:mm:ss:mmm). Waktu aktivasi dan masa berlaku ditetapkan secara default ke 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

Guna menetapkan waktu aktivasi paket tarif menggunakan UI Apigee di Konsol Cloud:

  1. Akses halaman Paket Tarif.
  2. Klik , lalu Tetapkan aktivasi untuk paket tarif yang ingin Anda tetapkan waktu aktivasinya.
  3. Pilih salah satu opsi berikut:
    • Belum ditentukan untuk membatalkan penetapan waktu aktivasi paket tarif (hanya tersedia untuk paket tarif draf).
    • Segera untuk menetapkan paket tarif sebagai langsung aktif.
    • On a future date untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Setel aktivasi.
  5. Publikasikan paket tarif jika belum dipublikasikan agar tersedia bagi developer untuk digunakan di aplikasi mereka.

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

  1. Akses halaman Paket Tarif.
  2. Klik , lalu Tetapkan masa berlaku untuk paket tarif yang ingin Anda tetapkan waktu habis masa berlakunya.
  3. Pilih salah satu opsi berikut:
    • Tidak pernah (default) untuk tidak pernah mengakhiri masa berlaku paket tarif.
    • Segera untuk menetapkan paket tarif sebagai langsung aktif.
    • On a future date untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan masa berlaku.

UI Apigee Klasik

Untuk menetapkan waktu aktivasi paket tarif menggunakan UI:

  1. Akses halaman Paket Tarif.
  2. Klik > Tetapkan aktivasi untuk paket tarif yang ingin Anda setel waktu aktivasinya.
  3. Pilih salah satu opsi berikut:
    • Belum ditentukan untuk membatalkan penetapan waktu aktivasi paket tarif (hanya tersedia untuk paket tarif draf).
    • Segera untuk menetapkan paket tarif sebagai langsung aktif.
    • On a future date untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Setel aktivasi.
  5. Publikasikan paket tarif jika belum dipublikasikan agar tersedia bagi developer untuk digunakan di aplikasi mereka.

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

  1. Akses halaman Paket Tarif.
  2. Klik > Tetapkan akhir masa berlaku untuk paket tarif yang ingin Anda tetapkan waktu habis masa berlakunya.
  3. Pilih salah satu opsi berikut:
    • Tidak pernah mengakhiri masa berlaku paket tarif.
    • Segera untuk menetapkan paket tarif sebagai langsung aktif.
    • On a future date untuk memilih tanggal saat paket tarif akan aktif.
  4. Klik Tetapkan masa berlaku.

API Apigee

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

  1. Lihat detail untuk paket tarif yang ingin diperbarui.
  2. Gunakan respons untuk membuat isi permintaan dan perbarui kolom berikut:
    • startTime untuk menyetel waktu aktivasi
    • endTime untuk menetapkan waktu habis masa berlaku
  3. Untuk memperbarui paket tarif dengan konfigurasi baru, kirimkan permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang telah 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 (1617302588000 waktu 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":"DRAFT",
    "startTime": 1617302588000
    }'

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

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Memperbarui API paket tarif

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 Paket Tarif dan klik , lalu klik Publikasikan untuk paket tarif draf yang ingin dipublikasikan.

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

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 dan klik > Publikasikan untuk rencana tarif draf yang ingin Anda publikasikan.

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

API Apigee

Untuk memublikasikan paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin Anda publikasikan.
  2. Gunakan respons untuk membuat isi permintaan dan perbarui kolom berikut:
    • Tetapkan status ke PUBLISHED.
    • Setel startTime ke waktu aktivasi dalam milidetik sejak epoch.
    • Jika ingin, setel endTime ke waktu habis masa berlaku dalam milidetik sejak epoch atau ke Never. Jika dihilangkan, waktu habis masa berlaku nilai defaultnya adalah Never.
    • Tetapkan kolom lain yang ingin Anda pertahankan.
  3. Untuk memublikasikan paket tarif, berikan permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang telah 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 ditetapkan 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.

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Memperbarui API paket tarif

Memindahkan paket tarif yang dipublikasikan ke status draf

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

Apigee di Konsol Cloud

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

  1. Akses halaman Paket 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 draf status menggunakan UI:

  1. Akses halaman Paket Tarif.
  2. Pilih > Pindahkan ke draf.

Paket tarif diperbarui dan kolom Status diubah menjadi Draf.

API Apigee

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

  1. Lihat detail untuk paket tarif yang dipublikasikan yang ingin dialihkan ke status draf.
  2. Gunakan respons untuk membuat isi permintaan dan perbarui kolom berikut:
    • Tetapkan status ke DRAF.
    • Tetapkan kolom lain yang ingin Anda pertahankan.
  3. Untuk memindahkan paket tarif yang dipublikasikan ke status draf, kirimkan permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang telah diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, tindakan berikut 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.

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Memperbarui API paket tarif

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. Akses halaman Paket Tarif.
  2. Klik nama paket tarif yang ingin diperbarui dalam daftar.
  3. Perbarui paket tarif, jika perlu.
  4. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk mengetahui 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. Akses halaman Paket Tarif.
  2. Klik nama paket tarif yang ingin diperbarui dalam daftar.
  3. Perbarui paket tarif, jika perlu.
  4. Klik salah satu opsi berikut:
    • Simpan dan publikasikan untuk menyimpan dan memublikasikan paket tarif. Anda akan diminta untuk memasukkan tanggal aktivasi. Untuk mengetahui informasi selengkapnya, lihat Menetapkan tanggal aktivasi untuk paket tarif.
    • Simpan untuk menyimpan draf paket tarif.
    • Batal untuk membatalkan pembaruan.

API Apigee

Untuk memperbarui paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin diperbarui.
  2. Gunakan respons untuk membuat isi permintaan dan memperbarui setelan konfigurasi lainnya, sesuai kebutuhan.
  3. Untuk memperbarui paket tarif, berikan permintaan PUT ke API berikut, dengan meneruskan isi permintaan yang telah diubah dalam permintaan Anda: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Misalnya, perubahan berikut akan mengubah biaya berbasis konsumsi menjadi 5; dan persentase pembagian keuntungan menjadi 6,5%, semua setelan konfigurasi lainnya disertakan untuk memastikan bahwa tag 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.

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Memperbarui API paket tarif

Meng-clone paket tarif

Buat clone paket tarif untuk membuat paket tarif duplikat berdasarkan paket tarif yang sudah ada.

Apigee di Konsol Cloud

Untuk meng-clone paket tarif menggunakan UI:

  1. Akses halaman Paket Tarif.
  2. Pilih , lalu Clone.
  3. Perbarui kolom Nama paket tarif dan produk API.
  4. Klik Clone.

Paket tarif akan ditambahkan ke daftar paket tarif.

UI Apigee Klasik

Untuk meng-clone paket tarif menggunakan UI:

  1. Akses halaman Paket Tarif.
  2. Pilih > Clone.
  3. Perbarui kolom Nama paket tarif dan produk API, sebagaimana diperlukan.
  4. Klik Clone.

Paket tarif akan ditambahkan ke daftar paket tarif.

API Apigee

Untuk meng-clone paket tarif menggunakan API:

  1. Lihat detail untuk paket tarif yang ingin di-clone.
  2. Gunakan respons untuk membuat isi permintaan dan perbarui kolom berikut:
    • Hapus kolom name.
    • Perbarui setelan konfigurasi lainnya, jika diperlukan.
  3. Buat paket tarif dengan meneruskan isi permintaan yang telah 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. Akses halaman Paket Tarif.
  2. Pilih , lalu Hapus untuk paket tarif yang ingin Anda hapus.
  3. Konfirmasi bahwa ini adalah paket tarif yang benar untuk dihapus, lalu klik Hapus.

Paket tarif akan dihapus dari daftar.

UI Apigee Klasik

Untuk menghapus paket tarif menggunakan UI:

  1. Akses halaman Paket Tarif.
  2. Pilih > Hapus untuk paket tarif yang ingin Anda hapus.
  3. Klik Delete saat diminta untuk mengonfirmasi penghapusan.

Paket tarif akan dihapus dari daftar.

API Apigee

Untuk menghapus paket tarif, kirimkan 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, perintah berikut akan 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

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

Berikut ini 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 mengetahui informasi selengkapnya, lihat Menghapus API paket tarif.