Preislistenplan konfigurieren

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Einführung

Bei einem Preislistentarif wird dem Entwickler jede Transaktion in Rechnung gestellt. Für diesen Tarif müssen Sie zusätzliche Details wie das Abrechnungsmodell und Preise für das Abrechnungsmodell angeben.

Optional können Sie einen Freemium-Tarif für einzelne Produkte (statt für ein API-Paket) angeben – dies ist nur für einen produktspezifischen Tarif möglich.

Wann werden wiederkehrende Gebühren berechnet und Pakettarife zurückgesetzt?

Preispläne können wiederkehrende Gebühren sowie API-Pakete (Volume-Band- und Bundle-Tarife) enthalten, bei denen jeweils zu einem bestimmten Zeitpunkt Gebühren berechnet und Pakettarife auf null zurückgesetzt werden. In der folgenden Tabelle wird beschrieben, wann wiederkehrende Gebühren berechnet und die Anzahl der Sets zurückgesetzt wird. Wenn Entwickler-Apps daran gehindert werden, weitere API-Aufrufe auszuführen, weil ein bestimmtes Transaktionslimit erreicht wurde, wird die Anzahl der API-Aufrufe zu diesen Zeiten auf null zurückgesetzt und die Apps können wieder Aufrufe senden.

Abo mit...	...das passiert
Eine wiederkehrende Gebühr ungleich null, die auf Month (Monat) festgelegt ist Ein Volumen-Band- oder Bundle-Tarif	Die wiederkehrende Gebühr und der Paketplan werden am Ersten des Monats zurückgesetzt (Standardeinstellung). Erstellen Sie für eine monatliche Wiederholung an einem bestimmten Tag einen Preisplan mithilfe der Management API und geben Sie den Tag mit der Property RecurringStartUnit an, wie unter Preispläne mit der API erstellen beschrieben.
Eine wiederkehrende Gebühr ungleich null, die auf Woche festgelegt ist Ein Volumen-Band- oder Bundle-Tarif	Die wiederkehrende Gebühr und der Paketplan werden alle 7 Tage nach dem Startdatum des Preisplans des Entwicklers zurückgesetzt.
Eine wiederkehrende Gebühr ungleich null, die auf Day festgelegt ist Ein Volumen-Band- oder Bundle-Tarif	Die wiederkehrende Gebühr und der Paketplan werden alle X Tage nach dem Startdatum des Preisplans des Entwicklers zurückgesetzt.
Keine (oder eine Null-Dollar-) wiederkehrende Gebühr Ein Volumen-Band- oder Bundle-Tarif	Paketpläne werden anhand der in der Preisliste definierten Aggregationsgrundlage zurückgesetzt. Wenn ein Entwickler beispielsweise am 19. des Monats einen Preisplan startet und die Aggregationsgrundlage alle 1 Monat ist, wird die Bundle-Nutzung jeden Monat am 19. zurückgesetzt. Beachten Sie, dass der Tag des Monats nicht immer gleich ist. Wenn ein Preisplan beispielsweise am 31. Dezember beginnt, wird in einem Nicht-Schaltjahr der 28. Februar zurückgesetzt, da im Februar nur 28 Tage liegen. Der 28. Tag bleibt dann der zurückgesetzte Tag.

Preislistenpläne über die UI konfigurieren

Konfigurieren Sie Preislistenpläne wie unten beschrieben.

Preislistenplan mithilfe der API konfigurieren

Konfigurieren Sie die Preislistentarifdetails mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Preislistentarifdetails über die API angeben

Sie geben Details zum Preislistenplan an, wenn Sie den Preisplan erstellen. Die Details werden im Attribut ratePlanDetails im Anfragetext in einem Aufruf von /organizations/{org_name}/monetization-packages/{package_id}/rate-plans angegeben. Was Sie in der Eigenschaft ratePlanDetails angeben, hängt vom ausgewählten Abrechnungsmodell ab: Pauschalpreis, Band mit Band oder Pakete.

Pauschalpreismodell angeben

Zum Implementieren des Abrechnungsmodells „Pauschalpreis“ geben Sie in den Details des Tarifplans Folgendes an:

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen (VOLUME) oder einem benutzerdefinierten Attribut (z. B. MINT_CUSTOM_ATTRIBUTE_1) basiert. VOLUME ist die Standardeinstellung.
• Ein Metering-Typ (UNIT), der angibt, dass der Preis pro Einheit festgelegt ist. Das heißt, er basiert nicht auf dem Transaktionsvolumen, wie es beim Modell mit Band- oder Paketgebühren der Fall ist.
• Der Fälligkeitsdatum der Zahlung (z. B. 30 Tage).
• Die ID Ihrer Organisation.
• Die „Basis- oder Buchhaltungswährung“ Ihres Unternehmens.
• Ein Preisplanpreis, der Details zur Berechnung des Preises enthält. Da das Abrechnungsmodell auf einem festen Preis basiert, geben Sie nur einen Preis an.

