Estás viendo la documentación de Apigee Edge.
Ve a 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, Necesitamos proporcionar detalles adicionales, como el modelo de cobro y el precio de este.
De forma opcional, puedes especificar un plan freemium para productos individuales (en lugar de para una API paquete), puedes hacer esto solo para un plan específico de producto.
¿Cuándo se cobran tarifas recurrentes y se restablecen los planes de paquetes?
Los planes de tarifas pueden incluir tarifas recurrentes, así como paquetes de APIs (planes por volumen y paquetes) que implican momentos específicos en que se cobran tarifas y los planes de paquetes se restablecen a cero. El de la siguiente tabla, se describe cuándo se cobran tarifas recurrentes y se restablecen los recuentos de paquetes. Si de apps de desarrollador ya no podrán realizar más llamadas a la API porque alcanzan un determinado límite de transacciones, estos son los momentos en que los recuentos de llamadas a la API se restablecen a cero y las apps pueden volver a realizar llamadas.
| Si el plan tiene... | ...esto sucede |
|---|---|
|
El restablecimiento de la tarifa recurrente y el plan de paquete se realiza el primer día del mes (opción predeterminada). Para una recurrencia mensual en un día específico, crea un plan de tarifas con la herramienta
API e indica el día con una propiedad |
|
La tarifa recurrente y el restablecimiento del plan de paquete se realizan cada 7 días después de la tarifa del desarrollador fecha de inicio del plan. |
|
La tarifa recurrente y el restablecimiento del plan de paquete se producen cada X días después del fecha de inicio del plan de tarifas del desarrollador. |
|
Los planes de paquetes se restablecen según la base de agregación definida en la hoja de tarifas. Para por ejemplo, si un desarrollador inicia un plan de tarifas el día 19 del mes, y el estado El valor básico es cada 1 mes y, luego, el uso del paquete se restablece el día 19 de cada mes. Ten en cuenta que es posible que el día del mes no siempre sea el mismo. Por ejemplo, si una tarifa el plan comienza el 31 de diciembre, la fecha de restablecimiento se convierte en el 28 de un año no bisiesto febrero, ya que solo hay 28 días en febrero. El día 28 sigue siendo el día en que se restablece. para siempre. |
Cómo configurar los planes de la hoja de tarifas con el IU
Configure los planes de las hojas de tarifas, como se describe a continuación.
Edge
Para configurar un plan de hoja de tarifas, al crear o editar un plan de tarifas, selecciona el tipo de plan Hoja de tarifas o Hoja de tarifas y reparto de ingresos y, en la sección Hoja de tarifas, selecciona uno de los siguientes modelos de cobro:
| Modelo de carga | Descripción |
| Tarifa plana | Al desarrollador se le cobra una tarifa fija por cada transacción. |
| Volumen seleccionado | Se cobra una tarifa variable al desarrollador en función del volumen de transacciones. |
| Paquetes | Se le cobra al desarrollador un importe fijo por adelantado por cada paquete de transacciones. Al desarrollador se le cobra el importe establecido, sin importar si el paquete se usa por completo o no.
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 |
| Todos | Frecuencia de cálculo | Es el período en el que se calcula el volumen de transacciones (o el volumen relacionado con atributos personalizados). Selecciona una cantidad de meses (entre 1 y 24 meses). |
| Tarifa plana | 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 cobrada con la API (no con la IU). Para conocer los detalles, consulta Configura la cantidad de decimales para las tarifas del plan de tarifas. Por ejemplo, si ingresas 0.10 y la moneda es el dólar estadounidense, se le cobrará al desarrollador USD 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 cobrará al desarrollador USD 0.10 por transmitir la cantidad de bytes especificada). |
| Volumen seleccionado | Bandas de volumen | Uno o más intervalos de volumen de transacciones (o basados en atributos de cliente) (cada intervalo es una “banda de volumen”) para el modelo de carga con banda volumétrica. A cada banda de volumen se le puede asignar una tarifa. La tarifa se aplica a todas las transacciones en la banda de volumen correspondiente. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior está predeterminado en más de 0).
Haz clic en +Nuevo para agregar más correas. 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 cobrada con la API (no con la IU). Para conocer los detalles, consulta Configura la cantidad de decimales para las tarifas del plan de tarifas. Por ejemplo, si especificas dos bandas de volumen en la sección Bandas de volumen (>0-1, 000 y 1,000 y más), podrías ingresar 0.15 para la banda de volumen >0-1000 y 0.10 para la de 1000 o más. Si la moneda seleccionada es el dólar estadounidense, la tasa para las primeras 1,000 transacciones es de USD 0.15 por cada transacción y, para más de 1,000 transacciones, la tasa es de USD 0.10 por cada transacción. |
| Paquetes | Precios de los paquetes de API | Cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado, como la cantidad total de bytes transmitidos en un paquete). Se puede asignar un precio a cada paquete. 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 está predeterminado en más de 0).
Haz clic en +Nuevo para agregar paquetes adicionales. Debes especificar un límite superior para el último paquete, a menos que desees cobrar al desarrollador un importe fijo por las transacciones ilimitadas que se realicen en ese último paquete. Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa cobrada con la API (no con la IU). Para conocer los detalles, consulta Configura la cantidad de decimales para las tarifas del plan de tarifas. Por ejemplo, si especifica dos paquetes en la sección Tamaño del paquete (superior a 0 a 1,000 y superior a 1,000 a 2,000), puede ingresar 50 para el paquete superior a 0 hasta 1,000 y 40 para el paquete superior a 1,000 hasta 2,000. Si la moneda seleccionada es el dólar estadounidense, el precio del primer paquete es de USD 50 y del segundo paquete, de USD 40. Al desarrollador se le cobra el precio del paquete aplicable, independientemente de la cantidad de transacciones que use dentro de este (es decir, se le cobra al desarrollador el precio del paquete en cuanto se completa la primera transacción). |
Si definiste atributos personalizados para el producto de API, puedes configurar un parámetro de calificación personalizada para cobrar al desarrollador de la app en función de un atributo personalizado en cada transacción. Por ejemplo, si configuras un plan en el que se cobra al desarrollador por cada transacción, puedes establecer la tarifa del plan en función de un atributo personalizado, como la cantidad de bytes transmitidos en el backend, que pueden variar según la transacción.
En ese caso, selecciona Usar parámetro de calificación personalizada y elige el atributo personalizado de la lista desplegable. Para obtener más información, consulta Configura el plan de tarifas con atributos personalizados.
Classic Edge (nube privada)
Para configurar planes de hojas de tarifas con la IU clásica de Edge, sigue estos pasos:
- Sigue los pasos para crear un plan de tarifas.
- Selecciona Hoja de tarifas en el menú desplegable Tipo de plan de tarifas para configurar el modelo de ingresos.
- Si el paquete de API seleccionado incluye varios productos de API, selecciona una de las siguientes opciones:
Nota: Si el paquete de API incluye un solo producto de API, puedes omitir este paso.
- Planes específicos por producto para configurar los detalles de los planes de tarifas para cada producto de API de forma individual.
- Plan genérico para todos los productos para configurar los detalles del plan de tarifas de todos los productos de API.
- Haz 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 específicos de productos de API, deberás configurar un plan de hoja de tarifas. para cada producto de API de forma individual.
Se abrirá la ventana de la hoja de tarifas.
- 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 ¿Producto freemium? La extensión del período gratuito. Elige uno de los siguientes botones de selección:
- Por cantidad. El período gratuito se basa en una cantidad especificada en el conjunto de datos .
- Por duración. El período de tarifa se basa en un intervalo de tiempo especificado en el campo Freemium Duration.
- Lo que ocurra primero. El período gratuito finaliza cuando la cantidad del Volume o el intervalo de tiempo en el campo Freemium Duration cuando se alcanza, 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 relacionado con un atributo personalizado registrado en la política de registro de transacciones) por los que no se les cobra a los desarrolladores. El volumen es 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 cobran las primeras 5,000 transacciones. (o para los primeros 5,000 usos de un artículo relacionado con atributos personalizados). Este campo es se habilita solo si seleccionas "Por cantidad" o "lo que ocurra primero" en la serie "Freemium el producto?". .
Duración freemium Es 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 los desarrolladores se cobra por 1 mes. Este campo se habilita solo si seleccionas "Por duración" o "Lo que ocurra primero" en el campo "Producto freemium"? .
- 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.
- Banda de volumen. En este modelo, el desarrollador cobra 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, independientemente de que el paquete se usa por completo.
Para el modelo de tarifa plana: Ingresa la siguiente información en la sección Precios la ventana de la hoja de tarifas genérica:
Campo Descripción Operador (organización) El nombre de tu organización. Este campo se ajusta de forma predeterminada usando el 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 Country 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). Para obtener más detalles, consulta Configura la cantidad de decimales de las tarifas del plan de tarifas.
Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, el desarrollador se cobraron USD 0.10 por cada transacción (o si se basa en un atributo personalizado como el cantidad de bytes transmitidos en una transacción, se cobran USD 0.10 al desarrollador por transmitir la cantidad especificada de bytes).
Para el modelo con bandas de volumen: En la ventana de la hoja de tarifas genérica, se muestran imágenes campos que usas para especificar una base de agregación y “bandas de volumen”, que son los intervalos de volumen de transacciones a los que puedes aplicar diferentes tarifas.
Este tipo de plan suele configurarse para incentivar a los desarrolladores a generar mayores volúmenes que ofrece tarifas con descuento para bandas de mayor volumen.
Ingresa la siguiente información en la ventana de la hoja de tarifas genérica:
Campo Descripción Base de agregación Es el período de tiempo durante el cual se generó el volumen de transacciones (o volumen relacionado con atributos). El volumen agregado se usa para identificar la banda de volumen y la tasa que se aplicará a cada transacción. Selecciona una cantidad de meses (de 1 a 12 meses).
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta Cuándo son recurrentes tarifas cobradas y se restablecen los planes de paquetes?
Bandas de volumen Uno o más intervalos de volumen de transacciones (o basado en atributos de cliente) (cada intervalo) es una "banda de volumen"). A cada banda de volumen se le puede asignar una velocidad (debes establecerla el campo Bandas de volumen de la sección Precios). La tarifa se aplica a todas en la banda de volumen correspondiente. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior está predeterminado a un valor superior a 0). Haz clic en +. para agregar una segunda banda; por ejemplo, entre más de 1,000 y 2,000. Haz clic en + para agregar más. correas. Puedes dejar vacío el límite superior de la última banda para indicar todas transacciones por encima de este nivel.
Precios Operador (organización) El nombre de tu organización. Este campo se ajusta de forma predeterminada usando el 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 El valor del campo Country en el perfil de la organización.
Moneda La "base" o la moneda de contabilidad que usa tu organización. Este campo es predeterminado con el valor del campo Moneda en el perfil de la organización, pero también cambiada aquí.
Bandas de volumen Es la tarifa de una banda de volumen. Debes especificar una velocidad para cada banda de volumen. Ingresa un un número decimal para cada banda (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de decimales que se pueden especificar. para la tasa de banda de volumen usando la API (no la IU). Para obtener más detalles, consulta Configura la cantidad de decimales de las tarifas del plan de tarifas.
Por ejemplo, si especificas dos bandas de volumen en la sección Bandas de volumen (>0-1,000 y 1,000 o más), puedes ingresar 0.15 para el volumen >0-1,000 y 0.10 para la de 1000 o más. Si la moneda seleccionada es EE.UU. dólares, la tasa para las primeras 1,000 transacciones es de 0,15 USD por cada transacción y para más de 1,000 transacciones, la tasa es de USD 0.10 por cada transacción.
Para el modelo empaquetado: En la ventana de la hoja de tarifas genérica, se muestran campos adicionales que que usas para especificar una base de agregación (el período en el que el desarrollador puede usar el paquete de transacciones) y especificar información relacionada con el paquete, como el tamaño de una en un paquete.
Ingresa la siguiente información en la ventana de la hoja de tarifas genérica:
Campo Descripción Base de agregación El período en el que el desarrollador puede usar el paquete de transacciones (o usar un paquete basado en atributos personalizados). Selecciona una cantidad de meses (de 1 a 12 meses). Después del este período, el plan vencerá y el desarrollador deberá comprar el plan (y los paquetes) de nuevo.
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta Cuándo son recurrentes tarifas cobradas y se restablecen los planes de paquetes?
Tamaño del paquete La cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado) como la cantidad total de bytes que se transmiten en un paquete). Se puede asignar cada paquete Un precio (debes establecer este precio en el campo Tamaño del paquete, en la sección Precios). El el precio se aplica a todo el paquete. Especifica el límite superior del primer paquete para por ejemplo, hasta 1,000 (el límite inferior se establece de forma predeterminada en un valor superior a 0). Haz clic en + para agregar un segundo paquete, por ejemplo, desde 1,000 hasta 2,000. Haz clic en + para agregar más. paquetes. Debes especificar un límite superior para el último paquete, a menos que desees cobrar al desarrollador un importe fijo por transacciones ilimitadas en los últimos en un paquete.
Precios Operador (organización) El nombre de tu organización. Este campo se ajusta de forma predeterminada usando el 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 El valor del campo Country en el perfil de la organización.
Moneda La "base" o la moneda de contabilidad que usa tu organización. Este campo es predeterminado con el valor del campo Moneda en el perfil de la organización, pero también cambiada aquí.
Tamaño del paquete (precio) Indica el precio de un paquete. Debes especificar un precio para cada paquete. Ingresa un decimal un número específico (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de decimales que se pueden especificar. para la tarifa del paquete usando la API (no la IU). Para obtener más detalles, consulta Configura la cantidad de decimales de las tarifas del plan de tarifas.
Por ejemplo, si especificas dos paquetes en la sección Tamaño del paquete (superior a 0) hasta 1,000 y de más de 1,000 hasta 2,000), puedes ingresar 50 como valor desde 0 hasta 1000 paquetes, y 40 para los paquetes mayores que 1000 hasta 2000. Si el botón la moneda seleccionada es el dólar estadounidense, el precio del primer paquete es de 50 USD y para la el segundo paquete, el precio es de USD 40. Al desarrollador se le cobra el precio del paquete aplicable sin importar cuántas transacciones utilicen en el paquete (es decir, al desarrollador se le cobra el precio del paquete en cuanto se realiza la primera transacción en el paquete esté completo).
- Haz clic en Aplicar y cerrar para guardar los detalles de la hoja de tarifas y volver al Plan de tarifas estándar. en la ventana modal.
- En el caso de los planes de tarifas específicos de los productos de API, configura los detalles del plan de tarifas para productos de API adicionales, según sea necesario.
Configura el plan de la 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.
Especifica los detalles del plan de la hoja de tarifas con la API
Debes especificar los detalles del plan de la hoja de tarifas cuando lo creas. Debes especificar los detalles en
la propiedad ratePlanDetails en el cuerpo de la solicitud en una llamada a
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans Lo que
que se especifica en la propiedad ratePlanDetails, según el modelo de carga que elijas:
tarifa plana, volumen
banco o paquetes.
Especificar un modelo de carga de tarifa plana
Para implementar el modelo de cobro de tarifa plana, especifica lo siguiente en el plan de tarifas. detalles:
- Un parámetro de calificación que indica que el plan de tarifas se basa en las transacciones
VOLUMEo se basan en un atributo personalizado (por ejemplo,MINT_CUSTOM_ATTRIBUTE_1).VOLUMEes el valor predeterminado. - Un tipo de medidor (
UNIT) que indica que la tarifa es fija por unidad (esa no se basa en el volumen de transacciones, como es el caso del volumen paquetes de modelos de cobro). - El período límite del pago (por ejemplo, 30 días)
- El ID de tu organización.
- La "base" o con la moneda de contabilidad que usa tu empresa.
- Una tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula la tarifa. Debido a que el de pago se basa en una tarifa fija, solo se especifica una tarifa del plan de tarifas.
En la tarifa del 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 cobran USD 0.10 al desarrollador por cada transacción (o si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se cobran USD 0.10 al desarrollador por transmitir la cantidad especificada de bytes).
- La unidad inicial de la aplicación de tarifas (
0). Esto significa que la tasa es se aplican a cada transacción, empezando por la primera.
Ver Plan de tarifas detalla los parámetros de configuración para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un modelo de cobro fijo. La tarifa es de establecido en USD 0.10 por cada transacción. El pago vence en 30 días. (Los detalles relacionados con la hoja de tarifas se highlighted.)
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
Especificando un modelo de carga con banda de volumen
En un modelo de bandas de volumen, debes especificar los detalles del plan de tarifas que incluyen uno o más planes de tarifas. de volumen, cada tarifa se aplica a una “banda de volumen”, es decir, a un rango de volumen de transacciones (o a un según un atributo personalizado, como la cantidad de bytes transmitidos). Este tipo de plan es se suele configurar para alentar a los desarrolladores a generar mayores volúmenes mediante el ofrecimiento de tarifas con descuento para bandas de mayor volumen.
Además de las tarifas del plan de tarifas, debes especificar 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 las transacciones
VOLUMEo se basan en un atributo personalizado (por ejemplo,CUSTOM_ATTRIBUTE_1).VOLUMEes el valor predeterminado. - Un tipo de medidor (
VOLUME) que indica que la tarifa se basa en el volumen de transacciones (es decir, no es una tasa fija por transacción, como es el caso de modelo de tarifa plana). - El período límite del pago (por ejemplo, 30 días)
- El ID de tu organización.
- La "base" o con la moneda de contabilidad que usa tu empresa.
- Es un tipo de duración y duración que, en conjunto, especifican el período durante el cual el volumen de transacciones (o volumen relacionado con atributos personalizados). Esto también se denomina “base de agregación”. El volumen de transacciones se agrega sobre la base de agregación (para ejemplo, 1 mes) para determinar la banda de volumen correspondiente.
- Contadores de agregación que se usan para determinar la banda de volumen aplicable.
Para cada tarifa del 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, al desarrollador se le cobran USD 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 cobran $0.15 al desarrollador por transmitir la cantidad especificada de bytes).
- Unidad inicial y final de la banda de volumen. La unidad inicial especifica la cantidad
límite de la banda de volumen, y la unidad final especifica el límite superior de la banda de volumen. Para
Por ejemplo, si especificas una unidad inicial de 0 y una final de 1,000, la banda de volumen abarca
hasta 1,000 transacciones en el período de agregación. Si la moneda es el dólar estadounidense,
período de agregación es 1 mes y la tasa para las primeras 1, 000 transacciones es 0.15,
al desarrollador se le cobran USD 0.15 por transacción para un máximo de 1000 transacciones mensuales.
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta Cuándo se cobran las tarifas recurrentes. y restablecer los planes de los paquetes?
Si no especificas una unidad final para la banda de volumen final, la tarifa para esa banda es de se aplica a todas las transacciones una vez que la cantidad supera la unidad inicial para esa correa. Por ejemplo, si la unidad inicial para la última banda es 1,000 y no especificas una unidad final para esa banda, la tarifa de la banda se aplica a todas las transacciones luego de 1,000 transacciones en el período de agregación.
Ver Plan de tarifas detalla los parámetros de configuración para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un modelo de cobro por bandas de volumen. El se fija en USD 0.15 para las primeras 1,000 transacciones y en USD 0.10 para todas las transacciones superiores a 1,000. La base de agregación es 1 mes. El pago vence en 30 días. (Los detalles de la hoja de tarifas están resaltados).
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
Especificar un modelo de carga integrada
En un modelo de cobro en paquete, el desarrollador paga (por adelantado) un "paquete" de transacciones (o para un paquete basado en un atributo personalizado, como la cantidad de bytes transmitidos). Debes especificar un para cada paquete y una agregación de bases, es decir, un período en el que el desarrollador pueden usar el paquete.
Por ejemplo, supongamos que configuraste dos paquetes y el primero es de 1 a 1, 000. de transacciones, y el segundo tamaño del paquete es de 1,001 a 2,000 transacciones. La tarifa es de USD 50 para primer paquete y USD 40 por el segundo, y la base de agregación es 1. Si el desarrollador compra un plan de hoja de tarifas para el primer paquete, pagan 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 usa por completo o no. Una vez que finaliza el período de agregación, el plan vence. Si el desarrollador quiere usar el paquete debe volver a comprar el plan (y el paquete).
Lo que especifiques en los detalles del plan de tarifas es, en esencia, lo mismo que lo que especificas en la detalles del plan de tarifas para el 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 un rango de volumen).
- Debes especificar un límite superior para el último paquete, a menos que quieras cobrar la desarrollador un importe fijo para transacciones ilimitadas del último paquete.
Ver Plan de tarifas detalla los parámetros de configuración para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, lo siguiente crea un plan de hoja de tarifas con un modelo de cargos en paquete. La tarifa es de establecer en USD 50 para el primer paquete (hasta 1,000 transacciones) y USD 40 para el segundo paquete (más de 1,000 y hasta 2,000). La base de agregación es 1 mes. El pago vence dentro de 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
Especificación de un plan freemium para productos individuales mediante la API
En un plan de hoja de tarifas, puede 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 tiempo o según la cantidad de uso.
Cuando configuras un plan freemium para un producto de API, lo 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 y cargar. 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 la cantidad de transacciones relacionadas con el producto de API o el volumen pertenecientes 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 el número de unidades freemium. Para ejemplo, el siguiente crea un plan de hoja de tarifas con un plan freemium basado en un volumen de 5,000 (las especificaciones relacionadas con freemium están destacadas).
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