Configura el plan de hojas de tarifas

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Introducción

En un plan de hoja de tarifas, se le cobra al desarrollador por cada transacción. Para este tipo de plan, debes proporcionar detalles adicionales, como el modelo y el precio del modelo de cobro.

De manera opcional, puedes especificar un plan freemium para productos individuales (en lugar de un paquete de API); solo puedes hacerlo para un plan específico de producto.

¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes por paquete?

Los planes de tarifas pueden incluir tarifas recurrentes, así como paquetes de API (planes por grupo y por paquete), que implican un momento específico en el que se cobran tarifas y se restablecen los planes de paquetes a cero. En la siguiente tabla, se describe cuándo se cobran tarifas recurrentes y se restablecen los recuentos de paquetes. Si se impide que las apps de desarrollador realicen más llamadas a la API porque se alcanzó un límite de transacciones determinado, estos son los momentos en los que los recuentos de llamadas a la API se restablecen a cero y las apps pueden comenzar a realizar llamadas nuevamente.

Si el plan... ...esto sucede
  • Una tarifa recurrente distinta de cero establecida en Mes
  • Un plan por grupo o por lotes

La tarifa recurrente y el restablecimiento del plan por paquete se produce el primer día del mes (configuración predeterminada).

Para una recurrencia mensual en un día específico, crea un plan de tarifas con la API de administración y, luego, indica el día con una propiedad RecurringStartUnit, como se describe en Crea planes de tarifas con la API.

  • Una tarifa recurrente distinta de cero establecida en Semana
  • Un plan por grupo o por lotes
El restablecimiento de la tarifa recurrente y el plan por paquete se produce cada 7 días después de la fecha de inicio del plan de tarifas del desarrollador.
  • Una tarifa recurrente distinta de cero establecida en Día
  • Un plan por grupo o por lotes
El restablecimiento de la tarifa recurrente y el plan por paquete se produce cada X días después de la fecha de inicio del plan de tarifas del desarrollador.
  • Sin tarifa recurrente (o sin cargo)
  • Un plan por grupo o por lotes

Los planes por paquete se restablecen en función de la base de agregación definida en la hoja de tarifas. Por ejemplo, si un desarrollador inicia un plan de tarifas el día 19 del mes y la base de agregación es cada 1 mes, el uso del paquete se restablece cada mes el día 19.

Ten en cuenta que el día del mes puede no ser siempre el mismo. Por ejemplo, si un plan de tarifas comienza el 31 de diciembre, la fecha de restablecimiento se convierte en el 28 de un año no bisiesto de febrero, ya que solo hay 28 días en febrero. El día 28 sigue siendo el día de restablecimiento posterior.

Configura planes de hojas de tarifas con la IU

Configure los planes de hoja de tarifas, como se describe a continuación.

Conexión de integración

Para configurar un plan de hoja de tarifas, cuando crees o edites un plan, selecciona el tipo de plan Hoja de tarifas o Hoja de tarifas y porcentaje de ingresos y, en la sección Hoja de tarifas, selecciona uno de los siguientes modelos de pago:

Modelo de carga Descripción
Tarifa plana El desarrollador debe pagar una tarifa fija por cada transacción.
Bandas con volumen El desarrollador debe pagar una tarifa variable según el volumen de transacciones.
Bundles Al desarrollador se le cobra un importe fijo por adelantado por cada paquete de transacciones. Al desarrollador se le cobra el importe establecido, sin importar si se usó o no el paquete por completo.

Nota: Esta opción no está disponible cuando seleccionas Hoja de tarifas y Reparto de ingresos.

Luego, configura la siguiente información según el modelo de carga seleccionado.

Modelo de carga Campo Descripción
All Frecuencia de cálculo Es el período en el que se calcula el volumen de transacciones (o el volumen relacionado con los atributos personalizados). Selecciona una cantidad de meses (de 1 a 24 meses).
Tarifa plana Tarifa plana Tarifa que se cobra por cada transacción Ingresa un número decimal (con hasta cuatro decimales).

Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa que se cobra mediante la API (no la IU). Si quieres obtener más detalles, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, se le cobra al desarrollador $0.10 por cada transacción (o si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobra al desarrollador $0.10 por transmitir la cantidad especificada de bytes).

Bandas con volumen Bandas de volumen Uno o más rangos de volumen de transacciones (o basado en atributos de clientes) (cada rango es una "banda de volumen") para el modelo de carga por bandas de volumen. Se puede asignar una velocidad a cada banda de volumen. La tarifa se aplica a todas las transacciones de la banda de volumen correspondiente. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior se ajusta de forma predeterminada a mayor que 0).

Haz clic en +Nuevo para agregar bandas adicionales.

Deja el límite superior de la banda final vacío para indicar todas las transacciones por encima de este nivel.

Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa que se cobra mediante la API (no la IU). Si quieres obtener más detalles, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

Por ejemplo, si especificas dos bandas de volumen en la sección Banda de volumen (>0-1000, y 1000 y más), puedes ingresar 0.15 para la banda de volumen >0-1000 y 0.10 para la banda de volumen 1000 en adelante. Si la moneda seleccionada es dólares estadounidenses, el tipo de cambio para las primeras 1,000 transacciones es de USD 0.15 por cada transacción y, para más de 1,000 transacciones, el tipo de cambio será de USD 0.10.

Bundles Precios de los paquetes de API Es la cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado, como el número total de bytes transmitidos en un paquete). A cada paquete se le puede asignar un precio. El precio se aplica a todo el paquete. Especifica el límite superior del primer paquete, por ejemplo, hasta 1,000 (el límite inferior se establece de forma predeterminada en mayor que 0).

Haz clic en +Nuevo para agregar paquetes adicionales. Debes especificar un límite superior para el último paquete, a menos que quieras cobrar al desarrollador un importe fijo por las transacciones ilimitadas en el último paquete.

Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa que se cobra mediante la API (no la IU). Si quieres obtener más detalles, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

Por ejemplo, si especifica dos paquetes en la sección Tamaño del paquete (superior a 0 hasta 1,000 y superior a 1,000 hasta 2,000), puede ingresar 50 para los paquetes más grandes de 0 a 1,000 y 40 para los paquetes de más de 1,000 hasta 2,000. Si la moneda seleccionada es el dólar estadounidense, el precio del primer paquete es de USD 50 y para el segundo, USD 40. Se le cobrará al desarrollador el precio del paquete aplicable, independientemente de cuántas transacciones use en él (es decir, se le cobrará el precio por paquete en cuanto se complete la primera transacción).

Si definiste atributos personalizados para tu producto de API, puedes configurar un parámetro de calificación personalizada para cobrar al desarrollador de apps según un atributo personalizado dentro de cada transacción. Por ejemplo, si configuras un plan en el que le cobras al desarrollador por cada transacción, puedes establecer la tarifa del plan según un atributo personalizado, como la cantidad de bytes transmitidos en el backend, que puede variar según la transacción.

En ese caso, selecciona Usar parámetro de calificación personalizado y elige el atributo personalizado de la lista desplegable. Para obtener más información, consulta Configura el plan de tarifas con atributos personalizados.

Versión clásica de Edge (nube privada)

