Ücret listesi planını yapılandırın

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Giriş

Ücret listesi planında geliştiriciden her işlem için ödeme alınır. Bu tür bir plan için ücretlendirme modeli ve ücretlendirme modelinin fiyatlandırması gibi ek ayrıntılar sağlamanız gerekir.

İsteğe bağlı olarak, API paketi yerine tek tek ürünler için bir freemium plan belirtebilirsiniz. Bunu yalnızca ürüne özel bir plan için yapabilirsiniz.

Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır?

Ücret planlarında yinelenen ücretler ve API paketleri (Hacimli Bantlı ve Paket planları) yer alabilir. Her ikisinde de ücret alınan ve paket planlarının sıfıra sıfırlandığı belirli zamanlar dahildir. Aşağıdaki tabloda, yinelenen ücretlerin ne zaman alındığı ve paket sayılarının sıfırlandığı durumlar açıklanmaktadır. Geliştirici uygulamalarının belirli bir işlem sınırına ulaşılması nedeniyle başka API çağrıları yapması engellenirse bu durumlarda API çağrısı sayılarının sıfırlandığı ve uygulamaların tekrar çağrı yapmaya başlayabileceği zamanlardır.

Plan...	...bu gerçekleştiğinde
Ay olarak ayarlanmış, sıfır olmayan bir yinelenen ücret. Hacim Bantlı veya Paket planı	Yinelenen ücret ve paket planı sıfırlaması ayın ilk gününde gerçekleşir (varsayılan). Belirli bir günde aylık bir yinelenme için Management API'yi kullanarak bir ücret planı oluşturun ve günü bir RecurringStartUnit mülküyle belirtin. Ayrıntılı bilgi için API'yi kullanarak ücret planları oluşturma başlıklı makaleye bakın.
Hafta olarak ayarlanmış, sıfır olmayan bir yinelenen ücret. Hacim Bantlı veya Paket planı	Yinelenen ücret ve paket planı sıfırlaması, geliştiricinin ücret planının başlangıç tarihinden sonraki 7 günde bir gerçekleşir.
Gün olarak ayarlanmış, sıfır olmayan bir yinelenen ücret Hacim Bantlı veya Paket planı	Yinelenen ücret ve paket planı sıfırlaması, geliştiricinin ücret planının başlangıç tarihinden X günde bir gerçekleşir.
Yinelenen ödeme yok (veya sıfır dolar) Hacim Bantlı veya Paket planı	Paket planlar, ücret listesinde tanımlanan Toplama Temeline göre sıfırlanır. Örneğin, bir geliştirici her ayın 19'unda ücret planı başlatırsa ve Toplama Temeli 1 ayda bir olursa paket kullanımı her ayın 19'unda sıfırlanır. Ayın gününün her zaman aynı olmayabileceğini unutmayın. Örneğin, ücret planı 31 Aralık'ta başlarsa Şubat ayında yalnızca 28 gün olduğu için sıfırlama tarihi, artık yıl olmayan bir Şubat ayında 28. gün olur. Daha sonra ayın 28'i, sıfırlandığı gün olarak kalır.

Kullanıcı arayüzünü kullanarak ücret listesi planlarını yapılandırma

Ücret listesi planlarını aşağıda açıklandığı gibi yapılandırın.

API'yi kullanarak ücret listesi planını yapılandırma

API'yi kullanarak ücret listesi planı ayrıntılarını aşağıdaki bölümlerde açıklandığı şekilde yapılandırın.

API'yi kullanarak ücret listesi planı ayrıntılarını belirtme

Ücret listesini oluştururken ücret listesi planı ayrıntılarını belirtirsiniz. Ayrıntıları, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans çağrısının istek gövdesinde yer alan ratePlanDetails özelliğinde belirtirsiniz. ratePlanDetails özelliğinde belirteceğiniz değerler, seçtiğiniz ödeme modeline bağlıdır: sabit ücret, bantlı hacim veya paketler.

Sabit ücretli ödeme modeli belirtme

Sabit ücret ödeme modelini uygulamak için ücret planı ayrıntılarında aşağıdakileri belirtirsiniz:

