Configurar plano de tabela de preços

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

Introdução

Em um plano de tabela de preços, 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 correspondentes.

Opcionalmente, é possível especificar um plano freemium para produtos individuais (em vez de um pacote de API). Faça isso apenas 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 e pacotes de API (com banda de volume e planos de pacote), que envolvem horários 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 as contagens de pacotes são redefinidas. Se os apps do desenvolvedor forem impedidos de fazer outras chamadas de API porque atingiram um determinado limite de transação, esses são os momentos em que a contagem de chamadas de API é redefinida 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 volume com banda ou pacote

A redefinição da taxa e do plano de pacote recorrentes ocorre no primeiro dia do mês (padrão).

Para a recorrência mensal em um dia específico, crie um plano de tarifas usando a API Management e indique o dia com uma propriedade RecurringStartUnit, conforme descrito em Como criar planos de tarifação usando a API.

  • Uma taxa recorrente diferente de zero definida como Semana
  • Um plano de volume com banda ou pacote
A redefinição da tarifa recorrente e do plano de pacote ocorre a cada sete dias após a data de início do plano de tarifa do desenvolvedor.
  • Uma taxa recorrente diferente de zero definida como Dia
  • Um plano de volume com banda ou pacote
A redefinição da taxa e do plano de pacote recorrente ocorre a cada X dias após a data de início do plano de tarifas do desenvolvedor.
  • Sem taxa recorrente (ou sem custos financeiros)
  • Um plano de volume com banda ou pacote

Os planos de pacote são redefinidos com base na base de agregação definida na tabela de preços. Por exemplo, se um desenvolvedor inicia um plano de tarifas no dia 19 do mês e a base de agregação é a cada um, o uso do pacote é redefinido todo dia no dia 19.

O dia do mês nem sempre é o mesmo. Por exemplo, se um plano de tarifa começa em 31 de dezembro, a data de redefinição se torna dia 28 em um fevereiro que não é bissexto, já que ele tem apenas 28 dias. Depois disso, o dia 28 permanece como o dia de redefinição.

Configurar planos de tabela de preços usando a interface

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

Edge

Para configurar um plano de tabela de preços, ao criar ou editar um deles, selecione o tipo de plano Tabela de preços ou Tabela de preços e participação na receita e, na seção Tabela de preços, selecione um dos seguintes modelos de cobrança:

Modelo de carregamento Descrição
Taxa fixa Uma taxa fixa é cobrada do desenvolvedor para cada transação.
Volume em banda É cobrada uma taxa variável do desenvolvedor, dependendo do volume de transações.
Bundles Um valor definido é cobrado do desenvolvedor antecipadamente para cada pacote de transações. O desenvolvedor é cobrado pelo valor definido, mesmo que o pacote não seja totalmente usado.

Observação: essa opção não está disponível quando você seleciona a tabela de preços e a participação na receita.

Depois, configure as informações a seguir com base no modelo de carregamento selecionado.

Modelo de carregamento Campo Descrição
All 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).
Taxa fixa Taxa fixa Taxa cobrada para cada transação. Insira um número decimal com até quatro casas decimais.

Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa cobrada usando a API, não a interface. Para saber mais detalhes, consulte Configurar o número de casas decimais das tarifas do plano.

Por exemplo, se você inserir 0,10 e a moeda for dólares americanos, será cobrado US $0,10 do desenvolvedor por cada transação (ou se estiver baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor receberá uma cobrança de US $0,10 pela transmissão do número especificado de bytes).

Volume em banda Faixas de volume Um ou mais intervalos de volume de transações (ou com base em atributos do cliente) (cada intervalo é uma "faixa de volume") para o modelo de cobrança por volume. Uma taxa pode ser atribuída a cada faixa de volume. A taxa é aplicada a todas as transações na faixa de volume aplicável. 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 última faixa em branco para indicar todas as transações acima desse nível.

Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa cobrada usando a API, não a interface. Para saber mais detalhes, consulte Configurar o número de casas decimais das tarifas do plano.

Por exemplo, se você especificar duas faixas de volume na seção "Banda de volume" (> 0 a 1.000 e 1.000 e superiores), insira 0,15 para a faixa de volume >0 a 1.000 e 0, 10 para a faixa de volume de 1.000 ou mais. Se a moeda selecionada for o dólar americano, a taxa para as primeiras 1.000 transações será de US $0,15 para cada transação e, para as mais de 1.000 transações, a taxa será de US $0,10 para cada transação.

Bundles Preços dos pacotes de APIs Número de transações em um pacote (ou um número relacionado a um atributo personalizado, como o número total de bytes transmitidos em um pacote). É possível atribuir um preço a cada pacote. O preço se aplica a todo o pacote. Especifique o limite máximo do primeiro pacote, até 1.000 (o limite mínimo é predefinido como maior que 0).

Clique em +Novo para adicionar outros pacotes. É 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.

Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa cobrada usando a API, não a interface. Para saber mais detalhes, consulte Configurar o número de casas decimais das tarifas do plano.

Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0 a 1.000 e maior de 1.000 até 2.000), será possível inserir 50 para o pacote maior que 0 até 1.000 e 40 para o pacote maior que 1.000 até 2.000. Se a moeda selecionada for o dólar americano, o preço do primeiro pacote será de US $50 e do segundo, de US $40. O preço do pacote aplicável é cobrado do desenvolvedor, independentemente do número de transações feitas no pacote. Ou seja, o preço do pacote é cobrado assim que a primeira transação é concluída.

Se você tiver definido atributos personalizados para seu produto de API, poderá configurar um parâmetro de avaliação personalizada para cobrar o desenvolvedor de apps 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, será possível 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.

Nesse caso, selecione Usar parâmetro de avaliação personalizado e escolha o atributo personalizado na lista suspensa. Para mais informações, consulte Configurar plano de tarifa com atributos personalizados.

Borda clássica (nuvem privada)

