Administra planes de tarifas

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

Administra los planes de tarifas con la IU y la API, como se describe en las siguientes secciones.

Explora la página de planes de tarifas

Accede a la página de planes de tarifas, como se describe a continuación.

Cómo crear un plan de tarifas

Para crear un plan de tarifas, sigue estos pasos:

1. Accede a la página Planes de tarifas.
2. Haz clic en + Plan de tarifas.
3. Configura los siguientes campos en el panel superior:
   

   Campo	Descripción	Predeterminado	Obligatorio
   Nombre del plan de tarifas	Es el nombre de tu plan de tarifas. NOTE: El nombre debe ser único dentro de un paquete de productos de API. Dos planes en el mismo paquete de productos no pueden tener el mismo nombre.	N/A	Sí
   Tipo de plan de tarifas	Es el tipo de plan de tarifas. Selecciona un valor de la lista desplegable. Para obtener una lista de los tipos de planes de tarifas válidos, consulta Tipos de planes de tarifas admitidos.	N/A	Sí
   Paquete de productos	Es un paquete de productos de API. Selecciona un valor de la lista desplegable. Para obtener más información sobre los paquetes de productos de API, consulta Administra paquetes de productos de API. Si seleccionas un paquete de productos que contiene más de un producto de API, debes seleccionar si deseas configurar planes de tarifas individuales para cada producto de API o un plan de tarifas genérico que se aplicará a todos los productos de API.	N/A	Sí
   Público	Es el público que puede acceder al plan de tarifas. Selecciona uno de los siguientes valores en la lista desplegable: Todos: Todos los desarrolladores. Desarrollador: Es el desarrollador o la empresa. Ingresa el nombre del desarrollador o la empresa. A medida que escribes, aparece una lista desplegable de los desarrolladores o las empresas que contienen la cadena. Haz clic en el nombre del desarrollador o la empresa en la lista desplegable. Categoría de desarrollador: Es la categoría de desarrollador. Selecciona la categoría de desarrollador en la lista desplegable. Configura las categorías de desarrolladores según sea necesario, como se describe en Administra categorías de desarrolladores.	Todos	No
   Fecha de inicio	Fecha en la que entra en vigencia el plan de tarifas. Ingresa una fecha de inicio o selecciona una fecha con el calendario.	Hoy	No
   Fecha de finalización	Fecha de finalización del plan de tarifas. Para especificar una fecha de finalización, habilita el botón de activación Tiene fecha de finalización y, luego, ingresa una fecha de finalización o selecciona una fecha con el calendario. NOTA: El plan de tarifas estará vigente hasta el final del día de la fecha especificada. Por ejemplo, si deseas que un plan de tarifas venza el 1 de diciembre de 2018, debes establecer el valor de endDate en 2018-11-30. En este caso, el plan de tarifas vencerá al final del día el 30 de noviembre de 2018, y se bloquearán todas las solicitudes del 1 de diciembre de 2018.	Ninguno	No
   Visible para los portales	Establece si el plan de tarifas es público o privado. Consulta Planes de tarifas públicos y privados.	Habilitado	No

4. Configura las comisiones del plan de tarifas. Consulta Cómo configurar las comisiones de un plan de tarifas.
   NOTE: No se aplica a los planes de notificaciones ajustables.
5. Si seleccionas un paquete de productos que contiene más de un producto de API, establece las siguientes preferencias en la sección Plan de tarifas específico o genérico:
   NOTA: Este paso no se aplica a los planes de notificaciones ajustables.
   

   Campo	Descripción	Predeterminado
   Configura cada producto de forma individual	Es una marca que especifica si se debe configurar un plan de tarifas individual para cada producto de API.	Inhabilitado
   Configura la oferta freemium de cada producto de forma individual	Es una marca que especifica si se debe configurar un plan freemium para cada producto de API.	Inhabilitado
   Selecciona un producto	Si habilitas una o ambas marcas, debes seleccionar cada producto de forma individual en la lista desplegable y configurar los detalles de su plan de tarifas. NOTE: Asegúrate de configurar todos los productos del paquete.	N/A

