Criar planos de tarifas futuros

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Introdução

Depois que um plano de tarifa é publicado, a única propriedade que pode ser alterada é a data de término. No entanto, é possível criar uma nova versão do plano com as propriedades alteradas, como taxas alteradas do plano. É possível configurar a revisão para que ela entre em vigor no futuro. O plano de tarifa original termina quando a revisão entra em vigor.

Por exemplo, suponha que você criou um plano de tarifa padrão que expira em 31 de dezembro de 2019 e quer substituí-lo por outro que entre em vigor em 1o de janeiro de 2020. Para isso, crie um plano de tarifas futuro e configure-o para entrar em vigor a partir de 1o de janeiro de 2020.

Se nenhuma data de término for definida para o plano de tarifas atual, você poderá substituir o atual por um futuro, que começa hoje. O plano de tarifas atual precisará expirar, conforme descrito em Expirar um plano de tarifas publicado.

Os desenvolvedores são notificados sobre o plano de preços revisado. Os desenvolvedores que aceitam o plano de tarifas original são registrados automaticamente na revisão, mas têm a opção de rejeitar a revisão.

Você pode criar um plano de tarifas futuro usando a interface de gerenciamento ou a API de monetização, conforme descrito nas seções a seguir.

Como criar um plano de tarifa futuro usando a interface

Crie um plano de tarifas futuro, conforme descrito abaixo.

Edge

Para criar uma versão futura de um plano de tarifa que será iniciada depois de hoje usando a IU do Edge, siga as etapas abaixo.

  1. Na página Planos de tarifa, posicione o cursor na linha associada ao plano de tarifa para criação do futuro.
    O plano de tarifa precisa ter uma data de término.
  2. Clique em +Futuro.
  3. Na seção Plano de tarifa futuro, selecione uma das seguintes opções:
    • Reiniciar o período de contrato completo na nova data de vigência: o plano de tarifação futuro vai entrar em vigor no início da vigência. A vigência da renovação do plano de tarifas futuro é a mesma do plano atual.
    • Deducar o tempo gasto no contrato anterior do novo período, no início da vigência: o plano de tarifação futuro vai entrar em vigor no início da vigência. O tempo gasto com o uso do plano de tarifas atual é deduzido do prazo de renovação do plano de tarifas futuro. Isso significa que, se um desenvolvedor usar o plano atual por três meses e o período de renovação for 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 plano de tarifa.

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

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

    Observação: o plano de tarifa vai entrar em vigor até o fim do dia na data especificada. Se você quiser expirar um plano de tarifas em 1o de dezembro de 2018, por exemplo, defina o valor de endDate como 30/11/2018. Nesse caso, o plano de tarifação expira no final do dia, em 30 de novembro de 2018. Todas as solicitações feitas em 1o de dezembro de 2018 serão bloqueadas.

    Nenhum Não
    Visível para os portais Defina se o plano de tarifa é público ou privado. Consulte Planos de tarifas públicos x privados. Ativado Não
  5. Configurar as taxas do plano de tarifas. Consulte Como configurar taxas.
    Observação: não se aplica a planos de notificação ajustáveis.
  6. Se você selecionar um pacote de produtos com 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 um plano freemium precisa ser configurado para cada produto de API. Desativado
    Selecione um produto Se você ativar uma ou ambas as flags, será preciso selecionar cada produto individualmente na lista suspensa e configurar os detalhes do plano de tarifa.

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

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

    O plano de tarifa só vai aparecer para os desenvolvedores de apps quando você o publicar. Você pode editar qualquer campo em um plano de tarifa de rascunho.

    Publicar rascunho Publique o plano.

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

Borda clássica (nuvem privada)

Para criar uma versão futura de um plano de tarifa com início em algum momento depois de hoje usando a IU clássica do Edge, siga as etapas abaixo.

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

    Isso abre uma janela futura do plano de tarifa.

    A principal diferença entre uma janela de plano de tarifação futura e uma janela de plano de tarifa atual é a adição de uma seção "Assinantes atuais".

  2. Como faria com qualquer plano de tarifas:
    • Digite um nome para o plano no campo Nome do plano de tarifa. Esse nome não precisa ser igual ao do plano de tarifas original.
    • Configurar taxas de um plano de tarifas (opcional).
    • Configure os detalhes do plano de tarifa com base no tipo selecionado:
    • Especifique uma data quando o plano futuro vai entrar em vigor (consulte Como publicar planos de tarifas) e uma data de término. Também é possível selecionar "Sem data de término" se você não quiser que o plano de tarifas futuro termine 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 precisa ser posterior à data de término do plano atual.
  3. Na seção "Assinantes atuais", selecione uma das seguintes opções:
    • Reiniciar o período do contrato completo na nova data de início da vigência. O plano de tarifa futuro vai entrar em vigor no início da vigência. A vigência da renovação do plano de tarifas futuro é a mesma do plano atual.
    • Deduzir o tempo gasto no contrato anterior do novo período, no início da vigência. O plano de tarifação futuro vai entrar em vigor no início da vigência. O tempo gasto com o uso do plano de tarifas atual é deduzido do prazo de renovação do plano de tarifas futuro. Isso significa que, se um desenvolvedor usar o plano atual por três meses e o período de renovação for reduzido em três meses.
  4. No campo "Início da vigência", insira uma data de início que ocorra após a data de término do plano de tarifa.

Criação de um plano de tarifas 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 de API.
  • {plan_Id} é a identificação do plano de tarifas.
Ao criar a revisão, é necessário especificar 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 entra em vigor.

O nome do plano de tarifas futuro não precisa ser igual ao do plano original. Se você quiser manter a data de início original registrada para os desenvolvedores, defina a flag keepOriginalStartDate como true. O padrão dessa sinalização é false.

Para mais informações sobre as definições de configuração, consulte Definições de 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