Para configurar planos de tabela de preços usando a interface clássica do Edge:

  1. Siga as etapas para criar um plano de tarifa.
  2. Selecione Tabela de preços no menu suspenso "Tipo de plano de tarifa" para configurar o modelo de receita.
  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 Tabela de preços para o plano de tarifas genérico ou para cada plano de preços específico para produtos de API.

    Observação: ao configurar planos específicos de produtos de API, é preciso definir um plano de tabela de preços para cada produto de API individualmente.

    A janela "Tabela de preços" será aberta.

  5. Configure um plano freemium para um produto de API. Um plano freemium oferece aos desenvolvedores o uso sem custo financeiro de um produto de API durante um período ou com base na quantidade de uso.

    Digite as seguintes informações:

    Campo Descrição
    Produto Freemium?

    A extensão do período sem custo financeiro. Selecione um dos seguintes botões de opção:

    • Por quantidade. O período sem custo financeiro é baseado em uma quantidade especificada no campo "Volume".
    • Por duração. O período da taxa é baseado em um intervalo de tempo especificado no campo "Duração freemium".
    • O que vier primeiro. O período sem custo financeiro termina quando a quantidade no campo "Volume" ou o intervalo de tempo no campo "Duração do Freemium" é atingido, o que ocorrer primeiro.
    • Não. Este não é um plano freemium. Esse é o padrão.
    Volume freemium

    O volume de transações (ou o volume de um atributo personalizado registrado na política de registro de transações) que não são cobrados dos desenvolvedores. O volume é medido para o produto da API. Digite um número de volume, como 5000. Isso significa que, quando os desenvolvedores iniciam o plano, eles não são cobrados pelas primeiras 5 mil transações (ou pelos primeiros 5 mil usos de um item personalizado relacionado a atributos). Esse campo só será ativado se você selecionar "Por quantidade" ou "O que vem primeiro" no campo "Produto Freemium?".

    Duração freemium

    O intervalo de tempo em que os desenvolvedores não são cobrados. Insira um número e selecione um período, como um mês. Isso significa que os desenvolvedores não são cobrados por um mês. Esse campo só será ativado se você selecionar "Por duração" ou "O que ocorrer primeiro" no campo "Produto freemium?".

  6. Selecione um dos seguintes modelos de carregamento:
    • Taxa fixa. Nesse modelo, uma taxa fixa é cobrada do desenvolvedor para cada transação.
    • Volume em faixas. Nesse modelo, uma taxa variável é cobrada do desenvolvedor, dependendo do volume de transações.
    • Pacotes Nesse modelo, é cobrado do desenvolvedor um valor definido (antecipadamente) para cada pacote de transações. O desenvolvedor é cobrado pelo valor definido, independentemente de o pacote ser totalmente usado ou não.

    Para o modelo de taxa fixa: insira as seguintes informações na seção "Preços" da janela "Tabela de preços 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.

    Taxa fixa

    A taxa cobrada para cada transação. Insira um número decimal com até quatro casas decimais.

    Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa cobrada usando a API, não a interface. Para mais detalhes, consulte Configurar o número de casas decimais para as tarifas do plano de tarifa.

    Por exemplo, se você inserir 0,10 e a moeda for dólares americanos, será cobrado do desenvolvedor US $0,10 por cada transação (ou se estiver baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor será cobrado US $0,10 pela transmissão do número especificado de bytes).

    Para o modelo de volume em banda:a janela "Tabela de preços genérica" exibe outros campos que você usa para especificar uma base para a agregação e especificar "faixas de volume", ou seja, intervalos de volume de transação aos quais é possível aplicar taxas diferentes.

    Esse tipo de plano geralmente é configurado para incentivar os desenvolvedores a gerar volumes maiores, oferecendo preços com desconto para bandas de maior volume.

    Insira as seguintes informações na janela "Tabela de preços genérica":

    Campo Descrição
    Base de agregação

    O período em que o volume de transações (ou volume relacionado a atributos personalizados) é agregado. O volume agregado é usado para identificar a banda de volume e a taxa a ser aplicada a cada transação. Selecione um número de meses (1 a 12 meses).

    Para mais detalhes sobre quando os pacotes são redefinidos, consulte Quando as taxas recorrentes são cobradas e os planos de pacote são redefinidos?.

    Faixas de volume

    Um ou mais intervalos de volume de transações (ou com base em atributos do cliente). Cada intervalo é uma "banda de volume". Cada faixa de volume pode receber uma taxa. Você define essa taxa no campo "Faixas de volume" da seção "Preço". A taxa é aplicada a todas as transações na faixa de volume aplicável. 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, entre 1.000 e 2.000. Clique em "+" para adicionar outras faixas. Você pode deixar o limite máximo da faixa final vazio para indicar todas as transações acima desse 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, mas pode ser alterado aqui.

    Faixas de volume

    A taxa de uma faixa de volume. Você especifica uma taxa para cada faixa de volume. Insira um número decimal para cada faixa (com até quatro casas decimais).

    Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa de banda de volume usando a API, não a interface. Para mais detalhes, consulte Configurar o número de casas decimais para as tarifas do plano de tarifa.

    Por exemplo, se você especificar duas faixas de volume na seção "Banda de volume" (> 0 a 1.000 e 1.000 e mais), será possível inserir 0,15 para a faixa de volume > 0 a 1.000 e 0, 10 para a de 1.000 e mais. Se a moeda selecionada for o dólar americano, a taxa para as primeiras 1.000 transações será de US $0,15 para cada transação e, para mais de 1.000 transações, a taxa será de US $0,10 para cada transação.

    Para o modelo agrupado: a janela "Tabela de preços genérica" exibe campos adicionais que você usa para especificar uma base para a agregação (o período em que o desenvolvedor pode usar o pacote de transações) e para especificar informações relacionadas ao pacote, como o tamanho dele.

    Insira as seguintes informações na janela "Tabela de preços genérica":

    Campo Descrição
    Base de agregação

    O período em que o desenvolvedor pode usar o pacote de transações (ou usar um pacote personalizado baseado em atributos). Selecione um número de meses (1 a 12 meses). Após esse período, o plano expira, e o desenvolvedor precisa comprar o plano (e os pacotes) novamente.

    Para mais detalhes sobre quando os pacotes são redefinidos, consulte Quando as taxas recorrentes são cobradas e os planos de pacote são redefinidos?.

    Tamanho do pacote

    O número de transações em um pacote (ou um número relacionado a um atributo personalizado, como o número total de bytes transmitidos em um pacote). Cada pacote pode receber um preço. Você pode definir esse preço no campo "Tamanho do pacote" da seção "Preços". O preço se aplica a todo o pacote. Especifique o limite máximo do primeiro pacote, até 1.000 (o limite mínimo é predefinido como maior que 0). Clique em "+" para adicionar um segundo pacote, por exemplo, entre 1.000 e 2.000. Clique em "+" para adicionar mais pacotes. É 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.

    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, mas pode ser alterado aqui.

    Tamanho do pacote (preço)

    Preço de um pacote. Você especifica um preço para cada pacote. Insira um número decimal com até quatro casas decimais.

    Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa de pacote usando a API, não a interface. Para mais detalhes, consulte Configurar o número de casas decimais para as tarifas do plano de tarifa.

    Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0 a 1.000 e maior de 1.000 até 2.000), insira 50 para o pacote maior que 0 até 1.000 e 40 para o maior de 1.000 até 2.000. Se a moeda selecionada for o dólar americano, o preço do primeiro pacote será de US $50 e, para o segundo, US $40. O preço do pacote aplicável é cobrado do desenvolvedor, independentemente do número de transações feitas no pacote. Ou seja, o preço do pacote é cobrado assim que a primeira transação é concluída.

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

