Configura el plan de porcentaje de ingresos

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Introducción

En un plan de reparto de ingresos, el proveedor de la API comparte con el desarrollador un porcentaje de los ingresos generados a partir de cada transacción (según el precio bruto o neto de una transacción). Cuando creas un plan de reparto de ingresos, debes indicar un modelo de reparto, que puede ser fijo o flexible, y una base de precios (por ejemplo, si el reparto de ingresos se basa en el precio bruto o neto de una transacción). Estableces el precio bruto o neto de la transacción cuando creas la política de registro de transacciones.

En el modelo de reparto fijo, compartes con el desarrollador un porcentaje fijo de los ingresos generados a partir de cada transacción (según el precio bruto o neto de una transacción). En el modelo de reparto flexible, compartes con el desarrollador un porcentaje variable de los ingresos. El reparto de ingresos depende de los ingresos generados durante un período. El porcentaje que se usa en el cálculo del reparto de ingresos puede variar según la cantidad de ingresos generados por las transacciones.

Cómo especificar los detalles del plan de reparto de ingresos con la IU

Configura los planes de reparto de ingresos, como se describe a continuación.

Cómo especificar los detalles del plan de reparto de ingresos con la API

Especificas los detalles del plan de reparto de ingresos cuando creas el plan de tarifas. Especificas los detalles en la propiedad ratePlanDetails dentro del cuerpo de la solicitud en una llamada a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Lo que especifiques en la propiedad ratePlanDetails depende del modelo de reparto que elijas: fijo o flexible.

Cómo especificar los detalles del plan de reparto de ingresos para un modelo de reparto fijo

Para implementar el modelo de reparto fijo, especifica lo siguiente en los detalles del plan de tarifas:

• Un parámetro de calificación que indica que el plan de tarifas se basa en transacciones (VOLUME). VOLUME es el valor predeterminado.
• Un tipo de medición (UNIT) que indica que el reparto de ingresos es fijo por unidad (es decir, no se basa en el volumen de transacciones, como es el caso del modelo de reparto flexible ).
• El tipo de ingresos (GROSS o NET). Esto indica si el reparto de ingresos se basa en el precio bruto o neto de una transacción.
• El período de vencimiento del pago (por ejemplo, 30 días).
• El ID de tu organización.
• La moneda "base" o contable que usa tu empresa.
• Una tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula el reparto de ingresos. Dado que el modelo de reparto se basa en una tarifa fija, solo especificas una tarifa del plan de tarifas.

Consulta Propiedades de configuración para obtener detalles del plan de tarifas y una lista completa de las propiedades de detalles del plan de tarifas.

En la tarifa del plan de tarifas, especifica lo siguiente:

• El tipo de tarifa del plan de tarifas (REVSHARE).
• El porcentaje que se usa para calcular el reparto de ingresos. Por ejemplo, si especificas 80.5555, el reparto de ingresos es del 80.5555%, es decir, como proveedor de la API, le pagas al desarrollador el 80.5555% de el precio que se cobra por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, le pagas al desarrollador el 80.5555% del precio que se cobra por transmitir la cantidad de bytes especificada).
• La unidad inicial de la aplicación de tarifas (0). Esto significa que la tarifa se aplica a cada transacción, comenzando por la primera.

Consulta Propiedades de configuración para planes de tarifas para obtener una lista completa de las propiedades del plan de tarifas.

Por ejemplo, lo siguiente crea un plan de reparto de ingresos con un modelo de reparto fijo. El porcentaje de reparto de ingresos es del 80.5555%. El reparto de ingresos se basa en el precio neto de una transacción. El contrato entra en vigencia el 15 de septiembre de 2013 y el pago vence en 30 días. (Se destacan los detalles relacionados con el reparto de ingresos ).

$ 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

La respuesta debería verse de la siguiente manera (solo se muestra una parte de la respuesta):

{
  "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"
}

Cómo especificar los detalles del plan de reparto de ingresos para un modelo de reparto flexible

En un modelo de reparto flexible, especificas los detalles del plan de tarifas que incluyen una o más tarifas del plan de tarifas. Cada tarifa del plan de tarifas abarca un rango de ingresos de transacciones (cada rango se denomina "rango de ingresos"). Asignas un porcentaje de reparto de ingresos para cada rango de ingresos.

Además de las tarifas del plan de tarifas, especifica lo siguiente en los detalles del plan de tarifas:

• Un parámetro de calificación que indica que el plan de tarifas se basa en transacciones (VOLUME). VOLUME es el valor predeterminado.
• Un tipo de medición (VOLUME) que indica que el reparto de ingresos no se basa en el volumen de transacciones (es decir, no es fijo, como es el caso del modelo de reparto fijo fijo).
• El tipo de ingresos (GROSS o NET). Esto indica si el reparto de ingresos se basa en el precio bruto o neto de una transacción.
• El período de vencimiento del pago (por ejemplo, 30 días).
• El ID de tu organización.
• La moneda "base" o contable que usa tu empresa.
• Un tipo de duración y duración que, en conjunto, especifican el período durante el cual se agregan los ingresos (esto también se denomina "base de agregación"). Las transacciones se agregan en función de la base de agregación (por ejemplo, 1 mes) para calcular los ingresos totales y el rango de ingresos aplicable. El porcentaje de reparto de ingresos que se aplica a cada transacción depende de su rango de ingresos.
• Contadores de agregación que se usan para determinar el rango de ingresos aplicable.

Consulta Propiedades de configuración para obtener detalles del plan de tarifas y una lista completa de las propiedades de detalles del plan de tarifas.

Para cada tarifa del plan de tarifas, especifica lo siguiente:

• El tipo de tarifa del plan de tarifas para el rango de ingresos (REVSHARE).
• El porcentaje que se usa para calcular el reparto de ingresos del rango de ingresos. Por ejemplo, si especificas 80.5555, el reparto de ingresos del rango de ingresos es del 80.5555%, es decir, como proveedor de la API, le pagas al desarrollador el 80.5555% del precio que se cobra por cada transacción en ese rango de ingresos.
• La unidad inicial y final del rango de ingresos. La unidad inicial especifica el límite inferior de un rango de ingresos, y la unidad final especifica el límite superior del rango de ingresos. Por ejemplo, si especificas una unidad inicial de 0 y una unidad final de 1,000, el rango de ingresos abarca los ingresos de transacciones superiores a 0 y hasta 1,000 en la moneda especificada. Si la moneda es dólares estadounidenses, la base de agregación es de 1 mes y el porcentaje del rango de ingresos es del 80.5555%, entonces, para las transacciones que generan hasta USD 1,000 en ingresos en un mes, el reparto de ingresos es del 80.5555% del precio de la transacción.

  Si no especificas una unidad final para el rango de ingresos final, el porcentaje de reparto de ese rango se aplica a todas las transacciones después de que los ingresos agregados hayan superado la unidad inicial de ese rango. Por ejemplo, si la unidad inicial del último rango es 1,000 (supón que son dólares estadounidenses) y no especificas una unidad final para ese rango, el porcentaje de ingresos del rango se aplica a todas las transacciones superiores a USD 1,000 de ingresos durante el período agregado.

Consulta Propiedades de configuración para planes de tarifas para obtener una lista completa de las propiedades del plan de tarifas.

Por ejemplo, lo siguiente crea un plan de reparto de ingresos con un modelo de reparto flexible. Especifica dos rangos de ingresos. El primer rango abarca los ingresos de transacciones superiores a 0 y hasta 1,000 dólares estadounidenses. El segundo rango abarca los ingresos de transacciones superiores a 1,000 dólares estadounidenses. El porcentaje de reparto de ingresos es del 80.5555% para el primer rango de ingresos y del 90.5% para el segundo rango de ingresos. El reparto de ingresos se basa en el precio neto de una transacción. La base de agregación es de 1 mes. El período del contrato entra en vigencia el 15 de septiembre de 2013 y el pago vence en 30 días. (Se destacan los detalles relacionados con el reparto de ingresos ).

$ 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

La respuesta debería verse de la siguiente manera (solo se muestra una parte de la respuesta):

{
  "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"
}