Melakukan penyesuaian penagihan

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

Pengantar

Monetisasi memungkinkan Anda melakukan penyesuaian pada detail penagihan. Misalnya, Anda mungkin perlu untuk menambah atau mengurangi pembagian keuntungan atau biaya untuk bulan penagihan tertentu karena perbedaan dalam catatan Anda.

Menjelajahi halaman Penyesuaian Penagihan

Akses halaman Penyesuaian Penagihan, seperti yang dijelaskan di bawah.

Tambahkan penyesuaian penagihan

Untuk menambahkan penyesuaian penagihan:

1. Akses halaman Penyesuaian Penagihan.
2. Klik + Penyesuaian.
3. Masukkan informasi berikut:

   Kolom	Deskripsi
   Nama	Nama deskriptif yang akan muncul di dokumen penagihan.
   % Penyesuaian	Jumlah penyesuaian, sebagai persentase positif atau negatif. Positif menyesuaikan bagi hasil atau biaya dalam transaksi dengan persentase. Penyesuaian negatif menyesuaikan pembagian keuntungan atau biaya pada transaksi sebesar persentase tersebut. Masukkan angka desimal positif atau negatif (dengan tanda sampai angka dua angka desimal).
   Bulan Penagihan	Bulan penagihan untuk penyesuaian. Pilih bulan dari menu drop-down.
   Jenis Transaksi	Jenis transaksi yang penyesuaiannya ingin Anda terapkan. Pilih dari menu drop-down: Semua Transaksi Tagihan (transaksi model pengisian daya) Pembelian (transaksi model pembagian keuntungan) Pengembalian dana (transaksi model pembagian keuntungan)
   Produk	Produk API yang penyesuaiannya ingin Anda terapkan. Anda tidak dapat menerapkan satu penyesuaian untuk beberapa produk API. Jika Anda perlu menerapkan penyesuaian pada beberapa produk API, buat penyesuaian untuk tiap produk. Pilih produk API dari menu drop-down.
   Developer	Developer yang penyesuaiannya ingin Anda terapkan. Anda dapat menerapkan penyesuaian untuk semua pengembang (secara {i>default<i}) atau pengembang tertentu. Pilih "Semua Developer" atau pengembang tertentu dari menu {i>drop-down<i}.

4. Klik Buat penyesuaian.

Mengedit penyesuaian penagihan

Untuk mengedit penyesuaian penagihan:

1. Akses halaman Penyesuaian Penagihan.
2. Arahkan kursor ke penyesuaian penagihan yang ingin Anda edit, lalu klik di menu tindakan.
3. Perbarui penyesuaian penagihan, jika diperlukan.
4. Klik Perbarui Penyesuaian.

Melakukan penyesuaian penagihan menggunakan API

Bagian berikut menjelaskan cara melakukan penyesuaian penagihan menggunakan API.

Membuat penyesuaian penagihan menggunakan API

Anda dapat menyesuaikan detail penagihan dengan mengeluarkan permintaan POST ke /organizations/{org_name}/billing-adjustments. Saat membuat permintaan, Anda menentukan di isi permintaan:

• Nama untuk penyesuaian penagihan.
• Persentase penyesuaian, yaitu nilai persentase positif atau negatif yang masing-masing akan meningkatkan atau mengurangi tagihan.
• Bulan penagihan.
• Tahun penagihan.
• Organisasi tempat penyesuaian penagihan diterapkan.

Anda juga dapat menentukan properti lainnya, seperti:

• Jenis transaksi yang penyesuaiannya ingin Anda terapkan (seperti pembelian transaksi).
• Developer yang penyesuaiannya ingin Anda terapkan.
• Apakah Anda ingin menerapkan penyesuaian untuk developer prabayar, developer pascabayar, atau keduanya.
• Paket API yang penyesuaiannya ingin Anda terapkan.
• Produk API yang penyesuaiannya ingin Anda terapkan.

Lihat Setelan konfigurasi penyesuaian penagihan untuk daftar lengkap properti penyesuaian penagihan yang dapat Anda tentukan dalam permintaan penyesuaian.

Jika properti opsional tidak ditentukan, maka penyesuaian dokumen penagihan adalah inklusif untuk properti tersebut. Misalnya, jika tidak ada jenis transaksi yang ditentukan, kolom penagihan penyesuaian akan berlaku untuk semua jenis transaksi.

Contoh berikut melakukan penyesuaian penagihan untuk bulan penagihan terbuka, Juni 2013. Tujuan pengurangan sebesar 3%, dan diterapkan ke transaksi pembelian, sebagai produk berbayar, dan developer pascabayar. Karena sifat untuk mengidentifikasi developer atau paket API tidak ditentukan, penyesuaian akan diterapkan ke semua developer (yang adalah developer pascabayar), dan produk pembayaran di semua paket API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

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

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

Melihat penyesuaian penagihan menggunakan API

Anda dapat melihat penyesuaian penagihan tertentu atau semua penyesuaian penagihan untuk suatu organisasi. Untuk melihat penyesuaian penagihan tertentu, kirim permintaan GET ke /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dengan {billing_adjustment_id} adalah identifikasi penyesuaian penagihan spesifik (ID tersebut ditampilkan dalam respons saat Anda membuat penyesuaian penagihan). Contoh:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Untuk melihat semua penyesuaian penagihan untuk organisasi, kirim permintaan GET ke /organizations/{org_name}/billing-adjustments. Contoh:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

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

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

Memperbarui penyesuaian penagihan menggunakan API

Anda dapat memperbarui penyesuaian penagihan dengan mengeluarkan permintaan PUT ke /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dengan {billing_adjustment_id} adalah identifikasi penyesuaian penagihan tertentu. Saat melakukan pembaruan, Anda perlu menentukan properti yang diperbarui dan atribut dalam isi permintaan identifikasi penyesuaian penagihan yang akan diperbarui. Anda juga harus menentukan properti untuk penyesuaian penagihan, yaitu, properti untuk nama, persentase penyesuaian, bulan penagihan, tahun penagihan, dan organisasi.

Misalnya, panggilan API berikut memperbarui nama dan faktor persentase penyesuaian ( properti yang diperbarui disorot dalam contoh):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Menghapus penyesuaian penagihan menggunakan API

Anda dapat menghapus penyesuaian penagihan dengan mengeluarkan permintaan DELETE untuk /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dengan {billing_adjustment_id} adalah identifikasi penyesuaian penagihan yang akan dihapus. Contoh:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Setelan konfigurasi penyesuaian penagihan untuk API

Opsi konfigurasi berikut tersedia untuk penyesuaian penagihan:

Langkah berikutnya

Monetisasi memberi Anda fleksibilitas untuk memberikan kredit kepada developer. Anda mungkin perlu melakukan ini jika developer tidak puas dengan layanan dan meminta pengembalian dana sebagian atau penuh atas penggunaan selama periode tertentu. Pelajari cara menerbitkan kredit di artikel Menerbitkan kredit.