Criar planos de tarifas futuros

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

Depois que um plano de taxas é 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 propriedades alteradas, como as taxas do plano. Você pode configurar a revisão para entrar em vigor em uma data futura. O plano de taxas original termina quando a revisão entra em vigor.

Por exemplo, suponha que você tenha criado um plano de taxas padrão que expira em 31 de dezembro de 2019 e queira substituí-lo por outro que entre em vigor em 1º de janeiro de 2020. Para fazer isso, crie um plano de taxas futuro e configure-o para entrar em vigor em 1º de janeiro de 2020.

Se nenhuma data de término for definida para o plano de taxas atual, você poderá substituir um plano de taxas existente por um futuro que comece hoje. Será necessário expirar o plano de taxas atual, conforme descrito em Expirar um plano de taxas publicado.

Os desenvolvedores são notificados sobre o plano de taxas revisado. Os desenvolvedores que aceitam o plano de taxas original são registrados automaticamente para a revisão, mas têm a opção de rejeitá-la .

É possível criar um plano de taxas 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 taxas futuro usando a interface

Crie um plano de taxas futuro, conforme descrito abaixo.

Edge

Para criar uma versão futura de um plano de taxas que começa algum tempo depois de hoje usando a interface do Edge, siga estas etapas.

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

    Nome do seu plano de taxas.

    Observação: o nome não precisa corresponder ao nome do plano de taxas original.

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

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

    		Nenhum Não
    Visível para portais Defina se o plano de taxas é público ou particular. Consulte Planos de tarifas públicos e tarifas exclusivas. Ativado Não
  5. Configure as taxas do plano de taxas. Consulte Configurar taxas.
    Observação: não aplicável a planos de notificação ajustáveis.
  6. Se você selecionar um pacote de produtos que contém mais de um produto de API, defina as seguintes preferências na seção Plano de taxas específico ou genérico:
    Observação: esta etapa não é aplicável a planos de notificação ajustáveis.
    Campo Descrição Padrão
    Configurar cada produto individualmente Flag que especifica se um plano de taxas individual será configurado para cada produto de API. Desativado
    Configurar a oferta freemium de cada produto individualmente Flag que especifica se um plano freemium será configurado para cada produto de API. Desativado
    Selecione um produto Se você ativar uma ou ambas as flags, selecione cada produto individualmente na lista suspensa e configure os detalhes do plano de taxas.

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

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

    O plano de taxas não ficará visível para os desenvolvedores de apps até que você o publique. É possível editar qualquer campo em um plano de taxas de rascunho.

    Publicar rascunho Publique o plano.

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

Edge clássico (nuvem privada)

Para criar uma versão futura de um plano de taxas que começa algum tempo depois de hoje usando a interface do Edge clássico, siga estas etapas.

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

    Isso abre uma janela de plano de taxas futuro.

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

  2. Como você faria para qualquer plano de taxas:
    • Insira um nome para o plano no campo "Nome do plano de taxas". O nome não precisa corresponder o nome do plano de taxas original.
    • Configurar taxas para um plano de taxas (opcional).
    • Configure os detalhes do plano de taxas com base no tipo de plano de taxas selecionado:
    • Especifique uma data em que o plano futuro entra em vigor (consulte Publicar planos de taxas), 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 taxas futuro termine em uma data específica. Se uma data de término for definida para o plano atual, a data de início da vigência do plano futuro deverá 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 de contrato completo na nova data de início da vigência. O plano de taxas futuro entra em vigor na data de início da vigência. O prazo de renovação do plano de taxas futuro é o mesmo do plano de taxas atual.
    • Deduzir o tempo gasto no contrato anterior do novo período, na data de início da vigência. O plano de taxas futuro entra em vigor na data de início da vigência. O tempo gasto usando o plano de taxas atual é deduzido do prazo de renovação do plano de taxas futuro. Isso significa que, se um desenvolvedor usar o plano atual por três meses, o período de renovação será reduzido em três meses.
  4. No campo "Data de início da vigência", insira uma data de início que ocorra após a data de término do plano de taxas atual.

Como criar um plano de taxas futuro usando a API

É possível criar um plano de taxas futuro usando a API enviando 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 taxas.
Ao criar a revisão, é necessário especificar as seguintes propriedades no corpo da solicitação:
  • parentRatePlan especifica o ID do plano de taxas original.
  • startDate especifica a data em que o novo plano entra em vigor.

O nome do plano de taxas futuro não pode corresponder ao nome do plano original. Além disso, ele precisa ser exclusivo entre todos os planos de taxas. Se você quiser manter a data de início original registrada para os desenvolvedores, defina a flag keepOriginalStartDate como true. Essa flag é definida como false por padrão.

Para mais informações sobre as configurações, consulte Configurações de planos de taxas.

Por exemplo, a solicitação a seguir cria um plano de taxas 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