Melakukan penyesuaian penagihan

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

Pengantar

Monetisasi memungkinkan Anda membuat penyesuaian pada detail penagihan. Misalnya, Anda mungkin perlu menaikkan atau mengurangi pembagian keuntungan atau biaya untuk bulan penagihan tertentu karena ada perbedaan dalam data Anda.

Menjelajahi halaman Penyesuaian Penagihan

Akses halaman Penyesuaian Penagihan, seperti yang dijelaskan di bawah.

Menambahkan 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. Persentase positif menyesuaikan pembagian keuntungan atau biaya dalam transaksi berdasarkan persentase tersebut. Penyesuaian negatif akan menurunkan bagi hasil atau biaya dalam transaksi berdasarkan persentase tersebut. Masukkan angka desimal positif atau negatif (dengan maksimal dua angka di belakang koma).
   Bulan Penagihan	Bulan penagihan untuk penyesuaian. Pilih bulan dari menu drop-down.
   Jenis Transaksi	Jenis transaksi yang ingin Anda terapkan penyesuaian. Pilih nilai dari drop-down: Semua Transaksi Tagihan (mengenakan transaksi model) Pembelian (transaksi model pembagian keuntungan) Pengembalian dana (transaksi model pembagian keuntungan)
   Produk	Produk API yang ingin Anda terapkan penyesuaian. Anda tidak dapat menerapkan satu penyesuaian untuk beberapa produk API. Jika Anda perlu menerapkan penyesuaian untuk beberapa produk API, buat penyesuaian untuk setiap produk. Pilih produk API dari menu drop-down.
   Developer	Developer yang ingin Anda terapkan penyesuaian. Anda dapat menerapkan penyesuaian ke semua developer (secara default) atau ke developer tertentu. Pilih "Semua Developer" atau developer tertentu dari menu drop-down.

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, sebagaimana 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 mengajukan permintaan POST ke /organizations/{org_name}/billing-adjustments. Saat membuat permintaan, Anda menentukannya dalam isi permintaan:

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

Anda juga dapat menentukan properti lainnya, seperti:

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

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

Jika properti opsional tidak ditentukan, penyesuaian dokumen penagihan akan mencakup semua untuk properti tersebut. Misalnya, jika jenis transaksi tidak ditentukan, penyesuaian penagihan akan berlaku untuk semua jenis transaksi.

Contoh berikut membuat penyesuaian penagihan untuk bulan penagihan terbuka, Juni 2013. Penyesuaian ini mengurangi faktor sebesar 3%, dan diterapkan ke transaksi pembelian, produk pembayaran, dan developer pascabayar. Karena properti untuk mengidentifikasi paket API atau developer tertentu tidak ditentukan, penyesuaian akan diterapkan ke semua developer (yang merupakan 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

Responsnya 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 sebuah organisasi. Untuk melihat penyesuaian penagihan tertentu, ajukan permintaan GET ke /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, dengan {billing_adjustment_id} adalah identifikasi penyesuaian penagihan tertentu (ID 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 sebuah organisasi, berikan 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

Responsnya 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 dari penyesuaian penagihan tertentu. Saat melakukan pembaruan, Anda harus menentukan properti yang diperbarui dan identifikasi penyesuaian penagihan yang akan diperbarui dalam isi permintaan. Anda juga harus menentukan properti wajib 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 ke /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:

Nama	Deskripsi	Default	Wajib diisi?
name	Nama deskriptif untuk penyesuaian penagihan.	T/A	Ya
adjustmentPercentageFactor	Jumlah penyesuaian, sebagai persentase numerik positif atau negatif. Persentase positif menyesuaikan bagi hasil atau biaya dalam transaksi berdasarkan persentase tersebut. Persentase negatif menyesuaikan bagi hasil atau biaya dalam transaksi berdasarkan persentase tersebut. Nilai dapat berkisar dari -100 hingga 999,9999.	T/A	Ya
billingMonth	Bulan penagihan untuk penyesuaian penagihan, ditentukan sebagai bilangan bulat. Misalnya, 11 untuk Desember.	T/A	Ya
billingYear	Tahun penagihan untuk penyesuaian penagihan, yang ditentukan menggunakan format berikut: YYYY. Misalnya, 2017.	T/A	Ya
organization	Organisasi tempat penyesuaian penagihan diterapkan.	T/A	Ya
isPublished	Tanda yang menentukan apakah penyesuaian harus dipublikasikan. Nilainya dapat berupa salah satu dari berikut: true. Penyesuaian penagihan harus dipublikasikan. false. Penyesuaian penagihan tidak boleh dipublikasikan.	T/A	Tidak
transactionType	Jenis transaksi yang menerapkan penyesuaian penagihan. Jenisnya bisa berupa salah satu dari berikut: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS. Ini adalah transaksi yang digunakan untuk menyesuaikan kembali transaksi yang diberi rating. Callback ini dipanggil saat perubahan pajak dilakukan pada bulan penagihan sebelumnya.	T/A	Tidak
developerBillingType	Jenis penagihan developer yang menerapkan penyesuaian penagihan. Nilainya bisa berupa salah satu dari berikut ini: PREPAID.. Developer prabayar. POSTPAID. Developer pascabayar. BOTH. Developer prabayar dan pascabayar.	T/A	Tidak
product	Produk API yang menerapkan penyesuaian penagihan. Jika Anda tidak menentukan properti ini, penyesuaian penagihan akan berlaku untuk semua produk API.	T/A	Tidak
monetizationPackage	Paket API yang menerapkan penyesuaian penagihan. Jika Anda tidak menentukan properti ini, penyesuaian penagihan akan berlaku untuk semua paket API.	T/A	Tidak
developer	Developer yang penyesuaian penagihannya diterapkan. Jika Anda tidak menentukan properti ini, penyesuaian penagihan berlaku untuk semua developer.	T/A	Tidak

Langkah berikutnya

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