Configurar o modelo de receita

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

Configure seu plano de taxas para usar um ou mais dos modelos de receita ou tipos de plano de taxas 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 da API compartilha com o desenvolvedor uma porcentagem da receita gerada por cada transação. Por exemplo, o consumidor compra um produto físico ou digital usando a API, e uma parte da receita é compartilhada com o desenvolvedor de apps.

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

  • Modelo de compartilhamento fixo: compartilhe com o desenvolvedor uma porcentagem fixa da receita gerada por 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 durante um 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 pode configurar:

  • Se o plano de taxas 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 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 cobrança são compatíveis:

  • Taxa fixa: o desenvolvedor é cobrado uma taxa fixa por cada transação.
  • Faixa de volume: o desenvolvedor é cobrado uma taxa variável dependendo do volume de transações.
  • Pacotes: o desenvolvedor é cobrado um valor definido (antecipadamente) por cada pacote de transações. O desenvolvedor é cobrado o valor definido, independentemente de o pacote ser usado por completo ou não.

Você também pode configurar:

  • Se o plano de taxas 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 detalhes do plano da tabela de preços

Com base no uso com atributo personalizado

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

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

Especificar o plano de taxas com detalhes de atributos personalizados

Participação na receita e com base no uso

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

Especificar detalhes do plano de participação na receita

Especificar detalhes do plano da tabela de preços

Taxas

O desenvolvedor de apps é cobrado para usar o pacote de API e os recursos dele.

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

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 cobrada se o desenvolvedor encerrar o plano antes do prazo de renovação.
  • Taxa recorrente: taxa cobrada do desenvolvedor de forma contínua até que ele encerre o plano.

Para taxas recorrentes, você também pode configurar:

  • Duração entre as cobranças de taxas recorrentes (como 30 dias).
  • Se uma taxa é proporcional se um desenvolvedor iniciar ou encerrar um plano no meio de um mês.
  • Se a taxa recorrente é cobrada antecipadamente.
  • Quando as taxas vencem.

Especificar taxas somente detalhes do plano

Adicionar taxas a um plano de taxas

Freemium

O desenvolvedor pode usar um produto de API sem custo por um período ou com base em a quantidade de uso.

Adicionar um plano freemium

Notificação ajustável

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

Observação: um plano de taxas de notificação ajustável pode ser ajustado após a publicação. Para todos os outros tipos de plano de taxas, os detalhes são finais depois que o plano é publicado e são iguais para todos os desenvolvedores de apps que aceitam o plano.

É possível configurar se e quando as notificações são enviadas com base na porcentagem do número de destino atingido, como 90%, 100% ou 150%. As transações adicionais não são bloqueadas depois que o número de destino é atingido. Você também pode configurar 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 de notificação. Funcionalmente equivalente a um plano de notificação ajustável, mas o contador de transações é baseado em um valor variável ou 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:

Opcional: adicione taxas ou um plano freemium: