Preislistenplan konfigurieren

Sie sehen sich die Dokumentation zu Apigee Edge an.
Rufen Sie die Dokumentation zu Apigee X auf. Weitere Informationen

Einführung

Bei einem Preisplan mit Preisliste wird dem Entwickler für jede Transaktion eine Gebühr berechnet. Für diesen Tarif müssen Sie zusätzliche Details angeben, z. B. das Abrechnungsmodell und die Preise für das Abrechnungsmodell.

Optional können Sie einen Freemium-Tarif für einzelne Produkte statt für ein API-Paket angeben. Dies ist nur bei einem produktspezifischen Tarif möglich.

Wann werden wiederkehrende Gebühren erhoben und Set-Pakete zurückgesetzt?

Preispläne können wiederkehrende Gebühren sowie API-Pakete (Volumen- und Pakettarife) umfassen. In beiden Tarifen können Gebühren anfallen und Pakettarife auf null zurückgesetzt werden. In der folgenden Tabelle wird beschrieben, wann wiederkehrende Gebühren in Rechnung gestellt 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, werden die Zähler für API-Aufrufe auf null zurückgesetzt und die Apps können wieder Aufrufe ausführen.

Wenn der Plan…	...passiert Folgendes:
Eine wiederkehrende Gebühr, die nicht null ist und auf Monat festgelegt ist Volumentarif oder Settarif	Die wiederkehrende Gebühr und das Paket werden am ersten des Monats zurückgesetzt (Standard). Wenn Sie ein monatliches wiederkehrendes Angebot an einem bestimmten Tag anbieten möchten, erstellen Sie ein Tarifpaket mit der Management API und geben Sie den Tag mit einer RecurringStartUnit-Eigenschaft an, wie unter Tarifpakete mit der API erstellen beschrieben.
Eine wiederkehrende Gebühr, die nicht null ist und auf Woche festgelegt ist Ein Volumen- oder Pakettarif	Die Rücksetzung der wiederkehrenden Gebühr und des Sets erfolgt alle sieben Tage nach dem Startdatum des Tarifs des Entwicklers.
Eine wiederkehrende Gebühr, die nicht null ist und auf Tag festgelegt ist Ein Volumen- oder Pakettarif	Die Rücksetzung der wiederkehrenden Gebühr und des Sets erfolgt alle X Tage nach dem Startdatum des Tarifs des Entwicklers.
Keine (oder eine Null-Dollar-) wiederkehrende Gebühr Ein Volumen- oder Pakettarif	Pakettarife werden basierend auf der auf der Preiskarte definierten Aggregationsbasis zurückgesetzt. Wenn ein Entwickler beispielsweise am 19. des Monats einen Tarifplan startet und die Aggregationsbasis jeden Monat ist, wird die Bundle-Nutzung jeden Monat am 19. des Monats zurückgesetzt. Der Tag des Monats ist möglicherweise nicht immer gleich. Wenn ein Preisplan beispielsweise am 31. Dezember beginnt, wird in einem Februar, der kein Schaltjahr ist, der 28. Tag, da der Februar nur 28 Tage hat. Der 28. ist dann immer der Tag, an dem das Zurücksetzen erfolgt.

Tarifkartenpläne über die Benutzeroberfläche konfigurieren

Konfigurieren Sie wie unten beschrieben Preislistenpläne.

Tarifkartenplan mit der API konfigurieren

Konfigurieren Sie die Details des Preislistenplans mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Details zu Preislistenplänen mithilfe der API angeben

Sie geben die Details zum Tarifplan an, wenn Sie ihn erstellen. Geben Sie die Details im Attribut ratePlanDetails im Anfragetext eines Aufrufs von /organizations/{org_name}/monetization-packages/{package_id}/rate-plans an. Was Sie im Attribut ratePlanDetails angeben, hängt vom ausgewählten Abrechnungsmodell ab: Pauschalpreis, Volumenband oder Sets.

Pauschalpreismodell angeben

