Configurar plano de tabela de preços

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

Introdução

Em um plano de taxas, o desenvolvedor é cobrado por cada transação. Para esse tipo de plano, você precisa fornecer mais detalhes, como o modelo de cobrança e os preços.

Opcionalmente, você pode especificar um plano freemium para produtos individuais (em vez de para um pacote de API). Só é possível fazer isso para um plano específico do produto.

Quando as taxas recorrentes são cobradas e os planos de pacote são redefinidos?

Os planos de tarifas podem incluir taxas recorrentes, bem como pacotes de API (planos por volume e em pacote), que envolvem períodos específicos em que as taxas são cobradas e os planos de pacote são redefinidos como zero. A tabela a seguir descreve quando as taxas recorrentes são cobradas e os pacotes são redefinidos. Se os apps de desenvolvedor forem bloqueados para fazer mais chamadas de API porque atingiram um determinado limite de transações, esses são os momentos em que as contagens de chamadas de API são redefinidas para zero e os apps podem começar a fazer chamadas novamente.

Se o plano tiver...	...isso acontece
Uma taxa recorrente diferente de zero definida como Mês Um plano de pacote ou de faixa de volume	A taxa recorrente e o plano de pacote são redefinidos no primeiro dia do mês (padrão). Para uma recorrência mensal em um dia específico, crie um plano de taxas usando a API de gerenciamento e indique o dia com uma propriedade RecurringStartUnit, conforme descrito em Como criar planos de taxas usando a API.
Uma taxa recorrente diferente de zero definida como Semana. Um plano de pacote ou de faixa de volume	O reajuste da taxa recorrente e do plano de pacotes ocorre a cada sete dias após a data de início do plano de preços do desenvolvedor.
Uma taxa recorrente diferente de zero definida como Dia Um plano de pacote ou de faixa de volume	O plano de pacote e a taxa recorrente são redefinidos a cada X dias após a data de início do plano de preços do desenvolvedor.
Sem taxa recorrente (ou taxa de US$ 0) Um plano de pacote ou de faixa de volume	Os planos de pacotes são redefinidos com base na base de agregação definida na tabela de preços. Por exemplo, se um desenvolvedor iniciar um plano de preços no dia 19 do mês e a base de agregação for a cada 1 mês, o uso do pacote será redefinido a cada 19 de cada mês. O dia do mês pode não ser sempre o mesmo. Por exemplo, se um plano de preço começar em 31 de dezembro, a data de redefinição vai ser 28 de fevereiro, em um ano não bissexto, já que há apenas 28 dias em fevereiro. O 28o dia permanece o dia de redefinição desde então.

Como configurar planos de tabelas de preços usando a interface

Configure planos de tabelas de preços, conforme descrito abaixo.

Como configurar o plano de tarifas usando a API

Configure os detalhes do plano de taxas usando a API, conforme descrito nas seções a seguir.

Como especificar detalhes do plano de taxas usando a API

Você especifica os detalhes do plano de tarifas 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 cobrança escolhido: taxa fixa, faixa de volume ou pacotes.

Como especificar um modelo de cobrança de taxa fixa

Para implementar o modelo de cobrança de tarifa fixa, 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) ou em um atributo personalizado (por exemplo, MINT_CUSTOM_ATTRIBUTE_1). VOLUME é o padrão.
• Um tipo de medição (UNIT) que indica que a taxa é fixada por unidade, ou seja, não é baseada no volume de transações, como no caso do modelo de cobrança de pacotes ou de faixas de volume.
• 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 taxa de plano de tarifas que fornece detalhes sobre como a tarifa é calculada. Como o modelo de cobrança é baseado em uma taxa fixa, você só especifica uma taxa do plano de tarifas.

Na taxa do plano de tarifa, você especifica:

• O tipo de tarifa do plano tarifário (RATECARD).
• A taxa do plano. Por exemplo, se você especificar 0,10 e a moeda for dólares americanos, o desenvolvedor vai receber uma cobrança de US $0,10 por cada transação. Se o valor for baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor vai receber uma cobrança de US $0,10 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 Configurações dos detalhes do plano de tarifas para acessar uma lista completa dessas opções.

Por exemplo, as informações a seguir criam um plano de tabela de preços com um modelo de cobrança fixa. A taxa é definida em US $0,10 para cada transação. O pagamento vence em 30 dias. Os detalhes relacionados à tabela de preços estão destacados.

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

Como especificar um modelo de carregamento com faixa de volume

Em um modelo de faixa de volume, você especifica detalhes do plano de tarifas que incluem uma ou mais tarifas de plano de tarifas. Cada tarifa se aplica a uma "faixa de volume", ou seja, um intervalo de volume de transações (ou um intervalo baseado em um atributo personalizado, como o número de bytes transmitidos). Esse tipo de plano geralmente é configurado para incentivar os desenvolvedores a gerar volumes maiores, oferecendo taxas com desconto para faixas de volume mais altas.

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) ou em um atributo personalizado (por exemplo, CUSTOM_ATTRIBUTE_1). VOLUME é o padrão.
• Um tipo de medição (VOLUME) que indica que a taxa é baseada no volume de transações, ou seja, não é uma taxa fixa por transação, como é o caso do modelo de cobrança de taxa fixa.
• 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 duração e um tipo de duração que especificam o período em que o volume de transações (ou volume relacionado a atributos personalizados) é agregado. Isso também é chamado de "base de agregação". O volume de transações é agregado com base na base de agregação (por exemplo, 1 mês) para determinar a faixa de volume aplicável.
• Contadores de agregação usados para determinar a faixa de volume aplicável.

Para cada taxa do plano de preços, você especifica:

• O tipo de tarifa do plano tarifário (RATECARD).
• A tarifa do plano. Por exemplo, se você especificar 0,10 e a moeda for dólares americanos, o desenvolvedor vai receber uma cobrança de US $0,15 por cada transação. Se o valor for baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor vai receber uma cobrança de US $0,15 pela transmissão do número especificado de bytes.
• A unidade inicial e final da faixa de volume. A unidade inicial especifica o limite inferior da faixa de volume, e a unidade final especifica o limite superior da faixa de volume. Por exemplo, se você especificar uma unidade inicial de 0 e uma unidade final de 1.000, a faixa de volume vai abranger até 1.000 transações no período de agregação. Se a moeda for o dólar americano, o período de agregação será de um mês e a taxa das primeiras 1.000 transações for de 0,15, o desenvolvedor receberá uma cobrança de US $0,15 por transação até 1.000 transações no mês.
  
  Para saber quando os pacotes são redefinidos, consulte Quando as taxas recorrentes são cobradas e os planos de pacotes são redefinidos?
  

  Se você não especificar uma unidade final para a faixa de volume final, a taxa dessa faixa será aplicada a todas as transações depois que o número de transações ultrapassar a unidade inicial dessa faixa. Por exemplo, se a unidade inicial da última faixa for 1.000 e você não especificar uma unidade final para essa faixa, a taxa da faixa será aplicada a todas as transações após 1.000 transações no período de agregação.

Consulte Configurações de detalhes de plano de preço para uma lista completa de opções de detalhes de plano de preço.

Por exemplo, o código a seguir cria um plano de tabela de preços com um modelo de cobrança por faixa de volume. A taxa é definida em US $0,15 para as primeiras 1.000 transações e US $0,10 para todas as transações acima de 1.000. A base da agregação é de 1 mês. O pagamento é devido em 30 dias. Os detalhes da tabela de preços estão destacados.

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

Como especificar um modelo de carregamento em pacote

Em um modelo de cobrança em pacote, o desenvolvedor paga (adiantado) por um "pacote" de transações (ou por um pacote baseado em um atributo personalizado, como o número de bytes transmitidos). Você especifica uma taxa para cada pacote e uma base de agregação, ou seja, um período em que o desenvolvedor pode usar o pacote.

Por exemplo, suponha que você configure dois pacotes, em que o tamanho do primeiro pacote é de 1 a 1.000 transações e o segundo é de 1.001 a 2.000 transações. A tarifa é de US $50 para o primeiro pacote e US $40 para o segundo, e a base de agregação é 1. Se o desenvolvedor comprar um plano de tabela de preços para o primeiro pacote, ele vai pagar US $50 (à vista) por 1.000 transações em um mês. O valor definido é cobrado do desenvolvedor, independentemente de o pacote ter sido totalmente usado ou não. O plano expira após o período de agregação. Se o desenvolvedor quiser usar o pacote novamente, ele vai precisar comprar o plano (e o pacote) novamente.

O que você especifica nos detalhes do plano de tarifas é basicamente o mesmo que você especifica nos detalhes do plano de tarifas para o modelo de cobrança por faixa de volume. As diferenças são as seguintes:

• Cada plano de preço especificado é para um pacote, e não para uma faixa de volume.
• É necessário especificar um limite máximo para o último pacote, a menos que você queira cobrar do desenvolvedor um valor fixo por transações ilimitadas no último pacote.

Consulte Configurações de detalhes de plano de preço para conferir uma lista completa de opções de detalhes de plano de preço.

Por exemplo, o código a seguir cria um plano de tabela de preços com um modelo de cobrança agrupado. A taxa é definida em US $50 para o primeiro pacote (até 1.000 transações) e US $40 para o segundo pacote (mais de 1.000 e até 2.000 transações). A base de agregação é de 1 mês. O pagamento vence em 30 dias.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "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

Como especificar um plano freemium para produtos individuais usando a API

Em um plano de tarifas, é possível configurar um plano freemium para um produto individual, em vez de um pacote de API. Um plano freemium oferece aos desenvolvedores o uso sem custo financeiro de um produto de API por um período ou com base na quantidade de uso.

Ao configurar um plano freemium para um produto de API, você especifica nos detalhes do plano de tarifas o período em que o desenvolvedor pode usar os recursos fornecidos pelo produto de API sem cobrança. O período pode ter como base um dos seguintes critérios:

• Duração, ou seja, o tempo entre o início da vigência e a data de término.
• Quantidade, como o número de transações que envolvem o produto da API ou o volume relacionado a um atributo personalizado registrado na política de gravação de transações.

Se o período freemium for baseado na quantidade, especifique-o como um número de unidades freemium. Por exemplo, o código a seguir cria um plano de taxa com um plano freemium com base em um volume de 5.000 unidades. As especificações relacionadas ao freemium estão em destaque.

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "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