Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info
Einführung
Bei einem Preislistenmodell wird dem Entwickler jede Transaktion in Rechnung gestellt. Für diese Art von Plan müssen Sie zusätzliche Details angeben, z. B. das Abrechnungsmodell und die Preise für das Abrechnungsmodell.
Optional können Sie einen Freemium-Plan für einzelne Produkte (und nicht für ein API-Paket) angeben. Dies ist nur für einen produktspezifischen Plan möglich.
Wann werden wiederkehrende Gebühren berechnet und wann werden Bundle-Tarife zurückgesetzt?
Tarife können wiederkehrende Gebühren sowie API-Pakete (Volumen- und Paket-Tarife) enthalten. Bei beiden werden Gebühren zu bestimmten Zeiten berechnet und Paket-Tarife auf null zurückgesetzt. In der folgenden Tabelle wird beschrieben, wann wiederkehrende Gebühren berechnet und die Anzahl der Pakete zurückgesetzt wird. Wenn Entwickler-Apps aufgrund eines bestimmten Transaktionslimits keine weiteren API-Aufrufe mehr ausführen können, werden die Zähler für API-Aufrufe zu diesen Zeiten auf null zurückgesetzt und die Apps können wieder Aufrufe ausführen.
| Wenn der Plan Folgendes enthält: | …das passiert |
|---|---|
|
Die wiederkehrende Gebühr und der Tarif für das Paket werden standardmäßig am Ersten des Monats zurückgesetzt. Wenn Sie einen monatlichen Wiederholungszeitraum an einem bestimmten Tag festlegen möchten, erstellen Sie ein Tarifpaket mit der Management API und geben Sie den Tag mit dem Attribut |
|
Die wiederkehrende Gebühr und die Zurücksetzung des Paketplans erfolgen alle 7 Tage nach dem Startdatum des Tarifmodells des Entwicklers. |
|
Die wiederkehrende Gebühr und die Zurücksetzung des Paketplans erfolgen alle X Tage nach dem Startdatum des Tarifs des Entwicklers. |
|
Die Kontingente von Bundle-Tarifen werden basierend auf der in der Ratenkarte definierten Aggregationsgrundlage zurückgesetzt. Wenn ein Entwickler beispielsweise am 19. eines Monats einen Tarif startet und die Aggregationsgrundlage „alle 1 Monate“ lautet, wird die Nutzung des Pakets jeden Monat am 19. zurückgesetzt. Das Datum kann variieren. Wenn ein Tarif beispielsweise am 31. Dezember beginnt, wird das Rücksetzdatum im Februar eines Nicht-Schaltjahres zum 28. Februar, da der Februar nur 28 Tage hat. Der 28. bleibt dann für immer der Tag, an dem das Kontingent zurückgesetzt wird. |
Tarifkartenpläne über die Benutzeroberfläche konfigurieren
Konfigurieren Sie Tarifkartenpläne, wie unten beschrieben.
Edge
Wenn Sie einen Preislistenplan erstellen oder bearbeiten, wählen Sie den Preislistentyp Preisliste oder Preisliste und Umsatzbeteiligung aus und wählen Sie im Bereich Preisliste eines der folgenden Abrechnungsmodelle aus:
| Modell für adaptives Laden | Beschreibung |
| Pauschalpreis | Dem Entwickler wird für jede Transaktion ein fester Betrag in Rechnung gestellt. |
| Volumen mit Band | Dem Entwickler wird je nach Transaktionsvolumen ein variabler Satz berechnet. |
| Sets | Dem Entwickler wird für jedes Transaktionspaket ein bestimmter Betrag im Voraus in Rechnung gestellt. Dem Entwickler wird der festgelegte Betrag in Rechnung gestellt, unabhängig davon, ob das Paket vollständig genutzt wird.
Hinweis: Diese Option ist nicht verfügbar, wenn Sie „Preisliste und Umsatzbeteiligung“ auswählen. |
Konfigurieren Sie dann die folgenden Informationen basierend auf dem ausgewählten Abrechnungsmodell.
| Abrechnungsmodell | Feld | Beschreibung |
| Alle | Häufigkeit der Berechnung | Zeitraum, über den das Transaktionsvolumen (oder das Volumen in Bezug auf benutzerdefinierte Attribute) berechnet wird. Wählen Sie eine Anzahl von Monaten (1–24) aus. |
| Pauschalpreis | Pauschalpreis | Der für jede Transaktion berechnete Preis. Geben Sie eine Dezimalzahl (mit bis zu vier Dezimalstellen) ein.
Hinweis: Sie können die Anzahl der Dezimalstellen konfigurieren, die für den berechneten Preis über die API (nicht über die Benutzeroberfläche) angegeben werden können. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren. Wenn Sie beispielsweise „0,10“ eingeben und die Währung US-Dollar ist, werden dem Entwickler 0,10 $ für jede Transaktion in Rechnung gestellt. Wenn die Gebühr auf einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Byte basiert, werden dem Entwickler 0,10 $ für die Übertragung der angegebenen Anzahl von Byte in Rechnung gestellt. |
| Volumen mit Band | Volumenbereiche | Ein oder mehrere Bereiche für das Transaktionsvolumen (oder das auf Kundenattributen basierende Volumen) (jeder Bereich ist ein „Volumenbereich“) für das Abrechnungsmodell mit Volumenbereichen. Jedem Volumenbereich kann ein Tarif zugewiesen werden. Der Tarif wird auf alle Transaktionen im entsprechenden Volumenbereich angewendet. Geben Sie die Obergrenze des ersten Bereichs an, z. B. bis 1.000 (die Untergrenze ist auf „größer als 0“ voreingestellt).
Klicken Sie auf + Neu, um weitere Bereiche hinzuzufügen. Lassen Sie das obere Limit des letzten Bereichs leer, um alle Transaktionen über diesem Niveau anzugeben. Hinweis: Sie können die Anzahl der Dezimalstellen konfigurieren, die für den berechneten Preis über die API (nicht über die Benutzeroberfläche) angegeben werden können. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren. Wenn Sie beispielsweise im Abschnitt „Volumenbereich“ zwei Volumenbereiche angeben (>0–1.000 und 1.000 und mehr), können Sie für den Volumenbereich „>0–1.000“ 0,15 und für den Volumenbereich „1.000 und mehr“ 0,10 eingeben. Wenn die ausgewählte Währung US-Dollar ist, beträgt der Preis für die ersten 1.000 Transaktionen 0, 15 $ pro Transaktion und für mehr als 1.000 Transaktionen 0, 10 $ pro Transaktion. |
| Sets | Preise für API-Bundles | Anzahl der Transaktionen in einem Bundle oder eine Zahl, die sich auf ein benutzerdefiniertes Attribut bezieht, z. B. die Gesamtzahl der in einem Bundle übertragenen Byte. Jedem Bundle kann ein Preis zugewiesen werden. Der Preis gilt für das gesamte Set. Geben Sie die Obergrenze des ersten Bündels an, z. B. bis zu 1.000 (die Untergrenze ist auf „größer als 0“ voreingestellt).
Klicken Sie auf + Neu, um weitere Pakete hinzuzufügen. Sie müssen ein oberes Limit 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. Hinweis: Sie können die Anzahl der Dezimalstellen konfigurieren, die für den berechneten Preis über die API (nicht über die Benutzeroberfläche) angegeben werden können. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren. Wenn Sie beispielsweise zwei Bundles im Bereich „Bundle-Größe“ angeben (größer als 0 bis 1.000 und größer als 1.000 bis 2.000), können Sie für das Bundle „größer als 0 bis 1.000“ den Wert 50 und für das Bundle „größer als 1.000 bis 2.000“ den Wert 40 eingeben. Wenn die ausgewählte Währung US-Dollar ist, beträgt der Preis für das erste Paket 50 $ und für das zweite Paket 40 $. Dem Entwickler wird der anwendbare Paketpreis in Rechnung gestellt, unabhängig davon, wie viele Transaktionen er innerhalb des Pakets nutzt. Das heißt, der Entwickler zahlt den Paketpreis, sobald die erste Transaktion im Paket abgeschlossen ist. |
Wenn Sie benutzerdefinierte Attribute für Ihr API-Produkt definiert haben, können Sie einen benutzerdefinierten Abrechnungsparameter konfigurieren, um dem App-Entwickler die Kosten basierend auf einem benutzerdefinierten Attribut innerhalb jeder Transaktion in Rechnung zu stellen. Wenn Sie beispielsweise ein Modell einrichten, bei dem Sie dem Entwickler jede Transaktion in Rechnung stellen, können Sie den Tarif für das Modell anhand eines benutzerdefinierten Attributs festlegen, z. B. der Anzahl der im Backend übertragenen Byte, die je nach Transaktion variieren kann.
Wählen Sie in diesem Fall Benutzerdefinierten Bewertungsparameter verwenden aus und wählen Sie das benutzerdefinierte Attribut aus der Liste aus. Weitere Informationen finden Sie unter Ratenplan mit benutzerdefinierten Attributen konfigurieren.
Classic Edge (Private Cloud)
So konfigurieren Sie Tarifkartenpläne über die klassische Edge-Benutzeroberfläche:
- Folgen Sie der Anleitung zum Erstellen eines Ratenplans.
- Wählen Sie im Drop-down-Menü „Tarifplantyp“ die Option Rate Card aus, um das Umsatzmodell zu konfigurieren.
- Wenn das ausgewählte API-Paket mehrere API-Produkte enthält, wählen Sie eine der folgenden Optionen aus:
Hinweis: Wenn das API-Paket nur ein API-Produkt enthält, können Sie diesen Schritt überspringen.
- Produktspezifische Pläne, um Preisplandetails für jedes API-Produkt einzeln zu konfigurieren.
- Allgemeiner Plan für alle Produkte, um Preisplandetails für alle API-Produkte zu konfigurieren.
- Klicken Sie für den generischen Preisplan oder für jeden API-produktbezogenen Preisplan auf Preisliste.
Hinweis: Wenn Sie API-produktspezifische Pläne konfigurieren, müssen Sie für jedes API-Produkt einen Tarifkartenplan konfigurieren.
Das Fenster „Rate Card“ wird geöffnet.
- Freemium-Plan für ein API-Produkt einrichten Mit einem Freemium-Tarif können Entwickler ein API-Produkt über einen bestimmten Zeitraum oder basierend auf der Nutzungsmenge kostenlos nutzen.
Geben Sie die folgenden Informationen ein:
Feld Beschreibung Freemium-Produkt? Umfang des kostenlosen Zeitraums. Wählen Sie eines der folgenden Optionsfelder aus:
- Nach Menge. Der kostenlose Zeitraum basiert auf einer Menge, die im Feld „Volume“ angegeben ist.
- Nach Dauer. Der Gebührenzeitraum basiert auf einem im Feld „Freemium Duration“ (Freemium-Dauer) angegebenen Zeitintervall.
- Je nachdem, was zuerst eintritt. Der kostenlose Zeitraum endet, wenn entweder die Menge im Feld „Volume“ oder das Zeitintervall im Feld „Freemium Duration“ erreicht wird – je nachdem, was zuerst eintritt.
- Nein, das ist kein Freemium-Plan. Das ist die Standardeinstellung.
Freemium-Volumen Das Transaktionsvolumen (oder das Volumen eines benutzerdefinierten Attributs, das in der Richtlinie zur Aufzeichnung von Transaktionen erfasst wird), für das Entwicklern keine Gebühren berechnet werden. Das Volumen wird für das API-Produkt gemessen. Geben Sie eine Lautstärkenummer ein, z. B. 5000. Das bedeutet, dass Entwicklern bei Beginn des Plans die ersten 5.000 Transaktionen (oder die ersten 5.000 Verwendungen eines Elements, das mit einem benutzerdefinierten Attribut verknüpft ist) nicht in Rechnung gestellt werden. Dieses Feld ist nur aktiviert, wenn Sie im Feld „Freemium-Produkt?“ die Option „Nach Menge“ oder „Je nachdem, was zuerst eintritt“ auswählen.
Freemium-Dauer Das Zeitintervall, in dem Entwicklern keine Gebühren berechnet werden. Geben Sie eine Zahl ein und wählen Sie einen Zeitraum aus, z. B. „1 Monat“. Das bedeutet, dass Entwicklern für einen Monat keine Gebühren berechnet werden. Dieses Feld ist nur aktiviert, wenn Sie im Feld „Freemium-Produkt?“ die Option „Nach Dauer“ oder „Je nachdem, was zuerst eintritt“ auswählen.
- Wählen Sie eines der folgenden Abrechnungsmodelle aus:
- Pauschalpreis. Bei diesem Modell wird dem Entwickler für jede Transaktion ein fester Betrag in Rechnung gestellt.
- Mit Band Bei diesem Modell wird dem Entwickler ein variabler Satz in Rechnung gestellt, der vom Transaktionsvolumen abhängt.
- Pakete. Bei diesem Modell wird dem Entwickler für jedes Transaktionsbündel ein bestimmter Betrag (im Voraus) in Rechnung gestellt. Dem Entwickler wird der festgelegte Betrag in Rechnung gestellt, unabhängig davon, ob das Paket vollständig genutzt wird.
Für das Pauschalpreismodell:Geben Sie im Bereich „Preise“ des Fensters „Allgemeine Preisliste“ die folgenden Informationen ein:
Feld Beschreibung Operator (oder Organisation) Der Name deiner Organisation. Dieses Feld wird mit dem Wert des Felds „Operator“ (oder „Organisation“) im Organisationsprofil voreingestellt.
Land Das Land, in dem Ihre Organisation tätig ist. Dieses Feld wird mit dem Wert des Felds „Land“ im Organisationsprofil vorausgefüllt.
Pauschalpreis Der für jede Transaktion berechnete Satz. Geben Sie eine Dezimalzahl mit bis zu vier Dezimalstellen ein.
Hinweis: Sie können die Anzahl der Dezimalstellen, die für den berechneten Preis angegeben werden können, über die API (nicht über die Benutzeroberfläche) konfigurieren. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren.
Wenn Sie beispielsweise „0,10“ eingeben und die Währung US-Dollar ist, werden dem Entwickler 0,10 $ für jede Transaktion in Rechnung gestellt. Wenn die Gebühr auf einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Byte basiert, werden dem Entwickler 0,10 $ für die Übertragung der angegebenen Anzahl von Byte in Rechnung gestellt.
Für das volumenbasierte Modell:Im Fenster „Generic Rate Card“ werden zusätzliche Felder angezeigt, mit denen Sie eine Grundlage für die Aggregation und „Volumenbereiche“ angeben können. Das sind Bereiche für das Transaktionsvolumen, für die Sie unterschiedliche Raten anwenden können.
Diese Art von Plan wird in der Regel eingerichtet, um Entwickler zu ermutigen, höhere Volumina zu generieren, indem Rabatte für höhere Volumengruppen angeboten werden.
Geben Sie im Fenster „Generic Rate Card“ (Allgemeine Preisliste) die folgenden Informationen ein:
Feld Beschreibung Aggregationsgrundlage Der Zeitraum, über den das Transaktionsvolumen (oder das Volumen in Bezug auf benutzerdefinierte Attribute) aggregiert wird. Das aggregierte Volumen wird verwendet, um das Volumenband und den auf jede Transaktion anzuwendenden Tarif zu ermitteln. Wählen Sie eine Anzahl von Monaten aus (1–12 Monate).
Weitere Informationen dazu, wann Pakete zurückgesetzt werden, finden Sie unter Wann werden wiederkehrende Gebühren berechnet und Paketpläne zurückgesetzt?
Volumenbereiche Ein oder mehrere Bereiche für das Transaktionsvolumen (oder das auf Kundenattributen basierende Volumen). Jeder Bereich ist ein „Volumenbereich“. Jedem Volumenbereich kann ein Tarif zugewiesen werden. Sie legen diesen Tarif im Feld „Volumenbereiche“ im Abschnitt „Preise“ fest. Der Prozentsatz wird auf alle Transaktionen im entsprechenden Volumenbereich angewendet. Geben Sie die Obergrenze des ersten Bereichs an, z. B. bis 1.000 (die Untergrenze ist auf „größer als 0“ voreingestellt). Klicken Sie auf +, um ein zweites Band hinzuzufügen, z. B. „Größer als 1.000 bis 2.000“. Klicken Sie auf das Pluszeichen, um weitere Bereiche hinzuzufügen. Sie können die Obergrenze des letzten Bereichs leer lassen, um alle Transaktionen über diesem Niveau anzugeben.
Preise Operator (oder Organisation) Der Name deiner Organisation. Dieses Feld wird mit dem Wert des Felds „Betreiber“ (oder „Organisation“) im Organisationsprofil voreingestellt.
Land Das Land, in dem Ihre Organisation tätig ist. Dieses Feld wird mit dem Wert des Felds „Land“ im Organisationsprofil vorausgefüllt.
Währung Die „Basis“- oder Abrechnungswährung, die Ihre Organisation verwendet. Dieses Feld wird mit dem Wert des Felds „Währung“ im Organisationsprofil vorausgefüllt, kann aber hier geändert werden.
Volumenbereiche Der Preis für ein Volumenband. Sie geben einen Preis für jedes Volumenband an. Geben Sie für jedes Band eine Dezimalzahl mit bis zu vier Dezimalstellen ein.
Hinweis: Sie können die Anzahl der Dezimalstellen, die für den Volumenbandtarif angegeben werden können, über die API (nicht über die Benutzeroberfläche) konfigurieren. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren.
Wenn Sie beispielsweise im Bereich „Volumenbereich“ zwei Volumenbereiche angeben (>0–1.000 und 1.000 und mehr), können Sie für den Volumenbereich „>0–1.000“ 0,15 und für den Volumenbereich „1.000 und mehr“ 0,10 eingeben. Wenn die ausgewählte Währung US-Dollar ist, beträgt der Preis für die ersten 1.000 Transaktionen 0, 15 $ pro Transaktion und für mehr als 1.000 Transaktionen 0, 10 $ pro Transaktion.
Für das gebündelte Modell:Im Fenster „Generic Rate Card“ werden zusätzliche Felder angezeigt, mit denen Sie eine Grundlage für die Aggregation (den Zeitraum, in dem der Entwickler das Transaktionspaket verwenden kann) und paketbezogene Informationen wie die Größe eines Pakets angeben können.
Geben Sie im Fenster „Generic Rate Card“ (Allgemeine Preisliste) die folgenden Informationen ein:
Feld Beschreibung Aggregationsgrundlage Der Zeitraum, in dem der Entwickler das Transaktionsbündel oder ein benutzerdefiniertes attributbasiertes Bündel verwenden kann. Wählen Sie eine Anzahl von Monaten (1–12) aus. Danach läuft das Abo ab und der Entwickler muss es (und die Pakete) noch einmal kaufen.
Weitere Informationen dazu, wann Pakete zurückgesetzt werden, finden Sie unter Wann werden wiederkehrende Gebühren berechnet und Paketpläne zurückgesetzt?
Bundle-Größe Die Anzahl der Transaktionen in einem Bundle oder eine Zahl, die sich auf ein benutzerdefiniertes Attribut bezieht, z. B. die Gesamtzahl der in einem Bundle übertragenen Byte. Jedem Paket kann ein Preis zugewiesen werden. Sie legen diesen Preis im Feld „Paketgröße“ im Bereich „Preise“ fest. Der Preis gilt für das gesamte Set. Geben Sie die Obergrenze des ersten Bündels an, z. B. bis zu 1.000 (die Untergrenze ist auf „größer als 0“ voreingestellt). Klicken Sie auf das Pluszeichen, um ein zweites Bündel hinzuzufügen, z. B. „größer als 1.000 bis 2.000“. Klicken Sie auf das Pluszeichen, um weitere Bundles hinzuzufügen. Sie müssen ein oberes Limit 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.
Preise Operator (oder Organisation) Der Name deiner Organisation. Dieses Feld wird mit dem Wert des Felds „Betreiber“ (oder „Organisation“) im Organisationsprofil voreingestellt.
Land Das Land, in dem Ihre Organisation tätig ist. Dieses Feld wird mit dem Wert des Felds „Land“ im Organisationsprofil vorausgefüllt.
Währung Die „Basis“- oder Abrechnungswährung, die Ihre Organisation verwendet. Dieses Feld wird mit dem Wert des Felds „Währung“ im Organisationsprofil vorausgefüllt, kann aber hier geändert werden.
Bundle-Größe (Preis) Der Preis für ein Set. Sie geben einen Preis für jedes Bundle an. Geben Sie eine Dezimalzahl (mit bis zu vier Dezimalstellen) ein.
Hinweis: Sie können die Anzahl der Dezimalstellen, die für den Paketpreis angegeben werden können, über die API (nicht über die Benutzeroberfläche) konfigurieren. Weitere Informationen finden Sie unter Anzahl der Dezimalstellen für Raten von Ratenplänen konfigurieren.
Wenn Sie beispielsweise im Bereich „Bundle-Größe“ zwei Bundles angeben (größer als 0 bis 1.000 und größer als 1.000 bis 2.000), können Sie für das Bundle „größer als 0 bis 1.000“ den Wert 50 und für das Bundle „größer als 1.000 bis 2.000“ den Wert 40 eingeben. Wenn die ausgewählte Währung US-Dollar ist, beträgt der Preis für das erste Paket 50 $ und für das zweite Paket 40 $. Dem Entwickler wird der anwendbare Paketpreis in Rechnung gestellt, unabhängig davon, wie viele Transaktionen er innerhalb des Pakets nutzt. Das heißt, dem Entwickler wird der Paketpreis in Rechnung gestellt, sobald die erste Transaktion im Paket abgeschlossen ist.
- Klicken Sie auf Anwenden und schließen, um die Details der Ratenkarte zu speichern und zum Fenster „Standardtarifpaket“ zurückzukehren.
- Konfigurieren Sie für API-produktspezifische Tarifpakete die Tarifpaketdetails für zusätzliche API-Produkte nach Bedarf.
Tarifpaket mit der API konfigurieren
Konfigurieren Sie die Details des Ratenkartenplans mithilfe der API, wie in den folgenden Abschnitten beschrieben.
Tarifpaketdetails mit der API angeben
Sie geben die Details des Ratenkartenplans an, wenn Sie den Ratenplan erstellen. Die Details werden im Attribut ratePlanDetails im Anfragetext eines Aufrufs von /organizations/{org_name}/monetization-packages/{package_id}/rate-plans angegeben. Was Sie in der ratePlanDetails-Eigenschaft angeben, hängt vom ausgewählten Abrechnungsmodell ab: Pauschaltarif, volumenbasiert oder Pakete.
Pauschalpreis-Abrechnungsmodell angeben
Wenn Sie das Pauschalpreis-Abrechnungsmodell implementieren möchten, geben Sie in den Preisplandetails Folgendes an:
- Ein Abrechnungsparameter, der angibt, ob der Tarif auf Transaktionen (
VOLUME) oder auf einem benutzerdefinierten Attribut (z. B.MINT_CUSTOM_ATTRIBUTE_1) basiert.VOLUMEist der Standardwert. - Ein Abrechnungstyp (
UNIT), der angibt, dass der Preis pro Einheit festgelegt ist. Er basiert also nicht auf dem Transaktionsvolumen wie beim Abrechnungsmodell mit Volumenstaffelung oder bei Paketen. - Der Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage).
- Die ID Ihrer Organisation.
- Die „Basis“- oder Abrechnungswährung, die Ihr Unternehmen verwendet.
- Ein Tarif, der Details zur Berechnung des Preises enthält. Da das Abrechnungsmodell auf einem festen Preis basiert, geben Sie nur einen Preisplanpreis an.
Im Tarifplan geben Sie 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,10 $ für jede Transaktion berechnet. Wenn die Gebühr auf einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Byte basiert, werden dem Entwickler 0,10 $ für die Übertragung der angegebenen Anzahl von Byte berechnet.
- Die Starteinheit der Ratenanwendung (
0). Das bedeutet, dass die Rate auf jede Transaktion angewendet wird, beginnend mit der ersten Transaktion.
Eine vollständige Liste der Optionen für Tarifdetails finden Sie unter Konfigurationseinstellungen für Tarifdetails.
Mit dem folgenden Code wird beispielsweise ein Preislistenplan mit einem festen Abrechnungsmodell erstellt. Der Satz beträgt 0,10 $ pro Transaktion. 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
Ein volumenbasiertes Abrechnungsmodell angeben
In einem volumenbasierten Modell geben Sie Tarifdetails an, die einen oder mehrere Tarifpreise enthalten. Jeder Preis gilt für ein „Volumenband“, d. h. einen Bereich des Transaktionsvolumens oder einen Bereich, der auf einem benutzerdefinierten Attribut wie der Anzahl der übertragenen Byte basiert. Diese Art von Plan wird in der Regel eingerichtet, um Entwickler zu einem höheren Volumen zu ermutigen, indem für höhere Volumenbereiche Rabatte angeboten werden.
Zusätzlich zu den Tarifpaketpreisen geben Sie in den Tarifpaketdetails Folgendes an:
- Ein Abrechnungsparameter, der angibt, ob der Tarif auf Transaktionen (
VOLUME) oder auf einem benutzerdefinierten Attribut (z. B.CUSTOM_ATTRIBUTE_1) basiert.VOLUMEist 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 beim Pauschalabrechnungsmodell. - Der Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage).
- Die ID Ihrer Organisation.
- Die „Basis“- oder Abrechnungswährung, die Ihr Unternehmen verwendet.
- Eine Dauer und ein Dauertyp, die zusammen den Zeitraum angeben, über den das Transaktionsvolumen (oder das Volumen in Bezug auf benutzerdefinierte Attribute) aggregiert wird. Dies wird auch als „Aggregationsgrundlage“ bezeichnet. Das Transaktionsvolumen wird über die Aggregationsgrundlage (z. B. 1 Monat) hinweg aggregiert, um den anwendbaren Volumenbereich zu ermitteln.
- Aggregationszähler, die zum Bestimmen des anwendbaren Volumenbereichs verwendet werden.
Für jeden Tarif geben Sie 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 berechnet. Wenn die Gebühr auf einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Byte basiert, werden dem Entwickler 0,15 $ für die Übertragung der angegebenen Anzahl von Byte berechnet.
- Die Start- und End-Einheit des Volumens. Die Starteinheit gibt die Untergrenze des Volumens an und die Endeinheit die Obergrenze. Wenn Sie beispielsweise eine Starteinheit von 0 und eine Endeinheit von 1.000 angeben, umfasst das Volumenband bis zu 1.000 Transaktionen im Aggregationszeitraum. Wenn die Währung US-Dollar ist, der Aggregationszeitraum 1 Monat beträgt und der Preis für die ersten 1.000 Transaktionen 0,15 $ ist, werden dem Entwickler für bis zu 1.000 Transaktionen im Monat 0,15 $ pro Transaktion berechnet.
Weitere Informationen dazu, wann Pakete zurückgesetzt werden, finden Sie unter Wann werden wiederkehrende Gebühren berechnet und Paketpläne zurückgesetzt?
Wenn Sie keine Endeinheit für das letzte Volumenband angeben, wird der Tarif für dieses Band auf alle Transaktionen angewendet, nachdem die Anzahl der Transaktionen die Start-Einheit für dieses Band überschritten hat. Wenn die Startmenge für das letzte Band beispielsweise 1.000 ist und Sie keine Endmenge für dieses Band angeben, wird der Tarif für das Band auf alle Transaktionen nach 1.000 Transaktionen im Aggregationszeitraum angewendet.
Eine vollständige Liste der Optionen für Tarifdetails finden Sie unter Konfigurationseinstellungen für Tarifdetails.
Mit dem folgenden Beispiel wird ein Tarifplan mit einem Abrechnungsmodell mit Volumestufen 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 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 zahlt der Entwickler im Voraus für ein „Paket“ von Transaktionen oder für ein Paket, das auf einem benutzerdefinierten Attribut wie der Anzahl der übertragenen Byte basiert. Sie geben für jedes Paket einen Preis und eine Aggregationsgrundlage an, d. h. einen Zeitraum, in dem der Entwickler das Paket verwenden kann.
Angenommen, Sie richten zwei Pakete ein, wobei 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 und 40 $ für das zweite Bundle. Die Aggregationsbasis ist 1. Wenn der Entwickler ein Rate Card-Abo für das erste Bundle kauft, zahlt er 50 $ (im Voraus) für 1.000 Transaktionen in einem Monat. Dem Entwickler wird der festgelegte Betrag in Rechnung gestellt, unabhängig davon, ob das Paket vollständig genutzt wird. Nach Ablauf des Aggregationszeitraums läuft das Abo ab. Wenn der Entwickler das Paket noch einmal verwenden möchte, muss er den Plan (und das Paket) noch einmal kaufen.
Die Angaben in den Tarifpaketdetails sind im Wesentlichen dieselben wie für das Abrechnungsmodell mit Volumengruppen. Es bestehen jedoch folgende Unterschiede:
- Jeder von Ihnen angegebene Tarif gilt für ein Paket (nicht für einen Volumenbereich).
- Sie müssen ein oberes Limit 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 Tarifdetails finden Sie unter Konfigurationseinstellungen für Tarifdetails.
Mit dem folgenden Beispiel wird ein Preislistenplan mit einem gebündelten Abrechnungsmodell erstellt. Der Preis für das erste Paket (bis zu 1.000 Transaktionen) beträgt 50 $ und für das zweite Paket (mehr als 1.000 und bis zu 2.000 Transaktionen) 40 $. Die Aggregationsbasis 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
Freemium-Tarif für einzelne Produkte über die API angeben
In einem Preislistenmodell können Sie ein Freemium-Modell für ein einzelnes Produkt (und nicht für ein API-Paket) einrichten. Mit einem Freemium-Tarif können Entwickler ein API-Produkt über einen bestimmten Zeitraum oder basierend auf der Nutzungsmenge kostenlos nutzen.
Wenn Sie ein Freemium-Modell für ein API-Produkt einrichten, geben Sie in den Tarifpaketdetails der Preisliste den Zeitraum an, in dem der Entwickler die vom API-Produkt bereitgestellten Ressourcen kostenlos nutzen kann. Der Zeitraum kann auf einem der folgenden Elemente basieren:
- Dauer, d. h. die Zeit zwischen einem Datum des Inkrafttretens und einem Enddatum.
- Menge, z. B. die Anzahl der Transaktionen, die das API-Produkt betreffen, oder das Volumen eines benutzerdefinierten Attributs, das in der Richtlinie zur Aufzeichnung von Transaktionen erfasst wird.
Wenn der Freemium-Zeitraum auf der Menge basiert, geben Sie ihn als Anzahl von Freemium-Einheiten an. Im folgenden Beispiel wird ein Tarif mit Ratenkarte mit einem Freemium-Tarif basierend auf einem Volumen 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