Configurar o modelo de receita

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

Configure seu plano de tarifas para usar um ou mais dos modelos de receita ou tipos de plano de tarifa mostrados na figura a seguir.

A tabela a seguir apresenta cada modelo de receita, descreve as opções de configuração e fornece um link para mais informações.

Modelo de receita Descrição Mais informações

Participação na receita

O provedor de API compartilha com o desenvolvedor uma porcentagem da receita gerada em cada transação. Por exemplo, o consumidor compra um produto físico ou digital usando a API, e uma parte dos lucros é compartilhada com o desenvolvedor do app.

Há suporte para os seguintes modelos de compartilhamento:

  • Modelo de compartilhamento fixo: compartilha com o desenvolvedor uma porcentagem fixa da receita gerada em cada transação (com base no preço bruto ou líquido de uma transação).
  • Modelo de compartilhamento flexível: compartilhe com o desenvolvedor uma porcentagem variável da receita.

A participação na receita depende da receita gerada em determinado período. A porcentagem usada no cálculo da participação na receita pode variar com base no valor da receita gerada pelas transações.

Você também vai configurar:

  • Indica se o plano de tarifas se aplica a todos os produtos em um pacote de API ou a um produto específico.
  • Período de renovação (em meses ou anos).
  • Quando o pagamento vence.

Especificar os detalhes do plano de participação na receita

Com base no uso (tabela de preços)

O desenvolvedor é cobrado por cada transação.

Os seguintes modelos de carregamento são compatíveis:

  • Taxa fixa: é cobrada uma taxa fixa do desenvolvedor para cada transação.
  • Volume em banda: é cobrada uma taxa variável do desenvolvedor, dependendo do volume de transações.
  • Pacotes: é cobrado do desenvolvedor um valor definido (antecipadamente) para cada pacote de transações. O desenvolvedor é cobrado pelo valor definido, mesmo que o pacote não seja totalmente usado.

Você também vai configurar:

  • Indica se o plano de tarifas se aplica a todos os produtos em um pacote de API ou a um produto específico.
  • Período de renovação (em meses ou anos).
  • Quando o pagamento vence.

Especificar os detalhes do plano de preços

Uso com base no atributo personalizado

O desenvolvedor de apps é cobrado com base em um atributo personalizado em cada transação. Por exemplo, se você configurar um plano para cobrar o desenvolvedor por cada transação, poderá definir a taxa para o plano com base em um atributo personalizado, como o número de bytes transmitidos no back-end, que pode variar de acordo com a transação.

Observação:esse tipo de plano de tarifa só estará disponível se você especificar atributos personalizados para o produto da API.

Especificar o plano de tarifa com detalhes do atributo personalizado

Participação na receita e com base no uso

O provedor de API compartilha com o desenvolvedor do app uma porcentagem da receita gerada em cada transação, e o desenvolvedor do app é cobrado por cada transação.

Especificar os detalhes do plano de participação na receita

Especificar os detalhes do plano de preços

Taxas

O desenvolvedor de apps cobra taxas para usar o pacote de API e os recursos dele.

Crie um plano de tarifa ou adicione taxas a um plano.

As taxas podem incluir:

  • Taxa de configuração: taxa única cobrada de cada desenvolvedor na data de início do plano.
  • Taxa de rescisão antecipada: taxa única que será cobrada se o desenvolvedor encerrar o plano antes do período de renovação.
  • Taxa recorrente: taxa cobrada do desenvolvedor de forma contínua até que o desenvolvedor encerre o plano.

Para taxas recorrentes, você também configura:

  • Duração entre as cobranças recorrentes das taxas (por exemplo, 30 dias).
  • Indica se uma taxa é proporcional se um desenvolvedor iniciar ou encerrar um plano no meio do mês.
  • Se a taxa recorrente é cobrada antecipadamente.
  • Quando as taxas são devidas

Especificar detalhes do plano apenas com tarifas

Adicionar taxas a um plano de tarifa

Freemium

O desenvolvedor usa um produto de API sem custo financeiro durante um período ou com base na quantidade de uso.

Adicionar um plano freemium

Notificação ajustável

Plano somente para notificações. O provedor da API pode ajustar o número desejado de transações para cada desenvolvedor de apps que acionará a notificação.

Observação: é possível ajustar um plano de tarifa de notificação ajustável após a publicação do plano. Para todos os outros tipos de plano de tarifa, os detalhes são definitivos quando o plano é publicado e são os mesmos para todos os desenvolvedores de apps que aceitarem o plano.

É possível configurar se e quando as notificações serão enviadas com base na porcentagem do número desejado que foi atingida (90%, 100% ou 150%). Outras transações não são bloqueadas depois que o número desejado é alcançado. Você também configura o período de renovação (em meses ou anos).

Especificar detalhes do plano de notificação ajustável

Notificação ajustável com atributo personalizado

Plano somente para notificações. Funcionalmente equivalente a um plano de notificação ajustável, mas o contador de transações é baseado em uma variável ou um valor personalizado.

Por exemplo, talvez seja necessário:

  • Cobrar dos desenvolvedores um valor variável com base em um valor fornecido na mensagem de uma chamada de API. Por exemplo, talvez você queira cobrar dos desenvolvedores de apps com base no número de bytes transmitidos na solicitação de API.
  • Agrupar várias chamadas de API em uma única transação.

Especificar detalhes do plano de notificação ajustável

Próximas etapas

Especifique os detalhes da tabela de preços para seu modelo de receita:

Se quiser, adicione taxas ou um plano freemium: