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 menaikkan atau menurunkan 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.

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 sebesar persentase tersebut. Penyesuaian negatif akan menyesuaikan penurunan pembagian keuntungan atau biaya dalam transaksi sebesar persentase tersebut. Masukkan bilangan desimal positif atau negatif (dengan hingga dua tempat desimal).
   Bulan Penagihan	Bulan penagihan untuk penyesuaian. Pilih bulan dari menu drop-down.
   Jenis Transaksi	Jenis transaksi yang ingin Anda terapkan penyesuaiannya. Pilih nilai dari menu drop-down: Semua Transaksi Biaya (transaksi model pengisian daya) Pembelian (transaksi model pembagian keuntungan) Pengembalian dana (transaksi model pembagian keuntungan)
   Produk	Produk API yang ingin Anda terapkan penyesuaiannya. Anda tidak dapat menerapkan satu penyesuaian ke beberapa produk API. Jika Anda perlu menerapkan penyesuaian pada beberapa produk API, buat penyesuaian untuk setiap produk. Pilih produk API dari menu drop-down.
   Developer	Developer yang ingin Anda terapkan penyesuaiannya. 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 sesuai kebutuhan.
4. Klik Perbarui Penyesuaian.

Melakukan penyesuaian penagihan menggunakan API

Bagian berikut menjelaskan cara melakukan penyesuaian penagihan menggunakan API.

Melakukan penyesuaian penagihan menggunakan API

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

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

Anda juga dapat menentukan properti lain, seperti:

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

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

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

Contoh berikut melakukan penyesuaian penagihan untuk bulan penagihan yang belum ditutup, Juni 2013. Penyesuaian ini mengurangi sebesar 3%, dan diterapkan pada 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 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 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 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

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 mengirimkan 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 identifikasi penyesuaian penagihan yang akan diperbarui dalam isi permintaan. Anda juga perlu menentukan properti wajib untuk penyesuaian penagihan, yaitu properti untuk nama, persentase penyesuaian, bulan penagihan, tahun penagihan, dan organisasi.

Misalnya, panggilan API berikut memperbarui faktor dan nama persentase penyesuaian (properti yang diperbarui ditandai 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 mengirimkan 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 tagihan untuk API

Opsi konfigurasi berikut tersedia untuk penyesuaian penagihan:

Langkah berikutnya

Monetisasi memberi Anda fleksibilitas untuk mengeluarkan 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 Memberikan kredit.