Para configurar los planes de hoja de tarifas con la IU clásica de Edge, sigue estos pasos:

  1. Sigue los pasos para crear un plan de tarifas.
  2. Selecciona Hoja de tarifas en el menú desplegable Tipo de plan de tarifas para configurar el modelo de ingresos.
  3. Si el paquete de API seleccionado incluye varios productos de API, elige una de las siguientes opciones:

    Nota: Si el paquete de API incluye un solo producto de API, puedes omitir este paso.

    • Planes específicos de productos para configurar los detalles del plan de tarifas de cada producto de API de forma individual.
    • Plan genérico para todos los productos, si desea configurar los detalles del plan de tarifas de todos los productos de API.
  4. Haga clic en Hoja de tarifas para ver el plan de tarifas genérico o cada plan de tarifas específico de un producto de API.

    Nota: Cuando configures planes de productos de API específicos, deberás configurar un plan de hoja de tarifas para cada producto de API de forma individual.

    Se abrirá la ventana Hoja de tarifas.

  5. Configura un plan freemium para un producto de API. Un plan freemium ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o según la cantidad de uso.

    Ingresa la siguiente información:

    Campo Descripción
    ¿Es un producto freemium?

    El alcance del período gratuito. Selecciona uno de los siguientes botones de selección:

    • Por cantidad El período gratuito se basa en una cantidad especificada en el campo Volumen.
    • Por duración El período de la tarifa se basa en un intervalo de tiempo especificado en el campo Duración Freemium.
    • Lo que ocurra primero. El período gratuito finaliza cuando se alcanza la cantidad en el campo Volumen o el intervalo de tiempo en el campo Duración Freemium, lo que ocurra primero.
    • No. Este no es un plan freemium. Esta es la opción predeterminada.
    Volumen freemium

    El volumen de transacciones (o volumen correspondiente a un atributo personalizado registrado en la política de registro de transacciones) por las que no se les cobra a los desarrolladores. El volumen se mide para el producto de API. Ingresa un número de volumen, como 5,000. Esto significa que cuando los desarrolladores inician el plan, no se les cobra por las primeras 5,000 transacciones (ni por los primeros 5,000 usos de un elemento relacionado con atributos personalizados). Este campo solo se habilita si seleccionas "Por cantidad" o "El que surja primero" en el campo "¿Producto freemium?".

    Duración freemium

    El intervalo de tiempo durante el cual no se les cobra a los desarrolladores. Ingresa un número y selecciona un período, por ejemplo, 1 mes. Esto significa que no se les cobra a los desarrolladores por 1 mes. Este campo se habilita solo si seleccionas "Por duración" o "Lo que ocurra primero" en el campo "¿Producto freemium?".

  6. Selecciona uno de los siguientes modelos de carga:
    • Tarifa plana. En este modelo, al desarrollador se le cobra una tarifa fija por cada transacción.
    • Bandas de volumen. En este modelo, se le cobra al desarrollador una tarifa variable según el volumen de transacciones.
    • Paquetes. En este modelo, al desarrollador se le cobra un importe fijo (por adelantado) por cada paquete de transacciones. Al desarrollador se le cobra el importe establecido, sin importar si se usó o no el paquete por completo.

    Para el modelo de tarifa plana: Ingresa la siguiente información en la sección Precios de la ventana Hoja de tarifas genérica:

    Campo Descripción
    Operador (o organización)

    El nombre de tu organización. Este campo se ajusta de forma predeterminada con el valor del campo Operador (o organización) en el perfil de la organización.

    País

    El país en el que opera tu organización. Este campo se ajusta de forma predeterminada con el valor del campo País en el perfil de la organización.

    Tarifa plana

    Es la tarifa que se cobra por cada transacción. Ingresa un número decimal (con hasta cuatro decimales).

    Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa que se cobra mediante la API (no la IU). Si quieres obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

    Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, se le cobra al desarrollador $0.10 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobra al desarrollador $0.10 por transmitir la cantidad especificada de bytes).

    Para el modelo de bandas de volumen: En la ventana Hoja de tarifas genérica, se muestran campos adicionales que puedes usar a fin de especificar una base de agregación y especificar "bandas de volumen", es decir, los rangos de volumen de transacciones a los que puedes aplicar tarifas diferentes.

    Por lo general, este tipo de plan se configura para alentar a los desarrolladores a generar mayores volúmenes mediante ofertas de tarifas con descuento para bandas de mayor volumen.

    Ingresa la siguiente información en la ventana Hoja de tarifas genérica:

    Campo Descripción
    Base de agregación

    El período durante el cual se agrega el volumen de transacciones (o el volumen relacionado con los atributos personalizados). El volumen agregado se usa para identificar la banda de volumen y la tarifa que se aplicará a cada transacción. Selecciona una cantidad de meses (de 1 a 12 meses).

    Para obtener información sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de los paquetes?

    Bandas de volumen

    Uno o más rangos de volumen de transacciones (o basado en atributos de clientes) (cada rango es una “banda de volumen”). Se le puede asignar una tarifa a cada banda de volumen (establece esta tarifa en el campo Bandas de volumen de la sección Precios). La tarifa se aplica a todas las transacciones en la banda de volumen aplicable. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior se ajusta de forma predeterminada a mayor que 0). Haz clic en + para agregar una segunda banda; por ejemplo, mayor de 1,000 hasta 2,000. Haz clic en + para agregar más bandas. Puedes dejar el límite superior de la banda final vacío para indicar todas las transacciones por encima de este nivel.

    Precios
    Operador (o organización)

    El nombre de tu organización. Este campo se ajusta de forma predeterminada con el valor del campo de operador (o organización) en el perfil de organización.

    País

    El país en el que opera tu organización. Este campo se ajusta de forma predeterminada con el valor del campo País en el perfil de la organización.

    Moneda

    La moneda "base" o contable que usa tu organización. Este campo se ajusta de forma predeterminada con el valor del campo Currency en el perfil de la organización, pero se puede cambiar aquí.

    Bandas de volumen

    Es la velocidad para una banda de volumen. Debes especificar una tarifa para cada banda de volumen. Ingresa un número decimal para cada banda (con hasta cuatro decimales).

    Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la velocidad de banda de volumen con la API (no la IU). Si quieres obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

    Por ejemplo, si especificas dos bandas de volumen en la sección Banda de volumen (>0-1,000, y 1,000 y más), puedes ingresar 0.15 para la banda de volumen >0-1,000 y 0.10 para la de 1,000 en adelante. Si la moneda seleccionada es el dólar estadounidense, la tasa correspondiente a las primeras 1,000 transacciones es de USD 0.15 y, para más de 1,000, la tasa es de USD 0.10.

    Para el modelo agrupado: En la ventana Hoja de tarifas genérica, se muestran campos adicionales que puedes usar a fin de especificar una base para la agregación (el período en el que el desarrollador puede usar el paquete de transacciones) y para especificar la información relacionada con los paquetes, como su tamaño.

    Ingresa la siguiente información en la ventana Hoja de tarifas genérica:

    Campo Descripción
    Base de agregación

    Es el período en el que el desarrollador puede usar el paquete de transacciones (o un paquete personalizado basado en atributos). Selecciona una cantidad de meses (de 1 a 12 meses). Después de este período, el plan vence y el desarrollador debe volver a comprar el plan (y los paquetes).

    Para obtener información sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de los paquetes?

    Tamaño del paquete

    Es la cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado, como el número total de bytes transmitidos en un paquete). A cada paquete se le puede asignar un precio (establece este precio en el campo Tamaño del paquete de la sección Precios). El precio se aplica a todo el paquete. Especifica el límite superior del primer paquete, por ejemplo, hasta 1,000 (el límite inferior se establece de forma predeterminada en mayor que 0). Haz clic en + para agregar un segundo paquete, por ejemplo, de más de 1,000 a 2,000. Haz clic en + para agregar más paquetes. Debes especificar un límite superior para el último paquete, a menos que quieras cobrar al desarrollador un importe fijo por transacciones ilimitadas en el último paquete.

    Precios
    Operador (o organización)

    El nombre de tu organización. Este campo se ajusta de forma predeterminada con el valor del campo de operador (o organización) en el perfil de organización.

    País

    El país en el que opera tu organización. Este campo se ajusta de forma predeterminada con el valor del campo País en el perfil de la organización.

    Moneda

    La moneda "base" o contable que usa tu organización. Este campo se ajusta de forma predeterminada con el valor del campo Currency en el perfil de la organización, pero se puede cambiar aquí.

    Tamaño del paquete (precio)

    Indica el precio de un paquete. Debes especificar un precio para cada paquete. Ingresa un número decimal (con hasta cuatro decimales).

    Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa del paquete mediante la API (no la IU). Si quieres obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.

    Por ejemplo, si especificas dos paquetes en la sección Bundle Size (de más de 0 a 1,000, y más de 1,000 a 2,000), puedes ingresar 50 para los paquetes más grandes de 0 a 1,000 y 40 para los paquetes de más de 1,000 y hasta 2,000. Si la moneda seleccionada es el dólar estadounidense, el precio del primer paquete es de USD 50 y, para el segundo, USD 40. Se le cobrará al desarrollador el precio del paquete aplicable, independientemente de cuántas transacciones use en él (es decir, se le cobrará el precio por paquete en cuanto se complete la primera transacción).

  7. Haz clic en Aplicar y cerrar para guardar los detalles de la hoja de tarifas y volver a la ventana del Plan de tarifas estándar.
  8. En el caso de los planes de tarifas específicos de productos de API, configura los detalles del plan de tarifas para productos de API adicionales, según sea necesario.

