Configurar plano de divisão da receita

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

Introdução

Em um plano de participação na receita, o provedor da API compartilha com o desenvolvedor uma porcentagem da receita gerada por 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). Você define o preço bruto ou líquido da transação ao criar a política de registro de transações.

No modelo de participação fixa, você compartilha 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). 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 em 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.

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

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

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

Você especifica os detalhes do plano de participação na receita ao criar o plano de tarifas. 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 tarifas:

• 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 é fixada por unidade, ou seja, não é baseada no volume de transações, como no caso do modelo de compartilhamento flexível.
• O tipo de receita (GROSS ou NET). Isso 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 moeda "base" ou contábil que sua empresa usa.
• Uma taxa de plano de tarifas que fornece 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 preços.

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

Na taxa do plano de tarifas, você especifica:

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

Consulte Propriedades de configuração para planos de preços para conferir uma lista completa de propriedades de planos de preços.

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 é devido 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 deve ser semelhante a esta (apenas 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 os detalhes do plano de participação na receita para um modelo de compartilhamento flexível

Em um modelo de compartilhamento flexível, você especifica detalhes do plano de tarifas que incluem uma ou mais tarifas. Cada taxa do plano de tarifas abrange 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 de tarifas, você especifica o seguinte nos detalhes do plano de tarifas:

• 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, ela não é fixa, como no caso do modelo de compartilhamento fixo.
• O tipo de receita (GROSS ou NET). Isso 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 moeda de contabilidade ou "base" usada pela sua empresa.
• Uma duração e um tipo de duração que, juntos, especificam o período em que a receita é agregada (também chamada de "base de agregação"). As transações são agregadas na base de agregação (por exemplo, um mês) para calcular a receita total e a faixa de receita aplicável. A porcentagem da receita compartilhada aplicada a cada transação depende da faixa de receita.
• Contadores de agregação usados para determinar a faixa de receita aplicável.

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

Para cada tarifa de plano de tarifa, você especifica:

• O tipo de taxa do plano de tarifas para a faixa de receita (REVSHARE).
• A porcentagem usada para calcular a participação na receita da faixa de receita. Por exemplo, se você especificar 80,5555, a participação na receita para a faixa de receita é de 80,5555%. Ou seja, como provedor de API, você paga ao desenvolvedor 80,5555% do preço cobrado para cada transação nessa faixa de receita.
• A unidade inicial e final da faixa de receita. A unidade inicial especifica o limite inferior de uma faixa de receita, e a unidade final especifica o limite superior da faixa de receita. 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 em dólares americanos, a base de agregação for de 1 mês e a porcentagem da faixa de receita for 80,5555%, para transações que geram até US $1.000 em receita em um mês, a receita compartilhada será de 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 ultrapassar a unidade inicial dessa faixa. Por exemplo, se a unidade inicial da última banda for 1.000 (suponha em dólares americanos) e você não especificar uma unidade final para essa banda, a porcentagem da receita dela será aplicada a todas as transações acima de USD 1. 000 durante o período agregado.

Consulte Propriedades de configuração para planos de preços para conferir uma lista completa de propriedades de planos de preços.

Por exemplo, o exemplo a seguir cria um plano de participação na receita com um modelo de compartilhamento flexível. Ela especifica duas faixas de receita. A primeira banda cobre receita de transações superior a 1.000 dólares americanos. A segunda cobre a receita de transações acima de 1.000 dólares americanos. A porcentagem da participação na receita é de 80,5555% para a primeira e de 90,5% para a segunda. A participação na receita é baseada no preço líquido de uma transação. A base da agregação é de 1 mês. O período do contrato é válido a partir de 15 de setembro de 2013, e o pagamento é devido 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 deve ser semelhante a esta (apenas 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"
}