6. Configura los detalles del plan de tarifas según el tipo de plan seleccionado:
   
   • Freemium
   • Hoja de tarifas
   • Porcentaje de ingresos
   • Notificación ajustable
7. Haz clic en una de las siguientes opciones:
   

   Botón	Descripción
   Guardar como borrador	Guarda el plan de tarifas como borrador. Los desarrolladores de apps no podrán ver el plan de tarifas hasta que lo publiques. Puedes editar cualquier campo de un plan de tarifas en borrador.
   Publicar plan nuevo	Publica el plan. NOTE: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no está establecida. No puedes borrar un plan de tarifas después de que se publique, pero puedes hacer que venza y reemplazarlo por un plan de tarifas futuro, como se describe en Cómo hacer que venza un plan de tarifas publicado.

8. Adjunta la política de Monetization Limits Check a los proxies de API asociados con los productos de API incluidos en el plan de tarifas. La política Monetization Limits Check aplica límites de monetización en los proxies de API y garantiza que las fallas se registren con precisión en los informes de análisis y monetización. Para obtener más información, consulta Aplica límites de monetización en proxies de API de forma forzosa.

Cómo editar un plan de tarifas

Puedes editar todos los campos de un plan de tarifas en borrador, excepto el paquete de productos, el tipo y el público. Después de publicar un plan de tarifas, solo puedes editar la fecha de finalización y solo si no se especificó ninguna.

Para editar un plan de tarifas, sigue estos pasos:

1. Accede a la página Planes de tarifas.
2. Haz clic dentro de la fila del plan de tarifas que deseas editar.
   Se mostrará el panel del plan de tarifas.
3. Edita los campos del plan de tarifas según sea necesario.
   NOTE: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no está establecida.
4. Haz clic en una de las siguientes opciones:

   Botón	Descripción
   Actualizar borrador (planes de tarifas de borrador)	Guarda el plan de tarifas como borrador. Los desarrolladores de apps no podrán ver el plan de tarifas hasta que lo publiques. Puedes editar cualquier campo de un plan de tarifas en borrador.
   Publicar borrador (planes de tarifas en borrador)	Publica el plan de tarifas. NOTE: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no se estableció. No puedes borrar un plan de tarifas después de que se publique, pero puedes hacer que venza y reemplazarlo por un plan de tarifas futuro, como se describe en Cómo hacer que venza un plan de tarifas publicado.
   Fecha de finalización actualizada (planes de tarifas publicados)	Establece la fecha de finalización de un plan publicado. NOTE: Después de establecer la fecha de finalización de un plan de tarifas publicado, ya no se podrá modificar.

Cómo borrar un borrador de plan de tarifas

Borra un plan de tarifas en borrador si ya no lo necesitas.

NOTA: No puedes borrar un plan de tarifas publicado.

Para borrar un borrador de plan de tarifas, haz lo siguiente:

1. Accede a la página Planes de tarifas.
2. Coloca el cursor sobre el plan de tarifas que deseas borrar para que se muestre el menú de acciones.
3. Haz clic en .
4. Haz clic en Borrar para confirmar la acción.

Administra planes de tarifas con la API

En las siguientes secciones, se describe cómo administrar planes de tarifas con la API.

Crea planes de tarifas con la API

Para crear un plan de tarifas, envía una solicitud POST a /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, donde {monetizationpackage_id} es el ID del paquete de productos de API para el que creas el plan de tarifas (el ID se devuelve en la respuesta cuando creas el paquete de productos de API).

Cuando creas un plan de tarifas, debes especificar lo siguiente en el cuerpo de la solicitud:

• ID de organización
• ID del paquete de productos de API
• Nombre del plan de tarifas
• Descripción del plan de tarifas
• Alcance del plan de tarifas (si se aplica a todos los desarrolladores o solo a un desarrollador, empresa o categoría de desarrollador específicos)
• Fecha en la que entra en vigencia el plan de tarifas
• Moneda del plan de tarifas
• Indica si se publicará el plan de tarifas.
• Indica si el plan de tarifas es público o privado.

Existen otros parámetros de configuración que puedes especificar de forma opcional, como el período en el que vence el pago (por ejemplo, 30 días). Consulta Propiedades de configuración para planes de tarifas.

Si creas un plan de tarifas (que no sea solo de comisiones) para un paquete de productos de API que tenga más de un producto, puedes aplicar el plan a un producto específico del paquete. Para ello, identifica el producto en la solicitud. Si no identificas un producto, el plan se aplica a todos los productos del paquete de productos de API.

En las siguientes secciones, se describe cómo crear planes de tarifas:

• Crea un plan de tarifas estándar con la API
• Crea un plan de tarifas para desarrolladores o empresas con la API
• Cómo crear un plan de tarifas de categorías de desarrolladores con la API
• Crea un plan de tarifas específico para un producto de API con la API
• Cómo configurar el plan de tarifas como público o privado con la API

Crea un plan de tarifas estándar con la API

Para crear un plan de tarifas estándar, establece el atributo type en STANDARD, como se muestra en el siguiente ejemplo.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Crea un plan de tarifas para desarrolladores o empresas con la API

Para aplicar el plan de tarifas a un desarrollador o una empresa específicos, establece el valor de type en Developer. También debes identificar al desarrollador o la empresa en la solicitud, indicando el ID, el nombre legal y el nombre del desarrollador o la empresa.

Por ejemplo, el siguiente fragmento crea un plan de tarifas para el desarrollador Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Crea un plan de tarifas de categoría de desarrollador con la API

Para aplicar el plan de tarifas a una categoría de desarrolladores, establece el valor de type en Developer_Category. También debes identificar la categoría de desarrollador en la solicitud. Por ejemplo:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Crea un plan de tarifas específico para un producto de API con la API

Cuando creas un plan de tarifas para paquetes de productos de API que incluyen varios productos de API, puedes especificar los detalles del plan de tarifas para los productos de API de forma individual.

Por ejemplo, el siguiente comando crea un plan de participación en los ingresos con dos productos de API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Para agregar un producto de API al paquete de productos de API my-package, deberás agregar los detalles del plan de tarifas para el producto de API en el cuerpo de la solicitud, como se describe en Cómo agregar un producto de API a un paquete de productos de API con planes de tarifas específicos del producto de API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Cómo configurar el plan de tarifas como público o privado con la API

Cuando crees un plan de tarifas, puedes especificar si es público o privado con el atributo isPrivate en el cuerpo de la solicitud. Si se establece en true, el plan de tarifas será privado. Para obtener más información, consulta Planes de tarifas públicos y privados.

Por ejemplo, el siguiente código crea un plan de tarifas privado:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Publica un plan de tarifas con la API

Para publicar un plan de tarifas, establece el valor de la propiedad published en verdadero cuando crees el plan de tarifas. Los desarrolladores podrán ver el plan de tarifas a partir de la fecha especificada en la propiedad startDate del plan.

Por ejemplo, el siguiente código crea un plan de tarjeta de tarifas y lo publica (solo se muestra parte de la solicitud):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Cómo guardar un borrador de plan de tarifas con la API

Para guardar un plan de tarifas sin publicarlo, establece el valor de la propiedad published en falso cuando crees el plan de tarifas.

Por ejemplo, el siguiente código crea un plan de tarjeta de tarifas y lo guarda como borrador (solo se muestra parte de la solicitud):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Edita un borrador de plan de tarifas con la API

Para actualizar un borrador de plan de tarifas, envía una solicitud PUT a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, donde {package_id} es la identificación del paquete de la API y {plan_Id} es la identificación del plan de tarifas. Cuando realices la actualización, deberás especificar en el cuerpo de la solicitud la configuración actualizada y el ID del plan de tarifas. Si actualizas la tarifa de un plan de tarifas, también debes especificar el ID de la tarifa del plan de tarifas. Por ejemplo, la siguiente solicitud actualiza la tarifa de un plan de tarifas cuyo ID es location_flat_rate_card_plan (la actualización está destacada):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "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": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "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/location_flat_rate_card_plan" \
-u email:password