Wenn Sie das Modell mit einem Pauschalpreis implementieren möchten, geben Sie in den Details zum Preisplan Folgendes an:

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen (VOLUME) oder auf einem benutzerdefinierten Attribut (z. B. MINT_CUSTOM_ATTRIBUTE_1) basiert. VOLUME ist der Standardwert.
• Ein Abrechnungstyp (UNIT), der angibt, dass der Preis pro Einheit festgelegt ist, d. h., er basiert nicht auf dem Transaktionsvolumen, wie es beim Abrechnungsmodell mit Volumenbeschränkung oder im Set-Preismodell der Fall ist.
• Der Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage).
• Die ID Ihrer Organisation.
• Die von Ihrem Unternehmen verwendete „Basiswährung“ oder „Rechnungswährung“.
• Ein Preisplanpreis, der Details zur Berechnung des Preises enthält. Da das Abrechnungsmodell auf einem festen Preis basiert, geben Sie nur einen Preisplanpreis an.

Geben Sie im Preisplan Folgendes an:

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

Eine vollständige Liste der Optionen für die Details des Preisplans finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im folgenden Beispiel wird beispielsweise ein Preiskartentarif mit einem festen Abrechnungsmodell erstellt. Der Preis ist auf 0,10 $pro Transaktion festgelegt. Die Zahlung ist in 30 Tagen fällig. Die preisbezogenen Details 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

Lademodell mit Speicherband angeben

Bei einem Modell mit Volumenbändern geben Sie Tarifdetails an, die einen oder mehrere Tarife enthalten. Jeder Tarif gilt für ein „Volumenband“, also einen Bereich des Transaktionsvolumens (oder einen Bereich, der auf einem benutzerdefinierten Attribut wie der Anzahl der übertragenen Bytes basiert). Diese Art von Plan ist in der Regel so eingerichtet, dass Entwickler durch Angabe von Rabatten für größere Volumenbänder höhere Volumen generieren können.

Neben den Preisen für das Preispaket geben Sie in den Details zum Preispaket Folgendes an:

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen (VOLUME) oder auf einem benutzerdefinierten Attribut (z. B. CUSTOM_ATTRIBUTE_1) basiert. VOLUME ist der Standardwert.
• Ein Abrechnungstyp (VOLUME), der angibt, dass der Preis auf dem Transaktionsvolumen basiert. Es handelt sich also nicht um einen Pauschalpreis pro Transaktion, wie es beim Modell mit Pauschalpreis der Fall ist.
• Der Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage).
• Die ID Ihrer Organisation.
• Die von Ihrem Unternehmen verwendete „Basiswährung“ oder „Rechnungswährung“.
• Eine Dauer und ein Dauertyp, die zusammen den Zeitraum angeben, über den das Transaktionsvolumen (oder das volumenbezogene benutzerdefinierte Attribut) zusammengefasst wird. Dies wird auch als „Aggregationsbasis“ bezeichnet. Das Transaktionsvolumen wird über die Aggregationsbasis (z. B. 1 Monat) aggregiert, um das entsprechende Volumenband zu ermitteln.
• Aggregationszähler, mit denen das anwendbare Lautstärkeband ermittelt wird.

Geben Sie für jeden Preisplan Folgendes an:

• Der Typ des Preisplanpreises (RATECARD).
• Der Preis für das Abo. 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. Wenn der Wert auf einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Bytes basiert, werden dem Entwickler 0,15 $für die Übertragung der angegebenen Anzahl von Bytes in Rechnung gestellt.
• Die Start- und Endeinheit des Lautstärkebereichs. Die Starteinheit gibt die Untergrenze des Lautstärkebereichs an und die Endeinheit die Obergrenze. Wenn Sie beispielsweise „0“ als Starteinheit und „1.000“ als Endeinheit angeben, umfasst das Volumenband bis zu 1.000 Transaktionen im Aggregationszeitraum. Wenn die Währung US-Dollar ist, der Aggregationszeitraum ein Monat und der Satz für die ersten 1.000 Transaktionen 0,15 % beträgt, werden dem Entwickler für bis zu 1.000 Transaktionen im Monat 0,15 $pro Transaktion in Rechnung gestellt.
  
  Weitere Informationen dazu, wann Pakete zurückgesetzt werden, finden Sie unter Wann werden wiederkehrende Gebühren erhoben und Paket-Tarife zurückgesetzt?.
  

  Wenn Sie für das letzte Volumenband kein Endkontingent angeben, wird der Preis für dieses Band auf alle Transaktionen angewendet, nachdem die Anzahl der Transaktionen das Startkontingent für dieses Band überschritten hat. Wenn die Starteinheit für den letzten Tarif beispielsweise 1.000 ist und Sie keine Endeinheit für diesen Tarif angeben, wird der Tarif für den Tarif auf alle Transaktionen nach 1.000 Transaktionen im Aggregationszeitraum angewendet.