Cómo configurar el plan de hoja de tarifas con la API

Configura los detalles del plan de la hoja de tarifas con la API, como se describe en las siguientes secciones.

Cómo especificar los detalles del plan de la hoja de tarifas mediante la API

Cuando creas el plan, debes especificar los detalles del plan de la hoja de tarifas. Debes especificar 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 dependerá del modelo de carga que elijas: tasa fija, por volumen con bandas o paquetes.

Cómo especificar un modelo de carga de tarifa plana

Para implementar el modelo de carga de tarifa plana, especifica lo siguiente en los detalles del plan de tarifas:

  • Es un parámetro de calificación que indica que el plan de tarifas se basa en transacciones (VOLUME) o en un atributo personalizado (por ejemplo, MINT_CUSTOM_ATTRIBUTE_1). VOLUME es el valor predeterminado.
  • Es un tipo de medición (UNIT) que indica que la tarifa es fija por unidad (es decir, no se basa en el volumen de transacciones, como es el caso del modelo de carga por paquetes o con bandas de volumen).
  • Es el período de pago (por ejemplo, 30 días).
  • El ID de tu organización.
  • La moneda "base" o contable que utiliza su empresa.
  • Una tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula la tarifa Debido a que el modelo de cobro se basa en una tarifa fija, especificas solo una tarifa del plan de tarifas.

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

  • El tipo de tarifa del plan de tarifas (RATECARD).
  • Es la tarifa del plan. Por ejemplo, si especificas 0.10 y la moneda es dólares estadounidenses, se le cobra al desarrollador $0.10 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se cobra al desarrollador $0.10 por transmitir la cantidad especificada de bytes).
  • La unidad inicial de la aplicación de tarifas (0). Esto significa que la tarifa se aplica a cada transacción a partir de la primera.

Consulta la configuración de detalles del plan de tarifas para obtener una lista completa de las opciones detalladas.

Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un modelo de cargo fijo. La tarifa se establece en USD 0.10 para cada transacción. El pago vence en 30 días. (Los detalles relacionados con la hoja de tarifas están destacados).

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

Cómo especificar un modelo de carga con bandas de volumen

En un modelo con bandas de volumen, debes especificar los detalles del plan de tarifas que incluyen una o más tarifas. Cada tarifa se aplica a una “banda de volumen”, es decir, un rango de volumen de transacciones (o un rango basado en un atributo personalizado, como la cantidad de bytes transmitidos). Por lo general, este tipo de plan se configura para alentar a los desarrolladores a generar mayores volúmenes mediante ofertas de tarifas con descuento para bandas de mayor volumen.

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

  • Es un parámetro de calificación que indica que el plan de tarifas se basa en transacciones (VOLUME) o en un atributo personalizado (por ejemplo, CUSTOM_ATTRIBUTE_1). VOLUME es el valor predeterminado.
  • Un tipo de medición (VOLUME) que indica que la tarifa se basa en el volumen de transacciones (es decir, no es una tarifa plana por transacción, como es el caso del modelo de cobro de tarifa plana).
  • Es el período de pago (por ejemplo, 30 días).
  • El ID de tu organización.
  • La moneda "base" o contable que utiliza su empresa.
  • Es un tipo de duración y duración que, en conjunto, especifican el período durante el cual se agrega el volumen de transacciones (o volumen relacionado con los atributos personalizados). Esto también se denomina "base de agregación". El volumen de transacciones se agrega sobre la base de la agregación (por ejemplo, 1 mes) para determinar la banda de volumen aplicable.
  • Contadores de agregación que se usan para determinar la banda de volumen aplicable.

Para cada tarifa de plan de tarifas, debes especificar lo siguiente:

  • El tipo de tarifa del plan de tarifas (RATECARD).
  • Es la tarifa del plan. Por ejemplo, si especificas 0.10 y la moneda es dólares estadounidenses, se le cobra al desarrollador $0.15 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobra al desarrollador $0.15 por transmitir la cantidad especificada de bytes).
  • La unidad inicial y final de la banda de volumen. La unidad inicial especifica el límite inferior de la banda de volumen y la unidad final especifica el límite superior de la banda de volumen. Por ejemplo, si especificas una unidad inicial de 0 y una unidad final de 1,000, la banda de volumen cubre hasta 1,000 transacciones en el período de agregación. Si la moneda es dólares estadounidenses, el período de agregación es de 1 mes y la tasa para las primeras 1,000 transacciones es de 0.15, se le cobra al desarrollador $0.15 por transacción hasta por 1,000 transacciones en el mes.

    Para obtener detalles sobre cuándo se restablecen los paquetes, consulta Cuándo se cobran las tarifas recurrentes y se restablecen los planes de los paquetes.

    Si no especificas una unidad final para la banda de volumen final, la tarifa de esa banda se aplicará a todas las transacciones una vez que el número de transacciones supere la unidad inicial correspondiente a esa banda. Por ejemplo, si la unidad inicial para la última banda es 1,000 y no especificas una unidad final para esa banda, la tasa de la banda se aplica a todas las transacciones después de 1,000 transacciones en el período de agregación.

Consulta la configuración de detalles del plan de tarifas para obtener una lista completa de las opciones detalladas.

Por ejemplo, en el siguiente ejemplo, se crea un plan de hoja de tarifas con un modelo de carga por bandas de volumen. La tarifa se establece en USD 0.15 para las primeras 1,000 transacciones y de USD 0.10 para todas las transacciones superiores a 1,000. La base de agregación es de 1 mes. El pago vence en 30 días. (Se destacan los detalles de la hoja de tarifas).

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

Cómo especificar un modelo de carga en paquetes

En un modelo de carga en paquete, el desarrollador paga (por adelantado) por un "paquete" de transacciones (o por un paquete basado en un atributo personalizado, como la cantidad de bytes transmitidos). Debes especificar una tarifa para cada paquete y una base de agregación, es decir, un período en el que el desarrollador puede usar el paquete.

Por ejemplo, supongamos que configuras dos paquetes, donde el primer tamaño de paquete corresponde a 1 a 1,000 transacciones, y el segundo, a 1,001 a 2,000 transacciones. La tarifa es de USD 50 para el primer paquete y de USD 40 para el segundo, y la base de agregación es de 1. Si el desarrollador compra un plan de hoja de tarifas para el primer paquete, paga USD 50 (por adelantado) por 1,000 transacciones en un mes. Al desarrollador se le cobra el importe establecido, independientemente de si el paquete se utiliza por completo o no. Una vez que finaliza el período de agregación, el plan vence. Si el desarrollador quiere volver a usar el paquete, debe volver a comprar el plan (y el paquete).

Lo que especificas en los detalles del plan de tarifas es básicamente lo mismo que especificas en los detalles del plan de tarifas del modelo de carga con bandas de volumen. Las diferencias se muestran a continuación:

  • Cada plan de tarifas que especificas es para un paquete (en lugar de una banda de volumen).
  • Debes especificar un límite superior para el último paquete, a menos que quieras cobrar al desarrollador un importe fijo por transacciones ilimitadas en el último paquete.

Consulta la configuración de detalles del plan de tarifas para obtener una lista completa de las opciones detalladas.

Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un modelo de carga en paquete. La tarifa se establece en USD 50 para el primer paquete (hasta 1,000 transacciones) y de USD 40 para el segundo (más de 1,000 y hasta 2,000 transacciones). La base de agregación es de 1 mes. El pago vence en 30 días.

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

Cómo especificar un plan freemium para productos individuales mediante la API

En un plan de hoja de tarifas, puedes configurar un plan freemium para un producto individual (en lugar de un paquete de API). Un plan freemium ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o según la cantidad de uso.

Cuando configuras un plan freemium para un producto de API, especificas en los detalles del plan de la hoja de tarifas el período en el que el desarrollador puede usar los recursos proporcionados por el producto de API sin cargo. El período se puede basar en una de las siguientes opciones:

  • Es la duración, es decir, el tiempo entre una fecha de entrada en vigencia y una de finalización.
  • Cantidad, como el número de transacciones que involucran el producto de API o el volumen correspondiente a un atributo personalizado registrado en la política de registro de transacciones.

Si el período freemium se basa en la cantidad, especifícalo como un número de unidades freemium. Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un plan freemium basado en un volumen de 5,000 unidades (se destacan las especificaciones relacionadas con este formato).

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