• Ücret planının işlemlere (VOLUME) veya özel bir özelliğe (örneğin, MINT_CUSTOM_ATTRIBUTE_1) dayalı olduğunu gösteren bir puan parametresi. Varsayılan değer VOLUME'dir.
• Ücretin birim başına sabit olduğunu belirten bir sayaç türü (UNIT).
• Son ödeme dönemi (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimidir.
• Ücretin nasıl hesaplandığıyla ilgili ayrıntılar sağlayan bir ücret planı ücreti. Ücretlendirme modeli sabit bir ücrete dayalı olduğundan yalnızca bir adet ücret planı ücreti belirtirsiniz.

Ücret planı ücretinde aşağıdakileri belirtirsiniz:

• Ücret planı ücretinin türü (RATECARD).
• Planın ücreti. Örneğin, 0, 10 değerini belirtirseniz ve para birimi ABD doları ise geliştiriciden her işlem için 0,10 ABD doları ücret alınır (veya bir işlemde aktarılan bayt sayısı gibi özel bir özelliğe dayanarak geliştiriciden belirtilen bayt sayısını iletmek için 0, 10 ABD doları ücret alınır).
• Ücret uygulamasının başlangıç birimi (0). Bu, fiyatın ilk işlemden başlayarak her işleme uygulandığı anlamına gelir.

Ücret planı ayrıntı seçeneklerinin tam listesi için Ücret planı ayrıntıları yapılandırma ayarları bölümüne bakın.

Örneğin, aşağıda sabit ücretlendirme modeli ile bir ücret listesi planı oluşturulmuştur. Ücret, her işlem için 0,10 ABD doları olarak ayarlanır. Ödemenin 30 gün içinde yapılması gerekir. (Ücret listesiyle ilgili ayrıntılar vurgulanmıştır.)

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

Hacim bantlı şarj modeli belirtme

Hacim bantlı modelde bir veya daha fazla ücret planı ücreti içeren ücret planı ayrıntılarını belirtirsiniz. Her ücret bir "hacim bandı", yani işlem hacmi aralığı (veya aktarılan bayt sayısı gibi özel bir özelliğe dayalı bir aralık) için geçerlidir. Bu plan türü, genellikle yüksek hacimli gruplar için indirimli fiyatlar sunarak geliştiricileri daha yüksek hacim elde etmeye teşvik etmek amacıyla oluşturulur.

Ücret planı ücretlerine ek olarak, ücret planı ayrıntılarında aşağıdakileri belirtirsiniz:

• Ücret planının işlemlere (VOLUME) veya özel bir özelliğe (örneğin, CUSTOM_ATTRIBUTE_1) dayalı olduğunu gösteren bir puan parametresi. Varsayılan değer VOLUME'dir.
• Ücretin işlem hacmine dayalı olduğunu gösteren bir sayaç türü (VOLUME). Diğer bir deyişle, sabit ücretli ödeme modelinde olduğu gibi işlem başına sabit bir ücret değildir.
• Son ödeme dönemi (örneğin, 30 gün).
• Kuruluşunuzun kimliği.
• Şirketinizin kullandığı "temel" veya muhasebe para birimidir.
• İşlem hacminin (veya özel özellikle ilgili hacmin) toplandığı süreyi birlikte belirten bir süre ve süre türü. Bu durum "toplama temeli" olarak da adlandırılır. İşlem hacmi, geçerli hacim aralığını belirlemek için toplama temelinde toplanır (örneğin, 1 ay).
• Geçerli hacim aralığını belirlemek için kullanılan toplama sayaçları.

Her bir ücret planı ücreti için aşağıdakileri belirtirsiniz:

• Ücret planı ücretinin türü (RATECARD).
• Planın ücreti. Örneğin, 0, 10 değerini belirtirseniz ve para birimi ABD doları ise geliştiriciden her işlem için 0,15 ABD doları ücret alınır (veya bir işlemde aktarılan bayt sayısı gibi özel bir özellik temel alınarak geliştiriciden belirtilen bayt sayısını iletmek için 0, 15 ABD doları ücret alınır).
• Ses seviyesi bandının başlangıç ve bitiş birimi. Başlangıç birimi, ses aralığı bandının alt sınırını, bitiş birimi ise ses aralığı bandının üst sınırını belirtir. Örneğin, başlangıç birimini 0, bitiş birimini 1.000 olarak belirtirseniz hacim aralığı, toplama döneminde en fazla 1.000 işlemi kapsar. Para birimi ABD doları ise toplama dönemi 1 ay ve ilk 1.000 işlemin oranı 0, 15 ise geliştiriciden bir aydaki en fazla 1.000 işlem için işlem başına 0, 15 ABD doları alınır.
  
  Paketlerin ne zaman sıfırlandığıyla ilgili ayrıntılı bilgi için Yinelenen ücretler ne zaman alınır ve paket planları ne zaman sıfırlanır? başlıklı makaleyi inceleyin.
  

  Son hacim aralığı için bir bitiş birimi belirtmezseniz bu aralığın ücreti, işlem sayısı bu grup için başlangıç biriminin üzerine çıktıktan sonra tüm işlemlere uygulanır. Örneğin, son aralığın başlangıç birimi 1.000 ise ve bu bant için bitiş birimi belirtmezseniz grubun ücreti, toplama döneminde 1.000 işlemden sonraki tüm işlemlere uygulanır.

Ücret planı ayrıntı seçeneklerinin tam listesi için Ücret planı ayrıntıları yapılandırma ayarları bölümüne bakın.

Örneğin, aşağıda hacimli bantlı ödeme modeline sahip bir ücret listesi planı oluşturulmuştur. Ücret, ilk 1.000 işlem için 0,15 ABD doları ve 1.000'in üzerindeki tüm işlemler için 0,10 ABD doları olarak belirlenir. Toplama 1 aydır. Ödemenin 30 gün içinde yapılması gerekir. (Ücret listesi ayrıntıları vurgulanmıştır.)

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

Paketlenmiş bir şarj modeli belirtme

Paket halinde sunulan bir ücretlendirme modelinde geliştirici, bir işlem "grubu" (veya aktarılan bayt sayısı gibi bir özel özelliğe dayalı bir paket) için (önden) ödeme yapar. Her paket için bir ücret ve toplama tabanlarını, yani geliştiricinin paketi kullanabileceği süreyi belirtirsiniz.

Örneğin, ilk paket boyutunun 1 ila 1.000 işlem ve ikinci paket boyutunun 1.001 ila 2.000 işlem olduğu iki paket oluşturduğunuzu varsayalım. Ücret, ilk paket için 50 ABD doları, ikinci paket için 40 ABD dolarıdır. Toplama yöntemi ise 1'dir. Geliştirici ilk paket için bir ücret listesi planı satın alırsa ayda 1.000 işlem için 50 ABD doları (önceden) öder. Paketi tamamen kullanılsın veya kullanılmasın, geliştiriciden belirlenen tutar tahsil edilir. Toplama dönemi sona erdiğinde planın süresi dolar. Geliştirici, paketi tekrar kullanmak isterse planı (ve paketi) tekrar satın almalıdır.

Ücret planı ayrıntılarında belirttiğiniz şeyler, temelde hacimli bantlı ödeme modelinin ücret planı ayrıntılarında belirttiğinizlerle aynıdır. Farklar aşağıda belirtilmiştir:

• Belirttiğiniz her ücret planı bir paket içindir (hacim aralığı yerine).
• Son pakette sınırsız işlemler için geliştiriciden sabit bir tutar almak istemediğiniz sürece son paket için bir üst sınır belirtmeniz gerekir.

Ücret planı ayrıntı seçeneklerinin tam listesi için Ücret planı ayrıntıları yapılandırma ayarları bölümüne bakın.

Örneğin, aşağıda gruplandırılmış ödeme modeli içeren bir ücret listesi planı oluşturulmaktadır. Ücret, ilk paket için 50 ABD doları (en fazla 1.000 işleme) ve ikinci paket için 40 ABD doları (1.000'den fazla ve 2.000'e kadar işlem) olarak belirlenir. Toplama 1 aydır. Ödemenin 30 gün içinde yapılması gerekir.

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

API'yi kullanarak her bir ürün için freemium ücretsiz plan belirtme

Ücret listesi planında, API paketi yerine tek bir ürün için ücretsiz premium plan oluşturabilirsiniz. Freemium plan, geliştiricilere bir API ürününü belirli bir süre boyunca veya kullanım miktarına göre ücretsiz olarak kullanma olanağı sunar.

Bir API ürünü için freemium plan oluştururken ücret listesinde, geliştiricinin API ürünü tarafından sağlanan kaynakları ücretsiz olarak kullanabileceği süreye ilişkin ayrıntıları belirtirsiniz. Süre, aşağıdakilerden birine dayalı olabilir:

• Süre, yani geçerlilik tarihi ile bitiş tarihi arasındaki süredir.
• Miktar (ör. API ürününü içeren işlem sayısı veya işlem kaydetme politikasında kaydedilen özel bir özelliğe ait hacim).

Freemium süresi miktara dayanıyorsa bunu satın alma opsiyonlu ücretsiz birimlerin sayısı olarak belirtin. Örneğin, aşağıda 5.000 birimlik hacmi temel alan freemium ücretsiz planla bir ücret listesi planı oluşturulur (satın alma opsiyonlu ücretsiz abonelikle ilgili özellikler vurgulanmıştır).

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