Umsatzbeteiligungsplan konfigurieren

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

Einführung

Bei einem Umsatzbeteiligungsplan teilt der API-Anbieter einen Prozentsatz des Umsatzes, der mit jeder Transaktion generiert wurde, an den Entwickler (basierend auf dem Brutto- oder Nettopreis einer Transaktion). Wenn Sie einen Umsatzbeteiligungsplan erstellen, müssen Sie ein Beteiligungsmodell (fest oder flexibel) und eine Preisbasis angeben (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 zur Transaktionsaufzeichnung erstellen.

Beim Modell mit fester Freigabe teilen Sie dem Entwickler einen festen Prozentsatz des Umsatzes, der mit jeder Transaktion erzielt wird (basierend auf dem Brutto- oder Nettopreis einer Transaktion). Beim flexiblen Freigabemodell teilen Sie dem Entwickler einen variablen Prozentsatz des Umsatzes. Die Umsatzbeteiligung hängt von dem über einen bestimmten Zeitraum generierten Umsatz ab. Der Prozentsatz, der für die Berechnung der Umsatzbeteiligung verwendet wird, kann je nach Höhe des durch Transaktionen generierten Umsatzes variieren.

Details zum Umsatzbeteiligungsplan über die UI angeben

Konfigurieren Sie Umsatzbeteiligungspläne wie unten beschrieben.

Details zum Plan zur Umsatzbeteiligung über die API angeben

Sie geben die Details des Umsatzbeteiligungsplans beim Erstellen des Preisplans an. 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 Property ratePlanDetails angeben, hängt vom ausgewählten Freigabemodell ab: fest oder flexibel.

Details des Plans zur Umsatzbeteiligung für ein Modell mit fester Beteiligung angeben

Zum Implementieren des Modells mit fester Freigabe geben Sie in den Details des Preisplans Folgendes an:

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen basiert (VOLUME). VOLUME ist die Standardeinstellung.
• Ein Messtyp (UNIT), der angibt, dass die Umsatzbeteiligung pro Einheit fest ist (also nicht auf dem Transaktionsvolumen basiert, wie es beim flexiblen Freigabemodell der Fall ist).
• Der Umsatztyp (GROSS oder NET). Gibt an, ob die Umsatzbeteiligung auf dem Brutto- oder Nettopreis einer Transaktion basiert.
• 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 der Umsatzbeteiligung enthält. Da das Freigabemodell auf einem festen Preis basiert, geben Sie nur einen Preisplan an.

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

Im Preisplan legen Sie Folgendes fest:

• Der Typ des Preisplans (REVSHARE).
• Der Prozentsatz, der für die Berechnung der Umsatzbeteiligung verwendet wird. Wenn Sie beispielsweise 80, 5555 angeben, beträgt die Umsatzbeteiligung 80,5555 %. Als API-Anbieter zahlen Sie dem Entwickler also 80, 5555% des Preises, der für jede Transaktion berechnet wird. Bei einem benutzerdefinierten Attribut wie der Anzahl der in einer Transaktion übertragenen Byte zahlen Sie dem Entwickler 80, 5555% des für die Übertragung berechneten Preises.
• 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 Preisplan-Properties finden Sie unter Konfigurationseigenschaften für Preispläne.

Im folgenden Beispiel wird ein Umsatzbeteiligungsplan mit einem Modell mit fester Beteiligung erstellt. 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 in 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 wie folgt 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 des Plans zur Umsatzbeteiligung für ein flexibles Freigabemodell angeben

In einem flexiblen Freigabemodell geben Sie Preisplandetails an, die einen oder mehrere Preisplanpreise enthalten. Jeder Preisplanpreis deckt einen Bereich von Transaktionsumsatz ab. Jeder Bereich wird als „Umsatzband“ bezeichnet. Sie weisen jedem Umsatzband eine prozentuale Umsatzbeteiligung zu.

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

• Ein Bewertungsparameter, der angibt, dass der Preisplan auf Transaktionen basiert (VOLUME). VOLUME ist die Standardeinstellung.
• Ein Messtyp (VOLUME), der angibt, dass die Umsatzbeteiligung nicht auf dem Transaktionsvolumen basiert (d. h., sie ist nicht festgelegt, wie es beim Modell mit fester Beteiligung der Fall ist).
• Der Umsatztyp (GROSS oder NET). Gibt an, ob die Umsatzbeteiligung auf dem Brutto- oder Nettopreis einer Transaktion basiert.
• 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 der Umsatz aggregiert wird. Dies wird auch als „Aggregationsgrundlage“ bezeichnet. Transaktionen werden über die Aggregationsbasis aggregiert (z. B. 1 Monat), um den Gesamtumsatz und das entsprechende Umsatzband zu berechnen. Der auf jede Transaktion angewendete Prozentsatz der Umsatzbeteiligung hängt vom jeweiligen Umsatzband ab.
• Zusammenfassungszähler, mit denen das anwendbare Umsatzband ermittelt wird.

Eine vollständige Liste der Preisplandetaileigenschaften 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 das Umsatzband verwendet wird. Wenn Sie beispielsweise 80, 5555 angeben, beträgt die Umsatzbeteiligung für das Umsatzband 80,5555 %. Als API-Anbieter zahlen Sie dem Entwickler also 80, 5555% des Preises, der für jede Transaktion in diesem Umsatzband berechnet wird.
• Die Start- und Endeinheit des Umsatzbands. Die Starteinheit gibt die Untergrenze eines Umsatzbands und die Endeinheit die Obergrenze an. Wenn Sie beispielsweise eine Anfangseinheit von 0 und eine Endeinheit von 1.000 angeben, deckt das Umsatzband Transaktionsumsatz mit einem Wert zwischen 0 und 1.000 in der angegebenen Währung ab. Wenn die Währung US-Dollar ist, beträgt die Aggregationsbasis ein Monat und der Prozentsatz für das Umsatzband 80,5555 %. Bei Transaktionen, die in einem Monat bis zu 1.000 $Umsatz generieren, beträgt die Umsatzbeteiligung 80,5555% des Transaktionspreises.

  Wenn du keine Endeinheit für das endgültige Umsatzband angibst, wird der prozentuale Anteil für dieses Band auf alle Transaktionen angewendet, nachdem der Gesamtumsatz die Starteinheit für dieses Band überschritten hat. Wenn die Starteinheit für das letzte Band beispielsweise 1.000 ist (in US-Dollar) und Sie keine Endeinheit für dieses Band angeben, wird der Umsatzprozentsatz für das Band auf alle Transaktionen mit einem Umsatz von über 1. 000 $während des aggregierten Zeitraums angewendet.

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

Im folgenden Beispiel wird ein Umsatzbeteiligungsplan mit einem flexiblen Umsatzbeteiligungsmodell erstellt. Es werden zwei Umsatzspannen angegeben. Das erste Band deckt Transaktionsumsätze von bis zu 1.000 US-Dollar ab. Das zweite Band deckt Transaktionsumsätze über 1000 US-Dollar ab. Die prozentuale Umsatzbeteiligung beträgt 80,5555% für das erste und 90,5% für das zweite. Die Umsatzbeteiligung basiert auf dem Nettopreis einer Transaktion. Die Aggregationsgrundlage beträgt 1 Monat. Die Vertragslaufzeit gilt am 15. September 2013 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 wie folgt 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"
}