Umsatzbeteiligungsplan konfigurieren

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

Einführung

Bei einem Umsatzbeteiligungsplan teilt der API-Anbieter mit dem Entwickler einen Prozentsatz des Umsatzes, der aus den einzelnen Transaktionen generiert wurde (basierend auf dem Brutto- oder Nettopreis einer Transaktion). Wenn Sie einen Umsatzbeteiligungsplan erstellen, müssen Sie ein Beteiligungsmodell angeben, das entweder fest oder flexibel sein kann, und eine Preisbasis (z. B. ob die Umsatzbeteiligung auf dem Brutto- oder Nettopreis einer Transaktion basiert). Sie legen den Brutto- oder Nettopreis für die Transaktion fest, wenn Sie die Richtlinie für die Transaktionsaufzeichnung erstellen.

Beim Modell mit fester Beteiligung teilen Sie dem Entwickler einen festen Prozentsatz des Umsatzes aus jeder Transaktion mit (basierend auf dem Brutto- oder Nettopreis einer Transaktion). Beim flexiblen Beteiligungsmodell teilen Sie dem Entwickler einen variablen Prozentsatz des Umsatzes mit. Die Umsatzbeteiligung hängt vom Umsatz ab, der über einen bestimmten Zeitraum erzielt wurde. Der für die Berechnung der Umsatzbeteiligung verwendete Prozentsatz kann je nach Umsatzbetrag variieren, der durch die Transaktionen generiert wurde.

Details zum Umsatzbeteiligungsplan über die Benutzeroberfläche angeben

Konfigurieren Sie Umsatzbeteiligungspläne wie unten beschrieben.

Details zum Umsatzbeteiligungsplan mithilfe der API angeben

Sie geben die Details zum Umsatzbeteiligungsplan an, wenn Sie den Tarif erstellen. Die Details geben Sie im Attribut ratePlanDetails im Anfragetext in einem Aufruf von /organizations/{org_name}/monetization-packages/{package_id}/rate-plans an. Was Sie im Attribut ratePlanDetails angeben, hängt vom ausgewählten Freigabemodell ab: fest oder flexibel.

Details zum Umsatzbeteiligungsplan für ein fixes Beteiligungsmodell angeben

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

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen basiert (VOLUME). VOLUME ist der Standardwert.
• Ein Abrechnungstyp (UNIT), der angibt, dass der Umsatzanteil pro Einheit festgelegt ist (d. h. nicht auf dem Transaktionsvolumen basiert, wie beim flexiblen Teilenetzwerkmodell).
• Der Umsatztyp (GROSS oder NET). Dieser gibt an, ob die Umsatzbeteiligung auf dem Brutto- oder Nettopreis einer Transaktion basiert.
• Der Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage).
• Die ID Ihrer Organisation.
• Die Basiswährung oder die Buchhaltungswährung, die Ihr Unternehmen verwendet.
• Ein Preisplanpreis, der Details zur Berechnung der Umsatzbeteiligung enthält. Da das Freigabemodell auf einem festen Preis basiert, geben Sie nur einen Preisplanpreis an.

Eine vollständige Liste der Details zu Preisplänen finden Sie unter Konfigurationseigenschaften für Details zu Preisplänen.

Im Preisplanpreis legen Sie Folgendes fest:

• Der Typ des Preisplans (REVSHARE).
• Der Prozentsatz, der zur Berechnung der Umsatzbeteiligung verwendet wird. Wenn Sie beispielsweise „80.5555“ angeben, beträgt die Beteiligung am Umsatz 80,5555 %. Das bedeutet, dass Sie als API-Anbieter dem Entwickler 80, 5555% des für jede Transaktion berechneten Preises zahlen. Wenn Sie einen benutzerdefinierten Wert wie die Anzahl der in einer Transaktion übertragenen Bytes angeben, zahlen Sie dem Entwickler 80, 5555% des für die Übertragung der angegebenen Anzahl von Bytes berechneten Preises.
• 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 Preisplanattribute finden Sie unter Konfigurationseigenschaften für Preispläne.

Das folgende Beispiel erstellt einen Umsatzbeteiligungsplan mit einem festen Beteiligungsmodell. Der Prozentsatz der Umsatzbeteiligung beträgt 80,5555%. Die Umsatzbeteiligung basiert auf dem Nettopreis einer Transaktion. Der Vertrag tritt am 15. September 2013 in Kraft und die Zahlung ist innerhalb von 30 Tagen fällig. Die Details zur Umsatzbeteiligung sind hervorgehoben.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Details zum Umsatzbeteiligungsplan für ein flexibles Beteiligungsmodell angeben

