Configurar um plano freemium

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

Com um plano freemium, os desenvolvedores de apps podem usar um plano de tarifas sem custo financeiro por um período baseado no uso, na duração ou em ambos. É possível configurar um plano freemium para qualquer tipo de plano de tarifa, exceto para notificações ajustáveis.

Como configurar um plano freemium usando a interface

Configure um plano freemium para um, conforme descrito abaixo.

Edge

Para configurar um plano freemium usando a interface do Edge ao criar ou editar um plano de tarifa, selecione qualquer tipo (exceto notificação ajustável). Na seção Freemium, ative esse plano e selecione uma das seguintes opções:

  • Oferta por uso (número de chamadas de API)
  • Oferta por período
  • O que vier primeiro

Com base na sua seleção, configure um ou ambos os campos a seguir:

Campo Descrição
Uso freemium (chamadas de API) Observação: obrigatório se você selecionar Oferta por quantidade ou O que ocorrer primeiro.

Número de transações (ou valor de um atributo personalizado registrado na política de registro de transações) que não são cobradas dos desenvolvedores. O volume é medido para o produto de API.

Período freemium Observação: obrigatório se você selecionar Oferta por duração ou O que ocorrer primeiro.

Intervalo de tempo em que os desenvolvedores não são cobrados. Por exemplo, 30 dias. Especifique o número e a unidade (dia, semana ou mês).

Borda clássica (nuvem privada)

Para configurar um plano freemium usando a interface clássica do Edge:

  1. Selecione a guia Freemium.

  2. Digite as seguintes informações:
    Campo Descrição
    Pacote Freemium?

    A extensão do período sem custo financeiro. Selecione um dos seguintes botões de opção:

    • Por quantidade. O período sem custo financeiro é baseado em uma quantidade especificada no campo "Volume".
    • Por duração. O período sem custo financeiro é baseado em um intervalo de tempo especificado no campo Freemium Duration.
    • O que vier primeiro. O período sem custo financeiro termina quando a quantidade no campo "Volume" ou o intervalo de tempo no campo "Duração do Freemium" é atingido, o que ocorrer primeiro.
    • Não. Este não é um plano Freemium. Esse é o padrão.
    Volume freemium

    O volume de transações (ou o volume de um atributo personalizado registrado na política de registro de transações) pelas quais os desenvolvedores são cobrados. O volume é medido em todos os produtos no pacote da API. Digite um número de volume, como 5000. Isso significa que, quando os desenvolvedores iniciam o plano, eles não são cobrados pelas primeiras 5.000 transações (ou pelos primeiros 5.000 usos de um item personalizado relacionado a atributos). Esse campo só será ativado se você selecionar "Por quantidade" ou "O que vem primeiro" no campo "Pacote freemium?".

    Duração freemium

    O intervalo de tempo em que os desenvolvedores não são cobrados. Insira um número e selecione um período, como um mês. Isso significa que os desenvolvedores não são cobrados por um mês após a data de início do plano comprado. Esse campo só será ativado se você selecionar "Por duração" ou "O que ocorrer primeiro" no campo "Pacote freemium?".

Como configurar um plano freemium para um plano de tarifas usando a API

Você pode adicionar um plano freemium ao criar ou atualizar o plano de tarifas. Você especifica as propriedades freemium no corpo da solicitação da chamada.

Por exemplo, a solicitação a seguir cria um plano de tarifa padrão com período de duração freemium de 30 dias. (As especificações relacionadas ao freemium estão destacadas.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "freemiumDuration": "30",
     "freemiumDurationType": "DAY",
     "monetizationPackage": {
      "id": "location_package"
     },
     "organization": {
      "id": "{org_name}
     },
     "published": "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

Para especificar uma quantidade baseada em freemium (como o número de transações que envolvem o pacote de API ou o volume de um atributo personalizado registrado na política de registro de transações), especifique-a como um número de unidades freemium. Por exemplo, a seguinte atribuição de propriedade especifica que o freemium é baseado em 5.000 unidades freemium:

"freemiumUnit": "5000"

Consulte as configurações do plano de tarifa para conferir uma lista completa das opções de planos de tarifa.