Konfigurasikan rencana bagi hasil

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

Pengantar

Dalam paket pembagian keuntungan, penyedia API akan membagikan persentase pendapatan yang dihasilkan dari setiap transaksi kepada developer (berdasarkan harga kotor atau bersih transaksi). Saat membuat rencana pembagian keuntungan, Anda harus menunjukkan model pembagian, yang dapat berupa tetap atau fleksibel, dan dasar penetapan harga (seperti apakah pembagian keuntungan didasarkan pada harga kotor atau bersih transaksi). Anda menetapkan harga kotor atau bersih untuk transaksi saat membuat kebijakan pencatatan transaksi.

Dalam model pembagian tetap, Anda berbagi dengan developer persentase tetap dari pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga kotor atau bersih transaksi). Dalam model pembagian yang fleksibel, Anda berbagi persentase pendapatan yang bervariasi dengan developer. Pembagian keuntungan bergantung pada pendapatan yang dihasilkan selama jangka waktu tertentu. Persentase yang digunakan dalam penghitungan pembagian keuntungan dapat bervariasi berdasarkan jumlah pendapatan yang dihasilkan oleh transaksi.

Menentukan detail paket pembagian keuntungan menggunakan UI

Konfigurasikan paket pembagian keuntungan, seperti yang dijelaskan di bawah.

Menentukan detail paket pembagian keuntungan menggunakan API

Anda akan menentukan detail paket pembagian keuntungan 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 dalam properti ratePlanDetails, bergantung pada model berbagi yang Anda pilih: tetap atau fleksibel.

Menentukan detail paket pembagian keuntungan untuk model pembagian tetap

Untuk menerapkan model berbagi tetap, Anda harus menentukan hal berikut di detail paket tarif:

• Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi (VOLUME). VOLUME adalah default.
• Jenis pengukuran (UNIT) yang menunjukkan bahwa pembagian keuntungan bersifat tetap per unit (yaitu, tidak didasarkan pada volume transaksi, seperti halnya model pembagian yang fleksibel).
• Jenis pendapatan (GROSS atau NET). Ini menunjukkan apakah pembagian keuntungan didasarkan pada harga kotor atau bersih dari transaksi.
• 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 pembagian keuntungan. Karena model berbagi didasarkan pada tarif tetap, Anda hanya menentukan satu tarif paket tarif.

Lihat Properti konfigurasi untuk detail paket tarif untuk mengetahui daftar lengkap properti detail paket tarif.

Dalam tarif paket tarif, Anda menentukan:

• Jenis tarif paket tarif (REVSHARE).
• Persentase yang digunakan untuk menghitung pembagian keuntungan. Misalnya, jika Anda menentukan 80.5555, pembagian keuntungan adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar developer 80,5555% dari harga yang ditagih untuk setiap transaksi (atau jika didasarkan pada atribut kustom seperti jumlah byte yang dikirim dalam transaksi, Anda membayar developer 80,5555% dari harga yang ditagih untuk mengirimkan jumlah byte yang ditentukan).
• Unit awal penerapan tarif (0). Artinya, tarif diterapkan ke setiap transaksi, dimulai dengan transaksi pertama.

Lihat Properti konfigurasi untuk paket tarif untuk mengetahui daftar lengkap properti paket tarif.

Misalnya, contoh berikut membuat rencana pembagian keuntungan dengan model pembagian tetap. Persentase pembagian keuntungan adalah 80,5555%. Pembagian keuntungan didasarkan pada harga bersih transaksi. Kontrak berlaku mulai 15 September 2013, dan pembayaran jatuh tempo dalam 30 hari. (Detail terkait pembagian keuntungan ditandai.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Menentukan detail paket pembagian keuntungan untuk model pembagian yang fleksibel

Dalam model berbagi fleksibel, Anda menentukan detail paket tarif yang menyertakan satu atau beberapa tarif paket tarif. Setiap tarif paket tarif mencakup rentang pendapatan transaksi (setiap rentang disebut "rentang pendapatan"). Anda menetapkan persentase pembagian keuntungan untuk setiap rentang pendapatan.

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

• Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi (VOLUME). VOLUME adalah default.
• Jenis pengukuran (VOLUME) yang menunjukkan bahwa pembagian keuntungan tidak didasarkan pada volume transaksi (yaitu, tidak tetap, seperti yang terjadi pada model pembagian tetap).
• Jenis pendapatan (GROSS atau NET). Ini menunjukkan apakah pembagian keuntungan didasarkan pada harga kotor atau bersih dari transaksi.
• 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 pendapatan (ini juga disebut "dasar agregasi"). Transaksi digabungkan berdasarkan dasar agregasi (misalnya, 1 bulan) untuk menghitung total pendapatan dan rentang pendapatan yang berlaku. Persentase pembagian keuntungan yang diterapkan ke setiap transaksi bergantung pada rentang pendapatannya.
• Penghitung agregasi yang digunakan untuk menentukan rentang pendapatan yang berlaku.

Lihat Properti konfigurasi untuk detail paket tarif guna mengetahui daftar lengkap properti detail paket tarif.

Untuk setiap tarif paket tarif, Anda menentukan:

• Jenis tarif paket tarif untuk rentang pendapatan (REVSHARE).
• Persentase yang digunakan untuk menghitung pembagian keuntungan untuk band pendapatan. Misalnya, jika Anda menentukan 80,5555, bagi hasil untuk rentang pendapatan adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar developer 80,5555% dari harga yang ditagih untuk setiap transaksi dalam rentang pendapatan tersebut.
• Unit awal dan akhir dari band pendapatan. Unit awal menentukan batas bawah rentang pendapatan, dan unit akhir menentukan batas atas rentang pendapatan. Misalnya, jika Anda menentukan unit awal 0 dan unit akhir 1.000, rentang pendapatan akan mencakup pendapatan transaksi yang lebih besar dari 0 dan hingga 1.000 dalam mata uang yang ditentukan. Jika mata uangnya adalah dolar AS, dasar agregasi adalah 1 bulan, dan persentase untuk rentang pendapatan adalah 80,5555%, maka untuk transaksi yang menghasilkan pendapatan hingga $1.000 dalam sebulan, pembagian keuntungan adalah 80,5555% dari harga transaksi.

  Jika Anda tidak menentukan unit akhir untuk rentang pendapatan akhir, persentase pembagian untuk rentang tersebut akan diterapkan ke semua transaksi setelah pendapatan gabungan melebihi unit awal untuk rentang tersebut. Misalnya, jika unit awal untuk band terakhir adalah 1.000 (misalnya dolar AS), dan Anda tidak menentukan unit akhir untuk band tersebut, persentase pendapatan untuk band akan diterapkan ke semua transaksi di atas pendapatan sebesar $1. 000 selama periode gabungan.

Lihat Properti konfigurasi untuk paket tarif untuk mengetahui daftar lengkap properti paket tarif.

Misalnya, kode berikut membuat rencana pembagian keuntungan dengan model pembagian yang fleksibel. Ini menentukan dua rentang pendapatan. Band pertama mencakup pendapatan transaksi yang lebih besar hingga 1.000 dolar AS. Band kedua mencakup pendapatan transaksi di atas 1.000 dolar AS. Persentase pembagian keuntungan adalah 80,5555% untuk rentang pendapatan pertama, dan 90,5% untuk rentang pendapatan kedua. Pembagian keuntungan didasarkan pada harga bersih transaksi. Dasar agregasi adalah 1 bulan. Periode kontrak berlaku mulai 15 September 2013 dan pembayaran akan jatuh tempo dalam waktu 30 hari. (Detail terkait pembagian keuntungan ditandai.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}