Eine vollständige Liste der Optionen für die Details des Preisplans finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Mit dem folgenden Beispiel wird ein Preislistenplan mit einem Abrechnungsmodell mit Volumenband erstellt. Der Preis beträgt 0,15 $für die ersten 1.000 Transaktionen und 0,10 $für alle Transaktionen über 1.000. Die Aggregationsbasis ist ein Monat. Die Zahlung ist in 30 Tagen fällig. Die Preislistendetails 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

Modell für die Kombination aus Ladestation und Ladekabel angeben

Bei einem gebündelten Abrechnungsmodell zahlt der Entwickler (im Voraus) für ein „Bundle“ von Transaktionen oder für ein Bundle auf Grundlage eines benutzerdefinierten Attributs wie der Anzahl übertragener Byte. Sie geben für jedes Paket einen Preis und eine Aggregationsbasis an, also einen Zeitraum, in dem der Entwickler das Paket verwenden kann.

Angenommen, Sie richten zwei Pakete ein, bei denen das erste Paket 1 bis 1.000 Transaktionen und das zweite Paket 1.001 bis 2.000 Transaktionen umfasst. Der Preis beträgt 50 $für das erste Bundle und 40 $für das zweite Bundle und die Aggregationsbasis ist 1. Wenn der Entwickler einen Preislistenplan für das erste Paket kauft, zahlt er 50 $im Voraus für 1.000 Transaktionen pro Monat. Dem Entwickler wird der festgelegte Betrag in Rechnung gestellt, unabhängig davon, ob das Set vollständig verwendet wird. Nach Ablauf des Aggregationszeitraums läuft der Plan ab. Wenn der Entwickler das Bundle wieder verwenden möchte, muss er das Abo (und das Bundle) noch einmal kaufen.

Die Angaben in den Tarifdetails stimmen im Wesentlichen mit den Angaben in den Tarifdetails für das Modell mit Volumenbeschränkung überein. Es bestehen jedoch folgende Unterschiede:

• Jeder von dir angegebene Preisplan gilt für ein Set, nicht für einen Volumenbereich.
• Sie müssen ein Oberlimit für das letzte Paket angeben, es sei denn, Sie möchten dem Entwickler einen festen Betrag für unbegrenzte Transaktionen im letzten Paket in Rechnung stellen.

Eine vollständige Liste der Optionen für die Details des Preisplans finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im folgenden Beispiel wird beispielsweise ein Preiskartenplan mit einem gebündelten Abrechnungsmodell erstellt. Der Preis beträgt 50 $für das erste Paket (bis zu 1.000 Transaktionen) und 40 $für das zweite Paket (mehr als 1.000 und bis zu 2.000 Transaktionen). Die Aggregationsbasis ist ein 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

Freemium-Tarif für einzelne Produkte mithilfe der API angeben

In einem Preisplan können Sie einen Freemium-Tarif für ein einzelnes Produkt (nicht für ein API-Paket) einrichten. Ein Freemium-Tarif bietet Entwicklern die kostenlose Nutzung eines API-Produkts über einen bestimmten Zeitraum oder basierend auf der Nutzungsmenge.

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

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

Wenn der Freemium-Zeitraum auf der Stückzahl basiert, geben Sie ihn als Anzahl der Freemium-Einheiten an. Im folgenden Beispiel wird beispielsweise ein Preisplan mit einem Freemium-Tarif erstellt, der auf einem Volumen von 5.000 Einheiten basiert. Die Freemium-spezifischen 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