Configurar o plano de tabela de preços usando a API

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

Especificar os detalhes do plano de tabela de preços usando a API

Você especifica os detalhes do plano de preços ao criá-lo. 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 carregamento escolhido: taxa fixa, volume com faixa ou pacotes.

Como especificar um modelo de carregamento de taxa fixa

Para implementar o modelo de cobrança de taxa fixa, 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) 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 é fixa por unidade, ou seja, não é baseada no volume de transações, como é o caso do modelo de cobrança por volume ou pacotes.
  • 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 tarifa de plano de tarifa com detalhes sobre o cálculo da taxa. Como o modelo de cobrança é baseado em uma taxa fixa, só especifique uma taxa do plano de tarifas.

Na tarifa do plano de tarifa, você especifica:

  • É o tipo de tarifa do plano de tarifas (RATECARD).
  • Taxa do plano. Por exemplo, se você especificar 0,10 e a moeda for dólares americanos, será cobrado US $0,10 do desenvolvedor por cada transação (ou, se estiver baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor receberá uma cobrança de US $0,10 pela transmissão do número especificado de bytes).
  • A unidade inicial do aplicativo de taxa (0). Isso significa que a taxa é aplicada a cada transação, começando pela primeira.

Consulte as configurações de detalhes do plano de tarifa para conferir uma lista completa das opções de detalhes.

Por exemplo, o código a seguir cria 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 deve ser feito 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

Especificar um modelo de carregamento com volume em faixa

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

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) 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 "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 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 é calculado com base na agregação (por exemplo, um mês) para determinar a faixa de volume aplicável.
  • Contadores de agregação usados para determinar a banda de volume aplicável.

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

  • É o tipo de tarifa do plano de tarifas (RATECARD).
  • Taxa do plano. Por exemplo, se você especificar 0,10 e a moeda for dólares americanos, será cobrado US $0,15 do desenvolvedor por cada transação ou, se estiver baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor receberá uma cobrança de US $0,15 pela transmissão do número especificado de bytes.
  • A unidade inicial e final da banda de volume. A unidade inicial especifica o limite mínimo da banda de volume, 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 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 é de um mês e a taxa das primeiras 1.000 transações é de 0,15, o desenvolvedor é cobrado US $0,15 por transação para até 1.000 transações no mês.

    Para mais detalhes sobre quando os pacotes são redefinidos, consulte Quando as taxas recorrentes são cobradas e os planos de pacote são redefinidos?.

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

Consulte as configurações de detalhes do plano de tarifa para conferir uma lista completa das opções de detalhes.

Por exemplo, o modelo a seguir cria um plano de tabela de preços com um modelo de carregamento com faixa de volume. A taxa é definida como 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 de agregação é de um mês. O pagamento deve ser feito 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 (antecipadamente) por um "pacote" de transações (ou por um pacote com base em um atributo personalizado, como o número de bytes transmitidos). Especifique 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 primeiro tamanho é de 1 a 1.000 transações e o segundo é de 1.001 a 2.000 transações. A taxa é 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 pagará US $50 (antecipadamente) por 1.000 transações em um mês. O desenvolvedor é cobrado pelo valor definido, mesmo que o pacote não seja totalmente usado. O plano expira após o término do período de agregação. Se o desenvolvedor quiser usar o pacote novamente, será necessário comprar o plano e o pacote outra vez.

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

  • Cada plano de tarifa 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 as configurações de detalhes do plano de tarifa para conferir uma lista completa das opções de detalhes.

Por exemplo, o código a seguir cria um plano de tabela de preços com um modelo de cobrança em pacote. A taxa é definida como US $50 para o primeiro pacote (até 1.000 transações) e US $40 para o segundo (mais de 1.000 e até 2.000 transações). A base de agregação é de um mês. O pagamento deve ser feito 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 tabela de preços, é possível configurar um plano freemium para um produto individual, em vez de para 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 na tabela de preços o período em que o desenvolvedor pode usar os recursos fornecidos pelo produto da API sem custo financeiro. O período pode ser baseado em um dos seguintes fatores:

  • Duração, ou seja, o tempo entre a data de vigência e a data de término.
  • Quantidade, como o número de transações que envolvem o produto de API ou o volume pertencente a um atributo personalizado registrado na política de registro 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 tabela de preços com um plano freemium baseado em um volume de 5.000 unidades (as especificações relacionadas a freemium estão destacadas).

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