Criar planos de tarifas futuros

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Introdução

Depois que um plano de tarifas existente é publicado, a única propriedade que pode ser alterada é a data de término. No entanto, é possível criar uma nova versão do plano que inclua as propriedades alteradas, como as taxas de plano de preços alteradas. Você pode configurar a revisão para que ela entre em vigor em uma data futura. A plano de tarifas original termina quando a revisão entra em vigor.

Por exemplo, suponha que você criou um plano de tarifação padrão que expira em 31 de dezembro de 2019 e você quer substituí-lo por outro que entre em vigor em 1o de janeiro de 2020. Para isso, você cria um plano de preços futuro e o configura para entrar em vigor em 1o de janeiro de 2020.

Se nenhuma data de término for definida para o plano de tarifas atual, será possível substituir um plano existente pelo um plano de preços futuro que comece hoje. Você precisa expirar o plano de tarifa atual, conforme descrito em Expirar um plano de tarifas publicado.

Os desenvolvedores são notificados sobre o plano de tarifas revisado. Os desenvolvedores que aceitarem como plano de preços são registrados automaticamente para a revisão (mas é possível rejeitar revisão).

É possível criar um plano de preços futuro usando a interface de gerenciamento ou a API de monetização, conforme descrito em nas seções a seguir.

Como criar um plano de preços futuro usando a interface

Crie um plano de tarifação futuro, conforme descrito abaixo.

Edge

Para criar uma versão futura de um plano de tarifas que será iniciada após hoje Na IU do Edge, siga estas etapas.

  1. Na página "Planos de tarifas", posicione o cursor na linha associada ao plano de tarifas para o qual você quer criar um plano de tarifas futuro.
    O plano de tarifação precisa ter uma data de término.
  2. Clique em +Futuro.
  3. Na seção Plano de tarifas futuro, selecione uma das seguintes opções:
    • Reiniciar período completo do contrato na nova data de vigência: o plano de tarifas futuro vai entrar em no início da vigência. O prazo de renovação do plano de tarifação futuro é o mesmo o plano de tarifa atual.
    • Deduzir o tempo gasto no contrato anterior do novo período, no início da vigência: o plano de tarifas futuro entrará em vigor no início da vigência. O tempo gasto usando a conta é deduzido do período de renovação do plano de tarifação futuro. Isso significa que, se um desenvolvedor usa o plano atual por três meses, e o período de renovação é reduzido em três meses.
  4. Configure os seguintes campos no painel superior:
    Observação: os outros campos são somente leitura.
    Campo Descrição Padrão Obrigatório
    Nome do plano de taxas

    Nome do seu plano de tarifação.

    Observação: o nome não precisa ser igual ao nome original do plano de tarifas.

    		 Nome do plano atual Sim
    Data de início Data em que o plano de tarifação entra em vigor. Digite uma data de início ou selecione uma no calendário. Hoje Não
    Data de término Data de término do plano de tarifação. Para especificar uma data de término, ative a chave Tem data de término e insira a data de término ou selecione uma no calendário.

    Observação: o plano de tarifação ficará em vigor até o fim do dia na data especificada. Se você quiser que um plano de tarifas expire em 1o de dezembro de 2018, por exemplo, defina o valor endDate como 2018-11-30. Nesse caso, o plano de tarifas expira ao final do dia, em 30 de novembro de 2018; todas as solicitações de 1o de dezembro de 2018 serão bloqueadas.

    		Nenhum Não
    Visível para portais Defina se o plano de tarifa é público ou particular. Consulte Planos de tarifas públicos e privados. Ativado Não
  5. Configure as taxas para o plano de tarifação. Consulte Como configurar taxas.
    Observação: não aplicável a planos de notificação ajustáveis.
  6. Se você selecionar um pacote de produtos que contenha mais de um produto de API, defina as seguintes preferências na seção Plano de tarifas específico ou genérico:
    Observação: esta etapa não se aplica a planos de notificação ajustáveis.
    Campo Descrição Padrão
    Configurar cada produto individualmente Sinalização que especifica se é necessário configurar um plano de tarifas individual para cada produto de API. Desativado
    Configurar a oferta freemium de cada produto individualmente Sinalização que especifica se você precisa configurar um plano freemium para cada produto de API. Desativado
    Selecione um produto Se você ativar uma ou ambas as sinalizações, deverá selecionar cada produto individualmente na lista suspensa e configurar os detalhes do plano de tarifação.

    Observação: configure todos os produtos no pacote de produtos.

    		N/A
  7. Configure os detalhes do plano de tarifação com base no tipo de plano selecionado:
  8. Clique em uma das seguintes opções:
    Botão Descrição
    Atualizar rascunho Salve o plano de tarifa como rascunho.

    O plano de tarifas não vai ficar visível para os desenvolvedores de apps até que seja publicado. É possível editar qualquer campo em um plano de tarifa de rascunho.

    Publicar rascunho Publique o plano.

    Observação: após a publicação de um plano de tarifas, só será possível modificar a data de término se ela ainda não estiver definida. Não é possível excluir um plano de tarifas depois de publicado, mas é possível expirar o plano de tarifas e substituí-lo por um plano de tarifas futuro, conforme descrito em Expirar um plano de tarifas publicado.