Im Preisplan legen Sie Folgendes fest:

• Der Typ des Preisplans (RATECARD).
• Der Preis für den Plan. Wenn Sie beispielsweise 0,10 angeben und die Währung US-Dollar ist, werden dem Entwickler für jede Transaktion 0,10 $in Rechnung gestellt. Bei einem benutzerdefinierten Attribut, z. B. der Anzahl der bei einer Transaktion übertragenen Byte, werden dem Entwickler 0,10 $für die Übertragung der angegebenen Bytezahl in Rechnung gestellt.
• Die Starteinheit der Preisanwendung (0). Dies bedeutet, dass der Preis auf jede Transaktion angewendet wird, beginnend mit der ersten Transaktion.

Eine vollständige Liste der Preisplandetailoptionen finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im folgenden Beispiel wird ein Preislistenplan mit einem festen Abrechnungsmodell erstellt. Der Preis für jede Transaktion ist auf 0,10 $festgelegt. Die Zahlung ist in 30 Tagen fällig. Die Details zur Preisliste sind hervorgehoben.

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

Volumenband-Lademodell angeben

In einem Volumenbandmodell geben Sie Preisplandetails an, die einen oder mehrere Preisplanpreise enthalten. Jeder Preis gilt für ein "Volumenband", d. h. einen Bereich von Transaktionsvolumen (oder einen Bereich, der auf einem benutzerdefinierten Attribut wie der Anzahl der übertragenen Byte basiert). Diese Art von Tarif ist in der Regel darauf ausgelegt, Entwickler zu ermutigen, ein höheres Volumen zu generieren, indem sie Rabatte für größere Volumen anbieten.

Zusätzlich zu den Preisplanpreisen geben Sie in den Preisplandetails Folgendes an:

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen (VOLUME) oder einem benutzerdefinierten Attribut (z. B. CUSTOM_ATTRIBUTE_1) basiert. VOLUME ist die Standardeinstellung.
• Ein Metering-Typ (VOLUME), der angibt, dass der Preis auf dem Transaktionsvolumen basiert. Es handelt sich also nicht um einen Pauschalpreis pro Transaktion, wie es beim Pauschalpreismodell der Fall ist.
• Der Fälligkeitsdatum der Zahlung (z. B. 30 Tage).
• Die ID Ihrer Organisation.
• Die „Basis- oder Buchhaltungswährung“ Ihres Unternehmens.
• Ein Typ für Dauer und Dauer, der zusammen den Zeitraum angibt, über den das Transaktionsvolumen (oder das auf das benutzerdefinierte Attribut bezogene Volumen) aggregiert wird. Dies wird auch als „Aggregationsgrundlage“ bezeichnet. Das Transaktionsvolumen wird über die Aggregationsbasis aggregiert (z. B. 1 Monat), um das anwendbare Volumenband zu ermitteln.
• Zusammenfassungszähler, mit denen das anwendbare Volumenband ermittelt wird.

Für jeden Preisplanpreis geben Sie Folgendes an:

• Der Typ des Preisplans (RATECARD).
• Der Preis für den Plan. Wenn Sie beispielsweise 0,10 angeben und die Währung US-Dollar ist, werden dem Entwickler 0,15 $für jede Transaktion in Rechnung gestellt. Bei einem benutzerdefinierten Attribut, z. B. der Anzahl der bei einer Transaktion übertragenen Byte, werden dem Entwickler 0,15 $für die Übertragung der angegebenen Bytezahl in Rechnung gestellt.
• Start- und Endeinheit des Lautstärkebands. Die Starteinheit gibt die Untergrenze des Lautstärkebands und die Endeinheit die Obergrenze an. Wenn Sie beispielsweise eine Starteinheit von 0 und eine Endeinheit von 1.000 angeben, deckt das Volumenband im Aggregationszeitraum bis zu 1.000 Transaktionen ab. Wenn die Währung US-Dollar ist, beträgt der Aggregationszeitraum einen Monat und der Preis für die ersten 1.000 Transaktionen ist 0,15. Dem Entwickler werden 0,15 $pro Transaktion für bis zu 1.000 Transaktionen im Monat in Rechnung gestellt.
  
  Weitere Informationen dazu, wann Pakete zurückgesetzt werden, finden Sie unter Wann werden wiederkehrende Gebühren und Pakettarife zurückgesetzt?
  

  Wenn Sie keine Endeinheit für das endgültige Volumenband angeben, wird der Preis für dieses Band auf alle Transaktionen angewendet, nachdem die Anzahl der Transaktionen die Starteinheit für dieses Band überschritten hat. Wenn beispielsweise die Starteinheit für das letzte Band 1.000 ist und Sie keine Endeinheit für dieses Band angeben, wird der Satz für das Band auf alle Transaktionen nach 1.000 Transaktionen im Aggregationszeitraum angewendet.