La respuesta incluye la tarifa del plan de tarifas actualizada (solo se muestra una parte de la respuesta):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Visualiza planes de tarifas con la API

Puedes consultar los planes de tarifas con la API de Monetización, como se describe en las siguientes secciones.

• Visualiza todos los planes de tarifas de una organización con la API
• Visualiza todos los planes de tarifas de un paquete de productos de API con la API
• Visualiza un plan de tarifas para un paquete de productos de API con la API
• Visualiza todos los planes de tarifas activos para un desarrollador con la API
• Visualiza un plan de tarifas aceptado para un desarrollador con la API
• Visualiza un plan de tarifas aceptado para un desarrollador que contiene un producto de API con la API
• Visualiza todos los planes de tarifas que acepta un desarrollador con la API

Visualiza todos los planes de tarifas de una organización con la API

Para ver todos los planes de tarifas de una organización, envía una solicitud GET a /mint/organizations/{org_name}/rate-plans, donde {org_name} es el nombre de tu organización.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Visualiza todos los planes de tarifas de un paquete de productos de API con la API

Para ver todos los planes de tarifas de un paquete de API, envía una solicitud GET a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, donde {package_id} es el ID del paquete de API (el ID del paquete se devuelve cuando creas el paquete de monetización).

De forma predeterminada, en los resultados solo se muestran los planes de tarifas activos, públicos y estándar. Debes incluir lo siguiente:

• En el caso de los planes de tarifas en borrador o vencidos, establece el parámetro de consulta current en false (por ejemplo, ?current=false).
• En el caso de los planes de tarifas privados, establece el parámetro de consulta showPrivate en true (por ejemplo, ?showPrivate=true).
• En todos los planes de tarifas estándar, establece el parámetro de consulta standard en true (por ejemplo, ?standard=true).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Visualiza un plan de tarifas para un paquete de API con la API

Para ver un plan de tarifas de un paquete de API, envía una solicitud GET a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, donde {package_id} es el ID del paquete de API y {plan_id} es el ID del plan de tarifas (el ID del paquete se devuelve cuando creas el paquete de monetización, y el ID del plan de tarifas se devuelve cuando creas el plan de tarifas).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Visualiza todos los planes de tarifas activos para un desarrollador con la API

Para ver todos los planes de tarifas activos de un desarrollador, envía una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, donde {developer_id} es la dirección de correo electrónico del desarrollador.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Visualiza un plan de tarifas aceptado para un desarrollador con la API

Para ver un plan de tarifas activo para un desarrollador, envía una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, donde {developer_id} es la dirección de correo electrónico del desarrollador y {developer_rateplan_id} es el ID del plan de tarifas aceptado que se devuelve en la respuesta cuando aceptas el plan de tarifas publicado.

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Visualiza un plan de tarifas aceptado para un desarrollador que contiene un producto de API con la API

Para ver un plan de tarifas aceptado para un desarrollador que contiene un producto de API, envía una solicitud GET a /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, donde {developer_id} es el ID del desarrollador y /{product_id} es el ID del producto.

De forma predeterminada, solo se devuelve un plan de tarifas público en los resultados. Para mostrar un plan de tarifas privado, establece el parámetro de consulta showPrivate en true (por ejemplo, ?showPrivate=true).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Visualiza todos los planes de tarifas que aceptó un desarrollador con la API

Para ver los planes de tarifas que aceptó un desarrollador, envía una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, en la que {developer_id} es el ID del desarrollador.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Borra un borrador de plan de tarifas con la API

Para borrar un borrador de plan de tarifas, envía una solicitud DELETE a /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, donde {plan_Id} es la identificación del plan de tarifas que se borrará y {package_id} es la identificación del paquete de la API para el plan de tarifas. Por ejemplo:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Propiedades de configuración de los planes de tarifas

Cuando creas un plan de tarifas con la API, puedes especificar los siguientes parámetros de configuración.

Propiedades de configuración para los detalles del plan de tarifas

Puedes especificar cualquiera de las siguientes propiedades de configuración como parte del array ratePlanDetails cuando crees el plan de tarifas.