Edge clássico (nuvem privada)

Para criar uma versão futura de um plano de tarifas que será iniciada após hoje usando a IU clássica do Edge, siga as etapas abaixo.

  1. No catálogo de pacotes, clique em +Future na coluna Rascunho/Futuro do que você quer substituir.

    Isso abre uma janela futura "Plano de tarifa".

    A principal diferença entre a janela de um plano de tarifas futuro e a atual é adicionar uma seção "Assinantes atuais".

  2. Como você faria para qualquer plano de tarifa:
    • Digite um nome para o plano no campo Nome do plano de tarifação. O nome não precisa ser igual o nome do plano original.
    • Como configurar taxas para um plano de tarifas (opcional).
    • Configure os detalhes do plano de tarifas com base no tipo de plano selecionado:
    • Especifique a data em que o plano futuro entrará em vigor. Consulte Como publicar planos de tarifas. e uma data de término (você também pode selecionar "Sem data de término" se não quiser que o plano de preços futuro terminar em uma data específica). Se uma data de término for definida para o plano atual, o início da vigência do plano futuro deverá ser posterior à data de término do de um plano eficaz de resposta a incidentes.
  3. Na seção Assinantes atuais, selecione uma destas opções:
    • Reiniciar o período completo do contrato na nova data de vigência. O plano de tarifa futuro entra em no início da vigência. O prazo de renovação do plano de tarifação futuro é o mesmo o plano de tarifa atual.
    • Deduzir o tempo gasto no contrato anterior do novo período, no início da vigência. A plano de tarifas futuro entrará em vigor no início da vigência. O tempo gasto usando a conta é deduzido do período de renovação do plano de tarifação futuro. Isso significa que, se um desenvolvedor usa o plano atual por três meses, e o período de renovação é reduzido em três meses.
  4. No campo Data efetiva, insira uma data de início que ocorra após a data de término do plano de tarifas atual.

Como criar um plano de tarifação futuro usando a API

É possível criar um plano de tarifas futuro usando a API emitindo uma solicitação POST para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revision.

Em que:

  • {org_id} é o nome da organização.
  • {package_id} é a identificação do pacote da API.
  • {plan_Id} é a identificação do plano de tarifação.
Ao criar a revisão, especifique as seguintes propriedades no corpo da solicitação:
  • parentRatePlan especifica o ID do plano de tarifas original.
  • startDate especifica a data em que o novo plano entrará em vigor.

O nome do plano de tarifa futuro não pode ser igual ao do plano original. Além disso, devem ser único entre todos os seus planos de tarifas. Se você quiser manter a data de início original registrada para os desenvolvedores, defina a flag keepOriginalStartDate como true. Esta sinalização o padrão é false.

Para obter mais informações sobre as definições de configuração, consulte Definições da configuração para planos de tarifas

Por exemplo, a solicitação a seguir cria um plano de tarifas futuro:

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "parentRatePlan": {
       "id": "monetization_package_flat_rate_card_plan_1379513833409"
     },
     "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": "myorg"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.05",
        "startUnit": "0"       
       }      
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2014-01-01 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/monetization_package_flat_rate_card_plan_1379513833409/revision" \
-u email:password