Bei einem flexiblen Freigabemodell geben Sie Details zum Preisplan an, die mindestens einen Preisplanpreis enthalten. Jeder Tarifplanpreis deckt einen Bereich des Transaktionsumsatzes ab. Dieser Bereich wird als „Umsatzband“ bezeichnet. Sie weisen jedem Umsatzbereich einen prozentualen Umsatzanteil zu.

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 basiert (VOLUME). VOLUME ist der Standardwert.
• Ein Abrechnungstyp (VOLUME), der angibt, dass der Umsatzanteil nicht auf dem Transaktionsvolumen basiert (d. h. er ist nicht festgelegt, wie beim Modell mit fester Beteiligung).
• Der Umsatztyp (GROSS oder NET). Gibt an, ob die Umsatzbeteiligung auf dem Brutto- oder Nettopreis einer Transaktion basiert.
• 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 der Umsatz aggregiert wird (auch als „Aggregationsbasis“ bezeichnet). Transaktionen werden über die Aggregationsbasis (z. B. 1 Monat) aggregiert, um den Gesamtumsatz und das anwendbare Umsatzband zu berechnen. Die prozentuale Umsatzbeteiligung, die auf jede Transaktion angewendet wird, hängt von ihrem Umsatzband ab.
• Aggregationszähler, mit denen der entsprechende Umsatzbereich ermittelt wird.

Eine vollständige Liste der Eigenschaften für Preisplandetails finden Sie unter Konfigurationseigenschaften für Preisplandetails.

Für jeden Preisplanpreis geben Sie Folgendes an:

• Der Typ des Preisplanpreises für das Umsatzband (REVSHARE).
• Der Prozentsatz, der zur Berechnung der Umsatzbeteiligung für den Umsatzbereich verwendet wird. Wenn Sie beispielsweise 80.5555 angeben, beträgt die Umsatzbeteiligung für den Umsatzbereich 80.5555 %. Das bedeutet, dass Sie als API-Anbieter dem Entwickler 80.5555% des Preises zahlen, der für jede Transaktion in diesem Umsatzbereich berechnet wird.
• Die Start- und Endeinheit des Umsatzbereichs. Die Starteinheit gibt die Untergrenze eines Umsatzbereichs an und die Endeinheit die Obergrenze. Wenn Sie beispielsweise eine Anfangseinheit von 0 und eine Endeinheit von 1.000 angeben, deckt das Umsatzband Transaktionsumsatz größer als 0 und bis zu 1.000 in der angegebenen Währung ab. Wenn die Währung US-Dollar ist, die Aggregationsbasis ein Monat und der Prozentsatz für den Umsatzbereich 80,5555 % beträgt, beträgt die Umsatzbeteiligung für Transaktionen, die in einem Monat einen Umsatz von bis zu 1.000 $generieren, 80,5555% des Transaktionspreises.

  Wenn Sie für den Bereich mit dem endgültigen Umsatz kein Endwert angeben, wird der Prozentsatz für diesen Bereich auf alle Transaktionen angewendet, nachdem der Gesamtumsatz den Startwert für diesen Bereich überschritten hat. Wenn die Starteinheit für das letzte Band beispielsweise 1.000 beträgt (von US-Dollar ausgenommen) und Sie keine Endeinheit für dieses Band angeben, wird der Umsatzprozentsatz für das Band auf alle Transaktionen über 1. 000 $Umsatz während des aggregierten Zeitraums angewendet.

Eine vollständige Liste der Preisplanattribute finden Sie unter Konfigurationseigenschaften für Preispläne.

Mit dem folgenden Beispiel wird beispielsweise ein Umsatzbeteiligungsplan mit einem flexiblen Teilenmodell erstellt. Es werden zwei Umsatzspannen angegeben. Der erste Bereich deckt Transaktionsumsätze ab 1.000 $ ab. Das zweite Band deckt Transaktionsumsätze über 1.000 US-Dollar ab. Der Prozentsatz der Umsatzbeteiligung beträgt 80,5555% für den ersten Umsatzbereich und 90,5% für den zweiten Umsatzbereich. Die Umsatzbeteiligung basiert auf dem Nettopreis einer Transaktion. Die Aggregationsbasis ist ein Monat. Die Vertragslaufzeit tritt am 15. September 2013 in Kraft und die Zahlung ist in 30 Tagen fällig. Die Details zur Umsatzbeteiligung sind hervorgehoben.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}