Eine vollständige Liste der Preisplandetailoptionen finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im Folgenden wird beispielsweise ein Preislistenplan mit einem Abrechnungsmodell mit volumengebundenem Volumen erstellt. Der Preis ist auf 0,15 $für die ersten 1.000 Transaktionen und 0,10 $für alle Transaktionen über 1.000 festgelegt. Die Aggregationsgrundlage beträgt 1 Monat. Die Zahlung ist in 30 Tagen fällig. Die Details der Preisliste sind hervorgehoben.

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

Gebündeltes Abrechnungsmodell angeben

Bei einem gebündelten Abrechnungsmodell bezahlt der Entwickler im Voraus für ein „Bundle“ von Transaktionen (oder für ein Bundle basierend auf einem benutzerdefinierten Attribut wie der Anzahl der übertragenen Byte). Sie geben für jedes Bundle einen Preis und eine Aggregationsbasis an, d. h. einen Zeitraum, in dem der Entwickler das Bundle verwenden kann.

Angenommen, Sie richten zwei Bundles ein. Die erste Bundle-Größe beträgt 1 bis 1.000 Transaktionen und die zweite Bundle-Größe 1.001 bis 2.000 Transaktionen. Das erste Paket kostet 50 $und das zweite 40 $und die Aggregationsgrundlage ist 1. Wenn der Entwickler für das erste Paket eine Preisliste erwirbt, zahlt er im Voraus 50 $für 1.000 Transaktionen in einem Monat. Dem Entwickler wird der festgelegte Betrag in Rechnung gestellt, unabhängig davon, ob das Set vollständig genutzt wurde oder nicht. Nach Ablauf des Aggregationszeitraums läuft der Plan ab. Wenn der Entwickler das Set noch einmal verwenden möchte, muss er den Tarif und das Set noch einmal kaufen.

Die Angaben in den Preisplandetails entsprechen im Wesentlichen den Angaben in den Preisplandetails für das volumenbasierte Abrechnungsmodell. Es bestehen jedoch folgende Unterschiede:

• Jeder Preisplan, den Sie angeben, gilt für ein Paket und nicht für ein Volumenband.
• Du musst eine Obergrenze für das letzte Bundle angeben, es sei denn, du möchtest dem Entwickler einen festen Betrag für unbegrenzte Transaktionen im letzten Bundle in Rechnung stellen.

Eine vollständige Liste der Preisplandetailoptionen finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im folgenden Beispiel wird ein Preislistentarif mit einem gebündelten Abrechnungsmodell erstellt. Der Preis beträgt 50 $für das erste Bundle (bis zu 1.000 Transaktionen) und 40 $für das zweite Bundle (mehr als 1.000 und bis zu 2.000 Transaktionen). Die Aggregationsgrundlage beträgt 1 Monat. Die Zahlung ist in 30 Tagen fällig.

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

Einen Freemium-Tarif für einzelne Produkte über die API festlegen

In einer Preisliste können Sie einen Freemium-Tarif für ein einzelnes Produkt (anstatt für ein API-Paket) einrichten. Ein Freemium-Abo bietet Entwicklern die kostenlose Nutzung eines API-Produkts über einen bestimmten Zeitraum oder je nach Nutzungsumfang.

Wenn Sie einen Freemium-Plan für ein API-Produkt einrichten, geben Sie in den Details des Preislistenplans den Zeitraum an, in dem der Entwickler die vom API-Produkt bereitgestellten Ressourcen kostenlos nutzen kann. Der Zeitraum kann auf einer der folgenden Faktoren basieren:

• Dauer, d. h. die Zeit zwischen einem Datum des Inkrafttretens und einem Enddatum.
• Menge, z. B. die Anzahl der Transaktionen mit dem API-Produkt oder das Volumen eines benutzerdefinierten Attributs, das in der Transaktionsaufzeichnungsrichtlinie erfasst wurde.

Wenn der Freemium-Zeitraum auf der Menge basiert, geben Sie eine Anzahl von Freemium-Einheiten an. Im folgenden Beispiel wird ein Preislistenplan mit einem Freemium-Plan auf der Grundlage eines Volumens von 5.000 Einheiten erstellt. Die Freemium-bezogenen Spezifikationen sind hervorgehoben.

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