Konfigurasikan paket kartu tarif

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

Pengantar

Dalam paket tarif, developer akan ditagih untuk setiap transaksi. Untuk jenis paket ini, Anda perlu memberikan detail tambahan, seperti model penagihan dan harga untuk model penagihan.

Secara opsional, Anda dapat menentukan paket freemium untuk setiap produk (bukan untuk paket API) — Anda hanya dapat melakukannya untuk paket khusus produk.

Kapan biaya berulang ditagih dan paket paket direset?

Paket tarif dapat mencakup biaya berulang serta paket API (paket Volume Banded dan Paket), yang keduanya melibatkan waktu tertentu saat biaya ditagih dan paket paket direset ke nol. Tabel berikut menjelaskan kapan biaya berulang ditagih dan jumlah paket direset. Jika aplikasi developer diblokir agar tidak melakukan panggilan API lebih lanjut karena telah mencapai batas transaksi tertentu, ini adalah waktu saat jumlah panggilan API direset ke nol dan aplikasi dapat mulai melakukan panggilan lagi.

Jika rencana memiliki...	...hal ini terjadi
Biaya berulang bukan nol yang ditetapkan ke Bulan Paket Volume Berikat atau Paket	Biaya berulang dan reset paket paket dilakukan pada tanggal satu setiap bulan (default). Untuk pengulangan bulanan pada hari tertentu, buat paket tarif menggunakan API manajemen dan tunjukkan hari dengan properti RecurringStartUnit, seperti yang dijelaskan dalam Membuat paket tarif menggunakan API.
Biaya berulang yang bukan nol ditetapkan ke Minggu Paket Volume Berikat atau Paket	Reset biaya berulang dan paket terjadi setiap 7 hari setelah tanggal mulai paket tarif developer.
Biaya berulang yang bukan nol dan ditetapkan ke Hari Paket Volume Banded atau Paket Gabungan	Reset biaya berulang dan paket terjadi setiap X hari setelah tanggal mulai paket tarif developer.
Tidak ada biaya berulang (atau nol dolar) Paket Volume Banded atau Paket Gabungan	Paket paket direset berdasarkan Dasar Agregasi yang ditentukan pada kartu tarif. Misalnya, jika developer memulai paket tarif pada tanggal 19 setiap bulan, dan Dasar Agregasi adalah setiap 1 bulan, penggunaan paket akan direset setiap bulan pada tanggal 19. Perhatikan bahwa hari dalam sebulan mungkin tidak selalu sama. Misalnya, jika paket tarif dimulai pada 31 Desember, tanggal reset akan menjadi tanggal 28 pada bulan Februari selain tahun kabisat karena hanya ada 28 hari di bulan Februari. Tanggal 28 akan tetap menjadi hari reset setelahnya.

Mengonfigurasi paket kartu tarif menggunakan UI

Konfigurasikan paket kartu tarif, seperti yang dijelaskan di bawah.

Mengonfigurasi paket kartu tarif menggunakan API

Konfigurasikan detail paket tarif menggunakan API, seperti yang dijelaskan di bagian berikut.

Menentukan detail paket kartu tarif menggunakan API

Anda menentukan detail paket kartu tarif saat membuat paket tarif. Anda menentukan detail dalam properti ratePlanDetails dalam isi permintaan dalam panggilan ke /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Apa yang Anda tentukan di properti ratePlanDetails bergantung pada model penagihan yang Anda pilih: tarif tetap, volume berbanderol, atau paket.

Menentukan model pengisian daya tarif tetap

Untuk menerapkan model penagihan tarif tetap, Anda menentukan hal berikut dalam detail paket tarif:

• Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi (VOLUME) atau berdasarkan atribut kustom (misalnya, MINT_CUSTOM_ATTRIBUTE_1). VOLUME adalah default.
• Jenis pengukuran (UNIT) yang menunjukkan bahwa tarif ditetapkan per unit (yaitu, tidak didasarkan pada volume transaksi, seperti halnya model pengisian daya paket atau volume yang dikelompokkan).
• Periode jatuh tempo pembayaran (misalnya, 30 hari).
• ID organisasi Anda.
• Mata uang "dasar" atau akuntansi yang digunakan perusahaan Anda.
• Tarif paket tarif yang memberikan detail tentang cara penghitungan tarif. Karena model pengisian daya didasarkan pada tarif tetap, Anda hanya menentukan satu tarif paket tarif.

