Configurar plano de divisão da receita

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

Introdução

Em um plano de participação na receita, o provedor de API compartilha com o desenvolvedor uma porcentagem da receita gerada em cada transação (com base no preço bruto ou líquido de uma transação). Ao criar um plano de participação na receita, é necessário indicar um modelo de compartilhamento, que pode ser fixo ou flexível, e uma base de preços (por exemplo, se a participação na receita é baseada no preço bruto ou líquido de uma transação). Defina o preço bruto ou líquido da transação ao criar a política de registro de transações.

No modelo de compartilhamento fixo, você 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). No modelo de compartilhamento flexível, você compartilha com o desenvolvedor uma porcentagem variável da receita. A participação na receita depende da receita gerada ao longo de 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.

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

Configure planos de participação na receita, conforme descrito abaixo.

Edge

Para configurar um plano de participação na receita usando a interface do Edge, ao criar ou editar um plano de tarifas, selecione o tipo de plano de preços Participação na receita ou Tabela de preços e participação na receita e, na seção Participação na receita, configure as seguintes informações:

Campo Descrição
Modelo de cálculo Selecione um dos seguintes tipos de preços:
  • Bruto: a participação na receita é baseada em uma porcentagem do preço bruto de uma transação.
  • Líquido: a participação na receita é baseada em uma porcentagem do preço líquido de uma transação.
Observação: você define o preço bruto ou líquido da transação ao criar a política de registro de transações.
Frequência de cálculo Período em que o volume de transações (ou o volume relacionado a atributos personalizados) é calculado. Selecione um número de meses (1 a 24 meses).
Modelo de compartilhamento Selecione um dos seguintes modelos de participação na receita:
  • Fixo: o provedor de API 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.
  • Flexível: o provedor de API compartilha 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.
Participação na receita fixa Para o modelo de compartilhamento fixo, especifica a porcentagem usada para calcular a participação na receita. Insira um número decimal com até quatro casas decimais. Por exemplo, se você inserir 80,5555, a participação na receita será de 80,5555%, ou seja, como um provedor de API, você paga ao desenvolvedor 80,5555% do preço cobrado em cada transação.
Faixas de participação na receita

No modelo de compartilhamento flexível, uma ou mais faixas de receita da transação (cada intervalo é uma "faixa de receita"). Uma porcentagem de participação na receita pode ser atribuída a cada faixa de receita. As transações são agregadas de acordo com a agregação para calcular a receita total e a faixa de receita da transação. A porcentagem da participação na receita aplicada a cada transação depende da faixa de receita.

Especifique o limite máximo da primeira faixa, por exemplo, até 1.000 (o limite mínimo é predefinido como maior que 0). Clique em +Nova para adicionar outras faixas. Deixe o limite máximo da faixa final vazio para indicar todas as transações depois que a receita agregada tiver ultrapassado esse nível.

Por exemplo, se especificar duas faixas de receita na seção Banda de receita (>0-1000 e 1000 e acima), você poderá inserir 80,5555 para a banda de receita >0-1000 e 90, 5 para a banda de receita de 1000 e acima. Considere também que a moeda está em dólares americanos. Para as transações que geram até US $1.000 em receita, a participação é 80,5555% do preço da transação. Para transações que geram mais de US $1.000 em receita, a participação é 90,5% do preço da transação.

Borda clássica (nuvem privada)

Para configurar planos de participação na receita usando a interface clássica do Edge:

  1. Siga as etapas para criar um plano de tarifa.
  2. Selecione Participação na receita no menu suspenso "Tipo de plano de tarifa" para configurar o modelo.
  3. Se o pacote de API selecionado incluir vários produtos de API, selecione uma das seguintes opções:

    Observação: se o pacote da API incluir um único produto de API, pule esta etapa.

    • Planos específicos de produtos para configurar os detalhes do plano de tarifas para cada produto de API individualmente.
    • Plano genérico para todos os produtos para configurar os detalhes do plano de tarifas para todos os produtos da API.
  4. Clique em Participação na receita para o plano de tarifas genérico ou para cada plano de tarifa específico de produto de API.

    Observação: ao configurar planos específicos de cada produto de API, você precisa definir um plano de participação na receita para cada um deles.

    A janela Participação na receita será exibida.

  5. Selecione um dos seguintes modelos de compartilhamento:
    • Fixa: nesse modelo, o provedor da API 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.
    • Flexível: nesse modelo, o provedor de API compartilha com o desenvolvedor uma porcentagem variável da receita. A participação na receita depende da receita gerada ao longo de 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.

    Para o modelo de compartilhamento fixo:

    Se você selecionar o modelo de compartilhamento fixo, insira as seguintes informações na seção "Preço" da janela "Participação na receita genérica":

    Campo Descrição
    Operador (ou organização)

    É o nome da sua organização. Esse campo é predefinido usando o valor do campo de operador (ou organização) no perfil da organização.

    País

    O país de operação da sua organização. Esse campo é predefinido usando o valor do campo "País" no perfil da organização.

    Moeda

    A "base" ou moeda contábil que sua empresa usa. Esse campo é predefinido usando o valor do campo "Moeda" no perfil da organização.

    Tipo de preços

    A base da participação na receita. Selecione "Bruto" ou "Líquido". Se você selecionar "Bruto", a divisão da receita será baseada em uma porcentagem do preço bruto de uma transação. Se você selecionar "Líquido", a participação na receita será baseada em uma porcentagem do preço líquido de uma transação. Observação: você define o preço bruto ou líquido da transação ao criar a política de registro de transações.

    % de compartilhamento fixo

    A porcentagem usada para calcular a participação na receita. Insira um número decimal com até quatro casas decimais. Por exemplo, se você inserir 80,5555, a participação na receita será de 80,5555%, ou seja, como provedor de API, você pagará ao desenvolvedor 80,5555% do preço cobrado por cada transação.

    Para o modelo de compartilhamento flexível:

    Se você selecionar o modelo de compartilhamento flexível, a janela "Participação na receita genérica" exibirá campos adicionais. Use esses campos para especificar uma base para a agregação e especificar "faixas de receita", ou seja, intervalos de receita gerada por transação aos quais é possível aplicar porcentagens de participação na receita diferentes.

    Insira as seguintes informações na janela Generic Revenue Share:

    Campo Descrição
    Base de agregação

    O período em que a receita é agregada. A receita agregada é usada para calcular a faixa de receita de cada transação e a porcentagem aplicável de participação na receita. Selecione um número de meses (entre 1 e 12).

    Faixas de receita

    Uma ou mais faixas de receita da transação (cada intervalo é uma "faixa de receita"). Cada faixa de receita pode receber uma porcentagem de participação na receita. Você define essa porcentagem no campo "Faixas de receita" da seção "Preços". As transações são agregadas de acordo com a base de agregação para calcular a receita total e a faixa de receita da transação. A porcentagem da participação na receita aplicada a cada transação depende da faixa de receita dela.

    Especifique o limite máximo da primeira banda, por exemplo, até 1.000 (o limite mínimo é predefinido como maior que 0). Clique em + para adicionar uma segunda faixa, por exemplo, maior que 1.000 e até 2.000. Clique em "+" para adicionar mais faixas. Você pode deixar o limite máximo da faixa final vazio para indicar todas as transações depois que a receita agregada tiver ultrapassado esse nível.

    Preços
    Operador (ou organização)

    É o nome da sua organização. Esse campo é predefinido usando o valor do campo de operador (ou organização) no perfil da organização.

    País

    O país de operação da sua organização. Esse campo é predefinido usando o valor do campo "País" no perfil da organização.

    Moeda

    A moeda "base" ou contábil que sua organização usa. Esse campo é predefinido usando o valor do campo "Moeda" no perfil da organização.

    Tipo de preços

    A base da participação na receita. Selecione "Bruto" ou "Líquido". Se você selecionar "Bruto", a divisão da receita será baseada em uma porcentagem do preço bruto de uma transação. Se você selecionar "Líquido", a participação na receita será baseada em uma porcentagem do preço líquido de uma transação. Observação: você define o preço bruto ou líquido da transação ao criar a política de registro de transações.

    % de participação para faixas de receita

    A porcentagem usada para calcular a participação na receita das transações em cada faixa de receita. Você especifica uma porcentagem para cada faixa. Insira um número decimal com até quatro casas decimais. Por exemplo, se você especificar duas faixas de receita na seção "Banda de receita" (> 0 a 1.000 e 1.000 e mais), será possível inserir 80,5555 para a banda de > 0 a 1.000 e 90, 5 para a faixa de receita de 1.000 e mais. Considere também que a moeda está em dólares americanos. Para as transações que geram até US $1.000 em receita, a participação na receita é 80,5555% do preço da transação, e para as transações que geram mais de US $1.000 em receita, a participação na receita é 90,5% do preço da transação.

  6. Clique em Aplicar e fechar para salvar os detalhes da participação na receita e voltar à janela do plano de tarifa padrão.
  7. Para planos de tarifas específicos de produtos de API, configure os detalhes do plano para outros produtos de API, conforme necessário.

Como especificar detalhes do plano de participação na receita usando a API

Você especifica os detalhes do plano de divisão da receita ao criar o plano. Especifique os detalhes na propriedade ratePlanDetails no corpo da solicitação em uma chamada para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. O que você especifica na propriedade ratePlanDetails depende do modelo de compartilhamento escolhido: fixo ou flexível.

Como especificar detalhes do plano de participação na receita para um modelo de compartilhamento fixo

Para implementar o modelo de compartilhamento fixo, especifique o seguinte nos detalhes do plano de tarifa:

  • Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações (VOLUME). VOLUME é o padrão.
  • Um tipo de medição (UNIT) que indica que a participação na receita é fixa por unidade (ou seja, não é baseada no volume de transações, como é o caso do modelo de compartilhamento flexível).
  • O tipo de receita (GROSS ou NET). Indica se a participação na receita é baseada no preço bruto ou líquido de uma transação.
  • O período de vencimento do pagamento (por exemplo, 30 dias).
  • É o ID da sua organização.
  • A "base" ou moeda contábil que sua empresa usa.
  • É uma taxa do plano de tarifa com detalhes sobre como a participação na receita é calculada. Como o modelo de compartilhamento é baseado em uma taxa fixa, você só especifica uma taxa do plano de tarifa.

Consulte Propriedades de configuração para detalhes do plano de tarifa para uma lista completa de propriedades de detalhes do plano de tarifa.

Na tarifa do plano de tarifa, você especifica:

  • É o tipo de tarifa do plano de tarifas (REVSHARE).
  • A porcentagem usada para calcular a participação na receita. Por exemplo, se você especificar 80,5555, a participação na receita será de 80,5555%, ou seja, como provedor de API, você pagará ao desenvolvedor 80,5555% do preço cobrado por cada transação (ou, se estiver com base em um atributo personalizado, como o número de bytes transmitidos em uma transação, você paga ao desenvolvedor 80,5555% do preço de transmissão especificado).
  • A unidade inicial do aplicativo de taxa (0). Isso significa que a taxa é aplicada a cada transação, começando pela primeira.

Consulte Propriedades de configuração dos planos de tarifa para acessar a lista completa.

Por exemplo, o código a seguir cria um plano de participação na receita com um modelo de compartilhamento fixo. A porcentagem de participação na receita é de 80,5555%. A participação na receita é baseada no preço líquido de uma transação. O contrato entra em vigor em 15 de setembro de 2013, e o pagamento vence em 30 dias. Os detalhes relacionados à participação na receita estão destacados.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "setUpFee": 10,
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

A resposta será semelhante a esta (somente parte da resposta é exibida):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Como especificar detalhes do plano de participação na receita para um modelo de compartilhamento flexível

Em um modelo de compartilhamento flexível, você especifica os detalhes do plano de tarifas que incluem uma ou mais taxas. Cada taxa do plano de tarifa cobre um intervalo de receita da transação. Cada intervalo é chamado de "faixa de receita". Você atribui uma porcentagem de divisão da receita para cada faixa de receita.

Além das taxas do plano, você especifica o seguinte nos detalhes do plano:

  • Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações (VOLUME). VOLUME é o padrão.
  • Um tipo de medição (VOLUME) que indica que a participação na receita não é baseada no volume de transações. Ou seja, não é fixo, como é o caso do modelo de compartilhamento fixo.
  • O tipo de receita (GROSS ou NET). Indica se a participação na receita é baseada no preço bruto ou líquido de uma transação.
  • O período de vencimento do pagamento (por exemplo, 30 dias).
  • É o ID da sua organização.
  • A "base" ou moeda contábil que sua empresa usa.
  • Uma duração e um tipo de duração que, juntos, especificam o período em que a receita é agregada (também é chamado de "base de agregação"). As transações são agregadas de acordo com o método de agregação (por exemplo, um mês) para calcular a receita total e a faixa de receita aplicável. A porcentagem da participação na receita aplicada a cada transação depende da faixa de receita dela.
  • Contadores de agregação usados para determinar a faixa de receita aplicável.

Consulte Propriedades de configuração para detalhes do plano de tarifa para uma lista completa de propriedades de detalhes do plano de tarifa.

Para cada tarifa do plano de tarifa, você especifica o seguinte:

  • É o tipo de taxa do plano de tarifa para a faixa de receita (REVSHARE).
  • A porcentagem usada para calcular o compartilhamento de receita para a faixa de receita. Por exemplo, se você especificar 80,5555, a participação na receita da faixa de receita será de 80,5555%, ou seja, como um provedor de API, você pagará ao desenvolvedor 80,5555% do preço cobrado por cada transação nessa faixa de receita.
  • A unidade inicial e final da faixa de receita. A unidade inicial especifica o limite mínimo de uma faixa de receita, e a unidade final especifica o limite máximo. Por exemplo, se você especificar uma unidade inicial de 0 e uma unidade final de 1.000, a faixa de receita vai abranger a receita de transações maior que 0 e até 1.000 na moeda especificada. Se a moeda for o dólar americano, a base de agregação será de um mês e a porcentagem da faixa de receita será de 80,5555%, então, para transações que geram até US $1.000 em receita em um mês, a participação na receita vai ser 80,5555% do preço da transação.

    Se você não especificar uma unidade final para a faixa de receita final, a porcentagem de compartilhamento dessa faixa será aplicada a todas as transações depois que a receita agregada estiver acima da unidade inicial da faixa. Por exemplo, se a unidade inicial da última banda for 1.000 (suponha dólares americanos) e você não especificar uma unidade final para essa faixa, a porcentagem da receita vai ser aplicada a todas as transações acima de US $1. 000 durante o período agregado.

Consulte Propriedades de configuração dos planos de tarifa para acessar a lista completa.

Por exemplo, o código a seguir cria um plano de participação na receita com um modelo de compartilhamento flexível. Especifica duas faixas de receita. A primeira faixa abrange receitas de transações superiores a até 1.000 dólares americanos. A segunda banda abrange receitas de transações acima de 1.000 dólares americanos. A porcentagem de participação na receita é de 80,5555% para a primeira faixa de receita e de 90,5% para a segunda. A participação na receita é baseada no preço líquido de uma transação. A base de agregação é de um mês. O período de contrato entra em vigor em 15 de setembro de 2013, e o pagamento vence em 30 dias. Os detalhes relacionados à participação na receita estão destacados.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",   
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

A resposta será semelhante a esta (somente parte da resposta é exibida):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}