Dalam tarif paket tarif, Anda menentukan:

• Jenis tarif paket tarif (RATECARD).
• Tarif untuk paket. Misalnya, jika Anda menentukan 0,10, dan mata uangnya adalah dolar AS, developer akan ditagih $0,10 untuk setiap transaksi (atau jika didasarkan pada atribut kustom seperti jumlah byte yang dikirim dalam transaksi, developer akan ditagih $0,10 untuk mengirimkan jumlah byte yang ditentukan).
• Unit awal aplikasi tarif (0). Artinya, tarif diterapkan ke setiap transaksi, dimulai dengan transaksi pertama.

Lihat Setelan konfigurasi detail paket tarif untuk mengetahui daftar lengkap opsi detail paket tarif.

Misalnya, kode berikut membuat paket tarif dengan model penagihan tetap. Tarifnya ditetapkan sebesar $0,10 untuk setiap transaksi. Pembayaran jatuh tempo dalam 30 hari. (Detail terkait kartu tarif ditandai.)

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Menentukan model pengisian daya dengan volume yang dikelompokkan

Dalam model volume band, Anda menentukan detail paket tarif yang menyertakan satu atau beberapa tarif paket tarif, setiap tarif berlaku untuk "volume band", yaitu rentang volume transaksi (atau rentang berdasarkan atribut kustom seperti jumlah byte yang dikirim). Jenis paket ini biasanya disiapkan untuk mendorong developer menghasilkan volume yang lebih tinggi dengan menawarkan tarif diskon untuk band volume yang lebih tinggi.

Selain tarif paket tarif, Anda menetapkan hal berikut dalam detail paket tarif:

• Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi (VOLUME) atau berdasarkan atribut kustom (misalnya, CUSTOM_ATTRIBUTE_1). VOLUME adalah default.
• Jenis pengukuran (VOLUME) yang menunjukkan bahwa tarif didasarkan pada volume transaksi (yaitu, bukan tarif tetap per transaksi, seperti halnya model penagihan tarif tetap).
• Periode jatuh tempo pembayaran (misalnya, 30 hari).
• ID organisasi Anda.
• Mata uang "dasar" atau akuntansi yang digunakan perusahaan Anda.
• Durasi dan jenis durasi yang bersama-sama menentukan jangka waktu penggabungan volume transaksi (atau volume terkait atribut kustom). Hal ini juga disebut sebagai "basis agregasi". Volume transaksi digabungkan berdasarkan basis agregasi (misalnya, 1 bulan) untuk menentukan band volume yang berlaku.
• Penghitung agregasi yang digunakan untuk menentukan band volume yang berlaku.

Untuk setiap tarif paket tarif, Anda menentukan:

• Jenis tarif paket tarif (RATECARD).
• Tarif untuk paket. Misalnya, jika Anda menentukan 0,10, dan mata uangnya adalah dolar AS, developer akan ditagih $0,15 untuk setiap transaksi (atau jika didasarkan pada atribut kustom seperti jumlah byte yang dikirim dalam transaksi, developer akan ditagih $0,15 untuk mengirimkan jumlah byte yang ditentukan).
• Unit awal dan akhir band volume. Unit awal menentukan batas bawah band volume, dan unit akhir menentukan batas atas band volume. Misalnya, jika Anda menentukan unit awal 0 dan unit akhir 1.000, band volume akan mencakup hingga 1.000 transaksi dalam periode agregasi. Jika mata uang adalah dolar AS periode agregasi adalah 1 bulan, dan tarif untuk 1.000 transaksi pertama adalah 0,15, developer akan dikenai biaya $0,15 per transaksi untuk hingga 1.000 transaksi dalam bulan.
  
  Untuk mengetahui detail tentang kapan paket direset, lihat Kapan biaya berulang ditagih dan paket paket direset?
  

  Jika Anda tidak menentukan unit akhir untuk band volume akhir, tarif untuk band tersebut akan diterapkan ke semua transaksi setelah jumlah transaksi melebihi unit awal untuk band tersebut. Misalnya, jika unit awal untuk band terakhir adalah 1.000, dan Anda tidak menentukan unit akhir untuk band tersebut, tarif untuk band akan diterapkan ke semua transaksi setelah 1.000 transaksi dalam periode agregasi.

Lihat Setelan konfigurasi detail paket tarif untuk mengetahui daftar lengkap opsi detail paket tarif.

Misalnya, kode berikut membuat paket tarif dengan model penagihan volume berband. Tarifnya ditetapkan sebesar $0,15 untuk 1.000 transaksi pertama, dan $0,10 untuk semua transaksi di atas 1.000. Dasar agregasi adalah 1 bulan. Pembayaran jatuh tempo dalam 30 hari. (Detail kartu tarif ditandai.)

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Menentukan model pengisian daya yang dipaketkan

Dalam model penagihan paket, developer membayar (di awal) untuk "paket" transaksi (atau untuk paket berdasarkan atribut kustom seperti jumlah byte yang dikirim). Anda menentukan tarif untuk setiap paket dan basis agregasi, yaitu jangka waktu yang dapat digunakan developer untuk menggunakan paket.

Misalnya, Anda menyiapkan dua paket, dengan ukuran paket yang pertama adalah transaksi 1 hingga 1.000, dan ukuran paket kedua adalah transaksi 1001 hingga 2000. Tarifnya adalah $50 untuk paket pertama dan $40 untuk paket kedua, dan dasar agregasi adalah 1. Jika developer membeli paket tarif untuk paket pertama, mereka membayar $50 (di muka) untuk 1.000 transaksi dalam sebulan. Developer akan ditagih jumlah yang ditetapkan, terlepas dari apakah paket tersebut digunakan sepenuhnya atau tidak. Setelah periode agregasi berakhir, masa berlaku paket akan berakhir. Jika developer ingin menggunakan paket lagi, mereka harus membeli paket (dan paket) lagi.

Apa yang Anda tentukan dalam detail paket tarif pada dasarnya sama dengan yang Anda tentukan dalam detail paket tarif untuk model penagihan dengan volume yang dikelompokkan. Perbedaannya adalah sebagai berikut:

• Setiap paket tarif yang Anda tentukan adalah untuk paket (bukan untuk band volume).
• Anda harus menentukan batas atas untuk paket terakhir, kecuali jika Anda ingin menagih developer jumlah tetap untuk transaksi tanpa batas dalam paket terakhir.

Lihat Setelan konfigurasi detail paket tarif untuk mengetahui daftar lengkap opsi detail paket tarif.

Misalnya, kode berikut membuat paket tarif dengan model penagihan paket. Tarif ini ditetapkan sebesar $50 untuk paket pertama (hingga 1.000 transaksi), dan $40 untuk paket kedua (lebih dari 1.000 dan hingga 2.000 transaksi). Dasar agregasi adalah 1 bulan. Pembayaran jatuh tempo dalam 30 hari.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Menentukan paket freemium untuk setiap produk menggunakan API

Dalam paket kartu tarif, Anda dapat menyiapkan paket freemium untuk produk individual (bukan untuk paket API). Paket freemium menawarkan penggunaan produk API secara gratis kepada developer selama jangka waktu tertentu atau berdasarkan jumlah penggunaan.

Saat menyiapkan paket freemium untuk produk API, Anda menentukan periode dalam detail paket kartu tarif saat developer dapat menggunakan resource yang disediakan oleh produk API tanpa biaya. Periode dapat didasarkan pada salah satu hal berikut:

• Durasi, yaitu waktu antara tanggal mulai berlaku dan tanggal akhir.
• Jumlah, seperti jumlah transaksi yang melibatkan produk API atau volume yang berkaitan dengan atribut kustom yang dicatat dalam kebijakan perekaman transaksi.

Jika periode freemium didasarkan pada kuantitas, tentukan sebagai jumlah unit freemium. Misalnya, kode berikut membuat paket tarif kartu dengan paket freemium berdasarkan volume 5.000 unit (spesifikasi terkait freemium ditandai.)

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password